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,663 +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 Resource
28
- class Org
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.Organization, all.User, org.*, or org.delete.
41
- #
42
- # Parameters:
43
- # * {string} orgId - ID associated with the organization
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 organization 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 organization 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("orgId is required") unless params.has_key?(:orgId)
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 = "/orgs/#{params[:orgId]}"
69
-
70
- @client.request(
71
- method: :delete,
72
- path: path,
73
- query: query_params,
74
- headers: headers,
75
- body: body)
76
- end
77
-
78
- # Returns device counts by day for the time range specified for this organization
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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.deviceCounts.
85
- #
86
- # Parameters:
87
- # * {string} orgId - ID associated with the organization
88
- # * {string} start - Start of range for device count query (ms since epoch)
89
- # * {string} end - End of range for device count query (ms since epoch)
90
- # * {string} losantdomain - Domain scope of request (rarely needed)
91
- # * {boolean} _actions - Return resource actions in response
92
- # * {boolean} _links - Return resource link in response
93
- # * {boolean} _embedded - Return embedded resources in response
94
- #
95
- # Responses:
96
- # * 200 - Device counts by day (https://api.losant.com/#/definitions/deviceCounts)
97
- #
98
- # Errors:
99
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
100
- # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
101
- def device_counts(params = {})
102
- params = Utils.symbolize_hash_keys(params)
103
- query_params = { _actions: false, _links: true, _embedded: true }
104
- headers = {}
105
- body = nil
106
-
107
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
108
-
109
- query_params[:start] = params[:start] if params.has_key?(:start)
110
- query_params[:end] = params[:end] if params.has_key?(:end)
111
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
112
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
113
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
114
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
115
-
116
- path = "/orgs/#{params[:orgId]}/deviceCounts"
117
-
118
- @client.request(
119
- method: :get,
120
- path: path,
121
- query: query_params,
122
- headers: headers,
123
- body: body)
124
- end
125
-
126
- # Retrieves information on an organization
127
- #
128
- # Authentication:
129
- # The client must be configured with a valid api
130
- # access token to call this action. The token
131
- # must include at least one of the following scopes:
132
- # all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.get.
133
- #
134
- # Parameters:
135
- # * {string} orgId - ID associated with the organization
136
- # * {string} summaryExclude - Comma-separated list of summary fields to exclude from org summary
137
- # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
138
- # * {string} losantdomain - Domain scope of request (rarely needed)
139
- # * {boolean} _actions - Return resource actions in response
140
- # * {boolean} _links - Return resource link in response
141
- # * {boolean} _embedded - Return embedded resources in response
142
- #
143
- # Responses:
144
- # * 200 - Organization information (https://api.losant.com/#/definitions/org)
145
- #
146
- # Errors:
147
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
148
- # * 404 - Error if organization not found (https://api.losant.com/#/definitions/error)
149
- def get(params = {})
150
- params = Utils.symbolize_hash_keys(params)
151
- query_params = { _actions: false, _links: true, _embedded: true }
152
- headers = {}
153
- body = nil
154
-
155
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
156
-
157
- query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
158
- query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
159
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
160
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
161
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
162
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
163
-
164
- path = "/orgs/#{params[:orgId]}"
165
-
166
- @client.request(
167
- method: :get,
168
- path: path,
169
- query: query_params,
170
- headers: headers,
171
- body: body)
172
- end
173
-
174
- # Invites a person to an organization
175
- #
176
- # Authentication:
177
- # The client must be configured with a valid api
178
- # access token to call this action. The token
179
- # must include at least one of the following scopes:
180
- # all.Organization, all.User, org.*, or org.inviteMember.
181
- #
182
- # Parameters:
183
- # * {string} orgId - ID associated with the organization
184
- # * {hash} invite - Object containing new invite info (https://api.losant.com/#/definitions/orgInvitePost)
185
- # * {string} losantdomain - Domain scope of request (rarely needed)
186
- # * {boolean} _actions - Return resource actions in response
187
- # * {boolean} _links - Return resource link in response
188
- # * {boolean} _embedded - Return embedded resources in response
189
- #
190
- # Responses:
191
- # * 200 - Invitation information (https://api.losant.com/#/definitions/orgInvites)
192
- #
193
- # Errors:
194
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
195
- # * 404 - Error if organization not found (https://api.losant.com/#/definitions/error)
196
- def invite_member(params = {})
197
- params = Utils.symbolize_hash_keys(params)
198
- query_params = { _actions: false, _links: true, _embedded: true }
199
- headers = {}
200
- body = nil
201
-
202
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
203
- raise ArgumentError.new("invite is required") unless params.has_key?(:invite)
204
-
205
- body = params[:invite] if params.has_key?(:invite)
206
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
207
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
208
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
209
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
210
-
211
- path = "/orgs/#{params[:orgId]}/invites"
212
-
213
- @client.request(
214
- method: :post,
215
- path: path,
216
- query: query_params,
217
- headers: headers,
218
- body: body)
219
- end
220
-
221
- # Modifies a current org member's role
222
- #
223
- # Authentication:
224
- # The client must be configured with a valid api
225
- # access token to call this action. The token
226
- # must include at least one of the following scopes:
227
- # all.Organization, all.User, org.*, or org.modifyMember.
228
- #
229
- # Parameters:
230
- # * {string} orgId - ID associated with the organization
231
- # * {hash} member - Object containing new member pair (https://api.losant.com/#/definitions/orgMemberPatch)
232
- # * {string} summaryExclude - Comma-separated list of summary fields to exclude from org summary
233
- # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
234
- # * {string} losantdomain - Domain scope of request (rarely needed)
235
- # * {boolean} _actions - Return resource actions in response
236
- # * {boolean} _links - Return resource link in response
237
- # * {boolean} _embedded - Return embedded resources in response
238
- #
239
- # Responses:
240
- # * 200 - Updated organization information (https://api.losant.com/#/definitions/org)
241
- #
242
- # Errors:
243
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
244
- # * 404 - Error if organization not found (https://api.losant.com/#/definitions/error)
245
- def modify_member(params = {})
246
- params = Utils.symbolize_hash_keys(params)
247
- query_params = { _actions: false, _links: true, _embedded: true }
248
- headers = {}
249
- body = nil
250
-
251
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
252
- raise ArgumentError.new("member is required") unless params.has_key?(:member)
253
-
254
- body = params[:member] if params.has_key?(:member)
255
- query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
256
- query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
257
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
258
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
259
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
260
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
261
-
262
- path = "/orgs/#{params[:orgId]}/member"
263
-
264
- @client.request(
265
- method: :patch,
266
- path: path,
267
- query: query_params,
268
- headers: headers,
269
- body: body)
270
- end
271
-
272
- # Returns notebook execution usage by day for the time range specified for this organization
273
- #
274
- # Authentication:
275
- # The client must be configured with a valid api
276
- # access token to call this action. The token
277
- # must include at least one of the following scopes:
278
- # all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.notebookMinuteCounts.
279
- #
280
- # Parameters:
281
- # * {string} orgId - ID associated with the organization
282
- # * {string} start - Start of range for notebook execution query (ms since epoch)
283
- # * {string} end - End of range for notebook execution query (ms since epoch)
284
- # * {string} losantdomain - Domain scope of request (rarely needed)
285
- # * {boolean} _actions - Return resource actions in response
286
- # * {boolean} _links - Return resource link in response
287
- # * {boolean} _embedded - Return embedded resources in response
288
- #
289
- # Responses:
290
- # * 200 - Notebook usage information (https://api.losant.com/#/definitions/notebookMinuteCounts)
291
- #
292
- # Errors:
293
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
294
- # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
295
- def notebook_minute_counts(params = {})
296
- params = Utils.symbolize_hash_keys(params)
297
- query_params = { _actions: false, _links: true, _embedded: true }
298
- headers = {}
299
- body = nil
300
-
301
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
302
-
303
- query_params[:start] = params[:start] if params.has_key?(:start)
304
- query_params[:end] = params[:end] if params.has_key?(:end)
305
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
306
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
307
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
308
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
309
-
310
- path = "/orgs/#{params[:orgId]}/notebookMinuteCounts"
311
-
312
- @client.request(
313
- method: :get,
314
- path: path,
315
- query: query_params,
316
- headers: headers,
317
- body: body)
318
- end
319
-
320
- # Updates information about an organization
321
- #
322
- # Authentication:
323
- # The client must be configured with a valid api
324
- # access token to call this action. The token
325
- # must include at least one of the following scopes:
326
- # all.Organization, all.User, org.*, or org.patch.
327
- #
328
- # Parameters:
329
- # * {string} orgId - ID associated with the organization
330
- # * {hash} organization - Object containing new organization properties (https://api.losant.com/#/definitions/orgPatch)
331
- # * {string} summaryExclude - Comma-separated list of summary fields to exclude from org summary
332
- # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
333
- # * {string} losantdomain - Domain scope of request (rarely needed)
334
- # * {boolean} _actions - Return resource actions in response
335
- # * {boolean} _links - Return resource link in response
336
- # * {boolean} _embedded - Return embedded resources in response
337
- #
338
- # Responses:
339
- # * 200 - Updated organization information (https://api.losant.com/#/definitions/org)
340
- #
341
- # Errors:
342
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
343
- # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
344
- def patch(params = {})
345
- params = Utils.symbolize_hash_keys(params)
346
- query_params = { _actions: false, _links: true, _embedded: true }
347
- headers = {}
348
- body = nil
349
-
350
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
351
- raise ArgumentError.new("organization is required") unless params.has_key?(:organization)
352
-
353
- body = params[:organization] if params.has_key?(:organization)
354
- query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
355
- query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
356
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
357
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
358
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
359
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
360
-
361
- path = "/orgs/#{params[:orgId]}"
362
-
363
- @client.request(
364
- method: :patch,
365
- path: path,
366
- query: query_params,
367
- headers: headers,
368
- body: body)
369
- end
370
-
371
- # Returns payload counts for the time range specified for all applications this organization owns
372
- #
373
- # Authentication:
374
- # The client must be configured with a valid api
375
- # access token to call this action. The token
376
- # must include at least one of the following scopes:
377
- # all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.payloadCounts.
378
- #
379
- # Parameters:
380
- # * {string} orgId - ID associated with the organization
381
- # * {string} start - Start of range for payload count query (ms since epoch)
382
- # * {string} end - End of range for payload count query (ms since epoch)
383
- # * {string} losantdomain - Domain scope of request (rarely needed)
384
- # * {boolean} _actions - Return resource actions in response
385
- # * {boolean} _links - Return resource link in response
386
- # * {boolean} _embedded - Return embedded resources in response
387
- #
388
- # Responses:
389
- # * 200 - Payload counts, by type and source (https://api.losant.com/#/definitions/payloadStats)
390
- #
391
- # Errors:
392
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
393
- # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
394
- def payload_counts(params = {})
395
- params = Utils.symbolize_hash_keys(params)
396
- query_params = { _actions: false, _links: true, _embedded: true }
397
- headers = {}
398
- body = nil
399
-
400
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
401
-
402
- query_params[:start] = params[:start] if params.has_key?(:start)
403
- query_params[:end] = params[:end] if params.has_key?(:end)
404
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
405
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
406
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
407
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
408
-
409
- path = "/orgs/#{params[:orgId]}/payloadCounts"
410
-
411
- @client.request(
412
- method: :get,
413
- path: path,
414
- query: query_params,
415
- headers: headers,
416
- body: body)
417
- end
418
-
419
- # Returns payload counts per resolution in the time range specified for all application this organization owns
420
- #
421
- # Authentication:
422
- # The client must be configured with a valid api
423
- # access token to call this action. The token
424
- # must include at least one of the following scopes:
425
- # all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.payloadCountsBreakdown.
426
- #
427
- # Parameters:
428
- # * {string} orgId - ID associated with the organization
429
- # * {string} start - Start of range for payload count query (ms since epoch)
430
- # * {string} end - End of range for payload count query (ms since epoch)
431
- # * {string} resolution - Resolution in milliseconds. Accepted values are: 86400000, 3600000
432
- # * {string} asBytes - If the resulting stats should be returned as bytes
433
- # * {string} includeNonBillable - If non-billable payloads should be included in the result
434
- # * {string} losantdomain - Domain scope of request (rarely needed)
435
- # * {boolean} _actions - Return resource actions in response
436
- # * {boolean} _links - Return resource link in response
437
- # * {boolean} _embedded - Return embedded resources in response
438
- #
439
- # Responses:
440
- # * 200 - Sum of payload counts by date (https://api.losant.com/#/definitions/payloadCountsBreakdown)
441
- #
442
- # Errors:
443
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
444
- # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
445
- def payload_counts_breakdown(params = {})
446
- params = Utils.symbolize_hash_keys(params)
447
- query_params = { _actions: false, _links: true, _embedded: true }
448
- headers = {}
449
- body = nil
450
-
451
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
452
-
453
- query_params[:start] = params[:start] if params.has_key?(:start)
454
- query_params[:end] = params[:end] if params.has_key?(:end)
455
- query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
456
- query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
457
- query_params[:includeNonBillable] = params[:includeNonBillable] if params.has_key?(:includeNonBillable)
458
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
459
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
460
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
461
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
462
-
463
- path = "/orgs/#{params[:orgId]}/payloadCountsBreakdown"
464
-
465
- @client.request(
466
- method: :get,
467
- path: path,
468
- query: query_params,
469
- headers: headers,
470
- body: body)
471
- end
472
-
473
- # Gets the current pending invites
474
- #
475
- # Authentication:
476
- # The client must be configured with a valid api
477
- # access token to call this action. The token
478
- # must include at least one of the following scopes:
479
- # all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.pendingInvites.
480
- #
481
- # Parameters:
482
- # * {string} orgId - ID associated with the organization
483
- # * {string} losantdomain - Domain scope of request (rarely needed)
484
- # * {boolean} _actions - Return resource actions in response
485
- # * {boolean} _links - Return resource link in response
486
- # * {boolean} _embedded - Return embedded resources in response
487
- #
488
- # Responses:
489
- # * 200 - Invitation information (https://api.losant.com/#/definitions/orgInvites)
490
- #
491
- # Errors:
492
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
493
- # * 404 - Error if organization not found (https://api.losant.com/#/definitions/error)
494
- def pending_invites(params = {})
495
- params = Utils.symbolize_hash_keys(params)
496
- query_params = { _actions: false, _links: true, _embedded: true }
497
- headers = {}
498
- body = nil
499
-
500
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
501
-
502
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
503
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
504
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
505
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
506
-
507
- path = "/orgs/#{params[:orgId]}/invites"
508
-
509
- @client.request(
510
- method: :get,
511
- path: path,
512
- query: query_params,
513
- headers: headers,
514
- body: body)
515
- end
516
-
517
- # Removes a member from the org
518
- #
519
- # Authentication:
520
- # The client must be configured with a valid api
521
- # access token to call this action. The token
522
- # must include at least one of the following scopes:
523
- # all.Organization, all.User, org.*, or org.removeMember.
524
- #
525
- # Parameters:
526
- # * {string} orgId - ID associated with the organization
527
- # * {string} userId - Id of user to remove
528
- # * {string} summaryExclude - Comma-separated list of summary fields to exclude from org summary
529
- # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
530
- # * {string} losantdomain - Domain scope of request (rarely needed)
531
- # * {boolean} _actions - Return resource actions in response
532
- # * {boolean} _links - Return resource link in response
533
- # * {boolean} _embedded - Return embedded resources in response
534
- #
535
- # Responses:
536
- # * 200 - Updated organization information (https://api.losant.com/#/definitions/org)
537
- #
538
- # Errors:
539
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
540
- # * 404 - Error if organization not found (https://api.losant.com/#/definitions/error)
541
- def remove_member(params = {})
542
- params = Utils.symbolize_hash_keys(params)
543
- query_params = { _actions: false, _links: true, _embedded: true }
544
- headers = {}
545
- body = nil
546
-
547
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
548
- raise ArgumentError.new("userId is required") unless params.has_key?(:userId)
549
-
550
- query_params[:userId] = params[:userId] if params.has_key?(:userId)
551
- query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
552
- query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
553
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
554
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
555
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
556
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
557
-
558
- path = "/orgs/#{params[:orgId]}/member"
559
-
560
- @client.request(
561
- method: :delete,
562
- path: path,
563
- query: query_params,
564
- headers: headers,
565
- body: body)
566
- end
567
-
568
- # Revokes an existing invite
569
- #
570
- # Authentication:
571
- # The client must be configured with a valid api
572
- # access token to call this action. The token
573
- # must include at least one of the following scopes:
574
- # all.Organization, all.User, org.*, or org.revokeInvite.
575
- #
576
- # Parameters:
577
- # * {string} orgId - ID associated with the organization
578
- # * {string} inviteId - Id of invite to revoke
579
- # * {string} losantdomain - Domain scope of request (rarely needed)
580
- # * {boolean} _actions - Return resource actions in response
581
- # * {boolean} _links - Return resource link in response
582
- # * {boolean} _embedded - Return embedded resources in response
583
- #
584
- # Responses:
585
- # * 200 - Invitation information (https://api.losant.com/#/definitions/orgInvites)
586
- #
587
- # Errors:
588
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
589
- # * 404 - Error if organization not found (https://api.losant.com/#/definitions/error)
590
- def revoke_invite(params = {})
591
- params = Utils.symbolize_hash_keys(params)
592
- query_params = { _actions: false, _links: true, _embedded: true }
593
- headers = {}
594
- body = nil
595
-
596
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
597
- raise ArgumentError.new("inviteId is required") unless params.has_key?(:inviteId)
598
-
599
- query_params[:inviteId] = params[:inviteId] if params.has_key?(:inviteId)
600
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
601
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
602
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
603
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
604
-
605
- path = "/orgs/#{params[:orgId]}/invites"
606
-
607
- @client.request(
608
- method: :delete,
609
- path: path,
610
- query: query_params,
611
- headers: headers,
612
- body: body)
613
- end
614
-
615
- # Moves resources to a new owner
616
- #
617
- # Authentication:
618
- # The client must be configured with a valid api
619
- # access token to call this action. The token
620
- # must include at least one of the following scopes:
621
- # all.Organization, all.User, org.*, or org.transferResources.
622
- #
623
- # Parameters:
624
- # * {string} orgId - ID associated with the organization
625
- # * {hash} transfer - Object containing properties of the transfer (https://api.losant.com/#/definitions/resourceTransfer)
626
- # * {string} losantdomain - Domain scope of request (rarely needed)
627
- # * {boolean} _actions - Return resource actions in response
628
- # * {boolean} _links - Return resource link in response
629
- # * {boolean} _embedded - Return embedded resources in response
630
- #
631
- # Responses:
632
- # * 200 - If resource transfer was successful (https://api.losant.com/#/definitions/success)
633
- #
634
- # Errors:
635
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
636
- # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
637
- def transfer_resources(params = {})
638
- params = Utils.symbolize_hash_keys(params)
639
- query_params = { _actions: false, _links: true, _embedded: true }
640
- headers = {}
641
- body = nil
642
-
643
- raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
644
- raise ArgumentError.new("transfer is required") unless params.has_key?(:transfer)
645
-
646
- body = params[:transfer] if params.has_key?(:transfer)
647
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
648
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
649
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
650
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
651
-
652
- path = "/orgs/#{params[:orgId]}/transferResources"
653
-
654
- @client.request(
655
- method: :patch,
656
- path: path,
657
- query: query_params,
658
- headers: headers,
659
- body: body)
660
- end
661
-
662
- end
663
- end