losant_rest 1.19.0 → 1.19.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (120) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +872 -38
  3. data/docs/applications.md +49 -0
  4. data/docs/device.md +12 -3
  5. data/docs/me.md +116 -0
  6. data/lib/losant_rest/version.rb +1 -1
  7. data/lib/platform_rest/application.rb +932 -0
  8. data/lib/platform_rest/application_api_token.rb +176 -0
  9. data/lib/platform_rest/application_api_tokens.rb +136 -0
  10. data/lib/platform_rest/application_certificate.rb +176 -0
  11. data/lib/platform_rest/application_certificate_authorities.rb +138 -0
  12. data/lib/platform_rest/application_certificate_authority.rb +176 -0
  13. data/lib/platform_rest/application_certificates.rb +138 -0
  14. data/lib/platform_rest/application_dashboard.rb +225 -0
  15. data/lib/platform_rest/application_dashboards.rb +138 -0
  16. data/lib/platform_rest/application_key.rb +176 -0
  17. data/lib/platform_rest/application_keys.rb +141 -0
  18. data/lib/platform_rest/application_template.rb +79 -0
  19. data/lib/platform_rest/application_templates.rb +176 -0
  20. data/lib/platform_rest/applications.rb +209 -0
  21. data/lib/platform_rest/audit_log.rb +81 -0
  22. data/lib/platform_rest/audit_logs.rb +93 -0
  23. data/lib/platform_rest/auth.rb +245 -0
  24. data/lib/platform_rest/client.rb +410 -0
  25. data/lib/platform_rest/credential.rb +224 -0
  26. data/lib/platform_rest/credentials.rb +138 -0
  27. data/lib/platform_rest/dashboard.rb +268 -0
  28. data/lib/platform_rest/dashboards.rb +136 -0
  29. data/lib/platform_rest/data.rb +176 -0
  30. data/lib/platform_rest/data_table.rb +274 -0
  31. data/lib/platform_rest/data_table_row.rb +182 -0
  32. data/lib/platform_rest/data_table_rows.rb +343 -0
  33. data/lib/platform_rest/data_tables.rb +138 -0
  34. data/lib/platform_rest/device.rb +767 -0
  35. data/lib/platform_rest/device_recipe.rb +234 -0
  36. data/lib/platform_rest/device_recipes.rb +146 -0
  37. data/lib/platform_rest/devices.rb +707 -0
  38. data/lib/platform_rest/edge_deployment.rb +81 -0
  39. data/lib/platform_rest/edge_deployments.rb +236 -0
  40. data/lib/platform_rest/embedded_deployment.rb +81 -0
  41. data/lib/platform_rest/embedded_deployments.rb +280 -0
  42. data/lib/platform_rest/error.rb +34 -0
  43. data/lib/platform_rest/event.rb +176 -0
  44. data/lib/platform_rest/events.rb +341 -0
  45. data/lib/platform_rest/experience.rb +142 -0
  46. data/lib/platform_rest/experience_domain.rb +176 -0
  47. data/lib/platform_rest/experience_domains.rb +126 -0
  48. data/lib/platform_rest/experience_endpoint.rb +230 -0
  49. data/lib/platform_rest/experience_endpoints.rb +200 -0
  50. data/lib/platform_rest/experience_group.rb +180 -0
  51. data/lib/platform_rest/experience_groups.rb +141 -0
  52. data/lib/platform_rest/experience_slug.rb +176 -0
  53. data/lib/platform_rest/experience_slugs.rb +126 -0
  54. data/lib/platform_rest/experience_user.rb +176 -0
  55. data/lib/platform_rest/experience_users.rb +142 -0
  56. data/lib/platform_rest/experience_version.rb +176 -0
  57. data/lib/platform_rest/experience_versions.rb +138 -0
  58. data/lib/platform_rest/experience_view.rb +228 -0
  59. data/lib/platform_rest/experience_views.rb +142 -0
  60. data/lib/platform_rest/file.rb +226 -0
  61. data/lib/platform_rest/files.rb +144 -0
  62. data/lib/platform_rest/flow.rb +580 -0
  63. data/lib/platform_rest/flow_version.rb +352 -0
  64. data/lib/platform_rest/flow_versions.rb +201 -0
  65. data/lib/platform_rest/flows.rb +310 -0
  66. data/lib/platform_rest/instance.rb +377 -0
  67. data/lib/platform_rest/instance_api_token.rb +176 -0
  68. data/lib/platform_rest/instance_api_tokens.rb +136 -0
  69. data/lib/platform_rest/instance_custom_node.rb +282 -0
  70. data/lib/platform_rest/instance_custom_nodes.rb +136 -0
  71. data/lib/platform_rest/instance_member.rb +176 -0
  72. data/lib/platform_rest/instance_members.rb +134 -0
  73. data/lib/platform_rest/instance_org.rb +336 -0
  74. data/lib/platform_rest/instance_org_invite.rb +182 -0
  75. data/lib/platform_rest/instance_org_invites.rb +138 -0
  76. data/lib/platform_rest/instance_org_member.rb +182 -0
  77. data/lib/platform_rest/instance_org_members.rb +138 -0
  78. data/lib/platform_rest/instance_orgs.rb +139 -0
  79. data/lib/platform_rest/instance_sandbox.rb +181 -0
  80. data/lib/platform_rest/instance_sandboxes.rb +98 -0
  81. data/lib/platform_rest/instances.rb +88 -0
  82. data/lib/platform_rest/integration.rb +178 -0
  83. data/lib/platform_rest/integrations.rb +138 -0
  84. data/lib/platform_rest/me.rb +923 -0
  85. data/lib/platform_rest/notebook.rb +423 -0
  86. data/lib/platform_rest/notebooks.rb +138 -0
  87. data/lib/platform_rest/org.rb +663 -0
  88. data/lib/platform_rest/org_invites.rb +124 -0
  89. data/lib/platform_rest/orgs.rb +140 -0
  90. data/lib/platform_rest/resource_job.rb +326 -0
  91. data/lib/platform_rest/resource_jobs.rb +138 -0
  92. data/lib/platform_rest/user_api_token.rb +170 -0
  93. data/lib/platform_rest/user_api_tokens.rb +132 -0
  94. data/lib/platform_rest/utils.rb +44 -0
  95. data/lib/platform_rest/webhook.rb +178 -0
  96. data/lib/platform_rest/webhooks.rb +138 -0
  97. data/lib/platform_rest.rb +129 -0
  98. data/schemas/apiTokenPost.json +4 -0
  99. data/schemas/applicationDashboardPost.json +66 -0
  100. data/schemas/dashboard.json +66 -0
  101. data/schemas/dashboardPatch.json +66 -0
  102. data/schemas/dashboardPost.json +66 -0
  103. data/schemas/dashboards.json +66 -0
  104. data/schemas/deviceConnectionStatus.json +10 -0
  105. data/schemas/deviceLog.json +3 -0
  106. data/schemas/event.json +8 -0
  107. data/schemas/eventPlusNewCount.json +8 -0
  108. data/schemas/events.json +8 -0
  109. data/schemas/githubLogin.json +4 -0
  110. data/schemas/integrationPatch.json +0 -10
  111. data/schemas/orgInviteActionUser.json +18 -0
  112. data/schemas/orgInviteResultUser.json +18 -0
  113. data/schemas/orgInviteUser.json +51 -0
  114. data/schemas/orgInvitesUser.json +59 -0
  115. data/schemas/payloadCountsBreakdown.json +1 -25
  116. data/schemas/periodSummaries.json +172 -0
  117. data/schemas/samlResponse.json +4 -0
  118. data/schemas/userCredentials.json +4 -0
  119. data/schemas/userPost.json +4 -0
  120. metadata +98 -2
@@ -0,0 +1,234 @@
1
+ # The MIT License (MIT)
2
+ #
3
+ # Copyright (c) 2023 Losant IoT, Inc.
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ # of this software and associated documentation files (the "Software"), to deal
7
+ # in the Software without restriction, including without limitation the rights
8
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ # copies of the Software, and to permit persons to whom the Software is
10
+ # furnished to do so, subject to the following conditions:
11
+ #
12
+ # The above copyright notice and this permission notice shall be included in all
13
+ # copies or substantial portions of the Software.
14
+ #
15
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ # SOFTWARE.
22
+
23
+ require "json"
24
+
25
+ module PlatformRest
26
+
27
+ # Class containing all the actions for the Device Recipe Resource
28
+ class DeviceRecipe
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Bulk creates devices using this recipe from a CSV
35
+ #
36
+ # Authentication:
37
+ # The client must be configured with a valid api
38
+ # access token to call this action. The token
39
+ # must include at least one of the following scopes:
40
+ # all.Application, all.Organization, all.User, deviceRecipe.*, or deviceRecipe.bulkCreate.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} deviceRecipeId - ID associated with the device recipe
45
+ # * {hash} bulkInfo - Object containing bulk creation info (https://api.losant.com/#/definitions/deviceRecipeBulkCreatePost)
46
+ # * {string} losantdomain - Domain scope of request (rarely needed)
47
+ # * {boolean} _actions - Return resource actions in response
48
+ # * {boolean} _links - Return resource link in response
49
+ # * {boolean} _embedded - Return embedded resources in response
50
+ #
51
+ # Responses:
52
+ # * 201 - If devices were successfully created (https://api.losant.com/#/definitions/deviceRecipeBulkCreate)
53
+ # * 202 - If devices were enqueued to be created (https://api.losant.com/#/definitions/jobEnqueuedResult)
54
+ #
55
+ # Errors:
56
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
57
+ # * 404 - Error if device recipe was not found (https://api.losant.com/#/definitions/error)
58
+ def bulk_create(params = {})
59
+ params = Utils.symbolize_hash_keys(params)
60
+ query_params = { _actions: false, _links: true, _embedded: true }
61
+ headers = {}
62
+ body = nil
63
+
64
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
65
+ raise ArgumentError.new("deviceRecipeId is required") unless params.has_key?(:deviceRecipeId)
66
+ raise ArgumentError.new("bulkInfo is required") unless params.has_key?(:bulkInfo)
67
+
68
+ body = params[:bulkInfo] if params.has_key?(:bulkInfo)
69
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
70
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
71
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
72
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
73
+
74
+ path = "/applications/#{params[:applicationId]}/device-recipes/#{params[:deviceRecipeId]}/bulkCreate"
75
+
76
+ @client.request(
77
+ method: :post,
78
+ path: path,
79
+ query: query_params,
80
+ headers: headers,
81
+ body: body)
82
+ end
83
+
84
+ # Deletes a device recipe
85
+ #
86
+ # Authentication:
87
+ # The client must be configured with a valid api
88
+ # access token to call this action. The token
89
+ # must include at least one of the following scopes:
90
+ # all.Application, all.Organization, all.User, deviceRecipe.*, or deviceRecipe.delete.
91
+ #
92
+ # Parameters:
93
+ # * {string} applicationId - ID associated with the application
94
+ # * {string} deviceRecipeId - ID associated with the device recipe
95
+ # * {string} losantdomain - Domain scope of request (rarely needed)
96
+ # * {boolean} _actions - Return resource actions in response
97
+ # * {boolean} _links - Return resource link in response
98
+ # * {boolean} _embedded - Return embedded resources in response
99
+ #
100
+ # Responses:
101
+ # * 200 - If device recipe was successfully deleted (https://api.losant.com/#/definitions/success)
102
+ #
103
+ # Errors:
104
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
105
+ # * 404 - Error if device recipe was not found (https://api.losant.com/#/definitions/error)
106
+ def delete(params = {})
107
+ params = Utils.symbolize_hash_keys(params)
108
+ query_params = { _actions: false, _links: true, _embedded: true }
109
+ headers = {}
110
+ body = nil
111
+
112
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
113
+ raise ArgumentError.new("deviceRecipeId is required") unless params.has_key?(:deviceRecipeId)
114
+
115
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
116
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
117
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
118
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
119
+
120
+ path = "/applications/#{params[:applicationId]}/device-recipes/#{params[:deviceRecipeId]}"
121
+
122
+ @client.request(
123
+ method: :delete,
124
+ path: path,
125
+ query: query_params,
126
+ headers: headers,
127
+ body: body)
128
+ end
129
+
130
+ # Retrieves information on a device recipe
131
+ #
132
+ # Authentication:
133
+ # The client must be configured with a valid api
134
+ # access token to call this action. The token
135
+ # must include at least one of the following scopes:
136
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, deviceRecipe.*, or deviceRecipe.get.
137
+ #
138
+ # Parameters:
139
+ # * {string} applicationId - ID associated with the application
140
+ # * {string} deviceRecipeId - ID associated with the device recipe
141
+ # * {string} tagsAsObject - Return tags as an object map instead of an array
142
+ # * {string} attributesAsObject - Return attributes as an object map instead of an array
143
+ # * {string} losantdomain - Domain scope of request (rarely needed)
144
+ # * {boolean} _actions - Return resource actions in response
145
+ # * {boolean} _links - Return resource link in response
146
+ # * {boolean} _embedded - Return embedded resources in response
147
+ #
148
+ # Responses:
149
+ # * 200 - Device recipe information (https://api.losant.com/#/definitions/deviceRecipe)
150
+ #
151
+ # Errors:
152
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
153
+ # * 404 - Error if device recipe was not found (https://api.losant.com/#/definitions/error)
154
+ def get(params = {})
155
+ params = Utils.symbolize_hash_keys(params)
156
+ query_params = { _actions: false, _links: true, _embedded: true }
157
+ headers = {}
158
+ body = nil
159
+
160
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
161
+ raise ArgumentError.new("deviceRecipeId is required") unless params.has_key?(:deviceRecipeId)
162
+
163
+ query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
164
+ query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
165
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
166
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
167
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
168
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
169
+
170
+ path = "/applications/#{params[:applicationId]}/device-recipes/#{params[:deviceRecipeId]}"
171
+
172
+ @client.request(
173
+ method: :get,
174
+ path: path,
175
+ query: query_params,
176
+ headers: headers,
177
+ body: body)
178
+ end
179
+
180
+ # Updates information about a device recipe
181
+ #
182
+ # Authentication:
183
+ # The client must be configured with a valid api
184
+ # access token to call this action. The token
185
+ # must include at least one of the following scopes:
186
+ # all.Application, all.Organization, all.User, deviceRecipe.*, or deviceRecipe.patch.
187
+ #
188
+ # Parameters:
189
+ # * {string} applicationId - ID associated with the application
190
+ # * {string} deviceRecipeId - ID associated with the device recipe
191
+ # * {hash} deviceRecipe - Object containing new properties of the device recipe (https://api.losant.com/#/definitions/deviceRecipePatch)
192
+ # * {string} tagsAsObject - Return tags as an object map instead of an array
193
+ # * {string} attributesAsObject - Return attributes as an object map instead of an array
194
+ # * {string} losantdomain - Domain scope of request (rarely needed)
195
+ # * {boolean} _actions - Return resource actions in response
196
+ # * {boolean} _links - Return resource link in response
197
+ # * {boolean} _embedded - Return embedded resources in response
198
+ #
199
+ # Responses:
200
+ # * 200 - Updated device recipe information (https://api.losant.com/#/definitions/deviceRecipe)
201
+ #
202
+ # Errors:
203
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
204
+ # * 404 - Error if device recipe was not found (https://api.losant.com/#/definitions/error)
205
+ def patch(params = {})
206
+ params = Utils.symbolize_hash_keys(params)
207
+ query_params = { _actions: false, _links: true, _embedded: true }
208
+ headers = {}
209
+ body = nil
210
+
211
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
212
+ raise ArgumentError.new("deviceRecipeId is required") unless params.has_key?(:deviceRecipeId)
213
+ raise ArgumentError.new("deviceRecipe is required") unless params.has_key?(:deviceRecipe)
214
+
215
+ body = params[:deviceRecipe] if params.has_key?(:deviceRecipe)
216
+ query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
217
+ query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
218
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
219
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
220
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
221
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
222
+
223
+ path = "/applications/#{params[:applicationId]}/device-recipes/#{params[:deviceRecipeId]}"
224
+
225
+ @client.request(
226
+ method: :patch,
227
+ path: path,
228
+ query: query_params,
229
+ headers: headers,
230
+ body: body)
231
+ end
232
+
233
+ end
234
+ end
@@ -0,0 +1,146 @@
1
+ # The MIT License (MIT)
2
+ #
3
+ # Copyright (c) 2023 Losant IoT, Inc.
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ # of this software and associated documentation files (the "Software"), to deal
7
+ # in the Software without restriction, including without limitation the rights
8
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ # copies of the Software, and to permit persons to whom the Software is
10
+ # furnished to do so, subject to the following conditions:
11
+ #
12
+ # The above copyright notice and this permission notice shall be included in all
13
+ # copies or substantial portions of the Software.
14
+ #
15
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ # SOFTWARE.
22
+
23
+ require "json"
24
+
25
+ module PlatformRest
26
+
27
+ # Class containing all the actions for the Device Recipes Resource
28
+ class DeviceRecipes
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Returns the device recipes for an application
35
+ #
36
+ # Authentication:
37
+ # The client must be configured with a valid api
38
+ # access token to call this action. The token
39
+ # must include at least one of the following scopes:
40
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, deviceRecipes.*, or deviceRecipes.get.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
45
+ # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
46
+ # * {string} page - Which page of results to return
47
+ # * {string} perPage - How many items to return per page
48
+ # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
49
+ # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
50
+ # * {string} tagsAsObject - Return tags as an object map instead of an array
51
+ # * {string} attributesAsObject - Return attributes as an object map instead of an array
52
+ # * {string} losantdomain - Domain scope of request (rarely needed)
53
+ # * {boolean} _actions - Return resource actions in response
54
+ # * {boolean} _links - Return resource link in response
55
+ # * {boolean} _embedded - Return embedded resources in response
56
+ #
57
+ # Responses:
58
+ # * 200 - Collection of device recipes (https://api.losant.com/#/definitions/deviceRecipes)
59
+ #
60
+ # Errors:
61
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
62
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
63
+ def get(params = {})
64
+ params = Utils.symbolize_hash_keys(params)
65
+ query_params = { _actions: false, _links: true, _embedded: true }
66
+ headers = {}
67
+ body = nil
68
+
69
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
70
+
71
+ query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
72
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
73
+ query_params[:page] = params[:page] if params.has_key?(:page)
74
+ query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
75
+ query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
76
+ query_params[:filter] = params[:filter] if params.has_key?(:filter)
77
+ query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
78
+ query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
79
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
80
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
81
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
82
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
83
+
84
+ path = "/applications/#{params[:applicationId]}/device-recipes"
85
+
86
+ @client.request(
87
+ method: :get,
88
+ path: path,
89
+ query: query_params,
90
+ headers: headers,
91
+ body: body)
92
+ end
93
+
94
+ # Create a new device recipe for an application
95
+ #
96
+ # Authentication:
97
+ # The client must be configured with a valid api
98
+ # access token to call this action. The token
99
+ # must include at least one of the following scopes:
100
+ # all.Application, all.Organization, all.User, deviceRecipes.*, or deviceRecipes.post.
101
+ #
102
+ # Parameters:
103
+ # * {string} applicationId - ID associated with the application
104
+ # * {hash} deviceRecipe - New device recipe information (https://api.losant.com/#/definitions/deviceRecipePost)
105
+ # * {string} tagsAsObject - Return tags as an object map instead of an array
106
+ # * {string} attributesAsObject - Return attributes as an object map instead of an array
107
+ # * {string} losantdomain - Domain scope of request (rarely needed)
108
+ # * {boolean} _actions - Return resource actions in response
109
+ # * {boolean} _links - Return resource link in response
110
+ # * {boolean} _embedded - Return embedded resources in response
111
+ #
112
+ # Responses:
113
+ # * 201 - Successfully created device recipe (https://api.losant.com/#/definitions/deviceRecipe)
114
+ #
115
+ # Errors:
116
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
117
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
118
+ def post(params = {})
119
+ params = Utils.symbolize_hash_keys(params)
120
+ query_params = { _actions: false, _links: true, _embedded: true }
121
+ headers = {}
122
+ body = nil
123
+
124
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
125
+ raise ArgumentError.new("deviceRecipe is required") unless params.has_key?(:deviceRecipe)
126
+
127
+ body = params[:deviceRecipe] if params.has_key?(:deviceRecipe)
128
+ query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
129
+ query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
130
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
131
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
132
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
133
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
134
+
135
+ path = "/applications/#{params[:applicationId]}/device-recipes"
136
+
137
+ @client.request(
138
+ method: :post,
139
+ path: path,
140
+ query: query_params,
141
+ headers: headers,
142
+ body: body)
143
+ end
144
+
145
+ end
146
+ end