losant_rest 1.15.2 → 1.16.0

data/docs/application.md

@@ -421,9 +421,7 @@ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli,
 Add multiple resources to an application via a zip file
 
 ```ruby
-result = client.application.import(
-  applicationId: my_application_id,
-  importBundle: my_import_bundle)
+result = client.application.import(applicationId: my_application_id)
 
 puts result
 ```
@@ -438,8 +436,9 @@ all.Application, all.Organization, all.User, application.*, or application.impor
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
-| importBundle | file | Y | The zip file containing all of the resources to import into the application |  | undefined |
+| importBundle | file | N | The zip file containing all of the resources to import into the application |  | undefined |
 | email | string | N | Email address to notify the user when the job to import the application resources has completed or errored, defaults to the email address of the user making the request |  | email@example.com |
+| options | [Application Import Options](_schemas.md#application-import-options) | N | Additional import options |  | [Application Import Options Example](_schemas.md#application-import-options-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/applications.md

@@ -61,7 +61,7 @@ all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read,
 Create a new application from an import bundle
 
 ```ruby
-result = client.applications.import(importBundle: my_import_bundle)
+result = client.applications.import(optional_params)
 
 puts result
 ```
@@ -75,13 +75,14 @@ all.Organization, all.User, applications.*, or applications.import.
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
-| importBundle | file | Y | The zip file containing the application to import and all of its resources |  | undefined |
+| importBundle | file | N | The zip file containing the application to import and all of its resources |  | undefined |
 | ownerId | string | N | The owner id of the new application, defaults to the id of the user making the request |  | 575ed6e87ae143cd83dc4aa8 |
 | ownerType | string | N | The type of the owner id. Accepted values are: user, organization | user | user |
 | includeDevices | string | N | If set, import devices from the import bundle |  | true |
 | includeDataTableRows | string | N | If set, import data table rows from import bundle |  | true |
 | includeFiles | string | N | If set, import files from import bundle |  | true |
 | email | string | N | Email address to notify the user when the job to import the application has completed or errored, defaults to the email address of the user making the request |  | email@example.com |
+| options | [Application Import Options](_schemas.md#application-import-options) | N | Additional import options |  | [Application Import Options Example](_schemas.md#application-import-options-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/flows.md

@@ -9,6 +9,7 @@ parameters and the potential responses.
 *   [Get](#get)
 *   [Get by Version](#get-by-version)
 *   [Import](#import)
+*   [Palette](#palette)
 *   [Post](#post)
 
 <br/>
@@ -151,6 +152,43 @@ all.Application, all.Organization, all.User, flows.*, or flows.import.
 
 <br/>
 
+## Palette
+
+Gets additional nodes that should be available in the palette
+
+```ruby
+result = client.flows.palette(applicationId: my_application_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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flows.*, or flows.palette.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Palette Response](_schemas.md#palette-response) | The additional nodes available in the palette |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |
+
+<br/>
+
 ## Post
 
 Create a new flow for an application

data/docs/instanceCustomNode.md

@@ -0,0 +1,222 @@
+# Instance Custom Node Actions
+
+Details on the various actions that can be performed on the
+Instance Custom Node resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Errors](#errors)
+*   [Get](#get)
+*   [Patch](#patch)
+*   [Stats](#stats)
+
+<br/>
+
+## Delete
+
+Deletes a Custom Node
+
+```ruby
+result = client.instance_custom_node.delete(
+  instanceId: my_instance_id,
+  instanceCustomNodeId: my_instance_custom_node_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, instanceCustomNode.*, or instanceCustomNode.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| instanceCustomNodeId | string | Y | ID associated with the Custom Node |  | 575ec7417ae143cd83dc4a95 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If Custom Node was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if Custom Node was not found |
+
+<br/>
+
+## Errors
+
+Get information about errors that occurred during runs of this Custom Node
+
+```ruby
+result = client.instance_custom_node.errors(
+  instanceId: my_instance_id,
+  instanceCustomNodeId: my_instance_custom_node_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, instanceCustomNode.*, or instanceCustomNode.errors.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| instanceCustomNodeId | string | Y | ID associated with the Custom Node |  | 575ec7417ae143cd83dc4a95 |
+| duration | string | N | Duration of time range in milliseconds | 86400000 | 86400000 |
+| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
+| limit | string | N | Maximum number of errors to return | 25 | 25 |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | desc |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Workflow Errors](_schemas.md#workflow-errors) | Custom Node error information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if Custom Node was not found |
+
+<br/>
+
+## Get
+
+Retrieves information on a Custom Node
+
+```ruby
+result = client.instance_custom_node.get(
+  instanceId: my_instance_id,
+  instanceCustomNodeId: my_instance_custom_node_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, instanceCustomNode.*, or instanceCustomNode.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| instanceCustomNodeId | string | Y | ID associated with the Custom Node |  | 575ec7417ae143cd83dc4a95 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Custom Node](_schemas.md#instance-custom-node) | Custom Node information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if Custom Node was not found |
+
+<br/>
+
+## Patch
+
+Updates information about a Custom Node
+
+```ruby
+result = client.instance_custom_node.patch(
+  instanceId: my_instance_id,
+  instanceCustomNodeId: my_instance_custom_node_id,
+  instanceCustomNode: my_instance_custom_node)
+
+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, instanceCustomNode.*, or instanceCustomNode.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| instanceCustomNodeId | string | Y | ID associated with the Custom Node |  | 575ec7417ae143cd83dc4a95 |
+| instanceCustomNode | [Instance Custom Node Patch](_schemas.md#instance-custom-node-patch) | Y | Object containing new properties of the Custom Node |  | [Instance Custom Node Patch Example](_schemas.md#instance-custom-node-patch-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Custom Node](_schemas.md#instance-custom-node) | Updated Custom Node information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if Custom Node was not found |
+
+<br/>
+
+## Stats
+
+Get statistics about runs for this Custom Node
+
+```ruby
+result = client.instance_custom_node.stats(
+  instanceId: my_instance_id,
+  instanceCustomNodeId: my_instance_custom_node_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, instanceCustomNode.*, or instanceCustomNode.stats.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| instanceCustomNodeId | string | Y | ID associated with the Custom Node |  | 575ec7417ae143cd83dc4a95 |
+| duration | string | N | Duration of time range in milliseconds | 86400000 | 86400000 |
+| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
+| resolution | string | N | Resolution in milliseconds | 3600000 | 3600000 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Workflow Statistics](_schemas.md#workflow-statistics) | Statistics for Custom Node runs |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if Custom Node was not found |

data/docs/instanceCustomNodes.md

@@ -0,0 +1,91 @@
+# Instance Custom Nodes Actions
+
+Details on the various actions that can be performed on the
+Instance Custom Nodes resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the Custom Nodes for an instance
+
+```ruby
+result = client.instance_custom_nodes.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, instanceCustomNodes.*, or instanceCustomNodes.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, id, creationDate, lastUpdated | 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 |  | key |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my*node |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Custom Nodes](_schemas.md#instance-custom-nodes) | Collection of Custom Nodes |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
+## Post
+
+Create a new Custom Node for an instance
+
+```ruby
+result = client.instance_custom_nodes.post(
+  instanceId: my_instance_id,
+  instanceCustomNode: my_instance_custom_node)
+
+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, instanceCustomNodes.*, or instanceCustomNodes.post.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| instanceCustomNode | [Instance Custom Node Post](_schemas.md#instance-custom-node-post) | Y | Custom Node information |  | [Instance Custom Node Post Example](_schemas.md#instance-custom-node-post-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Instance Custom Node](_schemas.md#instance-custom-node) | The successfully created Custom Node |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.22.2
+  # Built For Version 1.23.0
   class Client
     attr_accessor :auth_token, :url
 
@@ -268,6 +268,14 @@ module LosantRest
       @instance_api_tokens ||= InstanceApiTokens.new(self)
     end
 
+    def instance_custom_node
+      @instance_custom_node ||= InstanceCustomNode.new(self)
+    end
+
+    def instance_custom_nodes
+      @instance_custom_nodes ||= InstanceCustomNodes.new(self)
+    end
+
     def instance_member
       @instance_member ||= InstanceMember.new(self)
     end
@@ -358,7 +366,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.22.2"
+      headers["Accept-Version"] = "^1.23.0"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/flows.rb

@@ -213,6 +213,50 @@ module LosantRest
         body: body)
     end
 
+    # Gets additional nodes that should be available in the palette
+    #
+    # 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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flows.*, or flows.palette.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} losantdomain - Domain scope of request (rarely needed)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - The additional nodes available in the palette (https://api.losant.com/#/definitions/paletteResponse)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application was not found (https://api.losant.com/#/definitions/error)
+    def palette(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+
+      headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
+      query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
+      query_params[:_links] = params[:_links] if params.has_key?(:_links)
+      query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
+
+      path = "/applications/#{params[:applicationId]}/flows/palette"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Create a new flow for an application
     #
     # Authentication: