losant_rest 1.19.0 → 1.19.1

data/lib/platform_rest/client.rb

@@ -0,0 +1,410 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2023 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 "httparty"
+
+module PlatformRest
+  # Platform API
+  #
+  # User API for accessing platform data
+  #
+  # Built For Version 1.26.1
+  class Client
+    attr_accessor :auth_token, :url
+
+    def initialize(options = {})
+      self.auth_token = options.fetch(:auth_token, nil)
+      self.url        = options.fetch(:url, "https://api.losant.com")
+    end
+
+    def application
+      @application ||= Application.new(self)
+    end
+
+    def application_api_token
+      @application_api_token ||= ApplicationApiToken.new(self)
+    end
+
+    def application_api_tokens
+      @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_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
+
+    def application_keys
+      @application_keys ||= ApplicationKeys.new(self)
+    end
+
+    def application_template
+      @application_template ||= ApplicationTemplate.new(self)
+    end
+
+    def application_templates
+      @application_templates ||= ApplicationTemplates.new(self)
+    end
+
+    def applications
+      @applications ||= Applications.new(self)
+    end
+
+    def audit_log
+      @audit_log ||= AuditLog.new(self)
+    end
+
+    def audit_logs
+      @audit_logs ||= AuditLogs.new(self)
+    end
+
+    def auth
+      @auth ||= Auth.new(self)
+    end
+
+    def credential
+      @credential ||= Credential.new(self)
+    end
+
+    def credentials
+      @credentials ||= Credentials.new(self)
+    end
+
+    def dashboard
+      @dashboard ||= Dashboard.new(self)
+    end
+
+    def dashboards
+      @dashboards ||= Dashboards.new(self)
+    end
+
+    def data
+      @data ||= Data.new(self)
+    end
+
+    def data_table
+      @data_table ||= DataTable.new(self)
+    end
+
+    def data_table_row
+      @data_table_row ||= DataTableRow.new(self)
+    end
+
+    def data_table_rows
+      @data_table_rows ||= DataTableRows.new(self)
+    end
+
+    def data_tables
+      @data_tables ||= DataTables.new(self)
+    end
+
+    def device
+      @device ||= Device.new(self)
+    end
+
+    def device_recipe
+      @device_recipe ||= DeviceRecipe.new(self)
+    end
+
+    def device_recipes
+      @device_recipes ||= DeviceRecipes.new(self)
+    end
+
+    def devices
+      @devices ||= Devices.new(self)
+    end
+
+    def edge_deployment
+      @edge_deployment ||= EdgeDeployment.new(self)
+    end
+
+    def edge_deployments
+      @edge_deployments ||= EdgeDeployments.new(self)
+    end
+
+    def embedded_deployment
+      @embedded_deployment ||= EmbeddedDeployment.new(self)
+    end
+
+    def embedded_deployments
+      @embedded_deployments ||= EmbeddedDeployments.new(self)
+    end
+
+    def event
+      @event ||= Event.new(self)
+    end
+
+    def events
+      @events ||= Events.new(self)
+    end
+
+    def experience
+      @experience ||= Experience.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
+
+    def experience_endpoints
+      @experience_endpoints ||= ExperienceEndpoints.new(self)
+    end
+
+    def experience_group
+      @experience_group ||= ExperienceGroup.new(self)
+    end
+
+    def experience_groups
+      @experience_groups ||= ExperienceGroups.new(self)
+    end
+
+    def experience_slug
+      @experience_slug ||= ExperienceSlug.new(self)
+    end
+
+    def experience_slugs
+      @experience_slugs ||= ExperienceSlugs.new(self)
+    end
+
+    def experience_user
+      @experience_user ||= ExperienceUser.new(self)
+    end
+
+    def experience_users
+      @experience_users ||= ExperienceUsers.new(self)
+    end
+
+    def experience_version
+      @experience_version ||= ExperienceVersion.new(self)
+    end
+
+    def experience_versions
+      @experience_versions ||= ExperienceVersions.new(self)
+    end
+
+    def experience_view
+      @experience_view ||= ExperienceView.new(self)
+    end
+
+    def experience_views
+      @experience_views ||= ExperienceViews.new(self)
+    end
+
+    def file
+      @file ||= File.new(self)
+    end
+
+    def files
+      @files ||= Files.new(self)
+    end
+
+    def flow
+      @flow ||= Flow.new(self)
+    end
+
+    def flow_version
+      @flow_version ||= FlowVersion.new(self)
+    end
+
+    def flow_versions
+      @flow_versions ||= FlowVersions.new(self)
+    end
+
+    def flows
+      @flows ||= Flows.new(self)
+    end
+
+    def instance
+      @instance ||= Instance.new(self)
+    end
+
+    def instance_api_token
+      @instance_api_token ||= InstanceApiToken.new(self)
+    end
+
+    def instance_api_tokens
+      @instance_api_tokens ||= InstanceApiTokens.new(self)
+    end
+
+    def instance_custom_node
+      @instance_custom_node ||= InstanceCustomNode.new(self)
+    end
+
+    def instance_custom_nodes
+      @instance_custom_nodes ||= InstanceCustomNodes.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_invite
+      @instance_org_invite ||= InstanceOrgInvite.new(self)
+    end
+
+    def instance_org_invites
+      @instance_org_invites ||= InstanceOrgInvites.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 instance_sandbox
+      @instance_sandbox ||= InstanceSandbox.new(self)
+    end
+
+    def instance_sandboxes
+      @instance_sandboxes ||= InstanceSandboxes.new(self)
+    end
+
+    def instances
+      @instances ||= Instances.new(self)
+    end
+
+    def integration
+      @integration ||= Integration.new(self)
+    end
+
+    def integrations
+      @integrations ||= Integrations.new(self)
+    end
+
+    def me
+      @me ||= Me.new(self)
+    end
+
+    def notebook
+      @notebook ||= Notebook.new(self)
+    end
+
+    def notebooks
+      @notebooks ||= Notebooks.new(self)
+    end
+
+    def org
+      @org ||= Org.new(self)
+    end
+
+    def org_invites
+      @org_invites ||= OrgInvites.new(self)
+    end
+
+    def orgs
+      @orgs ||= Orgs.new(self)
+    end
+
+    def resource_job
+      @resource_job ||= ResourceJob.new(self)
+    end
+
+    def resource_jobs
+      @resource_jobs ||= ResourceJobs.new(self)
+    end
+
+    def user_api_token
+      @user_api_token ||= UserApiToken.new(self)
+    end
+
+    def user_api_tokens
+      @user_api_tokens ||= UserApiTokens.new(self)
+    end
+
+    def webhook
+      @webhook ||= Webhook.new(self)
+    end
+
+    def webhooks
+      @webhooks ||= Webhooks.new(self)
+    end
+
+    def request(options = {})
+      headers = options.fetch(:headers, {})
+      method  = options.fetch(:method, :get)
+
+      headers["Accept"]         = "application/json"
+      headers["Content-Type"]   = "application/json"
+      headers["Accept-Version"] = "^1.26.1"
+      headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
+      path = self.url + options.fetch(:path, "")
+
+      response = HTTParty.send(method, path,
+        query: Utils.fix_query_arrays(options[:query]),
+        body: options[:body] && options[:body].to_json(),
+        headers: headers)
+
+      result = response.parsed_response
+      if response.code >= 400
+        raise ResponseError.new(response.code, result)
+      end
+
+      result
+    end
+  end
+end

