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,124 +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 Org Invites Resource
28
- class OrgInvites
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Gets information about an invite
35
- #
36
- # Authentication:
37
- # No api access token is required to call this action.
38
- #
39
- # Parameters:
40
- # * {string} token - The token associated with the invite
41
- # * {string} email - The email associated with the invite
42
- # * {string} losantdomain - Domain scope of request (rarely needed)
43
- # * {boolean} _actions - Return resource actions in response
44
- # * {boolean} _links - Return resource link in response
45
- # * {boolean} _embedded - Return embedded resources in response
46
- #
47
- # Responses:
48
- # * 200 - Information about invite (https://api.losant.com/#/definitions/orgInviteInfo)
49
- #
50
- # Errors:
51
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
52
- # * 404 - Error if invite not found (https://api.losant.com/#/definitions/error)
53
- # * 410 - Error if invite has expired (https://api.losant.com/#/definitions/error)
54
- def get(params = {})
55
- params = Utils.symbolize_hash_keys(params)
56
- query_params = { _actions: false, _links: true, _embedded: true }
57
- headers = {}
58
- body = nil
59
-
60
- raise ArgumentError.new("token is required") unless params.has_key?(:token)
61
- raise ArgumentError.new("email is required") unless params.has_key?(:email)
62
-
63
- query_params[:token] = params[:token] if params.has_key?(:token)
64
- query_params[:email] = params[:email] if params.has_key?(:email)
65
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
66
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
67
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
68
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
69
-
70
- path = "/invites"
71
-
72
- @client.request(
73
- method: :get,
74
- path: path,
75
- query: query_params,
76
- headers: headers,
77
- body: body)
78
- end
79
-
80
- # Accepts/Rejects an invite
81
- #
82
- # Authentication:
83
- # No api access token is required to call this action.
84
- #
85
- # Parameters:
86
- # * {hash} invite - Invite info and acceptance (https://api.losant.com/#/definitions/orgInviteAction)
87
- # * {string} losantdomain - Domain scope of request (rarely needed)
88
- # * {boolean} _actions - Return resource actions in response
89
- # * {boolean} _links - Return resource link in response
90
- # * {boolean} _embedded - Return embedded resources in response
91
- #
92
- # Responses:
93
- # * 200 - Acceptance/Rejection of invite (https://api.losant.com/#/definitions/orgInviteResult)
94
- #
95
- # Errors:
96
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
97
- # * 404 - Error if invite not found (https://api.losant.com/#/definitions/error)
98
- # * 410 - Error if invite has expired (https://api.losant.com/#/definitions/error)
99
- def post(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("invite is required") unless params.has_key?(:invite)
106
-
107
- body = params[:invite] if params.has_key?(:invite)
108
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
109
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
110
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
111
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
112
-
113
- path = "/invites"
114
-
115
- @client.request(
116
- method: :post,
117
- path: path,
118
- query: query_params,
119
- headers: headers,
120
- body: body)
121
- end
122
-
123
- end
124
- end
@@ -1,140 +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 Orgs Resource
28
- class Orgs
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Returns the organizations associated with the current 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, orgs.*, or orgs.get.
41
- #
42
- # Parameters:
43
- # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
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
48
- # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
49
- # * {string} summaryExclude - Comma-separated list of summary fields to exclude from org summaries
50
- # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
51
- # * {string} losantdomain - Domain scope of request (rarely needed)
52
- # * {boolean} _actions - Return resource actions in response
53
- # * {boolean} _links - Return resource link in response
54
- # * {boolean} _embedded - Return embedded resources in response
55
- #
56
- # Responses:
57
- # * 200 - Collection of organizations (https://api.losant.com/#/definitions/orgs)
58
- #
59
- # Errors:
60
- # * 400 - Error if malformed request (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
-
68
- query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
69
- query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
70
- query_params[:page] = params[:page] if params.has_key?(:page)
71
- query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
72
- query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
73
- query_params[:filter] = params[:filter] if params.has_key?(:filter)
74
- query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
75
- query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
76
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
77
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
78
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
79
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
80
-
81
- path = "/orgs"
82
-
83
- @client.request(
84
- method: :get,
85
- path: path,
86
- query: query_params,
87
- headers: headers,
88
- body: body)
89
- end
90
-
91
- # Create a new organization
92
- #
93
- # Authentication:
94
- # The client must be configured with a valid api
95
- # access token to call this action. The token
96
- # must include at least one of the following scopes:
97
- # all.User, orgs.*, or orgs.post.
98
- #
99
- # Parameters:
100
- # * {hash} organization - New organization information (https://api.losant.com/#/definitions/orgPost)
101
- # * {string} summaryExclude - Comma-separated list of summary fields to exclude from org summary
102
- # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
103
- # * {string} losantdomain - Domain scope of request (rarely needed)
104
- # * {boolean} _actions - Return resource actions in response
105
- # * {boolean} _links - Return resource link in response
106
- # * {boolean} _embedded - Return embedded resources in response
107
- #
108
- # Responses:
109
- # * 201 - Successfully created organization (https://api.losant.com/#/definitions/org)
110
- #
111
- # Errors:
112
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
113
- def post(params = {})
114
- params = Utils.symbolize_hash_keys(params)
115
- query_params = { _actions: false, _links: true, _embedded: true }
116
- headers = {}
117
- body = nil
118
-
119
- raise ArgumentError.new("organization is required") unless params.has_key?(:organization)
120
-
121
- body = params[:organization] if params.has_key?(:organization)
122
- query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
123
- query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
124
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
125
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
126
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
127
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
128
-
129
- path = "/orgs"
130
-
131
- @client.request(
132
- method: :post,
133
- path: path,
134
- query: query_params,
135
- headers: headers,
136
- body: body)
137
- end
138
-
139
- end
140
- end
@@ -1,326 +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 Job Resource
28
- class ResourceJob
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Marks a specific resource job execution for cancellation
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, resourceJob.*, or resourceJob.cancelExecution.
41
- #
42
- # Parameters:
43
- # * {string} applicationId - ID associated with the application
44
- # * {string} resourceJobId - ID associated with the resource job
45
- # * {undefined} executionId - The ID of the execution to cancel
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 the execution was successfully marked for cancellation (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 execution was not found (https://api.losant.com/#/definitions/error)
57
- def cancel_execution(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("resourceJobId is required") unless params.has_key?(:resourceJobId)
65
- raise ArgumentError.new("executionId is required") unless params.has_key?(:executionId)
66
-
67
- query_params[:executionId] = params[:executionId] if params.has_key?(:executionId)
68
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
69
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
70
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
71
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
72
-
73
- path = "/applications/#{params[:applicationId]}/resource-jobs/#{params[:resourceJobId]}/cancelExecution"
74
-
75
- @client.request(
76
- method: :post,
77
- path: path,
78
- query: query_params,
79
- headers: headers,
80
- body: body)
81
- end
82
-
83
- # Deletes a resource job
84
- #
85
- # Authentication:
86
- # The client must be configured with a valid api
87
- # access token to call this action. The token
88
- # must include at least one of the following scopes:
89
- # all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.delete.
90
- #
91
- # Parameters:
92
- # * {string} applicationId - ID associated with the application
93
- # * {string} resourceJobId - ID associated with the resource job
94
- # * {string} includeWorkflows - If the workflows that trigger from this resource job should also be deleted.
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 resource job 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 resource job 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("resourceJobId is required") unless params.has_key?(:resourceJobId)
114
-
115
- query_params[:includeWorkflows] = params[:includeWorkflows] if params.has_key?(:includeWorkflows)
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 = "/applications/#{params[:applicationId]}/resource-jobs/#{params[:resourceJobId]}"
122
-
123
- @client.request(
124
- method: :delete,
125
- path: path,
126
- query: query_params,
127
- headers: headers,
128
- body: body)
129
- end
130
-
131
- # Queues the execution of a resource job
132
- #
133
- # Authentication:
134
- # The client must be configured with a valid api
135
- # access token to call this action. The token
136
- # must include at least one of the following scopes:
137
- # all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.execute.
138
- #
139
- # Parameters:
140
- # * {string} applicationId - ID associated with the application
141
- # * {string} resourceJobId - ID associated with the resource job
142
- # * {hash} executionOptions - The options for the execution (https://api.losant.com/#/definitions/resourceJobExecutionOptions)
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 - If the job was successfully queued (https://api.losant.com/#/definitions/successWithExecutionId)
150
- #
151
- # Errors:
152
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
153
- # * 404 - Error if resource job was not found (https://api.losant.com/#/definitions/error)
154
- def execute(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("resourceJobId is required") unless params.has_key?(:resourceJobId)
162
- raise ArgumentError.new("executionOptions is required") unless params.has_key?(:executionOptions)
163
-
164
- body = params[:executionOptions] if params.has_key?(:executionOptions)
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]}/resource-jobs/#{params[:resourceJobId]}/execute"
171
-
172
- @client.request(
173
- method: :post,
174
- path: path,
175
- query: query_params,
176
- headers: headers,
177
- body: body)
178
- end
179
-
180
- # Returns a resource job
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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, resourceJob.*, or resourceJob.get.
187
- #
188
- # Parameters:
189
- # * {string} applicationId - ID associated with the application
190
- # * {string} resourceJobId - ID associated with the resource job
191
- # * {string} losantdomain - Domain scope of request (rarely needed)
192
- # * {boolean} _actions - Return resource actions in response
193
- # * {boolean} _links - Return resource link in response
194
- # * {boolean} _embedded - Return embedded resources in response
195
- #
196
- # Responses:
197
- # * 200 - A single resource job (https://api.losant.com/#/definitions/resourceJob)
198
- #
199
- # Errors:
200
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
201
- # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
202
- def get(params = {})
203
- params = Utils.symbolize_hash_keys(params)
204
- query_params = { _actions: false, _links: true, _embedded: true }
205
- headers = {}
206
- body = nil
207
-
208
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
209
- raise ArgumentError.new("resourceJobId is required") unless params.has_key?(:resourceJobId)
210
-
211
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
212
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
213
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
214
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
215
-
216
- path = "/applications/#{params[:applicationId]}/resource-jobs/#{params[:resourceJobId]}"
217
-
218
- @client.request(
219
- method: :get,
220
- path: path,
221
- query: query_params,
222
- headers: headers,
223
- body: body)
224
- end
225
-
226
- # Retrieves information on resource job executions
227
- #
228
- # Authentication:
229
- # The client must be configured with a valid api
230
- # access token to call this action. The token
231
- # must include at least one of the following scopes:
232
- # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, resourceJob.*, or resourceJob.logs.
233
- #
234
- # Parameters:
235
- # * {string} applicationId - ID associated with the application
236
- # * {string} resourceJobId - ID associated with the resource job
237
- # * {string} limit - Max log entries to return (ordered by time descending)
238
- # * {string} since - Look for log entries since this time (ms since epoch)
239
- # * {string} losantdomain - Domain scope of request (rarely needed)
240
- # * {boolean} _actions - Return resource actions in response
241
- # * {boolean} _links - Return resource link in response
242
- # * {boolean} _embedded - Return embedded resources in response
243
- #
244
- # Responses:
245
- # * 200 - Resource job execution information (https://api.losant.com/#/definitions/resourceJobExecutionLogs)
246
- #
247
- # Errors:
248
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
249
- # * 404 - Error if resource job was not found (https://api.losant.com/#/definitions/error)
250
- def logs(params = {})
251
- params = Utils.symbolize_hash_keys(params)
252
- query_params = { _actions: false, _links: true, _embedded: true }
253
- headers = {}
254
- body = nil
255
-
256
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
257
- raise ArgumentError.new("resourceJobId is required") unless params.has_key?(:resourceJobId)
258
-
259
- query_params[:limit] = params[:limit] if params.has_key?(:limit)
260
- query_params[:since] = params[:since] if params.has_key?(:since)
261
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
262
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
263
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
264
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
265
-
266
- path = "/applications/#{params[:applicationId]}/resource-jobs/#{params[:resourceJobId]}/logs"
267
-
268
- @client.request(
269
- method: :get,
270
- path: path,
271
- query: query_params,
272
- headers: headers,
273
- body: body)
274
- end
275
-
276
- # Update a resource job
277
- #
278
- # Authentication:
279
- # The client must be configured with a valid api
280
- # access token to call this action. The token
281
- # must include at least one of the following scopes:
282
- # all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.patch.
283
- #
284
- # Parameters:
285
- # * {string} applicationId - ID associated with the application
286
- # * {string} resourceJobId - ID associated with the resource job
287
- # * {hash} resourceJob - The new resource job configuration (https://api.losant.com/#/definitions/resourceJobPatch)
288
- # * {string} losantdomain - Domain scope of request (rarely needed)
289
- # * {boolean} _actions - Return resource actions in response
290
- # * {boolean} _links - Return resource link in response
291
- # * {boolean} _embedded - Return embedded resources in response
292
- #
293
- # Responses:
294
- # * 201 - Successfully updated resource job (https://api.losant.com/#/definitions/resourceJob)
295
- #
296
- # Errors:
297
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
298
- # * 404 - Error if resource job was not found (https://api.losant.com/#/definitions/error)
299
- def patch(params = {})
300
- params = Utils.symbolize_hash_keys(params)
301
- query_params = { _actions: false, _links: true, _embedded: true }
302
- headers = {}
303
- body = nil
304
-
305
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
306
- raise ArgumentError.new("resourceJobId is required") unless params.has_key?(:resourceJobId)
307
- raise ArgumentError.new("resourceJob is required") unless params.has_key?(:resourceJob)
308
-
309
- body = params[:resourceJob] if params.has_key?(:resourceJob)
310
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
311
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
312
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
313
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
314
-
315
- path = "/applications/#{params[:applicationId]}/resource-jobs/#{params[:resourceJobId]}"
316
-
317
- @client.request(
318
- method: :patch,
319
- path: path,
320
- query: query_params,
321
- headers: headers,
322
- body: body)
323
- end
324
-
325
- end
326
- end