losant_rest 1.13.0 → 1.13.1

data/docs/instanceApiTokens.md

@@ -0,0 +1,91 @@
+# Instance Api Tokens Actions
+
+Details on the various actions that can be performed on the
+Instance Api Tokens resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the API tokens for an instance
+
+```ruby
+result = client.instance_api_tokens.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, instanceApiTokens.*, or instanceApiTokens.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| sortField | string | N | Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated, expirationDate | name | name |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
+| page | string | N | Which page of results to return | 0 | 0 |
+| perPage | string | N | How many items to return per page | 100 | 10 |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, status |  | key |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my*token |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [API Token](_schemas.md#api-token) | Collection of API tokens |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
+## Post
+
+Create a new API token for an instance
+
+```ruby
+result = client.instance_api_tokens.post(
+  instanceId: my_instance_id,
+  apiToken: my_api_token)
+
+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, instanceApiTokens.*, or instanceApiTokens.post.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| apiToken | [API Token Post](_schemas.md#api-token-post) | Y | API token information |  | [API Token Post Example](_schemas.md#api-token-post-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [API Token](_schemas.md#api-token) | The successfully created API token |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |

data/docs/instanceMembers.md

@@ -13,7 +13,7 @@ parameters and the potential responses.
 
 ## Get
 
-Returns an instance member
+Returns a collection of instance members
 
 ```ruby
 result = client.instance_members.get(instanceId: my_instance_id)

data/docs/instanceOrgMembers.md

@@ -13,7 +13,7 @@ parameters and the potential responses.
 
 ## Get
 
-Returns an instance member
+Returns a collection of instance organization members
 
 ```ruby
 result = client.instance_org_members.get(

data/docs/userApiToken.md

@@ -0,0 +1,125 @@
+# User Api Token Actions
+
+Details on the various actions that can be performed on the
+User Api Token resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+
+<br/>
+
+## Delete
+
+Deletes an API Token
+
+```ruby
+result = client.user_api_token.delete(apiTokenId: my_api_token_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.User, userApiToken.*, or userApiToken.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| apiTokenId | string | Y | ID associated with the API token |  | 575ec7417ae143cd83dc4a95 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If API token was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if API token was not found |
+
+<br/>
+
+## Get
+
+Retrieves information on an API token
+
+```ruby
+result = client.user_api_token.get(apiTokenId: my_api_token_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.User, all.User.read, userApiToken.*, or userApiToken.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| apiTokenId | string | Y | ID associated with the API token |  | 575ec7417ae143cd83dc4a95 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [API Token](_schemas.md#api-token) | API token information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if API token was not found |
+
+<br/>
+
+## Patch
+
+Updates information about an API token
+
+```ruby
+result = client.user_api_token.patch(
+  apiTokenId: my_api_token_id,
+  apiToken: my_api_token)
+
+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.User, userApiToken.*, or userApiToken.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| apiTokenId | string | Y | ID associated with the API token |  | 575ec7417ae143cd83dc4a95 |
+| apiToken | [API Token Patch](_schemas.md#api-token-patch) | Y | Object containing new properties of the API token |  | [API Token Patch Example](_schemas.md#api-token-patch-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [API Token](_schemas.md#api-token) | Updated API token information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if API token was not found |

data/docs/userApiTokens.md

@@ -0,0 +1,87 @@
+# User Api Tokens Actions
+
+Details on the various actions that can be performed on the
+User Api Tokens resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the API tokens for a user
+
+```ruby
+result = client.user_api_tokens.get(optional_params)
+
+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.User, all.User.read, userApiTokens.*, or userApiTokens.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| sortField | string | N | Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated, expirationDate | name | name |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
+| page | string | N | Which page of results to return | 0 | 0 |
+| perPage | string | N | How many items to return per page | 100 | 10 |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, status |  | key |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my*token |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [API Token](_schemas.md#api-token) | Collection of API tokens |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
+## Post
+
+Create a new API token for an user
+
+```ruby
+result = client.user_api_tokens.post(apiToken: my_api_token)
+
+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.User, userApiTokens.*, or userApiTokens.post.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| apiToken | [API Token Post](_schemas.md#api-token-post) | Y | API token information |  | [API Token Post Example](_schemas.md#api-token-post-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [API Token](_schemas.md#api-token) | The successfully created API token |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |

data/lib/losant_rest.rb

@@ -76,6 +76,8 @@ require_relative "losant_rest/flow_version"
 require_relative "losant_rest/flow_versions"
 require_relative "losant_rest/flows"
 require_relative "losant_rest/instance"
+require_relative "losant_rest/instance_api_token"
+require_relative "losant_rest/instance_api_tokens"
 require_relative "losant_rest/instance_member"
 require_relative "losant_rest/instance_members"
 require_relative "losant_rest/instance_org"
@@ -91,6 +93,8 @@ require_relative "losant_rest/notebooks"
 require_relative "losant_rest/org"
 require_relative "losant_rest/org_invites"
 require_relative "losant_rest/orgs"
+require_relative "losant_rest/user_api_token"
+require_relative "losant_rest/user_api_tokens"
 require_relative "losant_rest/webhook"
 require_relative "losant_rest/webhooks"
 require_relative "losant_rest/client"

data/lib/losant_rest/application.rb

@@ -405,7 +405,7 @@ module LosantRest
     # 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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.get.
+    # all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, application.*, or application.get.
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
@@ -453,7 +453,7 @@ module LosantRest
     # 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.Application, all.Organization, all.User, application.*, or application.patch.
+    # all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
@@ -547,7 +547,7 @@ module LosantRest
     # 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.Application, all.Organization, all.User, application.*, or application.patch.
+    # all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
@@ -646,7 +646,7 @@ module LosantRest
     # 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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.get.
+    # all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, application.*, or application.get.
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
@@ -690,7 +690,7 @@ module LosantRest
     # 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.Application, all.Organization, all.User, application.*, or application.patch.
+    # all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application

data/lib/losant_rest/application_api_tokens.rb

@@ -96,7 +96,7 @@ module LosantRest
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
-    # *  {hash} apiToken - API token information (https://api.losant.com/#/definitions/applicationApiTokenPost)
+    # *  {hash} apiToken - API token information (https://api.losant.com/#/definitions/apiTokenPost)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response

data/lib/losant_rest/applications.rb

@@ -37,7 +37,7 @@ module LosantRest
     # 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.Organization, all.Organization.read, all.User, all.User.read, applications.*, or applications.get.
+    # all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, applications.*, or applications.get.
     #
     # Parameters:
     # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, lastUpdated

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.20.0
+  # Built For Version 1.20.1
   class Client
     attr_accessor :auth_token, :url
 
@@ -248,6 +248,14 @@ module LosantRest
       @instance ||= Instance.new(self)
     end
 
+    def instance_api_token
+      @instance_api_token ||= InstanceApiToken.new(self)
+    end
+
+    def instance_api_tokens
+      @instance_api_tokens ||= InstanceApiTokens.new(self)
+    end
+
     def instance_member
       @instance_member ||= InstanceMember.new(self)
     end
@@ -308,6 +316,14 @@ module LosantRest
       @orgs ||= Orgs.new(self)
     end
 
+    def user_api_token
+      @user_api_token ||= UserApiToken.new(self)
+    end
+
+    def user_api_tokens
+      @user_api_tokens ||= UserApiTokens.new(self)
+    end
+
     def webhook
       @webhook ||= Webhook.new(self)
     end
@@ -322,7 +338,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.20.0"
+      headers["Accept-Version"] = "^1.20.1"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")