data/lib/platform_rest/credential.rb

@@ -0,0 +1,224 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2023 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 PlatformRest
+
+  # Class containing all the actions for the Credential Resource
+  class Credential
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Deletes a credential
+    #
+    # 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, credential.*, or credential.delete.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} credentialId - ID associated with the credential
+    # *  {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 credential was successfully deleted (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if credential 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 }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("credentialId is required") unless params.has_key?(:credentialId)
+
+      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]}/credentials/#{params[:credentialId]}"
+
+      @client.request(
+        method: :delete,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Retrieves information on a credential
+    #
+    # 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, credential.*, or credential.get.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} credentialId - ID associated with the credential
+    # *  {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 - credential information (https://api.losant.com/#/definitions/credential)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if credential 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)
+      raise ArgumentError.new("credentialId is required") unless params.has_key?(:credentialId)
+
+      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]}/credentials/#{params[:credentialId]}"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Retrieves information on resources linked to a credential
+    #
+    # 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, credential.*, or credential.linkedResources.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} credentialId - ID associated with the credential
+    # *  {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by returned workflows
+    # *  {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 - Linked resource information (https://api.losant.com/#/definitions/credentialLinkedResources)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if credential was not found (https://api.losant.com/#/definitions/error)
+    def linked_resources(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("credentialId is required") unless params.has_key?(:credentialId)
+
+      query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
+      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]}/credentials/#{params[:credentialId]}/linkedResources"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Updates information about a credential
+    #
+    # 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, credential.*, or credential.patch.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} credentialId - ID associated with the credential
+    # *  {hash} credential - Object containing new properties of the credential (https://api.losant.com/#/definitions/credentialPatch)
+    # *  {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 credential information (https://api.losant.com/#/definitions/credential)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if credential 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 }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("credentialId is required") unless params.has_key?(:credentialId)
+      raise ArgumentError.new("credential is required") unless params.has_key?(:credential)
+
+      body = params[:credential] if params.has_key?(:credential)
+      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]}/credentials/#{params[:credentialId]}"
+
+      @client.request(
+        method: :patch,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end