losant_rest 1.8.6 → 1.8.7

data/lib/losant_rest/application_certificates.rb

@@ -0,0 +1,136 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2019 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 Application Certificates Resource
+  class ApplicationCertificates
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the application certificates 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, applicationCertificates.*, or applicationCertificates.get.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} sortField - Field to sort the results by. Accepted values are: certificateInfo.commonName, status, 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: certificateInfo.commonName, status
+    # *  {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 certificates (https://api.losant.com/#/definitions/applicationCertificates)
+    #
+    # 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)
+
+      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 = "/applications/#{params[:applicationId]}/certificates"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Create a new application certificate 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, applicationCertificates.*, or applicationCertificates.post.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} applicationCertificate - Application certificate information (https://api.losant.com/#/definitions/applicationCertificatePost)
+    # *  {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 application certificate (https://api.losant.com/#/definitions/applicationCertificate)
+    #
+    # 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("applicationCertificate is required") unless params.has_key?(:applicationCertificate)
+
+      body = params[:applicationCertificate] if params.has_key?(:applicationCertificate)
+      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]}/certificates"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/auth.rb

@@ -42,7 +42,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Successful authentication. The included api access token has the scope 'all.Device'. (https://api.losant.com/#/definitions/authedDevice)
+    # *  200 - Successful authentication. The included api access token by default has the scope 'all.Device'. (https://api.losant.com/#/definitions/authedDevice)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.15.0
+  # Built For Version 1.15.1
   class Client
     attr_accessor :auth_token, :url
 
@@ -48,6 +48,22 @@ module LosantRest
       @application_api_tokens ||= ApplicationApiTokens.new(self)
     end
 
+    def application_certificate
+      @application_certificate ||= ApplicationCertificate.new(self)
+    end
+
+    def application_certificate_authorities
+      @application_certificate_authorities ||= ApplicationCertificateAuthorities.new(self)
+    end
+
+    def application_certificate_authority
+      @application_certificate_authority ||= ApplicationCertificateAuthority.new(self)
+    end
+
+    def application_certificates
+      @application_certificates ||= ApplicationCertificates.new(self)
+    end
+
     def application_key
       @application_key ||= ApplicationKey.new(self)
     end
@@ -274,7 +290,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.15.0"
+      headers["Accept-Version"] = "^1.15.1"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/data_table_rows.rb

@@ -143,6 +143,7 @@ module LosantRest
     # *  {string} sortDirection - Direction to sort the rows by. Accepted values are: asc, desc
     # *  {string} limit - How many rows to return
     # *  {string} offset - How many rows to skip
+    # *  {string} includeFields - Comma-separated list of fields to include in resulting rows. When not provided, returns all fields.
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -167,6 +168,7 @@ module LosantRest
       query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
       query_params[:limit] = params[:limit] if params.has_key?(:limit)
       query_params[:offset] = params[:offset] if params.has_key?(:offset)
+      query_params[:includeFields] = params[:includeFields] if params.has_key?(:includeFields)
       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)
@@ -246,6 +248,7 @@ module LosantRest
     # *  {string} sortDirection - Direction to sort the rows by. Accepted values are: asc, desc
     # *  {string} limit - How many rows to return
     # *  {string} offset - How many rows to skip
+    # *  {string} includeFields - Comma-separated list of fields to include in resulting rows. When not provided, returns all fields.
     # *  {hash} query - Query to apply to filter the data table (https://api.losant.com/#/definitions/dataTableQuery)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
@@ -271,6 +274,7 @@ module LosantRest
       query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
       query_params[:limit] = params[:limit] if params.has_key?(:limit)
       query_params[:offset] = params[:offset] if params.has_key?(:offset)
+      query_params[:includeFields] = params[:includeFields] if params.has_key?(:includeFields)
       body = params[:query] if params.has_key?(:query)
       headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
       query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)

data/lib/losant_rest/events.rb

@@ -39,7 +39,7 @@ module LosantRest
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
-    # *  {string} sortField - Field to sort the results by. Accepted values are: subject, id, creationDate
+    # *  {string} sortField - Field to sort the results by. Accepted values are: subject, id, creationDate, lastUpdated, level, state, deviceId
     # *  {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

