losant_rest 1.19.4 → 1.19.6

data/lib/losant_rest/device_recipe.rb

@@ -1,234 +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 Device Recipe Resource
-  class DeviceRecipe
-
-    def initialize(client)
-      @client = client
-    end
-
-    # Bulk creates devices using this recipe from a CSV
-    #
-    # 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, deviceRecipe.*, or deviceRecipe.bulkCreate.
-    #
-    # Parameters:
-    # *  {string} applicationId - ID associated with the application
-    # *  {string} deviceRecipeId - ID associated with the device recipe
-    # *  {hash} bulkInfo - Object containing bulk creation info (https://api.losant.com/#/definitions/deviceRecipeBulkCreatePost)
-    # *  {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 - If devices were successfully created (https://api.losant.com/#/definitions/deviceRecipeBulkCreate)
-    # *  202 - If devices were enqueued to be created (https://api.losant.com/#/definitions/jobEnqueuedResult)
-    #
-    # Errors:
-    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if device recipe was not found (https://api.losant.com/#/definitions/error)
-    def bulk_create(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("deviceRecipeId is required") unless params.has_key?(:deviceRecipeId)
-      raise ArgumentError.new("bulkInfo is required") unless params.has_key?(:bulkInfo)
-
-      body = params[:bulkInfo] if params.has_key?(:bulkInfo)
-      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]}/device-recipes/#{params[:deviceRecipeId]}/bulkCreate"
-
-      @client.request(
-        method: :post,
-        path: path,
-        query: query_params,
-        headers: headers,
-        body: body)
-    end
-
-    # Deletes a device recipe
-    #
-    # 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, deviceRecipe.*, or deviceRecipe.delete.
-    #
-    # Parameters:
-    # *  {string} applicationId - ID associated with the application
-    # *  {string} deviceRecipeId - ID associated with the device recipe
-    # *  {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 device recipe was successfully deleted (https://api.losant.com/#/definitions/success)
-    #
-    # Errors:
-    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if device recipe 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("deviceRecipeId is required") unless params.has_key?(:deviceRecipeId)
-
-      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]}/device-recipes/#{params[:deviceRecipeId]}"
-
-      @client.request(
-        method: :delete,
-        path: path,
-        query: query_params,
-        headers: headers,
-        body: body)
-    end
-
-    # Retrieves information on a device recipe
-    #
-    # 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, deviceRecipe.*, or deviceRecipe.get.
-    #
-    # Parameters:
-    # *  {string} applicationId - ID associated with the application
-    # *  {string} deviceRecipeId - ID associated with the device recipe
-    # *  {string} tagsAsObject - Return tags as an object map instead of an array
-    # *  {string} attributesAsObject - Return attributes as an object map instead of an array
-    # *  {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 - Device recipe information (https://api.losant.com/#/definitions/deviceRecipe)
-    #
-    # Errors:
-    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if device recipe 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("deviceRecipeId is required") unless params.has_key?(:deviceRecipeId)
-
-      query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
-      query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
-      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]}/device-recipes/#{params[:deviceRecipeId]}"
-
-      @client.request(
-        method: :get,
-        path: path,
-        query: query_params,
-        headers: headers,
-        body: body)
-    end
-
-    # Updates information about a device recipe
-    #
-    # 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, deviceRecipe.*, or deviceRecipe.patch.
-    #
-    # Parameters:
-    # *  {string} applicationId - ID associated with the application
-    # *  {string} deviceRecipeId - ID associated with the device recipe
-    # *  {hash} deviceRecipe - Object containing new properties of the device recipe (https://api.losant.com/#/definitions/deviceRecipePatch)
-    # *  {string} tagsAsObject - Return tags as an object map instead of an array
-    # *  {string} attributesAsObject - Return attributes as an object map instead of an array
-    # *  {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 device recipe information (https://api.losant.com/#/definitions/deviceRecipe)
-    #
-    # Errors:
-    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if device recipe 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("deviceRecipeId is required") unless params.has_key?(:deviceRecipeId)
-      raise ArgumentError.new("deviceRecipe is required") unless params.has_key?(:deviceRecipe)
-
-      body = params[:deviceRecipe] if params.has_key?(:deviceRecipe)
-      query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
-      query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
-      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]}/device-recipes/#{params[:deviceRecipeId]}"
-
-      @client.request(
-        method: :patch,
-        path: path,
-        query: query_params,
-        headers: headers,
-        body: body)
-    end
-
-  end
-end

data/lib/losant_rest/device_recipes.rb

@@ -1,146 +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 Device Recipes Resource
-  class DeviceRecipes
-
-    def initialize(client)
-      @client = client
-    end
-
-    # Returns the device recipes 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, deviceRecipes.*, or deviceRecipes.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} tagsAsObject - Return tags as an object map instead of an array
-    # *  {string} attributesAsObject - Return attributes as an object map instead of an array
-    # *  {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 device recipes (https://api.losant.com/#/definitions/deviceRecipes)
-    #
-    # 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)
-      query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
-      query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
-      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]}/device-recipes"
-
-      @client.request(
-        method: :get,
-        path: path,
-        query: query_params,
-        headers: headers,
-        body: body)
-    end
-
-    # Create a new device recipe 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, deviceRecipes.*, or deviceRecipes.post.
-    #
-    # Parameters:
-    # *  {string} applicationId - ID associated with the application
-    # *  {hash} deviceRecipe - New device recipe information (https://api.losant.com/#/definitions/deviceRecipePost)
-    # *  {string} tagsAsObject - Return tags as an object map instead of an array
-    # *  {string} attributesAsObject - Return attributes as an object map instead of an array
-    # *  {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 device recipe (https://api.losant.com/#/definitions/deviceRecipe)
-    #
-    # 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("deviceRecipe is required") unless params.has_key?(:deviceRecipe)
-
-      body = params[:deviceRecipe] if params.has_key?(:deviceRecipe)
-      query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
-      query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
-      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]}/device-recipes"
-
-      @client.request(
-        method: :post,
-        path: path,
-        query: query_params,
-        headers: headers,
-        body: body)
-    end
-
-  end
-end