losant_rest 1.19.4 → 1.19.7

data/lib/losant_rest/webhooks.rb

@@ -1,138 +0,0 @@
-# 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 LosantRest
-
-  # Class containing all the actions for the Webhooks Resource
-  class Webhooks
-
-    def initialize(client)
-      @client = client
-    end
-
-    # Returns the webhooks 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, webhooks.*, or webhooks.get.
-    #
-    # Parameters:
-    # *  {string} applicationId - ID associated with the application
-    # *  {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 webhooks (https://api.losant.com/#/definitions/webhooks)
-    #
-    # 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]}/webhooks"
-
-      @client.request(
-        method: :get,
-        path: path,
-        query: query_params,
-        headers: headers,
-        body: body)
-    end
-
-    # Create a new webhook 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, webhooks.*, or webhooks.post.
-    #
-    # Parameters:
-    # *  {string} applicationId - ID associated with the application
-    # *  {hash} webhook - New webhook information (https://api.losant.com/#/definitions/webhookPost)
-    # *  {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 webhook (https://api.losant.com/#/definitions/webhook)
-    #
-    # 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("webhook is required") unless params.has_key?(:webhook)
-
-      body = params[:webhook] if params.has_key?(:webhook)
-      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]}/webhooks"
-
-      @client.request(
-        method: :post,
-        path: path,
-        query: query_params,
-        headers: headers,
-        body: body)
-    end
-
-  end
-end

data/lib/losant_rest.rb

@@ -1,129 +0,0 @@
-# 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_relative "losant_rest/version"
-require_relative "losant_rest/error"
-require_relative "losant_rest/utils"
-require_relative "losant_rest/application"
-require_relative "losant_rest/application_api_token"
-require_relative "losant_rest/application_api_tokens"
-require_relative "losant_rest/application_certificate"
-require_relative "losant_rest/application_certificate_authorities"
-require_relative "losant_rest/application_certificate_authority"
-require_relative "losant_rest/application_certificates"
-require_relative "losant_rest/application_dashboard"
-require_relative "losant_rest/application_dashboards"
-require_relative "losant_rest/application_key"
-require_relative "losant_rest/application_keys"
-require_relative "losant_rest/application_template"
-require_relative "losant_rest/application_templates"
-require_relative "losant_rest/applications"
-require_relative "losant_rest/audit_log"
-require_relative "losant_rest/audit_logs"
-require_relative "losant_rest/auth"
-require_relative "losant_rest/credential"
-require_relative "losant_rest/credentials"
-require_relative "losant_rest/dashboard"
-require_relative "losant_rest/dashboards"
-require_relative "losant_rest/data"
-require_relative "losant_rest/data_table"
-require_relative "losant_rest/data_table_row"
-require_relative "losant_rest/data_table_rows"
-require_relative "losant_rest/data_tables"
-require_relative "losant_rest/device"
-require_relative "losant_rest/device_recipe"
-require_relative "losant_rest/device_recipes"
-require_relative "losant_rest/devices"
-require_relative "losant_rest/edge_deployment"
-require_relative "losant_rest/edge_deployments"
-require_relative "losant_rest/embedded_deployment"
-require_relative "losant_rest/embedded_deployments"
-require_relative "losant_rest/event"
-require_relative "losant_rest/events"
-require_relative "losant_rest/experience"
-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_slug"
-require_relative "losant_rest/experience_slugs"
-require_relative "losant_rest/experience_user"
-require_relative "losant_rest/experience_users"
-require_relative "losant_rest/experience_version"
-require_relative "losant_rest/experience_versions"
-require_relative "losant_rest/experience_view"
-require_relative "losant_rest/experience_views"
-require_relative "losant_rest/file"
-require_relative "losant_rest/files"
-require_relative "losant_rest/flow"
-require_relative "losant_rest/flow_version"
-require_relative "losant_rest/flow_versions"
-require_relative "losant_rest/flows"
-require_relative "losant_rest/instance"
-require_relative "losant_rest/instance_api_token"
-require_relative "losant_rest/instance_api_tokens"
-require_relative "losant_rest/instance_custom_node"
-require_relative "losant_rest/instance_custom_nodes"
-require_relative "losant_rest/instance_member"
-require_relative "losant_rest/instance_members"
-require_relative "losant_rest/instance_org"
-require_relative "losant_rest/instance_org_invite"
-require_relative "losant_rest/instance_org_invites"
-require_relative "losant_rest/instance_org_member"
-require_relative "losant_rest/instance_org_members"
-require_relative "losant_rest/instance_orgs"
-require_relative "losant_rest/instance_sandbox"
-require_relative "losant_rest/instance_sandboxes"
-require_relative "losant_rest/instances"
-require_relative "losant_rest/integration"
-require_relative "losant_rest/integrations"
-require_relative "losant_rest/me"
-require_relative "losant_rest/notebook"
-require_relative "losant_rest/notebooks"
-require_relative "losant_rest/org"
-require_relative "losant_rest/org_invites"
-require_relative "losant_rest/orgs"
-require_relative "losant_rest/resource_job"
-require_relative "losant_rest/resource_jobs"
-require_relative "losant_rest/user_api_token"
-require_relative "losant_rest/user_api_tokens"
-require_relative "losant_rest/webhook"
-require_relative "losant_rest/webhooks"
-require_relative "losant_rest/client"
-
-module LosantRest
-
-  def self.client
-    @client ||= Client.new
-  end
-
-  def self.method_missing(sym, *args, &block)
-    self.client.__send__(sym, *args, &block)
-  end
-
-  def respond_to_missing?(method_name, include_private = false)
-    self.client.respond_to?(method_name, include_private)
-  end
-
-end