data/lib/losant_rest/experience_users.rb

@@ -45,7 +45,8 @@ module LosantRest
     # *  {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: firstName, lastName, email
     # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
-    # *  {string} experienceGroupId - Filter users to those only in the specified group
+    # *  {string} experienceGroupId - Filter users to those only in the specified group, special experienceGroupIds of 'any' which will give users who are in at least one group and 'none' will give you users who are not in any groups.
+    # *  {string} includeAncestorGroups - If set will include members from ancestors of the specified experienceGroupId
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -72,6 +73,7 @@ module LosantRest
       query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
       query_params[:filter] = params[:filter] if params.has_key?(:filter)
       query_params[:experienceGroupId] = params[:experienceGroupId] if params.has_key?(:experienceGroupId)
+      query_params[:includeAncestorGroups] = params[:includeAncestorGroups] if params.has_key?(:includeAncestorGroups)
       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

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.8.6"
+  VERSION = "1.8.7"
 end

data/schemas/applicationApiTokenPost.json

@@ -28,6 +28,10 @@
           "application.*",
           "applicationApiToken.*",
           "applicationApiTokens.*",
+          "applicationCertificate.*",
+          "applicationCertificates.*",
+          "applicationCertificateAuthority.*",
+          "applicationCertificateAuthorities.*",
           "applicationKey.*",
           "applicationKeys.*",
           "data.*",
@@ -84,6 +88,16 @@
           "applicationApiToken.patch",
           "applicationApiTokens.get",
           "applicationApiTokens.post",
+          "applicationCertificate.delete",
+          "applicationCertificate.get",
+          "applicationCertificate.patch",
+          "applicationCertificates.get",
+          "applicationCertificates.post",
+          "applicationCertificateAuthority.delete",
+          "applicationCertificateAuthority.get",
+          "applicationCertificateAuthority.patch",
+          "applicationCertificateAuthorities.get",
+          "applicationCertificateAuthorities.post",
           "applicationKey.delete",
           "applicationKey.get",
           "applicationKey.patch",

data/schemas/applicationCertificate.json

@@ -0,0 +1,67 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "applicationCertificateId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "creationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "active",
+        "inactive"
+      ]
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "deviceIds": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "pattern": "^[A-Fa-f\\d]{24}$"
+      },
+      "maxItems": 1000
+    },
+    "deviceTags": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "pattern": "^[0-9a-zA-Z_-]{1,255}$"
+          },
+          "value": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          }
+        },
+        "additionalProperties": false
+      },
+      "maxItems": 100
+    },
+    "certificateInfo": {
+      "$ref": "#/definitions/certificateInfo"
+    }
+  }
+}

data/schemas/applicationCertificateAuthorities.json

@@ -0,0 +1,93 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "title": "Application Certificate Authority",
+        "description": "Schema for a single Application Certificate Authority",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "applicationCertificateAuthorityId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "applicationId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "creationDate": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "lastUpdated": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "active",
+              "inactive"
+            ]
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "description": {
+            "type": "string",
+            "maxLength": 32767
+          },
+          "caBundle": {
+            "$ref": "#/definitions/common/certificateString"
+          },
+          "caInfo": {
+            "type": "array",
+            "items": {
+              "$ref": "#/definitions/certificateInfo"
+            }
+          }
+        }
+      }
+    },
+    "count": {
+      "type": "integer"
+    },
+    "totalCount": {
+      "type": "integer"
+    },
+    "perPage": {
+      "type": "integer"
+    },
+    "page": {
+      "type": "integer"
+    },
+    "filter": {
+      "type": "string"
+    },
+    "filterField": {
+      "type": "string"
+    },
+    "sortField": {
+      "type": "string"
+    },
+    "sortDirection": {
+      "type": "string",
+      "enum": [
+        "asc",
+        "desc"
+      ]
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    }
+  }
+}

data/schemas/applicationCertificateAuthority.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "applicationCertificateAuthorityId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "creationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "active",
+        "inactive"
+      ]
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "caBundle": {
+      "$ref": "#/definitions/common/certificateString"
+    },
+    "caInfo": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/certificateInfo"
+      }
+    }
+  }
+}