class LosantRest::DeviceRecipe
Class containing all the actions for the Device
Recipe Resource
Public Class Methods
# File lib/losant_rest/device_recipe.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
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 (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 (api.losant.com/#/definitions/deviceRecipeBulkCreate)
-
202 - If devices were enqueued to be created (api.losant.com/#/definitions/deviceRecipeBulkCreateEnqueued)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if device recipe was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/device_recipe.rb, line 58 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 (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if device recipe was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/device_recipe.rb, line 106 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} 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 (api.losant.com/#/definitions/deviceRecipe)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if device recipe was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/device_recipe.rb, line 152 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) 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 (api.losant.com/#/definitions/deviceRecipePatch)
-
{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 (api.losant.com/#/definitions/deviceRecipe)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if device recipe was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/device_recipe.rb, line 199 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) 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