losant_rest 1.16.1 → 1.16.5

data/docs/applications.md

@@ -82,7 +82,7 @@ all.Organization, all.User, applications.*, or applications.import.
 | 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) |
+| options | [Applications Import Options](_schemas.md#applications-import-options) | N | Additional import options |  | [Applications Import Options Example](_schemas.md#applications-import-options-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/dashboard.md

@@ -189,6 +189,8 @@ No api access token is required to call this action.
 | dashboardId | string | Y | ID of the associated dashboard |  | 575ece2b7ae143cd83dc4a9b |
 | ctx | [Dashboard Context Instance](_schemas.md#dashboard-context-instance) | Y | The context object to validate |  | [Dashboard Context Instance Example](_schemas.md#dashboard-context-instance-example) |
 | password | string | N | Password for password-protected dashboards |  | myPassword |
+| duration | string | N | Duration of data to fetch in milliseconds |  | 3600000 |
+| resolution | string | N | Resolution in milliseconds |  | 60000 |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/device.md

@@ -131,6 +131,8 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
 | excludeConnectionInfo | string | N | If set, do not return connection info |  | true |
+| tagsAsObject | string | N | Return tags as an object map instead of an array. |  | true |
+| attributesAsObject | string | N | Return attributes as an object map instead of an array. |  | false |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -345,6 +347,8 @@ all.Application, all.Organization, all.User, device.*, or device.patch.
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
 | device | [Device Patch](_schemas.md#device-patch) | Y | Object containing new properties of the device |  | [Device Patch Example](_schemas.md#device-patch-example) |
+| tagsAsObject | string | N | Return tags as an object map instead of an array. |  | true |
+| attributesAsObject | string | N | Return attributes as an object map instead of an array. |  | false |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/devices.md

@@ -212,6 +212,8 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | excludeConnectionInfo | string | N | If set, do not return connection info |  | true |
 | parentId | string | N | Filter devices as children of a given system id |  | 575ecf887ae143cd83dc4aa2 |
 | query | [Advanced Device Query](_schemas.md#advanced-device-query) | N | Device filter JSON object which overrides the filterField, filter, deviceClass, tagFilter, and parentId parameters. |  | [Advanced Device Query Example](_schemas.md#advanced-device-query-example) |
+| tagsAsObject | string | N | Return tags as an object map instead of an array. |  | true |
+| attributesAsObject | string | N | Return attributes as an object map instead of an array. |  | false |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -331,6 +333,8 @@ all.Application, all.Organization, all.User, devices.*, or devices.post.
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | device | [Device Post](_schemas.md#device-post) | Y | New device information |  | [Device Post Example](_schemas.md#device-post-example) |
+| tagsAsObject | string | N | Return tags as an object map instead of an array. |  | true |
+| attributesAsObject | string | N | Return attributes as an object map instead of an array. |  | false |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/instanceSandbox.md

@@ -0,0 +1,135 @@
+# Instance Sandbox Actions
+
+Details on the various actions that can be performed on the
+Instance Sandbox resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Undelete](#undelete)
+
+<br/>
+
+## Delete
+
+Deletes a sandbox user account
+
+```ruby
+result = client.instance_sandbox.delete(
+  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.User, instanceSandbox.*, or instanceSandbox.delete.
+
+#### 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 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If a sandbox 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, organization or invite was not found |
+
+<br/>
+
+## Get
+
+Returns a sandbox user
+
+```ruby
+result = client.instance_sandbox.get(
+  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.get.
+
+#### 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 |
+| summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary |  | payloadCount |
+| summaryInclude | string | N | Comma-separated list of summary fields to include in user summary |  | payloadCount |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Sandbox User](_schemas.md#instance-sandbox-user) | A single sandbox user |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if sandbox was not found |
+
+<br/>
+
+## Undelete
+
+Restores a sandbox user account
+
+```ruby
+result = client.instance_sandbox.undelete(
+  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.User, instanceSandbox.*, or instanceSandbox.undelete.
+
+#### 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 |
+| summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary |  | payloadCount |
+| summaryInclude | string | N | Comma-separated list of summary fields to include in user summary |  | payloadCount |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Sandbox User](_schemas.md#instance-sandbox-user) | A single restored sandbox user |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if sandbox was not found |

data/docs/instanceSandboxes.md

@@ -0,0 +1,55 @@
+# Instance Sandboxes Actions
+
+Details on the various actions that can be performed on the
+Instance Sandboxes resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+
+<br/>
+
+## Get
+
+Returns a collection of instance sandboxes
+
+```ruby
+result = client.instance_sandboxes.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, instanceSandboxes.*, or instanceSandboxes.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary |  | payloadCount |
+| summaryInclude | string | N | Comma-separated list of summary fields to include in user summary |  | payloadCount |
+| sortField | string | N | Field to sort the results by. Accepted values are: firstName, lastName, email, id, creationDate, lastSuccessfulLogin, lastFailedLogin, failedLoginCount, lastUpdated | email | firstName |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
+| startingAfterId | string | N | Exclusive ID from which to begin querying |  | 575ec8687ae143cd83dc4a97 |
+| endingBeforeId | string | N | Exclusive ID at which to end querying |  | 575ec8687ae143cd83dc4a97 |
+| limit | string | N | How many items to return | 100 | 10 |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: firstName, lastName, email |  | firstName |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my * instance |
+| includeDeleted | string | N | If the result of the request should also include deleted sandboxes. |  | true |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Sandboxes](_schemas.md#instance-sandboxes) | Collection of instance sandboxes |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |

data/docs/me.md

@@ -13,6 +13,7 @@ parameters and the potential responses.
 *   [Disconnect Github](#disconnect-github)
 *   [Enable Two Factor Auth](#enable-two-factor-auth)
 *   [Fetch Recent Items](#fetch-recent-items)
+*   [Generate Two Factor Auth](#generate-two-factor-auth)
 *   [Get](#get)
 *   [Patch](#patch)
 *   [Payload Counts](#payload-counts)
@@ -274,6 +275,41 @@ all.User, all.User.read, me.*, or me.fetchRecentItems.
 
 <br/>
 
+## Generate Two Factor Auth
+
+Returns the two factor auth key for a user
+
+```ruby
+result = client.me.generate_two_factor_auth(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, me.*, or me.generateTwoFactorAuth.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Two Factor Auth Info](_schemas.md#two-factor-auth-info) | Updated user information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
 ## Get
 
 Retrieves information on the current user

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.23.1
+  # Built For Version 1.23.5
   class Client
     attr_accessor :auth_token, :url
 
@@ -308,6 +308,14 @@ module LosantRest
       @instance_orgs ||= InstanceOrgs.new(self)
     end
 
+    def instance_sandbox
+      @instance_sandbox ||= InstanceSandbox.new(self)
+    end
+
+    def instance_sandboxes
+      @instance_sandboxes ||= InstanceSandboxes.new(self)
+    end
+
     def instances
       @instances ||= Instances.new(self)
     end
@@ -366,7 +374,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.23.1"
+      headers["Accept-Version"] = "^1.23.5"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/dashboard.rb

@@ -221,6 +221,8 @@ module LosantRest
     # *  {string} dashboardId - ID of the associated dashboard
     # *  {hash} ctx - The context object to validate (https://api.losant.com/#/definitions/dashboardContextInstance)
     # *  {string} password - Password for password-protected dashboards
+    # *  {string} duration - Duration of data to fetch in milliseconds
+    # *  {string} resolution - Resolution in milliseconds
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -243,6 +245,8 @@ module LosantRest
 
       body = params[:ctx] if params.has_key?(:ctx)
       query_params[:password] = params[:password] if params.has_key?(:password)
+      query_params[:duration] = params[:duration] if params.has_key?(:duration)
+      query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
       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/losant_rest/device.rb

@@ -145,6 +145,8 @@ module LosantRest
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
     # *  {string} excludeConnectionInfo - If set, do not return connection info
+    # *  {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} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -166,6 +168,8 @@ module LosantRest
       raise ArgumentError.new("deviceId is required") unless params.has_key?(:deviceId)
 
       query_params[:excludeConnectionInfo] = params[:excludeConnectionInfo] if params.has_key?(:excludeConnectionInfo)
+      query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
+      query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
       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)
@@ -401,6 +405,8 @@ module LosantRest
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
     # *  {hash} device - Object containing new properties of the device (https://api.losant.com/#/definitions/devicePatch)
+    # *  {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} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -423,6 +429,8 @@ module LosantRest
       raise ArgumentError.new("device is required") unless params.has_key?(:device)
 
       body = params[:device] if params.has_key?(:device)
+      query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
+      query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
       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/losant_rest/devices.rb

@@ -250,6 +250,8 @@ module LosantRest
     # *  {string} excludeConnectionInfo - If set, do not return connection info
     # *  {string} parentId - Filter devices as children of a given system id
     # *  {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} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -281,6 +283,8 @@ module LosantRest
       query_params[:parentId] = params[:parentId] if params.has_key?(:parentId)
       query_params[:query] = params[:query] if params.has_key?(:query)
       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)
       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)
@@ -401,6 +405,8 @@ module LosantRest
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {hash} device - New device information (https://api.losant.com/#/definitions/devicePost)
+    # *  {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} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -422,6 +428,8 @@ module LosantRest
       raise ArgumentError.new("device is required") unless params.has_key?(:device)
 
       body = params[:device] if params.has_key?(:device)
+      query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
+      query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
       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/losant_rest/instance_sandbox.rb

@@ -0,0 +1,181 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2022 Losant IoT, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require "json"
+
+module LosantRest
+
+  # Class containing all the actions for the Instance Sandbox Resource
+  class InstanceSandbox
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Deletes a sandbox user account
+    #
+    # 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, instanceSandbox.*, or instanceSandbox.delete.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {string} instanceSandboxId - ID associated with the sandbox user
+    # *  {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 - If a sandbox was successfully deleted (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if instance, organization or invite was not found (https://api.losant.com/#/definitions/error)
+    def delete(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)
+      raise ArgumentError.new("instanceSandboxId is required") unless params.has_key?(:instanceSandboxId)
+
+      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]}/sandboxes/#{params[:instanceSandboxId]}"
+
+      @client.request(
+        method: :delete,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Returns a sandbox user
+    #
+    # 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.get.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {string} instanceSandboxId - ID associated with the sandbox user
+    # *  {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
+    # *  {string} summaryInclude - Comma-separated list of summary fields to include in user summary
+    # *  {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 - A single sandbox user (https://api.losant.com/#/definitions/instanceSandbox)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if sandbox was not found (https://api.losant.com/#/definitions/error)
+    def get(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)
+      raise ArgumentError.new("instanceSandboxId is required") unless params.has_key?(:instanceSandboxId)
+
+      query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
+      query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
+      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]}/sandboxes/#{params[:instanceSandboxId]}"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Restores a sandbox user account
+    #
+    # 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, instanceSandbox.*, or instanceSandbox.undelete.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {string} instanceSandboxId - ID associated with the sandbox user
+    # *  {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
+    # *  {string} summaryInclude - Comma-separated list of summary fields to include in user summary
+    # *  {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 - A single restored sandbox user (https://api.losant.com/#/definitions/instanceSandbox)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if sandbox was not found (https://api.losant.com/#/definitions/error)
+    def undelete(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)
+      raise ArgumentError.new("instanceSandboxId is required") unless params.has_key?(:instanceSandboxId)
+
+      query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
+      query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
+      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]}/sandboxes/#{params[:instanceSandboxId]}/undelete"
+
+      @client.request(
+        method: :patch,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end