Class: PlatformRest::DeviceRecipe

Inherits:
Object
  • Object
show all
Defined in:
lib/platform_rest/device_recipe.rb

Overview

Class containing all the actions for the Device Recipe Resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ DeviceRecipe

Returns a new instance of DeviceRecipe.



30
31
32
 
# File 'lib/platform_rest/device_recipe.rb', line 30

def initialize(client)
  @client = client
end

Instance Method Details

#bulk_create(params = {}) ⇒ Object

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:

Errors:

Raises:

  • (ArgumentError) 


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/platform_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

#delete(params = {}) ⇒ Object

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:

Errors:

Raises:

  • (ArgumentError) 


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/platform_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

#get(params = {}) ⇒ Object

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:

Errors:

Raises:

  • (ArgumentError) 


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/platform_rest/device_recipe.rb', line 154

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

#patch(params = {}) ⇒ Object

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 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:

Errors:

Raises:

  • (ArgumentError) 


205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/platform_rest/device_recipe.rb', line 205

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