losant_rest 1.16.6 → 1.17.0

data/docs/applicationApiTokens.md

@@ -43,7 +43,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [API Token](_schemas.md#api-token) | Collection of API tokens |
+| 200 | [API Tokens](_schemas.md#api-tokens) | Collection of API tokens |
 
 #### Error Responses
 

data/docs/events.md

@@ -164,7 +164,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | undefined | The event, plus count of currently new events |
+| 200 | [Event Plus New Count](_schemas.md#event-plus-new-count) | The event, plus count of currently new events |
 
 #### Error Responses
 

data/docs/notebook.md

@@ -130,7 +130,7 @@ all.Application, all.Organization, all.User, notebook.*, or notebook.execute.
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | If execution request was accepted and successfully queued |
+| 200 | [Success With Execution ID](_schemas.md#success-with-execution-id) | If execution request was accepted and successfully queued |
 
 #### Error Responses
 

data/docs/resourceJob.md

@@ -0,0 +1,263 @@
+# Resource Job Actions
+
+Details on the various actions that can be performed on the
+Resource Job resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Cancel Execution](#cancel-execution)
+*   [Delete](#delete)
+*   [Execute](#execute)
+*   [Get](#get)
+*   [Logs](#logs)
+*   [Patch](#patch)
+
+<br/>
+
+## Cancel Execution
+
+Marks a specific resource job execution for cancellation
+
+```ruby
+result = client.resource_job.cancel_execution(
+  applicationId: my_application_id,
+  resourceJobId: my_resource_job_id,
+  executionId: my_execution_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.Organization, all.User, resourceJob.*, or resourceJob.cancelExecution.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| resourceJobId | string | Y | ID associated with the resource job |  | 575ec8687ae143cd83dc4a97 |
+| executionId | undefined | Y | The ID of the execution to cancel |  | 632e18632f59592e773a4153 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If the execution was successfully marked for cancellation |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if execution was not found |
+
+<br/>
+
+## Delete
+
+Deletes a resource job
+
+```ruby
+result = client.resource_job.delete(
+  applicationId: my_application_id,
+  resourceJobId: my_resource_job_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.Organization, all.User, resourceJob.*, or resourceJob.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| resourceJobId | string | Y | ID associated with the resource job |  | 575ec8687ae143cd83dc4a97 |
+| includeWorkflows | string | N | If the workflows that trigger from this resource job should also be deleted. |  | true |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If resource job was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if resource job was not found |
+
+<br/>
+
+## Execute
+
+Queues the execution of a resource job
+
+```ruby
+result = client.resource_job.execute(
+  applicationId: my_application_id,
+  resourceJobId: my_resource_job_id,
+  executionOptions: my_execution_options)
+
+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.Organization, all.User, resourceJob.*, or resourceJob.execute.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| resourceJobId | string | Y | ID associated with the resource job |  | 575ec8687ae143cd83dc4a97 |
+| executionOptions | [Resource Job Execution Options](_schemas.md#resource-job-execution-options) | Y | The options for the execution |  | [Resource Job Execution Options Example](_schemas.md#resource-job-execution-options-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success With Execution ID](_schemas.md#success-with-execution-id) | If the job was successfully queued |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if resource job was not found |
+
+<br/>
+
+## Get
+
+Returns a resource job
+
+```ruby
+result = client.resource_job.get(
+  applicationId: my_application_id,
+  resourceJobId: my_resource_job_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, resourceJob.*, or resourceJob.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| resourceJobId | string | Y | ID associated with the resource job |  | 575ec8687ae143cd83dc4a97 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Resource Job](_schemas.md#resource-job) | A single resource job |
+
+#### 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/>
+
+## Logs
+
+Retrieves information on resource job executions
+
+```ruby
+result = client.resource_job.logs(
+  applicationId: my_application_id,
+  resourceJobId: my_resource_job_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, resourceJob.*, or resourceJob.logs.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| resourceJobId | string | Y | ID associated with the resource job |  | 575ec8687ae143cd83dc4a97 |
+| limit | string | N | Max log entries to return (ordered by time descending) | 1 | 10 |
+| since | string | N | Look for log entries since this time (ms since epoch) |  | 1465790400000 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Resource Job Execution Logs](_schemas.md#resource-job-execution-logs) | Resource job execution information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if resource job was not found |
+
+<br/>
+
+## Patch
+
+Update a resource job
+
+```ruby
+result = client.resource_job.patch(
+  applicationId: my_application_id,
+  resourceJobId: my_resource_job_id,
+  resourceJob: my_resource_job)
+
+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.Organization, all.User, resourceJob.*, or resourceJob.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| resourceJobId | string | Y | ID associated with the resource job |  | 575ec8687ae143cd83dc4a97 |
+| resourceJob | [Resource Job Patch](_schemas.md#resource-job-patch) | Y | The new resource job configuration |  | [Resource Job Patch Example](_schemas.md#resource-job-patch-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Resource Job](_schemas.md#resource-job) | Successfully updated resource job |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if resource job was not found |

data/docs/resourceJobs.md

@@ -0,0 +1,93 @@
+# Resource Jobs Actions
+
+Details on the various actions that can be performed on the
+Resource Jobs resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the resource jobs for an application
+
+```ruby
+result = client.resource_jobs.get(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, resourceJobs.*, or resourceJobs.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated, lastExecutionRequested, resourceType | 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, resourceType |  | device |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my*job |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Resource Jobs](_schemas.md#resource-jobs) | Collection of resource jobs |
+
+#### 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 resource job for an application
+
+```ruby
+result = client.resource_jobs.post(
+  applicationId: my_application_id,
+  resourceJob: my_resource_job)
+
+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.Organization, all.User, resourceJobs.*, or resourceJobs.post.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| resourceJob | [Resource Job Post](_schemas.md#resource-job-post) | Y | New resource job information |  | [Resource Job Post Example](_schemas.md#resource-job-post-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Resource Job](_schemas.md#resource-job) | Successfully created resource job |
+
+#### 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 |

data/lib/losant_rest/application_api_tokens.rb

@@ -53,7 +53,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Collection of API tokens (https://api.losant.com/#/definitions/apiToken)
+    # *  200 - Collection of API tokens (https://api.losant.com/#/definitions/apiTokens)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.23.6
+  # Built For Version 1.24.0
   class Client
     attr_accessor :auth_token, :url
 
@@ -352,6 +352,14 @@ module LosantRest
       @orgs ||= Orgs.new(self)
     end
 
+    def resource_job
+      @resource_job ||= ResourceJob.new(self)
+    end
+
+    def resource_jobs
+      @resource_jobs ||= ResourceJobs.new(self)
+    end
+
     def user_api_token
       @user_api_token ||= UserApiToken.new(self)
     end
@@ -374,7 +382,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.23.6"
+      headers["Accept-Version"] = "^1.24.0"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/events.rb

@@ -202,7 +202,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - The event, plus count of currently new events
+    # *  200 - The event, plus count of currently new events (https://api.losant.com/#/definitions/eventPlusNewCount)
     #
     # Errors:
     # *  404 - Error if application was not found (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/notebook.rb

@@ -144,7 +144,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If execution request was accepted and successfully queued (https://api.losant.com/#/definitions/success)
+    # *  200 - If execution request was accepted and successfully queued (https://api.losant.com/#/definitions/successWithExecutionId)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)