losant_rest 1.9.2 → 1.9.3

data/docs/application.md

@@ -17,6 +17,8 @@ parameters and the potential responses.
 *   [Mqtt Publish Message](#mqtt-publish-message)
 *   [Patch](#patch)
 *   [Payload Counts](#payload-counts)
+*   [Readme](#readme)
+*   [Readme Patch](#readme-patch)
 *   [Search](#search)
 
 <br/>
@@ -63,7 +65,7 @@ all.Application, all.Organization, all.User, application.*, or application.archi
 
 ## Backfill Archive Data
 
-Returns success when a job has been enqueued to backfill all current data to it&#x27;s archive
+Returns success when a job has been enqueued to backfill all current data to its archive
 
 ```ruby
 result = client.application.backfill_archive_data(applicationId: my_application_id)
@@ -178,7 +180,7 @@ all.Application, all.Organization, all.User, application.*, or application.delet
 
 ## Export
 
-Export an application and all of it&#x27;s resources
+Export an application and all of its resources
 
 ```ruby
 result = client.application.export(
@@ -451,6 +453,83 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 <br/>
 
+## Readme
+
+Get the current application readme information
+
+```ruby
+result = client.application.readme(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, application.*, or application.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Readme](_schemas.md#application-readme) | The application readme information |
+
+#### 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/>
+
+## Readme Patch
+
+Update the current application readme information
+
+```ruby
+result = client.application.readme_patch(
+  applicationId: my_application_id,
+  readme: my_readme)
+
+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, application.*, or application.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
+| readme | [Application Readme Patch](_schemas.md#application-readme-patch) | Y | Object containing new readme information |  | [Application Readme Patch Example](_schemas.md#application-readme-patch-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Readme](_schemas.md#application-readme) | Updated readme information |
+
+#### 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/>
+
 ## Search
 
 Search across an application&#x27;s resources by target identifier

data/docs/applicationTemplates.md

@@ -0,0 +1,50 @@
+# Application Templates Actions
+
+Details on the various actions that can be performed on the
+Application Templates resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+
+<br/>
+
+## Get
+
+Returns the application templates the current user has permission to see
+
+```ruby
+result = client.application_templates.get(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, all.User.read, applicationTemplates.*, or applicationTemplates.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | 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 | 1000 | 10 |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name |  | name |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my * app |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Templates](_schemas.md#application-templates) | Collection of application templates |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |

data/docs/auth.md

@@ -9,6 +9,8 @@ parameters and the potential responses.
 *   [Authenticate Device](#authenticate-device)
 *   [Authenticate User](#authenticate-user)
 *   [Authenticate User Github](#authenticate-user-github)
+*   [Authenticate User Saml](#authenticate-user-saml)
+*   [Sso Domain](#sso-domain)
 
 <br/>
 
@@ -114,3 +116,73 @@ No api access token is required to call this action.
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
 | 401 | [Error](_schemas.md#error) | Unauthorized error if authentication fails |
+
+<br/>
+
+## Authenticate User Saml
+
+Authenticates a user via a SAML response.
+
+```ruby
+result = client.auth.authenticate_user_saml(saml: my_saml)
+
+puts result
+```
+
+#### Authentication
+No api access token is required to call this action.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| saml | [SAML Response](_schemas.md#saml-response) | Y | Encoded SAML response from an IDP for a user. |  | [SAML Response Example](_schemas.md#saml-response-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Authenticated User](_schemas.md#authenticated-user) | Successful authentication. The included api access token has the scope &#x27;all.User&#x27;. |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 401 | [Error](_schemas.md#error) | Unauthorized error if authentication fails |
+
+<br/>
+
+## Sso Domain
+
+Checks email domain for SSO configuration.
+
+```ruby
+result = client.auth.sso_domain(email: my_email)
+
+puts result
+```
+
+#### Authentication
+No api access token is required to call this action.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| email | string | Y | The email address associated with the user login |  | example@example.com |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [SSO Request](_schemas.md#sso-request) | Successful finding SSO for domain. Returns SSO request URL and type. |
+| 204 | undefined | No domain associated with an SSO configuration |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |

data/docs/devices.md

@@ -83,6 +83,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | tagFilter | [Device Tag Filter](_schemas.md#device-tag-filter) | N | Array of tag pairs to filter by |  | [Device Tag Filter Example](_schemas.md#device-tag-filter-example) |
 | 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 overides the filterField, filter, deviceClass, tagFilter, and parentId parameters. |  | [Advanced Device Query Example](_schemas.md#advanced-device-query-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/lib/losant_rest/application.rb

@@ -78,7 +78,7 @@ module LosantRest
         body: body)
     end
 
-    # Returns success when a job has been enqueued to backfill all current data to it's archive
+    # Returns success when a job has been enqueued to backfill all current data to its archive
     #
     # Authentication:
     # The client must be configured with a valid api
@@ -215,7 +215,7 @@ module LosantRest
         body: body)
     end
 
-    # Export an application and all of it's resources
+    # Export an application and all of its resources
     #
     # Authentication:
     # The client must be configured with a valid api
@@ -545,6 +545,97 @@ module LosantRest
         body: body)
     end
 
+    # Get the current application readme information
+    #
+    # 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, application.*, or application.get.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID of the associated 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 - The application readme information (https://api.losant.com/#/definitions/applicationReadme)
+    #
+    # 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 readme(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]}/readme"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Update the current application readme information
+    #
+    # 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, application.*, or application.patch.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID of the associated application
+    # *  {hash} readme - Object containing new readme information (https://api.losant.com/#/definitions/applicationReadmePatch)
+    # *  {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 readme information (https://api.losant.com/#/definitions/applicationReadme)
+    #
+    # 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 readme_patch(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("readme is required") unless params.has_key?(:readme)
+
+      body = params[:readme] if params.has_key?(:readme)
+      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]}/readme"
+
+      @client.request(
+        method: :patch,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Search across an application's resources by target identifier
     #
     # Authentication:

data/lib/losant_rest/application_templates.rb

@@ -0,0 +1,88 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2020 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 Application Templates Resource
+  class ApplicationTemplates
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the application templates the current user has permission to see
+    #
+    # 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, all.User.read, applicationTemplates.*, or applicationTemplates.get.
+    #
+    # Parameters:
+    # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
+    # *  {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
+    # *  {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
+    # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
+    # *  {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 application templates (https://api.losant.com/#/definitions/applicationTemplates)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (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
+
+
+      query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
+      query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
+      query_params[:page] = params[:page] if params.has_key?(:page)
+      query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
+      query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
+      query_params[:filter] = params[:filter] if params.has_key?(:filter)
+      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 = "/applicationTemplates"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/auth.rb

@@ -157,5 +157,89 @@ module LosantRest
         body: body)
     end
 
+    # Authenticates a user via a SAML response.
+    #
+    # Authentication:
+    # No api access token is required to call this action.
+    #
+    # Parameters:
+    # *  {hash} saml - Encoded SAML response from an IDP for a user. (https://api.losant.com/#/definitions/samlResponse)
+    # *  {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 - Successful authentication. The included api access token has the scope 'all.User'. (https://api.losant.com/#/definitions/authedUser)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  401 - Unauthorized error if authentication fails (https://api.losant.com/#/definitions/error)
+    def authenticate_user_saml(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("saml is required") unless params.has_key?(:saml)
+
+      body = params[:saml] if params.has_key?(:saml)
+      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 = "/auth/user/saml"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Checks email domain for SSO configuration.
+    #
+    # Authentication:
+    # No api access token is required to call this action.
+    #
+    # Parameters:
+    # *  {string} email - The email address associated with the user login
+    # *  {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 - Successful finding SSO for domain. Returns SSO request URL and type. (https://api.losant.com/#/definitions/ssoRequest)
+    # *  204 - No domain associated with an SSO configuration
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    def sso_domain(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("email is required") unless params.has_key?(:email)
+
+      query_params[:email] = params[:email] if params.has_key?(:email)
+      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 = "/auth/ssoDomain"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
   end
 end

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.16.2
+  # Built For Version 1.16.4
   class Client
     attr_accessor :auth_token, :url
 
@@ -72,6 +72,10 @@ module LosantRest
       @application_keys ||= ApplicationKeys.new(self)
     end
 
+    def application_templates
+      @application_templates ||= ApplicationTemplates.new(self)
+    end
+
     def applications
       @applications ||= Applications.new(self)
     end
@@ -274,7 +278,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.16.2"
+      headers["Accept-Version"] = "^1.16.4"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/devices.rb

@@ -99,6 +99,7 @@ module LosantRest
     # *  {hash} tagFilter - Array of tag pairs to filter by (https://api.losant.com/#/definitions/deviceTagFilter)
     # *  {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 overides the filterField, filter, deviceClass, tagFilter, and parentId parameters. (https://api.losant.com/#/definitions/advancedDeviceQuery)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -128,6 +129,8 @@ module LosantRest
       query_params[:tagFilter] = params[:tagFilter] if params.has_key?(:tagFilter)
       query_params[:excludeConnectionInfo] = params[:excludeConnectionInfo] if params.has_key?(:excludeConnectionInfo)
       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)
       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/version.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2019 Losant IoT, Inc.
+# Copyright (c) 2020 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
@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.9.2"
+  VERSION = "1.9.3"
 end

data/lib/losant_rest.rb

@@ -32,6 +32,7 @@ require_relative "losant_rest/application_certificate_authority"
 require_relative "losant_rest/application_certificates"
 require_relative "losant_rest/application_key"
 require_relative "losant_rest/application_keys"
+require_relative "losant_rest/application_templates"
 require_relative "losant_rest/applications"
 require_relative "losant_rest/audit_log"
 require_relative "losant_rest/audit_logs"