losant_rest 1.3.3 → 1.4.0

data/docs/me.md

@@ -7,6 +7,7 @@ parameters and the potential responses.
 ##### Contents
 
 *   [Add Recent Item](#add-recent-item)
+*   [Change Password](#change-password)
 *   [Delete](#delete)
 *   [Disable Two Factor Auth](#disable-two-factor-auth)
 *   [Disconnect Github](#disconnect-github)
@@ -56,6 +57,41 @@ all.SolutionUser, all.User, me.*, or me.addRecentItem.
 
 <br/>
 
+## Change Password
+
+Changes the current user&#x27;s password and optionally logs out all other sessions
+
+```ruby
+result = client.me.change_password(data: my_data)
+
+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.SolutionUser, all.User, me.*, or me.changePassword.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| data | [Change Password](_schemas.md#change-password) | Y | Object containing the password change info |  | [Change Password Example](_schemas.md#change-password-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Authenticated User](_schemas.md#authenticated-user) | A new, valid, auth token (potentially all previous tokens are now invalid) |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
 ## Delete
 
 Deletes the current user

data/lib/losant_rest.rb

@@ -45,14 +45,16 @@ require_relative "losant_rest/device_recipes"
 require_relative "losant_rest/devices"
 require_relative "losant_rest/event"
 require_relative "losant_rest/events"
+require_relative "losant_rest/experience_domain"
+require_relative "losant_rest/experience_domains"
 require_relative "losant_rest/experience_endpoint"
 require_relative "losant_rest/experience_endpoints"
 require_relative "losant_rest/experience_group"
 require_relative "losant_rest/experience_groups"
-require_relative "losant_rest/experience_template"
-require_relative "losant_rest/experience_templates"
 require_relative "losant_rest/experience_user"
 require_relative "losant_rest/experience_users"
+require_relative "losant_rest/experience_view"
+require_relative "losant_rest/experience_views"
 require_relative "losant_rest/flow"
 require_relative "losant_rest/flow_version"
 require_relative "losant_rest/flow_versions"

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.8.0
+  # Built For Version 1.9.0
   class Client
     attr_accessor :auth_token, :url
 
@@ -124,6 +124,14 @@ module LosantRest
       @events ||= Events.new(self)
     end
 
+    def experience_domain
+      @experience_domain ||= ExperienceDomain.new(self)
+    end
+
+    def experience_domains
+      @experience_domains ||= ExperienceDomains.new(self)
+    end
+
     def experience_endpoint
       @experience_endpoint ||= ExperienceEndpoint.new(self)
     end
@@ -140,14 +148,6 @@ module LosantRest
       @experience_groups ||= ExperienceGroups.new(self)
     end
 
-    def experience_template
-      @experience_template ||= ExperienceTemplate.new(self)
-    end
-
-    def experience_templates
-      @experience_templates ||= ExperienceTemplates.new(self)
-    end
-
     def experience_user
       @experience_user ||= ExperienceUser.new(self)
     end
@@ -156,6 +156,14 @@ module LosantRest
       @experience_users ||= ExperienceUsers.new(self)
     end
 
+    def experience_view
+      @experience_view ||= ExperienceView.new(self)
+    end
+
+    def experience_views
+      @experience_views ||= ExperienceViews.new(self)
+    end
+
     def flow
       @flow ||= Flow.new(self)
     end
@@ -226,7 +234,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.8.0"
+      headers["Accept-Version"] = "^1.9.0"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/data_table_rows.rb

@@ -29,6 +29,54 @@ module LosantRest
       @client = client
     end
 
+    # Request an export of the data table's data
+    #
+    # 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, dataTableRows.*, or dataTableRows.export.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} dataTableId - ID associated with the data table
+    # *  {hash} exportData - Object containing export specifications (https://api.losant.com/#/definitions/dataTableRowsExport)
+    # *  {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 request was successfully queued (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if data table 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)
+      raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
+
+      body = params[:exportData] if params.has_key?(:exportData)
+      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]}/data-tables/#{params[:dataTableId]}/rows/export"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Returns the rows for a data table
     #
     # Authentication:

data/lib/losant_rest/device_recipe.rb

@@ -48,6 +48,7 @@ module LosantRest
     #
     # Responses:
     # *  201 - If devices were successfully created (https://api.losant.com/#/definitions/deviceRecipeBulkCreate)
+    # *  202 - If devices were enqueued to be created (https://api.losant.com/#/definitions/deviceRecipeBulkCreateEnqueued)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/{experience_template.rb → experience_domain.rb}

@@ -22,35 +22,35 @@
 
 module LosantRest
 
-  # Class containing all the actions for the Experience Template Resource
-  class ExperienceTemplate
+  # Class containing all the actions for the Experience Domain Resource
+  class ExperienceDomain
 
     def initialize(client)
       @client = client
     end
 
-    # Deletes an experience template
+    # Deletes an experience domain
     #
     # 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, experienceTemplate.*, or experienceTemplate.delete.
+    # all.Application, all.Organization, all.User, experienceDomain.*, or experienceDomain.delete.
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
-    # *  {string} experienceTemplateId - ID associated with the experience template
+    # *  {string} experienceDomainId - ID associated with the experience domain
     # *  {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 experience template was successfully deleted (https://api.losant.com/#/definitions/success)
+    # *  200 - If experience domain was successfully deleted (https://api.losant.com/#/definitions/success)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if experience template was not found (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if experience domain 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 }
@@ -58,14 +58,14 @@ module LosantRest
       body = nil
 
       raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
-      raise ArgumentError.new("experienceTemplateId is required") unless params.has_key?(:experienceTemplateId)
+      raise ArgumentError.new("experienceDomainId is required") unless params.has_key?(:experienceDomainId)
 
       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]}/experience/templates/#{params[:experienceTemplateId]}"
+      path = "/applications/#{params[:applicationId]}/experience/domains/#{params[:experienceDomainId]}"
 
       @client.request(
         method: :delete,
@@ -75,28 +75,28 @@ module LosantRest
         body: body)
     end
 
-    # Retrieves information on an experience template
+    # Retrieves information on an experience domain
     #
     # 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, experienceTemplate.*, or experienceTemplate.get.
+    # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceDomain.*, or experienceDomain.get.
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
-    # *  {string} experienceTemplateId - ID associated with the experience template
+    # *  {string} experienceDomainId - ID associated with the experience domain
     # *  {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 - Experience template information (https://api.losant.com/#/definitions/experienceTemplate)
+    # *  200 - Experience domain information (https://api.losant.com/#/definitions/experienceDomain)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if experience template was not found (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if experience domain 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 }
@@ -104,14 +104,14 @@ module LosantRest
       body = nil
 
       raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
-      raise ArgumentError.new("experienceTemplateId is required") unless params.has_key?(:experienceTemplateId)
+      raise ArgumentError.new("experienceDomainId is required") unless params.has_key?(:experienceDomainId)
 
       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]}/experience/templates/#{params[:experienceTemplateId]}"
+      path = "/applications/#{params[:applicationId]}/experience/domains/#{params[:experienceDomainId]}"
 
       @client.request(
         method: :get,
@@ -121,29 +121,29 @@ module LosantRest
         body: body)
     end
 
-    # Updates information about an experience template
+    # Updates information about an experience domain
     #
     # 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, experienceTemplate.*, or experienceTemplate.patch.
+    # all.Application, all.Organization, all.User, experienceDomain.*, or experienceDomain.patch.
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
-    # *  {string} experienceTemplateId - ID associated with the experience template
-    # *  {hash} experienceTemplate - Object containing new properties of the experience template (https://api.losant.com/#/definitions/experienceTemplatePatch)
+    # *  {string} experienceDomainId - ID associated with the experience domain
+    # *  {hash} experienceDomain - Object containing new properties of the experience domain (https://api.losant.com/#/definitions/experienceDomainPatch)
     # *  {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 - Updated experience template information (https://api.losant.com/#/definitions/experienceTemplate)
+    # *  200 - Updated experience domain information (https://api.losant.com/#/definitions/experienceDomain)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if experience template was not found (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if experience domain was not found (https://api.losant.com/#/definitions/error)
     def patch(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { _actions: false, _links: true, _embedded: true }
@@ -151,16 +151,16 @@ module LosantRest
       body = nil
 
       raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
-      raise ArgumentError.new("experienceTemplateId is required") unless params.has_key?(:experienceTemplateId)
-      raise ArgumentError.new("experienceTemplate is required") unless params.has_key?(:experienceTemplate)
+      raise ArgumentError.new("experienceDomainId is required") unless params.has_key?(:experienceDomainId)
+      raise ArgumentError.new("experienceDomain is required") unless params.has_key?(:experienceDomain)
 
-      body = params[:experienceTemplate] if params.has_key?(:experienceTemplate)
+      body = params[:experienceDomain] if params.has_key?(:experienceDomain)
       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]}/experience/templates/#{params[:experienceTemplateId]}"
+      path = "/applications/#{params[:applicationId]}/experience/domains/#{params[:experienceDomainId]}"
 
       @client.request(
         method: :patch,

data/lib/losant_rest/experience_domains.rb

@@ -0,0 +1,124 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 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.
+
+module LosantRest
+
+  # Class containing all the actions for the Experience Domains Resource
+  class ExperienceDomains
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the experience domains for an application
+    #
+    # 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, experienceDomains.*, or experienceDomains.get.
+    #
+    # 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 - Collection of experience domains (https://api.losant.com/#/definitions/experienceDomains)
+    #
+    # 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 get(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]}/experience/domains"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Create a new experience domain for an application
+    #
+    # 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, experienceDomains.*, or experienceDomains.post.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} experienceDomain - New experience domain information (https://api.losant.com/#/definitions/experienceDomainPost)
+    # *  {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:
+    # *  201 - Successfully created experience domain (https://api.losant.com/#/definitions/experienceDomain)
+    #
+    # 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 post(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("experienceDomain is required") unless params.has_key?(:experienceDomain)
+
+      body = params[:experienceDomain] if params.has_key?(:experienceDomain)
+      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]}/experience/domains"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end