losant_rest 1.10.3 → 1.13.0

data/docs/instanceMember.md

@@ -0,0 +1,133 @@
+# Instance Member Actions
+
+Details on the various actions that can be performed on the
+Instance Member resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+
+<br/>
+
+## Delete
+
+Deletes an instance member
+
+```ruby
+result = client.instance_member.delete(
+  instanceId: my_instance_id,
+  userId: my_user_id)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Instance, all.User, instanceMember.*, or instanceMember.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| userId | string | Y | ID associated with the instance member |  | 575ec8687ae143cd83dc4a94 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If member was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance or member was not found |
+
+<br/>
+
+## Get
+
+Returns an instance member
+
+```ruby
+result = client.instance_member.get(
+  instanceId: my_instance_id,
+  userId: my_user_id)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Instance, all.Instance.read, all.User, all.User.read, instanceMember.*, or instanceMember.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| userId | string | Y | ID associated with the instance member |  | 575ec8687ae143cd83dc4a94 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Member](_schemas.md#instance-member) | A single instance member |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance or member was not found |
+
+<br/>
+
+## Patch
+
+Modifies the role of an instance member
+
+```ruby
+result = client.instance_member.patch(
+  instanceId: my_instance_id,
+  userId: my_user_id,
+  member: my_member)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Instance, all.User, instanceMember.*, or instanceMember.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| userId | string | Y | ID associated with the instance member |  | 575ec8687ae143cd83dc4a94 |
+| member | [Instance Member Patch](_schemas.md#instance-member-patch) | Y | Object containing new member info |  | [Instance Member Patch Example](_schemas.md#instance-member-patch-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Member Patch](_schemas.md#instance-member-patch) | The modified instance member |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance or member was not found |

data/docs/instanceMembers.md

@@ -0,0 +1,91 @@
+# Instance Members Actions
+
+Details on the various actions that can be performed on the
+Instance Members resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns an instance member
+
+```ruby
+result = client.instance_members.get(instanceId: my_instance_id)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Instance, all.Instance.read, all.User, all.User.read, instanceMembers.*, or instanceMembers.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| sortField | string | N | Field to sort the results by. Accepted values are: email, role | email | role |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role |  | email |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my * instance |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Members](_schemas.md#instance-members) | A collection of instance members |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance was not found |
+
+<br/>
+
+## Post
+
+Creates a new instance member
+
+```ruby
+result = client.instance_members.post(
+  instanceId: my_instance_id,
+  member: my_member)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Instance, all.User, instanceMembers.*, or instanceMembers.post.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| member | [Instance Member Post](_schemas.md#instance-member-post) | Y | Object containing new member info |  | [Instance Member Post Example](_schemas.md#instance-member-post-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Member](_schemas.md#instance-member) | The newly created instance member |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance was not found |

data/docs/instanceOrg.md

@@ -0,0 +1,133 @@
+# Instance Org Actions
+
+Details on the various actions that can be performed on the
+Instance Org resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+
+<br/>
+
+## Delete
+
+Deletes an organization
+
+```ruby
+result = client.instance_org.delete(
+  instanceId: my_instance_id,
+  orgId: my_org_id)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Instance, all.User, instanceOrg.*, or instanceOrg.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If organization was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization was not found |
+
+<br/>
+
+## Get
+
+Retrieves information on an organization
+
+```ruby
+result = client.instance_org.get(
+  instanceId: my_instance_id,
+  orgId: my_org_id)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Organization](_schemas.md#instance-organization) | A single organization |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization was not found |
+
+<br/>
+
+## Patch
+
+Updates information about an organization
+
+```ruby
+result = client.instance_org.patch(
+  instanceId: my_instance_id,
+  orgId: my_org_id,
+  organization: my_organization)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Instance, all.User, instanceOrg.*, or instanceOrg.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+| organization | [Instance Owned Organization Patch](_schemas.md#instance-owned-organization-patch) | Y | Object containing new organization properties |  | [Instance Owned Organization Patch Example](_schemas.md#instance-owned-organization-patch-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Organization](_schemas.md#instance-organization) | Updated organization information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization was not found |

data/docs/instanceOrgMember.md

@@ -0,0 +1,139 @@
+# Instance Org Member Actions
+
+Details on the various actions that can be performed on the
+Instance Org Member resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+
+<br/>
+
+## Delete
+
+Deletes an organization member
+
+```ruby
+result = client.instance_org_member.delete(
+  instanceId: my_instance_id,
+  orgId: my_org_id,
+  userId: my_user_id)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Instance, all.User, instanceOrgMember.*, or instanceOrgMember.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a95 |
+| orgId | string | Y | ID associated with the organization |  | 575ec8687ae143cd83dc4a97 |
+| userId | string | Y | ID associated with the organization member |  | 575ec8687ae143cd83dc4a94 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If member was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization or member was not found |
+
+<br/>
+
+## Get
+
+Returns an organization member
+
+```ruby
+result = client.instance_org_member.get(
+  instanceId: my_instance_id,
+  orgId: my_org_id,
+  userId: my_user_id)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgMember.*, or instanceOrgMember.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a95 |
+| orgId | string | Y | ID associated with the organization |  | 575ec8687ae143cd83dc4a97 |
+| userId | string | Y | ID associated with the organization member |  | 575ec8687ae143cd83dc4a94 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Org Member](_schemas.md#instance-org-member) | A single organization member |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance, organization, or member was not found |
+
+<br/>
+
+## Patch
+
+Modifies the role of an organization member
+
+```ruby
+result = client.instance_org_member.patch(
+  instanceId: my_instance_id,
+  orgId: my_org_id,
+  userId: my_user_id,
+  member: my_member)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Instance, all.User, instanceOrgMember.*, or instanceOrgMember.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a95 |
+| orgId | string | Y | ID associated with the organization |  | 575ec8687ae143cd83dc4a97 |
+| userId | string | Y | ID associated with the organization member |  | 575ec8687ae143cd83dc4a94 |
+| member | [Instance Org Member Patch](_schemas.md#instance-org-member-patch) | Y | Object containing new member info |  | [Instance Org Member Patch Example](_schemas.md#instance-org-member-patch-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Org Member](_schemas.md#instance-org-member) | The modified organization member |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization or member was not found |