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,336 +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 Instance Org Resource
28
- class InstanceOrg
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Deletes an organization
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.Instance, all.User, instanceOrg.*, or instanceOrg.delete.
41
- #
42
- # Parameters:
43
- # * {string} instanceId - ID associated with the instance
44
- # * {string} orgId - ID associated with the organization
45
- # * {string} losantdomain - Domain scope of request (rarely needed)
46
- # * {boolean} _actions - Return resource actions in response
47
- # * {boolean} _links - Return resource link in response
48
- # * {boolean} _embedded - Return embedded resources in response
49
- #
50
- # Responses:
51
- # * 200 - If organization was successfully deleted (https://api.losant.com/#/definitions/success)
52
- #
53
- # Errors:
54
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
55
- # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
56
- def delete(params = {})
57
- params = Utils.symbolize_hash_keys(params)
58
- query_params = { _actions: false, _links: true, _embedded: true }
59
- headers = {}
60
- body = nil
61
-
62
- raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
63
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
64
-
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 = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}"
71
-
72
- @client.request(
73
- method: :delete,
74
- path: path,
75
- query: query_params,
76
- headers: headers,
77
- body: body)
78
- end
79
-
80
- # Returns device counts by day for the time range specified for this organization
81
- #
82
- # Authentication:
83
- # The client must be configured with a valid api
84
- # access token to call this action. The token
85
- # must include at least one of the following scopes:
86
- # all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.deviceCounts.
87
- #
88
- # Parameters:
89
- # * {string} instanceId - ID associated with the instance
90
- # * {string} orgId - ID associated with the organization
91
- # * {string} start - Start of range for device count query (ms since epoch)
92
- # * {string} end - End of range for device count query (ms since epoch)
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 - Device counts by day (https://api.losant.com/#/definitions/deviceCounts)
100
- #
101
- # Errors:
102
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
103
- # * 404 - Error if instance or organization was not found (https://api.losant.com/#/definitions/error)
104
- def device_counts(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("instanceId is required") unless params.has_key?(:instanceId)
111
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
112
-
113
- query_params[:start] = params[:start] if params.has_key?(:start)
114
- query_params[:end] = params[:end] if params.has_key?(:end)
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 = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/deviceCounts"
121
-
122
- @client.request(
123
- method: :get,
124
- path: path,
125
- query: query_params,
126
- headers: headers,
127
- body: body)
128
- end
129
-
130
- # Retrieves information on an organization
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.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.get.
137
- #
138
- # Parameters:
139
- # * {string} instanceId - ID associated with the instance
140
- # * {string} orgId - ID associated with the organization
141
- # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
142
- # * {string} losantdomain - Domain scope of request (rarely needed)
143
- # * {boolean} _actions - Return resource actions in response
144
- # * {boolean} _links - Return resource link in response
145
- # * {boolean} _embedded - Return embedded resources in response
146
- #
147
- # Responses:
148
- # * 200 - A single organization (https://api.losant.com/#/definitions/instanceOrg)
149
- #
150
- # Errors:
151
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
152
- # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
153
- def get(params = {})
154
- params = Utils.symbolize_hash_keys(params)
155
- query_params = { _actions: false, _links: true, _embedded: true }
156
- headers = {}
157
- body = nil
158
-
159
- raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
160
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
161
-
162
- query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
163
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
164
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
165
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
166
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
167
-
168
- path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}"
169
-
170
- @client.request(
171
- method: :get,
172
- path: path,
173
- query: query_params,
174
- headers: headers,
175
- body: body)
176
- end
177
-
178
- # Returns notebook execution usage by day for the time range specified for this organization
179
- #
180
- # Authentication:
181
- # The client must be configured with a valid api
182
- # access token to call this action. The token
183
- # must include at least one of the following scopes:
184
- # all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.notebookMinuteCounts.
185
- #
186
- # Parameters:
187
- # * {string} instanceId - ID associated with the instance
188
- # * {string} orgId - ID associated with the organization
189
- # * {string} start - Start of range for notebook execution query (ms since epoch)
190
- # * {string} end - End of range for notebook execution query (ms since epoch)
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 - Notebook usage information (https://api.losant.com/#/definitions/notebookMinuteCounts)
198
- #
199
- # Errors:
200
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
201
- # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
202
- def notebook_minute_counts(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("instanceId is required") unless params.has_key?(:instanceId)
209
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
210
-
211
- query_params[:start] = params[:start] if params.has_key?(:start)
212
- query_params[:end] = params[:end] if params.has_key?(:end)
213
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
214
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
215
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
216
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
217
-
218
- path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/notebookMinuteCounts"
219
-
220
- @client.request(
221
- method: :get,
222
- path: path,
223
- query: query_params,
224
- headers: headers,
225
- body: body)
226
- end
227
-
228
- # Updates information about an organization
229
- #
230
- # Authentication:
231
- # The client must be configured with a valid api
232
- # access token to call this action. The token
233
- # must include at least one of the following scopes:
234
- # all.Instance, all.User, instanceOrg.*, or instanceOrg.patch.
235
- #
236
- # Parameters:
237
- # * {string} instanceId - ID associated with the instance
238
- # * {string} orgId - ID associated with the organization
239
- # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
240
- # * {hash} organization - Object containing new organization properties (https://api.losant.com/#/definitions/instanceOrgPatch)
241
- # * {string} losantdomain - Domain scope of request (rarely needed)
242
- # * {boolean} _actions - Return resource actions in response
243
- # * {boolean} _links - Return resource link in response
244
- # * {boolean} _embedded - Return embedded resources in response
245
- #
246
- # Responses:
247
- # * 200 - Updated organization information (https://api.losant.com/#/definitions/instanceOrg)
248
- #
249
- # Errors:
250
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
251
- # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
252
- def patch(params = {})
253
- params = Utils.symbolize_hash_keys(params)
254
- query_params = { _actions: false, _links: true, _embedded: true }
255
- headers = {}
256
- body = nil
257
-
258
- raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
259
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
260
- raise ArgumentError.new("organization is required") unless params.has_key?(:organization)
261
-
262
- query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
263
- body = params[:organization] if params.has_key?(:organization)
264
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
265
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
266
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
267
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
268
-
269
- path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}"
270
-
271
- @client.request(
272
- method: :patch,
273
- path: path,
274
- query: query_params,
275
- headers: headers,
276
- body: body)
277
- end
278
-
279
- # Returns payload counts per resolution in the time range specified for all application this organization owns
280
- #
281
- # Authentication:
282
- # The client must be configured with a valid api
283
- # access token to call this action. The token
284
- # must include at least one of the following scopes:
285
- # all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.payloadCountsBreakdown.
286
- #
287
- # Parameters:
288
- # * {string} instanceId - ID associated with the instance
289
- # * {string} orgId - ID associated with the organization
290
- # * {string} start - Start of range for payload count query (ms since epoch)
291
- # * {string} end - End of range for payload count query (ms since epoch)
292
- # * {string} resolution - Resolution in milliseconds. Accepted values are: 86400000, 3600000
293
- # * {string} asBytes - If the resulting stats should be returned as bytes
294
- # * {string} includeNonBillable - If non-billable payloads should be included in the result
295
- # * {string} losantdomain - Domain scope of request (rarely needed)
296
- # * {boolean} _actions - Return resource actions in response
297
- # * {boolean} _links - Return resource link in response
298
- # * {boolean} _embedded - Return embedded resources in response
299
- #
300
- # Responses:
301
- # * 200 - Payload counts, by type and source (https://api.losant.com/#/definitions/payloadCountsBreakdown)
302
- #
303
- # Errors:
304
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
305
- # * 404 - Error if instance was not found (https://api.losant.com/#/definitions/error)
306
- def payload_counts_breakdown(params = {})
307
- params = Utils.symbolize_hash_keys(params)
308
- query_params = { _actions: false, _links: true, _embedded: true }
309
- headers = {}
310
- body = nil
311
-
312
- raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
313
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
314
-
315
- query_params[:start] = params[:start] if params.has_key?(:start)
316
- query_params[:end] = params[:end] if params.has_key?(:end)
317
- query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
318
- query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
319
- query_params[:includeNonBillable] = params[:includeNonBillable] if params.has_key?(:includeNonBillable)
320
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
321
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
322
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
323
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
324
-
325
- path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/payloadCountsBreakdown"
326
-
327
- @client.request(
328
- method: :get,
329
- path: path,
330
- query: query_params,
331
- headers: headers,
332
- body: body)
333
- end
334
-
335
- end
336
- end
@@ -1,182 +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 Instance Org Invite Resource
28
- class InstanceOrgInvite
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Revokes an instance org invitation
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.Instance, all.User, instanceOrgInvite.*, or instanceOrgInvite.delete.
41
- #
42
- # Parameters:
43
- # * {string} instanceId - ID associated with the instance
44
- # * {string} orgId - ID associated with the organization
45
- # * {string} inviteId - ID associated with the organization invite
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 an invite 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 instance, organization or invite 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("instanceId is required") unless params.has_key?(:instanceId)
64
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
65
- raise ArgumentError.new("inviteId is required") unless params.has_key?(:inviteId)
66
-
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 = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/invites/#{params[:inviteId]}"
73
-
74
- @client.request(
75
- method: :delete,
76
- path: path,
77
- query: query_params,
78
- headers: headers,
79
- body: body)
80
- end
81
-
82
- # Returns an organization invite
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.Instance, all.Instance.read, all.User, all.User.read, instanceOrgInvite.*, or instanceOrgInvite.get.
89
- #
90
- # Parameters:
91
- # * {string} instanceId - ID associated with the instance
92
- # * {string} orgId - ID associated with the organization
93
- # * {string} inviteId - ID associated with the organization invite
94
- # * {string} losantdomain - Domain scope of request (rarely needed)
95
- # * {boolean} _actions - Return resource actions in response
96
- # * {boolean} _links - Return resource link in response
97
- # * {boolean} _embedded - Return embedded resources in response
98
- #
99
- # Responses:
100
- # * 200 - A single organization invite (https://api.losant.com/#/definitions/orgInvite)
101
- #
102
- # Errors:
103
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
104
- # * 404 - Error if instance, organization, or invite was not found (https://api.losant.com/#/definitions/error)
105
- def get(params = {})
106
- params = Utils.symbolize_hash_keys(params)
107
- query_params = { _actions: false, _links: true, _embedded: true }
108
- headers = {}
109
- body = nil
110
-
111
- raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
112
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
113
- raise ArgumentError.new("inviteId is required") unless params.has_key?(:inviteId)
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 = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/invites/#{params[:inviteId]}"
121
-
122
- @client.request(
123
- method: :get,
124
- path: path,
125
- query: query_params,
126
- headers: headers,
127
- body: body)
128
- end
129
-
130
- # Resend an organization invite with modified role info
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.Instance, all.User, instanceOrgInvite.*, or instanceOrgInvite.resendInvite.
137
- #
138
- # Parameters:
139
- # * {string} instanceId - ID associated with the instance
140
- # * {string} orgId - ID associated with the organization
141
- # * {string} inviteId - ID associated with the organization invite
142
- # * {hash} roleInfo - Object containing updated role info (https://api.losant.com/#/definitions/orgRoleInfo)
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
- # * 201 - The new org invite (https://api.losant.com/#/definitions/orgInvite)
150
- #
151
- # Errors:
152
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
153
- # * 404 - Error if instance, organization, or invite was not found (https://api.losant.com/#/definitions/error)
154
- def resend_invite(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("instanceId is required") unless params.has_key?(:instanceId)
161
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
162
- raise ArgumentError.new("inviteId is required") unless params.has_key?(:inviteId)
163
- raise ArgumentError.new("roleInfo is required") unless params.has_key?(:roleInfo)
164
-
165
- body = params[:roleInfo] if params.has_key?(:roleInfo)
166
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
167
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
168
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
169
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
170
-
171
- path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/invites/#{params[:inviteId]}"
172
-
173
- @client.request(
174
- method: :post,
175
- path: path,
176
- query: query_params,
177
- headers: headers,
178
- body: body)
179
- end
180
-
181
- end
182
- end
@@ -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 Instance Org Invites Resource
28
- class InstanceOrgInvites
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Returns a collection of instance organization invites
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.Instance, all.Instance.read, all.User, all.User.read, instanceOrgInvites.*, or instanceOrgInvites.get.
41
- #
42
- # Parameters:
43
- # * {string} instanceId - ID associated with the instance
44
- # * {string} orgId - ID associated with the organization
45
- # * {string} sortField - Field to sort the results by. Accepted values are: email, role, inviteDate
46
- # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
47
- # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role
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 - A collection of instance organization invitations (https://api.losant.com/#/definitions/orgInviteCollection)
56
- #
57
- # Errors:
58
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
59
- # * 404 - Error if instance or organization was not found (https://api.losant.com/#/definitions/error)
60
- def get(params = {})
61
- params = Utils.symbolize_hash_keys(params)
62
- query_params = { _actions: false, _links: true, _embedded: true }
63
- headers = {}
64
- body = nil
65
-
66
- raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
67
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
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[:filterField] = params[:filterField] if params.has_key?(:filterField)
72
- query_params[:filter] = params[:filter] if params.has_key?(:filter)
73
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
74
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
75
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
76
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
77
-
78
- path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/invites"
79
-
80
- @client.request(
81
- method: :get,
82
- path: path,
83
- query: query_params,
84
- headers: headers,
85
- body: body)
86
- end
87
-
88
- # Invites a member to an instance organization
89
- #
90
- # Authentication:
91
- # The client must be configured with a valid api
92
- # access token to call this action. The token
93
- # must include at least one of the following scopes:
94
- # all.Instance, all.User, instanceOrgInvites.*, or instanceOrgInvites.post.
95
- #
96
- # Parameters:
97
- # * {string} instanceId - ID associated with the instance
98
- # * {string} orgId - ID associated with the organization
99
- # * {hash} invite - Object containing new invite info (https://api.losant.com/#/definitions/orgInvitePost)
100
- # * {string} losantdomain - Domain scope of request (rarely needed)
101
- # * {boolean} _actions - Return resource actions in response
102
- # * {boolean} _links - Return resource link in response
103
- # * {boolean} _embedded - Return embedded resources in response
104
- #
105
- # Responses:
106
- # * 201 - The new organization invite (https://api.losant.com/#/definitions/orgInviteCollection)
107
- #
108
- # Errors:
109
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
110
- # * 404 - Error if instance or organization was not found (https://api.losant.com/#/definitions/error)
111
- def post(params = {})
112
- params = Utils.symbolize_hash_keys(params)
113
- query_params = { _actions: false, _links: true, _embedded: true }
114
- headers = {}
115
- body = nil
116
-
117
- raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
118
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
119
- raise ArgumentError.new("invite is required") unless params.has_key?(:invite)
120
-
121
- body = params[:invite] if params.has_key?(:invite)
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 = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/invites"
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