losant_rest 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c11a85f0b5a6200a2ea9aa541eb96aee3ba5a376
-  data.tar.gz: d3f145e28a8e00dc74d2745881c51201c8569a9b
+  metadata.gz: 0bfc15783106347d0e9336d77f09fbe18c3f7296
+  data.tar.gz: 303070ad864a6e82c37df14a54536327c008ec39
 SHA512:
-  metadata.gz: cac9c0ec1272db66322919234c75292d3bb9e5dd0eeee4846d5fb298f434eeabee9ff2ef467719d8ccc9d5350f92f91b011c047c378ef43021fa2e65de66e0b4
-  data.tar.gz: 2e6d8b88d29de4d78dc8dd088f83d171aa196d9d5e8ad4348c7bbf45a766d0c38e811943da3cbf220f1f750fd0628e9eabe6572f1d5703c8b665322a1c86ab82
+  metadata.gz: f6bfed1c415e2bdc7b7d3142360dce177635213bd3bf682c0df3cf16d55085252cae0b3a5bfe20c815a842aa70ee71442b8ca91d4a8a4e01c64480485338e622
+  data.tar.gz: edd540c833947b9db7fc9a7979340d0cb2ec961316ecb3a5f2fffe6a7da405e4b4c48bc6391614719757c0965bcfc7a08f44084a213216a8033758f81b02ef0a

data/docs/_schemas.md

@@ -1016,7 +1016,7 @@ Schema for a collection of Applications
 
 ## Authenticated Device
 
-Schema for the sucessful response when authenticating a Device
+Schema for the successful response when authenticating a Device
 
 ### <a name="authenticated-device-schema"></a> Schema
 
@@ -1071,7 +1071,7 @@ Schema for the sucessful response when authenticating a Device
 
 ## Authenticated Solution User
 
-Schema for the sucessful response when authenticating a Solution User
+Schema for the successful response when authenticating a Solution User
 
 ### <a name="authenticated-solution-user-schema"></a> Schema
 
@@ -1108,7 +1108,7 @@ Schema for the sucessful response when authenticating a Solution User
 
 ## Authenticated User
 
-Schema for the sucessful response when authenticating a User
+Schema for the successful response when authenticating a User
 
 ### <a name="authenticated-user-schema"></a> Schema
 

data/docs/dashboards.md

@@ -49,7 +49,7 @@ puts result
 
 ## Post
 
-Create a new dasboard
+Create a new dashboard
 
 ```ruby
 result = client.dashboards.post(dashboard: my_dashboard)

data/docs/deviceRecipe.md

@@ -38,7 +38,7 @@ puts result
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 201 | [Device Recipe Bulk Create](_schemas.md#device-recipe-bulk-create) | If devices were sucessfully created |
+| 201 | [Device Recipe Bulk Create](_schemas.md#device-recipe-bulk-create) | If devices were successfully created |
 
 #### Error Responses
 

data/docs/devices.md

@@ -6,12 +6,46 @@ parameters and the potential responses.
 
 ##### Contents
 
+*   [Export](#export)
 *   [Get](#get)
 *   [Post](#post)
 *   [Send Command](#send-command)
 
 <br/>
 
+## Export
+
+Creates an export of all device metadata.
+
+```ruby
+result = client.devices.export(applicationId: my_application_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| email | string | N | Email address to send export to.  Defaults to current user&#x27;s email. |  | email@example.com |
+| callbackUrl | string | N | Callback URL to call with export result. |  | https://example.com/cburl |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If generation of export was successfully started |
+
+#### 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/>
+
 ## Get
 
 Returns the devices for an application

data/lib/losant_rest/client.rb

@@ -5,7 +5,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.5.0
+  # Built For Version 1.5.1
   class Client
     attr_accessor :auth_token, :url
 
@@ -128,7 +128,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.5.0"
+      headers["Accept-Version"] = "^1.5.1"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/dashboards.rb

@@ -56,7 +56,7 @@ module LosantRest
         body: body)
     end
 
-    # Create a new dasboard
+    # Create a new dashboard
     #
     # Parameters:
     # *  {hash} dashboard - New dashboard information (https://api.losant.com/#/definitions/dashboardPost)

data/lib/losant_rest/device_recipe.rb

@@ -19,7 +19,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - If devices were sucessfully created (https://api.losant.com/#/definitions/deviceRecipeBulkCreate)
+    # *  201 - If devices were successfully created (https://api.losant.com/#/definitions/deviceRecipeBulkCreate)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/devices.rb

@@ -7,6 +7,48 @@ module LosantRest
       @client = client
     end
 
+    # Creates an export of all device metadata.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} email - Email address to send export to.  Defaults to current user's email.
+    # *  {string} callbackUrl - Callback URL to call with export result.
+    # *  {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 generation of export was successfully started (https://api.losant.com/#/definitions/success)
+    #
+    # 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 export(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)
+
+      query_params[:email] = params[:email] if params.has_key?(:email)
+      query_params[:callbackUrl] = params[:callbackUrl] if params.has_key?(:callbackUrl)
+      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/export"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Returns the devices for an application
     #
     # Parameters:

data/lib/losant_rest/version.rb

@@ -1,3 +1,3 @@
 module LosantRest
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: losant_rest
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Michael Kuehl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-12 00:00:00.000000000 Z
+date: 2016-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty