losant_rest 1.10.3 → 1.13.0

data/lib/losant_rest/application_templates.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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
@@ -44,8 +44,10 @@ module LosantRest
     # *  {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} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, authorName
     # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
+    # *  {array} keywords - List of keywords to filter by. Matches all provided keywords.
+    # *  {string} categoryId - ID of a category to filter by.
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -69,6 +71,8 @@ module LosantRest
       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)
+      query_params[:keywords] = params[:keywords] if params.has_key?(:keywords)
+      query_params[:categoryId] = params[:categoryId] if params.has_key?(:categoryId)
       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)
@@ -84,5 +88,89 @@ module LosantRest
         body: body)
     end
 
+    # Returns a category list, beginning at the specified category
+    #
+    # 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.getCategories.
+    #
+    # Parameters:
+    # *  {string} baseId - ID of the category to begin from
+    # *  {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 categories (https://api.losant.com/#/definitions/applicationTemplateCategories)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    def get_categories(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+
+      query_params[:baseId] = params[:baseId] if params.has_key?(:baseId)
+      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/categories"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Returns an array of all unique keywords currently in use by templates
+    #
+    # 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.getUniqueKeywords.
+    #
+    # Parameters:
+    # *  {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 - Array of all unique template keywords (https://api.losant.com/#/definitions/templateKeywords)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    def get_unique_keywords(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+
+      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/keywords"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
   end
 end

data/lib/losant_rest/applications.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/audit_log.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/audit_logs.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/auth.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/client.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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
@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.17.3
+  # Built For Version 1.20.0
   class Client
     attr_accessor :auth_token, :url
 
@@ -64,6 +64,14 @@ module LosantRest
       @application_certificates ||= ApplicationCertificates.new(self)
     end
 
+    def application_dashboard
+      @application_dashboard ||= ApplicationDashboard.new(self)
+    end
+
+    def application_dashboards
+      @application_dashboards ||= ApplicationDashboards.new(self)
+    end
+
     def application_key
       @application_key ||= ApplicationKey.new(self)
     end
@@ -72,6 +80,10 @@ module LosantRest
       @application_keys ||= ApplicationKeys.new(self)
     end
 
+    def application_template
+      @application_template ||= ApplicationTemplate.new(self)
+    end
+
     def application_templates
       @application_templates ||= ApplicationTemplates.new(self)
     end
@@ -232,6 +244,38 @@ module LosantRest
       @flows ||= Flows.new(self)
     end
 
+    def instance
+      @instance ||= Instance.new(self)
+    end
+
+    def instance_member
+      @instance_member ||= InstanceMember.new(self)
+    end
+
+    def instance_members
+      @instance_members ||= InstanceMembers.new(self)
+    end
+
+    def instance_org
+      @instance_org ||= InstanceOrg.new(self)
+    end
+
+    def instance_org_member
+      @instance_org_member ||= InstanceOrgMember.new(self)
+    end
+
+    def instance_org_members
+      @instance_org_members ||= InstanceOrgMembers.new(self)
+    end
+
+    def instance_orgs
+      @instance_orgs ||= InstanceOrgs.new(self)
+    end
+
+    def instances
+      @instances ||= Instances.new(self)
+    end
+
     def integration
       @integration ||= Integration.new(self)
     end
@@ -278,7 +322,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.17.3"
+      headers["Accept-Version"] = "^1.20.0"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/dashboard.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/dashboards.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/data.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/data_table.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/data_table_row.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/data_table_rows.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/data_tables.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/device.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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
@@ -192,8 +192,9 @@ module LosantRest
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
-    # *  {string} limit - Max command entries to return (ordered by time descending)
+    # *  {string} limit - Maximum number of command entries to return
     # *  {string} since - Look for command entries since this time (ms since epoch)
+    # *  {string} sortDirection - Direction to sort the command entries (by time). Accepted values are: asc, desc
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -216,6 +217,7 @@ module LosantRest
 
       query_params[:limit] = params[:limit] if params.has_key?(:limit)
       query_params[:since] = params[:since] if params.has_key?(:since)
+      query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
       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)
@@ -294,8 +296,9 @@ module LosantRest
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
-    # *  {string} limit - Max log entries to return (ordered by time descending)
+    # *  {string} limit - Maximum number of log entries to return
     # *  {string} since - Look for log entries since this time (ms since epoch)
+    # *  {string} sortDirection - Direction to sort the log entries (by time). Accepted values are: asc, desc
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -318,6 +321,7 @@ module LosantRest
 
       query_params[:limit] = params[:limit] if params.has_key?(:limit)
       query_params[:since] = params[:since] if params.has_key?(:since)
+      query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
       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)
@@ -344,8 +348,9 @@ module LosantRest
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
-    # *  {string} limit - Max state entries to return (ordered by time descending)
+    # *  {string} limit - Maximum number of state entries to return
     # *  {string} since - Look for state entries since this time (ms since epoch)
+    # *  {string} sortDirection - Direction to sort the state entries (by time). Accepted values are: asc, desc
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -368,6 +373,7 @@ module LosantRest
 
       query_params[:limit] = params[:limit] if params.has_key?(:limit)
       query_params[:since] = params[:since] if params.has_key?(:since)
+      query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
       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_recipe.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/device_recipes.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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

data/lib/losant_rest/devices.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Losant IoT, Inc.
+# Copyright (c) 2021 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
@@ -31,6 +31,57 @@ module LosantRest
       @client = client
     end
 
+    # Gets the attribute names that match the given query. Maximum 1K returned.
+    #
+    # 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, devices.*, or devices.attributeNames.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} query - Device filter JSON object (https://api.losant.com/#/definitions/advancedDeviceQuery)
+    # *  {hash} dataType - Filter the devices by the given attribute data type or types (https://api.losant.com/#/definitions/deviceAttributeDataTypeFilter)
+    # *  {string} startsWith - Filter attributes down to those that have names starting with the given string. Case insensitive.
+    # *  {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 matching attribute names (https://api.losant.com/#/definitions/attributeNamesResponse)
+    #
+    # 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 attribute_names(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[:query] = params[:query] if params.has_key?(:query)
+      query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
+      query_params[:dataType] = params[:dataType] if params.has_key?(:dataType)
+      query_params[:startsWith] = params[:startsWith] if params.has_key?(:startsWith)
+      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/attributeNames"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Delete devices
     #
     # Authentication:
@@ -386,5 +437,106 @@ module LosantRest
         body: body)
     end
 
+    # Gets the unique tag keys for devices that match the given query. Maximum 1K returned.
+    #
+    # 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, devices.*, or devices.tagKeys.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} query - Device filter JSON object (https://api.losant.com/#/definitions/advancedDeviceQuery)
+    # *  {string} startsWith - Filter keys down to those that start with the given string. Case insensitive.
+    # *  {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 matching tag keys (https://api.losant.com/#/definitions/tagKeysResponse)
+    #
+    # 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 tag_keys(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[:query] = params[:query] if params.has_key?(:query)
+      query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
+      query_params[:startsWith] = params[:startsWith] if params.has_key?(:startsWith)
+      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/tagKeys"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Gets the unique tag values for the given key for devices that match the given query. Maximum 1K returned.
+    #
+    # 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, devices.*, or devices.tagValues.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} query - Device filter JSON object (https://api.losant.com/#/definitions/advancedDeviceQuery)
+    # *  {string} key - The tag key to get the values for
+    # *  {string} startsWith - Filter values down to those that start with the given string. Case insensitive.
+    # *  {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 matching tag values (https://api.losant.com/#/definitions/tagValuesResponse)
+    #
+    # 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 tag_values(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("key is required") unless params.has_key?(:key)
+
+      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[:key] = params[:key] if params.has_key?(:key)
+      query_params[:startsWith] = params[:startsWith] if params.has_key?(:startsWith)
+      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/tagValues"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
   end
 end