losant_rest 1.20.1 → 1.21.1

data/docs/instanceSandbox.md

@@ -7,7 +7,11 @@ parameters and the potential responses.
 ##### Contents
 
 *   [Delete](#delete)
+*   [Device Counts](#device-counts)
 *   [Get](#get)
+*   [Notebook Minute Counts](#notebook-minute-counts)
+*   [Payload Counts](#payload-counts)
+*   [Payload Counts Breakdown](#payload-counts-breakdown)
 *   [Undelete](#undelete)
 
 <br/>
@@ -48,7 +52,49 @@ all.Instance, all.User, instanceSandbox.*, or instanceSandbox.delete.
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if instance, organization or invite was not found |
+| 404 | [Error](_schemas.md#error) | Error if sandbox or instance was not found |
+
+<br/>
+
+## Device Counts
+
+Returns device counts by day for the time range specified for all applications the sandbox user owns
+
+```ruby
+result = client.instance_sandbox.device_counts(
+  instanceId: my_instance_id,
+  instanceSandboxId: my_instance_sandbox_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, instanceSandbox.*, or instanceSandbox.deviceCounts.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| instanceSandboxId | string | Y | ID associated with the sandbox user |  | 575ec8687ae143cd83dc4a97 |
+| start | string | N | Start of range for device count query (ms since epoch) |  | 0 |
+| end | string | N | End of range for device count query (ms since epoch) |  | 1465790400000 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Device Counts](_schemas.md#device-counts) | Device counts by day |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if sandbox or instance was not found |
 
 <br/>
 
@@ -90,7 +136,137 @@ all.Instance, all.Instance.read, all.User, all.User.read, instanceSandbox.*, or
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if sandbox was not found |
+| 404 | [Error](_schemas.md#error) | Error if sandbox or instance was not found |
+
+<br/>
+
+## Notebook Minute Counts
+
+Returns notebook execution usage by day for the time range specified for all applications the sandbox user owns
+
+```ruby
+result = client.instance_sandbox.notebook_minute_counts(
+  instanceId: my_instance_id,
+  instanceSandboxId: my_instance_sandbox_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, instanceSandbox.*, or instanceSandbox.notebookMinuteCounts.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| instanceSandboxId | string | Y | ID associated with the sandbox user |  | 575ec8687ae143cd83dc4a97 |
+| start | string | N | Start of range for notebook execution query (ms since epoch) |  | 0 |
+| end | string | N | End of range for notebook execution query (ms since epoch) |  | 1465790400000 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Notebook Minute Counts](_schemas.md#notebook-minute-counts) | Notebook usage information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if sandbox or instance was not found |
+
+<br/>
+
+## Payload Counts
+
+Returns payload counts for the time range specified for all applications the sandbox user owns
+
+```ruby
+result = client.instance_sandbox.payload_counts(
+  instanceId: my_instance_id,
+  instanceSandboxId: my_instance_sandbox_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, instanceSandbox.*, or instanceSandbox.payloadCounts.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| instanceSandboxId | string | Y | ID associated with the sandbox user |  | 575ec8687ae143cd83dc4a97 |
+| start | string | N | Start of range for payload count query (ms since epoch) |  | 0 |
+| end | string | N | End of range for payload count query (ms since epoch) |  | 1465790400000 |
+| asBytes | string | N | If the resulting stats should be returned as bytes | false | true |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Payload Stats](_schemas.md#payload-stats) | Payload counts, by type and source |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if sandbox or instance was not found |
+
+<br/>
+
+## Payload Counts Breakdown
+
+Returns payload counts per resolution in the time range specified for all applications the sandbox user owns
+
+```ruby
+result = client.instance_sandbox.payload_counts_breakdown(
+  instanceId: my_instance_id,
+  instanceSandboxId: my_instance_sandbox_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, instanceSandbox.*, or instanceSandbox.payloadCountsBreakdown.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| instanceSandboxId | string | Y | ID associated with the sandbox user |  | 575ec8687ae143cd83dc4a97 |
+| start | string | N | Start of range for payload count query (ms since epoch) |  | 0 |
+| end | string | N | End of range for payload count query (ms since epoch) |  | 1465790400000 |
+| resolution | string | N | Resolution in milliseconds. Accepted values are: 86400000, 3600000 | 86400000 | 86400000 |
+| asBytes | string | N | If the resulting stats should be returned as bytes | false | true |
+| includeNonBillable | string | N | If non-billable payloads should be included in the result | false | true |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Payload Counts Breakdown](_schemas.md#payload-counts-breakdown) | Sum of payload counts by date |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if sandbox or instance was not found |
 
 <br/>
 
@@ -132,4 +308,4 @@ all.Instance, all.User, instanceSandbox.*, or instanceSandbox.undelete.
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if sandbox was not found |
+| 404 | [Error](_schemas.md#error) | Error if sandbox or instance was not found |

data/docs/me.md

@@ -558,6 +558,7 @@ all.User, all.User.read, me.*, or me.payloadCounts.
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | start | string | N | Start of range for payload count query (ms since epoch) |  | 0 |
 | end | string | N | End of range for payload count query (ms since epoch) |  | 1465790400000 |
+| asBytes | string | N | If the resulting stats should be returned as bytes | false | true |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/org.md

@@ -322,6 +322,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.
 | orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
 | start | string | N | Start of range for payload count query (ms since epoch) |  | 0 |
 | end | string | N | End of range for payload count query (ms since epoch) |  | 1465790400000 |
+| asBytes | string | N | If the resulting stats should be returned as bytes | false | true |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/lib/platform_rest/application.rb

@@ -748,6 +748,7 @@ module PlatformRest
     # *  {string} applicationId - ID of the associated application
     # *  {string} start - Start of range for payload count query (ms since epoch)
     # *  {string} end - End of range for payload count query (ms since epoch)
+    # *  {string} asBytes - If the resulting stats should be returned as bytes
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -769,6 +770,7 @@ module PlatformRest
 
       query_params[:start] = params[:start] if params.has_key?(:start)
       query_params[:end] = params[:end] if params.has_key?(:end)
+      query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
       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)

data/lib/platform_rest/client.rb

@@ -27,7 +27,7 @@ module PlatformRest
   #
   # User API for accessing platform data
   #
-  # Built For Version 1.26.11
+  # Built For Version 1.27.1
   class Client
     attr_accessor :auth_token, :url
 
@@ -300,6 +300,14 @@ module PlatformRest
       @instance_members ||= InstanceMembers.new(self)
     end
 
+    def instance_notification_rule
+      @instance_notification_rule ||= InstanceNotificationRule.new(self)
+    end
+
+    def instance_notification_rules
+      @instance_notification_rules ||= InstanceNotificationRules.new(self)
+    end
+
     def instance_org
       @instance_org ||= InstanceOrg.new(self)
     end
@@ -398,7 +406,7 @@ module PlatformRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.26.11"
+      headers["Accept-Version"] = "^1.27.1"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/platform_rest/devices.rb

@@ -92,7 +92,7 @@ module PlatformRest
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
-    # *  {hash} options - Object containing device query and email (https://api.losant.com/#/definitions/devicesDeletePost)
+    # *  {hash} options - Object containing device deletion options (https://api.losant.com/#/definitions/devicesDeleteOrRestorePost)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -239,7 +239,7 @@ module PlatformRest
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
-    # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated, connectionStatus
+    # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated, connectionStatus, deletedAt
     # *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
     # *  {string} page - Which page of results to return
     # *  {string} perPage - How many items to return per page
@@ -252,6 +252,7 @@ module PlatformRest
     # *  {hash} query - Device filter JSON object which overrides the filterField, filter, deviceClass, tagFilter, and parentId parameters. (https://api.losant.com/#/definitions/advancedDeviceQuery)
     # *  {string} tagsAsObject - Return tags as an object map instead of an array
     # *  {string} attributesAsObject - Return attributes as an object map instead of an array
+    # *  {string} queryDeleted - If true, endpoint will return recently deleted devices instead
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -285,6 +286,7 @@ module PlatformRest
       query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
       query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
       query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
+      query_params[:queryDeleted] = params[:queryDeleted] if params.has_key?(:queryDeleted)
       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)
@@ -553,6 +555,54 @@ module PlatformRest
         body: body)
     end
 
+    # Restore deleted devices
+    #
+    # 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, devices.*, or devices.restore.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} options - Object containing device restoration options (https://api.losant.com/#/definitions/devicesDeleteOrRestorePost)
+    # *  {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 - Object indicating number of devices restored or failed (https://api.losant.com/#/definitions/bulkRestoreResponse)
+    # *  202 - If a job was enqueued for the devices to be restored (https://api.losant.com/#/definitions/jobEnqueuedResult)
+    #
+    # 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 restore(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)
+      raise ArgumentError.new("options is required") unless params.has_key?(:options)
+
+      body = params[:options] if params.has_key?(:options)
+      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]}/devices/restore"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Send a command to multiple devices
     #
     # Authentication:

data/lib/platform_rest/instance.rb

@@ -319,6 +319,56 @@ module PlatformRest
         body: body)
     end
 
+    # Returns payload counts for the time range specified for this instance
+    #
+    # 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, instance.*, or instance.payloadCounts.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {string} start - Start of range for payload count query (ms since epoch)
+    # *  {string} end - End of range for payload count query (ms since epoch)
+    # *  {string} asBytes - If the resulting stats should be returned as bytes
+    # *  {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 - Payload counts, by type and source (https://api.losant.com/#/definitions/payloadStats)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if instance was not found (https://api.losant.com/#/definitions/error)
+    def payload_counts(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
+
+      query_params[:start] = params[:start] if params.has_key?(:start)
+      query_params[:end] = params[:end] if params.has_key?(:end)
+      query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
+      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 = "/instances/#{params[:instanceId]}/payloadCounts"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Returns payload counts per resolution in the time range specified for this instance
     #
     # Authentication: