losant_rest 1.19.4 → 1.19.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (237) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +9 -9
  4. data/docs/_schemas.md +1142 -63
  5. data/docs/instanceAuditLog.md +49 -0
  6. data/docs/instanceAuditLogs.md +53 -0
  7. data/examples/auth.rb +1 -1
  8. data/examples/list_devices.rb +1 -1
  9. data/lib/platform_rest/application.rb +1 -1
  10. data/lib/platform_rest/application_api_token.rb +1 -1
  11. data/lib/platform_rest/application_api_tokens.rb +1 -1
  12. data/lib/platform_rest/application_certificate.rb +1 -1
  13. data/lib/platform_rest/application_certificate_authorities.rb +1 -1
  14. data/lib/platform_rest/application_certificate_authority.rb +1 -1
  15. data/lib/platform_rest/application_certificates.rb +1 -1
  16. data/lib/platform_rest/application_dashboard.rb +1 -1
  17. data/lib/platform_rest/application_dashboards.rb +1 -1
  18. data/lib/platform_rest/application_key.rb +1 -1
  19. data/lib/platform_rest/application_keys.rb +1 -1
  20. data/lib/platform_rest/application_template.rb +1 -1
  21. data/lib/platform_rest/application_templates.rb +1 -1
  22. data/lib/platform_rest/applications.rb +1 -1
  23. data/lib/platform_rest/audit_log.rb +1 -1
  24. data/lib/platform_rest/audit_logs.rb +1 -1
  25. data/lib/platform_rest/auth.rb +1 -1
  26. data/lib/platform_rest/client.rb +11 -3
  27. data/lib/platform_rest/credential.rb +1 -1
  28. data/lib/platform_rest/credentials.rb +1 -1
  29. data/lib/platform_rest/dashboard.rb +1 -1
  30. data/lib/platform_rest/dashboards.rb +1 -1
  31. data/lib/platform_rest/data.rb +1 -1
  32. data/lib/platform_rest/data_table.rb +1 -1
  33. data/lib/platform_rest/data_table_row.rb +1 -1
  34. data/lib/platform_rest/data_table_rows.rb +1 -1
  35. data/lib/platform_rest/data_tables.rb +1 -1
  36. data/lib/platform_rest/device.rb +1 -1
  37. data/lib/platform_rest/device_recipe.rb +1 -1
  38. data/lib/platform_rest/device_recipes.rb +1 -1
  39. data/lib/platform_rest/devices.rb +1 -1
  40. data/lib/platform_rest/edge_deployment.rb +1 -1
  41. data/lib/platform_rest/edge_deployments.rb +1 -1
  42. data/lib/platform_rest/embedded_deployment.rb +1 -1
  43. data/lib/platform_rest/embedded_deployments.rb +1 -1
  44. data/lib/platform_rest/error.rb +1 -1
  45. data/lib/platform_rest/event.rb +1 -1
  46. data/lib/platform_rest/events.rb +1 -1
  47. data/lib/platform_rest/experience.rb +1 -1
  48. data/lib/platform_rest/experience_domain.rb +1 -1
  49. data/lib/platform_rest/experience_domains.rb +1 -1
  50. data/lib/platform_rest/experience_endpoint.rb +1 -1
  51. data/lib/platform_rest/experience_endpoints.rb +1 -1
  52. data/lib/platform_rest/experience_group.rb +1 -1
  53. data/lib/platform_rest/experience_groups.rb +1 -1
  54. data/lib/platform_rest/experience_slug.rb +1 -1
  55. data/lib/platform_rest/experience_slugs.rb +1 -1
  56. data/lib/platform_rest/experience_user.rb +1 -1
  57. data/lib/platform_rest/experience_users.rb +1 -1
  58. data/lib/platform_rest/experience_version.rb +1 -1
  59. data/lib/platform_rest/experience_versions.rb +1 -1
  60. data/lib/platform_rest/experience_view.rb +1 -1
  61. data/lib/platform_rest/experience_views.rb +1 -1
  62. data/lib/platform_rest/file.rb +1 -1
  63. data/lib/platform_rest/files.rb +1 -1
  64. data/lib/platform_rest/flow.rb +1 -1
  65. data/lib/platform_rest/flow_version.rb +1 -1
  66. data/lib/platform_rest/flow_versions.rb +1 -1
  67. data/lib/platform_rest/flows.rb +1 -1
  68. data/lib/platform_rest/instance.rb +1 -1
  69. data/lib/platform_rest/instance_api_token.rb +1 -1
  70. data/lib/platform_rest/instance_api_tokens.rb +1 -1
  71. data/lib/{losant_rest/application_template.rb → platform_rest/instance_audit_log.rb} +13 -11
  72. data/lib/{losant_rest/audit_logs.rb → platform_rest/instance_audit_logs.rb} +12 -12
  73. data/lib/platform_rest/instance_custom_node.rb +1 -1
  74. data/lib/platform_rest/instance_custom_nodes.rb +1 -1
  75. data/lib/platform_rest/instance_member.rb +1 -1
  76. data/lib/platform_rest/instance_members.rb +1 -1
  77. data/lib/platform_rest/instance_org.rb +1 -1
  78. data/lib/platform_rest/instance_org_invite.rb +1 -1
  79. data/lib/platform_rest/instance_org_invites.rb +1 -1
  80. data/lib/platform_rest/instance_org_member.rb +1 -1
  81. data/lib/platform_rest/instance_org_members.rb +1 -1
  82. data/lib/platform_rest/instance_orgs.rb +1 -1
  83. data/lib/platform_rest/instance_sandbox.rb +1 -1
  84. data/lib/platform_rest/instance_sandboxes.rb +1 -1
  85. data/lib/platform_rest/instances.rb +1 -1
  86. data/lib/platform_rest/integration.rb +1 -1
  87. data/lib/platform_rest/integrations.rb +1 -1
  88. data/lib/platform_rest/me.rb +1 -1
  89. data/lib/platform_rest/notebook.rb +1 -1
  90. data/lib/platform_rest/notebooks.rb +1 -1
  91. data/lib/platform_rest/org.rb +1 -1
  92. data/lib/platform_rest/org_invites.rb +1 -1
  93. data/lib/platform_rest/orgs.rb +1 -1
  94. data/lib/platform_rest/resource_job.rb +1 -1
  95. data/lib/platform_rest/resource_jobs.rb +1 -1
  96. data/lib/platform_rest/user_api_token.rb +1 -1
  97. data/lib/platform_rest/user_api_tokens.rb +1 -1
  98. data/lib/platform_rest/utils.rb +1 -1
  99. data/lib/{losant_rest → platform_rest}/version.rb +3 -3
  100. data/lib/platform_rest/webhook.rb +1 -1
  101. data/lib/platform_rest/webhooks.rb +1 -1
  102. data/lib/platform_rest.rb +3 -1
  103. data/losant_rest.gemspec +2 -2
  104. data/schemas/apiTokenPost.json +9 -1
  105. data/schemas/auditLog.json +3 -2
  106. data/schemas/auditLogFilter.json +3 -2
  107. data/schemas/auditLogs.json +3 -2
  108. data/schemas/credential.json +50 -1
  109. data/schemas/credentialLinkedResources.json +81 -4
  110. data/schemas/credentialPatch.json +56 -0
  111. data/schemas/credentialPost.json +71 -1
  112. data/schemas/credentials.json +50 -1
  113. data/schemas/deviceConnectionStatus.json +6 -2
  114. data/schemas/devicesHistoricalImportPost.json +25 -0
  115. data/schemas/experienceLinkedResources.json +7 -5
  116. data/schemas/experienceView.json +1 -2
  117. data/schemas/experienceViewPatch.json +1 -2
  118. data/schemas/experienceViewPost.json +2 -4
  119. data/schemas/experienceViews.json +1 -2
  120. data/schemas/flow.json +2 -1
  121. data/schemas/flowPatch.json +2 -1
  122. data/schemas/flowPost.json +2 -1
  123. data/schemas/flowVersion.json +4 -2
  124. data/schemas/flowVersionPost.json +2 -1
  125. data/schemas/flowVersions.json +4 -2
  126. data/schemas/flows.json +2 -1
  127. data/schemas/flowsImportPost.json +4 -2
  128. data/schemas/flowsImportResult.json +6 -3
  129. data/schemas/githubLogin.json +9 -1
  130. data/schemas/instance.json +1 -4
  131. data/schemas/instanceAuditLog.json +94 -0
  132. data/schemas/instanceAuditLogFilter.json +106 -0
  133. data/schemas/instanceAuditLogs.json +41 -0
  134. data/schemas/instanceCustomNodePatch.json +2 -1
  135. data/schemas/instanceCustomNodePost.json +2 -1
  136. data/schemas/instanceOrgMember.json +4 -1
  137. data/schemas/instances.json +1 -4
  138. data/schemas/integration.json +75 -1
  139. data/schemas/integrationPatch.json +73 -0
  140. data/schemas/integrationPost.json +75 -1
  141. data/schemas/integrations.json +75 -1
  142. data/schemas/mePatch.json +18 -0
  143. data/schemas/samlResponse.json +9 -1
  144. data/schemas/userCredentials.json +9 -1
  145. data/schemas/userPost.json +9 -1
  146. data/test/basic_test.rb +6 -6
  147. data/test/test_helper.rb +1 -1
  148. metadata +11 -94
  149. data/lib/losant_rest/application.rb +0 -932
  150. data/lib/losant_rest/application_api_token.rb +0 -176
  151. data/lib/losant_rest/application_api_tokens.rb +0 -136
  152. data/lib/losant_rest/application_certificate.rb +0 -176
  153. data/lib/losant_rest/application_certificate_authorities.rb +0 -138
  154. data/lib/losant_rest/application_certificate_authority.rb +0 -176
  155. data/lib/losant_rest/application_certificates.rb +0 -138
  156. data/lib/losant_rest/application_dashboard.rb +0 -225
  157. data/lib/losant_rest/application_dashboards.rb +0 -138
  158. data/lib/losant_rest/application_key.rb +0 -176
  159. data/lib/losant_rest/application_keys.rb +0 -141
  160. data/lib/losant_rest/application_templates.rb +0 -176
  161. data/lib/losant_rest/applications.rb +0 -142
  162. data/lib/losant_rest/audit_log.rb +0 -81
  163. data/lib/losant_rest/auth.rb +0 -245
  164. data/lib/losant_rest/client.rb +0 -410
  165. data/lib/losant_rest/credential.rb +0 -224
  166. data/lib/losant_rest/credentials.rb +0 -138
  167. data/lib/losant_rest/dashboard.rb +0 -268
  168. data/lib/losant_rest/dashboards.rb +0 -136
  169. data/lib/losant_rest/data.rb +0 -176
  170. data/lib/losant_rest/data_table.rb +0 -274
  171. data/lib/losant_rest/data_table_row.rb +0 -182
  172. data/lib/losant_rest/data_table_rows.rb +0 -343
  173. data/lib/losant_rest/data_tables.rb +0 -138
  174. data/lib/losant_rest/device.rb +0 -749
  175. data/lib/losant_rest/device_recipe.rb +0 -234
  176. data/lib/losant_rest/device_recipes.rb +0 -146
  177. data/lib/losant_rest/devices.rb +0 -707
  178. data/lib/losant_rest/edge_deployment.rb +0 -81
  179. data/lib/losant_rest/edge_deployments.rb +0 -236
  180. data/lib/losant_rest/embedded_deployment.rb +0 -81
  181. data/lib/losant_rest/embedded_deployments.rb +0 -280
  182. data/lib/losant_rest/error.rb +0 -34
  183. data/lib/losant_rest/event.rb +0 -176
  184. data/lib/losant_rest/events.rb +0 -341
  185. data/lib/losant_rest/experience.rb +0 -142
  186. data/lib/losant_rest/experience_domain.rb +0 -176
  187. data/lib/losant_rest/experience_domains.rb +0 -126
  188. data/lib/losant_rest/experience_endpoint.rb +0 -230
  189. data/lib/losant_rest/experience_endpoints.rb +0 -200
  190. data/lib/losant_rest/experience_group.rb +0 -180
  191. data/lib/losant_rest/experience_groups.rb +0 -141
  192. data/lib/losant_rest/experience_slug.rb +0 -176
  193. data/lib/losant_rest/experience_slugs.rb +0 -126
  194. data/lib/losant_rest/experience_user.rb +0 -176
  195. data/lib/losant_rest/experience_users.rb +0 -142
  196. data/lib/losant_rest/experience_version.rb +0 -176
  197. data/lib/losant_rest/experience_versions.rb +0 -138
  198. data/lib/losant_rest/experience_view.rb +0 -228
  199. data/lib/losant_rest/experience_views.rb +0 -142
  200. data/lib/losant_rest/file.rb +0 -226
  201. data/lib/losant_rest/files.rb +0 -144
  202. data/lib/losant_rest/flow.rb +0 -580
  203. data/lib/losant_rest/flow_version.rb +0 -352
  204. data/lib/losant_rest/flow_versions.rb +0 -201
  205. data/lib/losant_rest/flows.rb +0 -310
  206. data/lib/losant_rest/instance.rb +0 -377
  207. data/lib/losant_rest/instance_api_token.rb +0 -176
  208. data/lib/losant_rest/instance_api_tokens.rb +0 -136
  209. data/lib/losant_rest/instance_custom_node.rb +0 -282
  210. data/lib/losant_rest/instance_custom_nodes.rb +0 -136
  211. data/lib/losant_rest/instance_member.rb +0 -176
  212. data/lib/losant_rest/instance_members.rb +0 -134
  213. data/lib/losant_rest/instance_org.rb +0 -336
  214. data/lib/losant_rest/instance_org_invite.rb +0 -182
  215. data/lib/losant_rest/instance_org_invites.rb +0 -138
  216. data/lib/losant_rest/instance_org_member.rb +0 -182
  217. data/lib/losant_rest/instance_org_members.rb +0 -138
  218. data/lib/losant_rest/instance_orgs.rb +0 -139
  219. data/lib/losant_rest/instance_sandbox.rb +0 -181
  220. data/lib/losant_rest/instance_sandboxes.rb +0 -98
  221. data/lib/losant_rest/instances.rb +0 -88
  222. data/lib/losant_rest/integration.rb +0 -178
  223. data/lib/losant_rest/integrations.rb +0 -138
  224. data/lib/losant_rest/me.rb +0 -790
  225. data/lib/losant_rest/notebook.rb +0 -423
  226. data/lib/losant_rest/notebooks.rb +0 -138
  227. data/lib/losant_rest/org.rb +0 -663
  228. data/lib/losant_rest/org_invites.rb +0 -124
  229. data/lib/losant_rest/orgs.rb +0 -140
  230. data/lib/losant_rest/resource_job.rb +0 -326
  231. data/lib/losant_rest/resource_jobs.rb +0 -138
  232. data/lib/losant_rest/user_api_token.rb +0 -170
  233. data/lib/losant_rest/user_api_tokens.rb +0 -132
  234. data/lib/losant_rest/utils.rb +0 -44
  235. data/lib/losant_rest/webhook.rb +0 -178
  236. data/lib/losant_rest/webhooks.rb +0 -138
  237. data/lib/losant_rest.rb +0 -129
@@ -1,138 +0,0 @@
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 LosantRest
26
-
27
- # Class containing all the actions for the Resource Jobs Resource
28
- class ResourceJobs
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Returns the resource jobs 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, resourceJobs.*, or resourceJobs.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, lastExecutionRequested, resourceType
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, resourceType
49
- # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
50
- # * {string} losantdomain - Domain scope of request (rarely needed)
51
- # * {boolean} _actions - Return resource actions in response
52
- # * {boolean} _links - Return resource link in response
53
- # * {boolean} _embedded - Return embedded resources in response
54
- #
55
- # Responses:
56
- # * 200 - Collection of resource jobs (https://api.losant.com/#/definitions/resourceJobs)
57
- #
58
- # Errors:
59
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
60
- # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
61
- def get(params = {})
62
- params = Utils.symbolize_hash_keys(params)
63
- query_params = { _actions: false, _links: true, _embedded: true }
64
- headers = {}
65
- body = nil
66
-
67
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
68
-
69
- query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
70
- query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
71
- query_params[:page] = params[:page] if params.has_key?(:page)
72
- query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
73
- query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
74
- query_params[:filter] = params[:filter] if params.has_key?(:filter)
75
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
76
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
77
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
78
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
79
-
80
- path = "/applications/#{params[:applicationId]}/resource-jobs"
81
-
82
- @client.request(
83
- method: :get,
84
- path: path,
85
- query: query_params,
86
- headers: headers,
87
- body: body)
88
- end
89
-
90
- # Create a new resource job for an application
91
- #
92
- # Authentication:
93
- # The client must be configured with a valid api
94
- # access token to call this action. The token
95
- # must include at least one of the following scopes:
96
- # all.Application, all.Organization, all.User, resourceJobs.*, or resourceJobs.post.
97
- #
98
- # Parameters:
99
- # * {string} applicationId - ID associated with the application
100
- # * {hash} resourceJob - New resource job information (https://api.losant.com/#/definitions/resourceJobPost)
101
- # * {string} losantdomain - Domain scope of request (rarely needed)
102
- # * {boolean} _actions - Return resource actions in response
103
- # * {boolean} _links - Return resource link in response
104
- # * {boolean} _embedded - Return embedded resources in response
105
- #
106
- # Responses:
107
- # * 201 - Successfully created resource job (https://api.losant.com/#/definitions/resourceJob)
108
- #
109
- # Errors:
110
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
111
- # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
112
- def post(params = {})
113
- params = Utils.symbolize_hash_keys(params)
114
- query_params = { _actions: false, _links: true, _embedded: true }
115
- headers = {}
116
- body = nil
117
-
118
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
119
- raise ArgumentError.new("resourceJob is required") unless params.has_key?(:resourceJob)
120
-
121
- body = params[:resourceJob] if params.has_key?(:resourceJob)
122
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
123
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
124
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
125
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
126
-
127
- path = "/applications/#{params[:applicationId]}/resource-jobs"
128
-
129
- @client.request(
130
- method: :post,
131
- path: path,
132
- query: query_params,
133
- headers: headers,
134
- body: body)
135
- end
136
-
137
- end
138
- end
@@ -1,170 +0,0 @@
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 LosantRest
26
-
27
- # Class containing all the actions for the User Api Token Resource
28
- class UserApiToken
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Deletes an API Token
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.User, userApiToken.*, or userApiToken.delete.
41
- #
42
- # Parameters:
43
- # * {string} apiTokenId - ID associated with the API token
44
- # * {string} losantdomain - Domain scope of request (rarely needed)
45
- # * {boolean} _actions - Return resource actions in response
46
- # * {boolean} _links - Return resource link in response
47
- # * {boolean} _embedded - Return embedded resources in response
48
- #
49
- # Responses:
50
- # * 200 - If API token was successfully deleted (https://api.losant.com/#/definitions/success)
51
- #
52
- # Errors:
53
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
54
- # * 404 - Error if API token was not found (https://api.losant.com/#/definitions/error)
55
- def delete(params = {})
56
- params = Utils.symbolize_hash_keys(params)
57
- query_params = { _actions: false, _links: true, _embedded: true }
58
- headers = {}
59
- body = nil
60
-
61
- raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId)
62
-
63
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
64
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
65
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
66
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
67
-
68
- path = "/me/tokens/#{params[:apiTokenId]}"
69
-
70
- @client.request(
71
- method: :delete,
72
- path: path,
73
- query: query_params,
74
- headers: headers,
75
- body: body)
76
- end
77
-
78
- # Retrieves information on an API token
79
- #
80
- # Authentication:
81
- # The client must be configured with a valid api
82
- # access token to call this action. The token
83
- # must include at least one of the following scopes:
84
- # all.User, all.User.read, userApiToken.*, or userApiToken.get.
85
- #
86
- # Parameters:
87
- # * {string} apiTokenId - ID associated with the API token
88
- # * {string} losantdomain - Domain scope of request (rarely needed)
89
- # * {boolean} _actions - Return resource actions in response
90
- # * {boolean} _links - Return resource link in response
91
- # * {boolean} _embedded - Return embedded resources in response
92
- #
93
- # Responses:
94
- # * 200 - API token information (https://api.losant.com/#/definitions/apiToken)
95
- #
96
- # Errors:
97
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
98
- # * 404 - Error if API token was not found (https://api.losant.com/#/definitions/error)
99
- def get(params = {})
100
- params = Utils.symbolize_hash_keys(params)
101
- query_params = { _actions: false, _links: true, _embedded: true }
102
- headers = {}
103
- body = nil
104
-
105
- raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId)
106
-
107
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
108
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
109
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
110
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
111
-
112
- path = "/me/tokens/#{params[:apiTokenId]}"
113
-
114
- @client.request(
115
- method: :get,
116
- path: path,
117
- query: query_params,
118
- headers: headers,
119
- body: body)
120
- end
121
-
122
- # Updates information about an API token
123
- #
124
- # Authentication:
125
- # The client must be configured with a valid api
126
- # access token to call this action. The token
127
- # must include at least one of the following scopes:
128
- # all.User, userApiToken.*, or userApiToken.patch.
129
- #
130
- # Parameters:
131
- # * {string} apiTokenId - ID associated with the API token
132
- # * {hash} apiToken - Object containing new properties of the API token (https://api.losant.com/#/definitions/apiTokenPatch)
133
- # * {string} losantdomain - Domain scope of request (rarely needed)
134
- # * {boolean} _actions - Return resource actions in response
135
- # * {boolean} _links - Return resource link in response
136
- # * {boolean} _embedded - Return embedded resources in response
137
- #
138
- # Responses:
139
- # * 200 - Updated API token information (https://api.losant.com/#/definitions/apiToken)
140
- #
141
- # Errors:
142
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
143
- # * 404 - Error if API token was not found (https://api.losant.com/#/definitions/error)
144
- def patch(params = {})
145
- params = Utils.symbolize_hash_keys(params)
146
- query_params = { _actions: false, _links: true, _embedded: true }
147
- headers = {}
148
- body = nil
149
-
150
- raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId)
151
- raise ArgumentError.new("apiToken is required") unless params.has_key?(:apiToken)
152
-
153
- body = params[:apiToken] if params.has_key?(:apiToken)
154
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
155
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
156
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
157
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
158
-
159
- path = "/me/tokens/#{params[:apiTokenId]}"
160
-
161
- @client.request(
162
- method: :patch,
163
- path: path,
164
- query: query_params,
165
- headers: headers,
166
- body: body)
167
- end
168
-
169
- end
170
- end
@@ -1,132 +0,0 @@
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 LosantRest
26
-
27
- # Class containing all the actions for the User Api Tokens Resource
28
- class UserApiTokens
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Returns the API tokens for a user
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.User, all.User.read, userApiTokens.*, or userApiTokens.get.
41
- #
42
- # Parameters:
43
- # * {string} sortField - Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated, expirationDate
44
- # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
45
- # * {string} page - Which page of results to return
46
- # * {string} perPage - How many items to return per page
47
- # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, status
48
- # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
49
- # * {string} losantdomain - Domain scope of request (rarely needed)
50
- # * {boolean} _actions - Return resource actions in response
51
- # * {boolean} _links - Return resource link in response
52
- # * {boolean} _embedded - Return embedded resources in response
53
- #
54
- # Responses:
55
- # * 200 - Collection of API tokens (https://api.losant.com/#/definitions/apiToken)
56
- #
57
- # Errors:
58
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
59
- def get(params = {})
60
- params = Utils.symbolize_hash_keys(params)
61
- query_params = { _actions: false, _links: true, _embedded: true }
62
- headers = {}
63
- body = nil
64
-
65
-
66
- query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
67
- query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
68
- query_params[:page] = params[:page] if params.has_key?(:page)
69
- query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
70
- query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
71
- query_params[:filter] = params[:filter] if params.has_key?(:filter)
72
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
73
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
74
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
75
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
76
-
77
- path = "/me/tokens"
78
-
79
- @client.request(
80
- method: :get,
81
- path: path,
82
- query: query_params,
83
- headers: headers,
84
- body: body)
85
- end
86
-
87
- # Create a new API token for an user
88
- #
89
- # Authentication:
90
- # The client must be configured with a valid api
91
- # access token to call this action. The token
92
- # must include at least one of the following scopes:
93
- # all.User, userApiTokens.*, or userApiTokens.post.
94
- #
95
- # Parameters:
96
- # * {hash} apiToken - API token information (https://api.losant.com/#/definitions/apiTokenPost)
97
- # * {string} losantdomain - Domain scope of request (rarely needed)
98
- # * {boolean} _actions - Return resource actions in response
99
- # * {boolean} _links - Return resource link in response
100
- # * {boolean} _embedded - Return embedded resources in response
101
- #
102
- # Responses:
103
- # * 201 - The successfully created API token (https://api.losant.com/#/definitions/apiToken)
104
- #
105
- # Errors:
106
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
107
- def post(params = {})
108
- params = Utils.symbolize_hash_keys(params)
109
- query_params = { _actions: false, _links: true, _embedded: true }
110
- headers = {}
111
- body = nil
112
-
113
- raise ArgumentError.new("apiToken is required") unless params.has_key?(:apiToken)
114
-
115
- body = params[:apiToken] if params.has_key?(:apiToken)
116
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
117
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
118
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
119
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
120
-
121
- path = "/me/tokens"
122
-
123
- @client.request(
124
- method: :post,
125
- path: path,
126
- query: query_params,
127
- headers: headers,
128
- body: body)
129
- end
130
-
131
- end
132
- end
@@ -1,44 +0,0 @@
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
- module LosantRest
24
- class Utils
25
- def self.symbolize_hash_keys(hash)
26
- Hash[hash.dup.map { |k, v| [k.to_sym, v] }]
27
- end
28
-
29
- def self.fix_query_arrays(value)
30
- if value.respond_to?(:to_ary)
31
- value = value.to_ary.map.with_index.to_a.to_h.invert
32
- end
33
-
34
- if value.respond_to?(:to_hash)
35
- value = value.to_hash
36
- value.each do |k, v|
37
- value[k] = fix_query_arrays(v)
38
- end
39
- end
40
-
41
- value
42
- end
43
- end
44
- end
@@ -1,178 +0,0 @@
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 LosantRest
26
-
27
- # Class containing all the actions for the Webhook Resource
28
- class Webhook
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Deletes a webhook
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, webhook.*, or webhook.delete.
41
- #
42
- # Parameters:
43
- # * {string} applicationId - ID associated with the application
44
- # * {string} webhookId - ID associated with the webhook
45
- # * {string} includeWorkflows - If the workflows that utilize this webhook should also be deleted.
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
- # * 200 - If webhook was successfully deleted (https://api.losant.com/#/definitions/success)
53
- #
54
- # Errors:
55
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
56
- # * 404 - Error if webhook was not found (https://api.losant.com/#/definitions/error)
57
- def delete(params = {})
58
- params = Utils.symbolize_hash_keys(params)
59
- query_params = { _actions: false, _links: true, _embedded: true }
60
- headers = {}
61
- body = nil
62
-
63
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
64
- raise ArgumentError.new("webhookId is required") unless params.has_key?(:webhookId)
65
-
66
- query_params[:includeWorkflows] = params[:includeWorkflows] if params.has_key?(:includeWorkflows)
67
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
68
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
69
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
70
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
71
-
72
- path = "/applications/#{params[:applicationId]}/webhooks/#{params[:webhookId]}"
73
-
74
- @client.request(
75
- method: :delete,
76
- path: path,
77
- query: query_params,
78
- headers: headers,
79
- body: body)
80
- end
81
-
82
- # Retrieves information on a webhook
83
- #
84
- # Authentication:
85
- # The client must be configured with a valid api
86
- # access token to call this action. The token
87
- # must include at least one of the following scopes:
88
- # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, webhook.*, or webhook.get.
89
- #
90
- # Parameters:
91
- # * {string} applicationId - ID associated with the application
92
- # * {string} webhookId - ID associated with the webhook
93
- # * {string} losantdomain - Domain scope of request (rarely needed)
94
- # * {boolean} _actions - Return resource actions in response
95
- # * {boolean} _links - Return resource link in response
96
- # * {boolean} _embedded - Return embedded resources in response
97
- #
98
- # Responses:
99
- # * 200 - Webhook information (https://api.losant.com/#/definitions/webhook)
100
- #
101
- # Errors:
102
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
103
- # * 404 - Error if webhook was not found (https://api.losant.com/#/definitions/error)
104
- def get(params = {})
105
- params = Utils.symbolize_hash_keys(params)
106
- query_params = { _actions: false, _links: true, _embedded: true }
107
- headers = {}
108
- body = nil
109
-
110
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
111
- raise ArgumentError.new("webhookId is required") unless params.has_key?(:webhookId)
112
-
113
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
114
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
115
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
116
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
117
-
118
- path = "/applications/#{params[:applicationId]}/webhooks/#{params[:webhookId]}"
119
-
120
- @client.request(
121
- method: :get,
122
- path: path,
123
- query: query_params,
124
- headers: headers,
125
- body: body)
126
- end
127
-
128
- # Updates information about a webhook
129
- #
130
- # Authentication:
131
- # The client must be configured with a valid api
132
- # access token to call this action. The token
133
- # must include at least one of the following scopes:
134
- # all.Application, all.Organization, all.User, webhook.*, or webhook.patch.
135
- #
136
- # Parameters:
137
- # * {string} applicationId - ID associated with the application
138
- # * {string} webhookId - ID associated with the webhook
139
- # * {hash} webhook - Object containing new properties of the webhook (https://api.losant.com/#/definitions/webhookPatch)
140
- # * {string} losantdomain - Domain scope of request (rarely needed)
141
- # * {boolean} _actions - Return resource actions in response
142
- # * {boolean} _links - Return resource link in response
143
- # * {boolean} _embedded - Return embedded resources in response
144
- #
145
- # Responses:
146
- # * 200 - Updated webhook information (https://api.losant.com/#/definitions/webhook)
147
- #
148
- # Errors:
149
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
150
- # * 404 - Error if webhook was not found (https://api.losant.com/#/definitions/error)
151
- def patch(params = {})
152
- params = Utils.symbolize_hash_keys(params)
153
- query_params = { _actions: false, _links: true, _embedded: true }
154
- headers = {}
155
- body = nil
156
-
157
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
158
- raise ArgumentError.new("webhookId is required") unless params.has_key?(:webhookId)
159
- raise ArgumentError.new("webhook is required") unless params.has_key?(:webhook)
160
-
161
- body = params[:webhook] if params.has_key?(:webhook)
162
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
163
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
164
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
165
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
166
-
167
- path = "/applications/#{params[:applicationId]}/webhooks/#{params[:webhookId]}"
168
-
169
- @client.request(
170
- method: :patch,
171
- path: path,
172
- query: query_params,
173
- headers: headers,
174
- body: body)
175
- end
176
-
177
- end
178
- end