losant_rest 1.19.4 → 1.19.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (249) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +9 -9
  4. data/docs/_schemas.md +7090 -2334
  5. data/docs/experienceUsers.md +1 -0
  6. data/docs/instanceAuditLog.md +49 -0
  7. data/docs/instanceAuditLogs.md +53 -0
  8. data/examples/auth.rb +1 -1
  9. data/examples/list_devices.rb +1 -1
  10. data/lib/platform_rest/application.rb +1 -1
  11. data/lib/platform_rest/application_api_token.rb +1 -1
  12. data/lib/platform_rest/application_api_tokens.rb +1 -1
  13. data/lib/platform_rest/application_certificate.rb +1 -1
  14. data/lib/platform_rest/application_certificate_authorities.rb +1 -1
  15. data/lib/platform_rest/application_certificate_authority.rb +1 -1
  16. data/lib/platform_rest/application_certificates.rb +1 -1
  17. data/lib/platform_rest/application_dashboard.rb +1 -1
  18. data/lib/platform_rest/application_dashboards.rb +1 -1
  19. data/lib/platform_rest/application_key.rb +1 -1
  20. data/lib/platform_rest/application_keys.rb +1 -1
  21. data/lib/platform_rest/application_template.rb +1 -1
  22. data/lib/platform_rest/application_templates.rb +1 -1
  23. data/lib/platform_rest/applications.rb +1 -1
  24. data/lib/platform_rest/audit_log.rb +1 -1
  25. data/lib/platform_rest/audit_logs.rb +1 -1
  26. data/lib/platform_rest/auth.rb +1 -1
  27. data/lib/platform_rest/client.rb +11 -3
  28. data/lib/platform_rest/credential.rb +1 -1
  29. data/lib/platform_rest/credentials.rb +1 -1
  30. data/lib/platform_rest/dashboard.rb +1 -1
  31. data/lib/platform_rest/dashboards.rb +1 -1
  32. data/lib/platform_rest/data.rb +1 -1
  33. data/lib/platform_rest/data_table.rb +1 -1
  34. data/lib/platform_rest/data_table_row.rb +1 -1
  35. data/lib/platform_rest/data_table_rows.rb +1 -1
  36. data/lib/platform_rest/data_tables.rb +1 -1
  37. data/lib/platform_rest/device.rb +1 -1
  38. data/lib/platform_rest/device_recipe.rb +1 -1
  39. data/lib/platform_rest/device_recipes.rb +1 -1
  40. data/lib/platform_rest/devices.rb +1 -1
  41. data/lib/platform_rest/edge_deployment.rb +1 -1
  42. data/lib/platform_rest/edge_deployments.rb +1 -1
  43. data/lib/platform_rest/embedded_deployment.rb +1 -1
  44. data/lib/platform_rest/embedded_deployments.rb +1 -1
  45. data/lib/platform_rest/error.rb +1 -1
  46. data/lib/platform_rest/event.rb +1 -1
  47. data/lib/platform_rest/events.rb +1 -1
  48. data/lib/platform_rest/experience.rb +1 -1
  49. data/lib/platform_rest/experience_domain.rb +1 -1
  50. data/lib/platform_rest/experience_domains.rb +1 -1
  51. data/lib/platform_rest/experience_endpoint.rb +1 -1
  52. data/lib/platform_rest/experience_endpoints.rb +1 -1
  53. data/lib/platform_rest/experience_group.rb +1 -1
  54. data/lib/platform_rest/experience_groups.rb +1 -1
  55. data/lib/platform_rest/experience_slug.rb +1 -1
  56. data/lib/platform_rest/experience_slugs.rb +1 -1
  57. data/lib/platform_rest/experience_user.rb +1 -1
  58. data/lib/platform_rest/experience_users.rb +4 -1
  59. data/lib/platform_rest/experience_version.rb +1 -1
  60. data/lib/platform_rest/experience_versions.rb +1 -1
  61. data/lib/platform_rest/experience_view.rb +1 -1
  62. data/lib/platform_rest/experience_views.rb +1 -1
  63. data/lib/platform_rest/file.rb +1 -1
  64. data/lib/platform_rest/files.rb +1 -1
  65. data/lib/platform_rest/flow.rb +1 -1
  66. data/lib/platform_rest/flow_version.rb +1 -1
  67. data/lib/platform_rest/flow_versions.rb +1 -1
  68. data/lib/platform_rest/flows.rb +1 -1
  69. data/lib/platform_rest/instance.rb +1 -1
  70. data/lib/platform_rest/instance_api_token.rb +1 -1
  71. data/lib/platform_rest/instance_api_tokens.rb +1 -1
  72. data/lib/{losant_rest/application_template.rb → platform_rest/instance_audit_log.rb} +13 -11
  73. data/lib/{losant_rest/audit_logs.rb → platform_rest/instance_audit_logs.rb} +12 -12
  74. data/lib/platform_rest/instance_custom_node.rb +1 -1
  75. data/lib/platform_rest/instance_custom_nodes.rb +1 -1
  76. data/lib/platform_rest/instance_member.rb +1 -1
  77. data/lib/platform_rest/instance_members.rb +1 -1
  78. data/lib/platform_rest/instance_org.rb +1 -1
  79. data/lib/platform_rest/instance_org_invite.rb +1 -1
  80. data/lib/platform_rest/instance_org_invites.rb +1 -1
  81. data/lib/platform_rest/instance_org_member.rb +1 -1
  82. data/lib/platform_rest/instance_org_members.rb +1 -1
  83. data/lib/platform_rest/instance_orgs.rb +1 -1
  84. data/lib/platform_rest/instance_sandbox.rb +1 -1
  85. data/lib/platform_rest/instance_sandboxes.rb +1 -1
  86. data/lib/platform_rest/instances.rb +1 -1
  87. data/lib/platform_rest/integration.rb +1 -1
  88. data/lib/platform_rest/integrations.rb +1 -1
  89. data/lib/platform_rest/me.rb +1 -1
  90. data/lib/platform_rest/notebook.rb +1 -1
  91. data/lib/platform_rest/notebooks.rb +1 -1
  92. data/lib/platform_rest/org.rb +1 -1
  93. data/lib/platform_rest/org_invites.rb +1 -1
  94. data/lib/platform_rest/orgs.rb +1 -1
  95. data/lib/platform_rest/resource_job.rb +1 -1
  96. data/lib/platform_rest/resource_jobs.rb +1 -1
  97. data/lib/platform_rest/user_api_token.rb +1 -1
  98. data/lib/platform_rest/user_api_tokens.rb +1 -1
  99. data/lib/platform_rest/utils.rb +1 -1
  100. data/lib/{losant_rest → platform_rest}/version.rb +3 -3
  101. data/lib/platform_rest/webhook.rb +1 -1
  102. data/lib/platform_rest/webhooks.rb +1 -1
  103. data/lib/platform_rest.rb +3 -1
  104. data/losant_rest.gemspec +2 -2
  105. data/schemas/advancedExperienceUserQuery.json +1068 -0
  106. data/schemas/apiTokenPost.json +9 -1
  107. data/schemas/auditLog.json +3 -2
  108. data/schemas/auditLogFilter.json +3 -2
  109. data/schemas/auditLogs.json +3 -2
  110. data/schemas/credential.json +95 -1
  111. data/schemas/credentialLinkedResources.json +417 -19
  112. data/schemas/credentialPatch.json +107 -0
  113. data/schemas/credentialPost.json +129 -1
  114. data/schemas/credentials.json +95 -1
  115. data/schemas/deviceConnectionStatus.json +6 -2
  116. data/schemas/devicesHistoricalImportPost.json +25 -0
  117. data/schemas/experienceLinkedResources.json +343 -20
  118. data/schemas/experienceVersion.json +64 -0
  119. data/schemas/experienceVersionPatch.json +64 -0
  120. data/schemas/experienceVersionPost.json +64 -0
  121. data/schemas/experienceVersions.json +64 -0
  122. data/schemas/experienceView.json +1 -2
  123. data/schemas/experienceViewPatch.json +1 -2
  124. data/schemas/experienceViewPost.json +2 -4
  125. data/schemas/experienceViews.json +1 -2
  126. data/schemas/flow.json +114 -6
  127. data/schemas/flowPatch.json +114 -6
  128. data/schemas/flowPost.json +114 -6
  129. data/schemas/flowVersion.json +228 -12
  130. data/schemas/flowVersionPost.json +114 -6
  131. data/schemas/flowVersions.json +228 -12
  132. data/schemas/flows.json +114 -6
  133. data/schemas/flowsImportPost.json +228 -12
  134. data/schemas/flowsImportResult.json +342 -18
  135. data/schemas/githubLogin.json +9 -1
  136. data/schemas/instance.json +1 -4
  137. data/schemas/instanceAuditLog.json +94 -0
  138. data/schemas/instanceAuditLogFilter.json +106 -0
  139. data/schemas/instanceAuditLogs.json +41 -0
  140. data/schemas/instanceCustomNode.json +2 -1
  141. data/schemas/instanceCustomNodePatch.json +2 -7
  142. data/schemas/instanceCustomNodePost.json +2 -7
  143. data/schemas/instanceCustomNodes.json +2 -1
  144. data/schemas/instanceOrgMember.json +4 -1
  145. data/schemas/instances.json +1 -4
  146. data/schemas/integration.json +75 -1
  147. data/schemas/integrationPatch.json +73 -0
  148. data/schemas/integrationPost.json +75 -1
  149. data/schemas/integrations.json +75 -1
  150. data/schemas/mePatch.json +18 -0
  151. data/schemas/resourceJob.json +2 -1
  152. data/schemas/resourceJobExecutionLogs.json +2 -1
  153. data/schemas/resourceJobPost.json +2 -1
  154. data/schemas/resourceJobs.json +2 -1
  155. data/schemas/samlResponse.json +9 -1
  156. data/schemas/userCredentials.json +9 -1
  157. data/schemas/userPost.json +9 -1
  158. data/test/basic_test.rb +6 -6
  159. data/test/test_helper.rb +1 -1
  160. metadata +12 -94
  161. data/lib/losant_rest/application.rb +0 -932
  162. data/lib/losant_rest/application_api_token.rb +0 -176
  163. data/lib/losant_rest/application_api_tokens.rb +0 -136
  164. data/lib/losant_rest/application_certificate.rb +0 -176
  165. data/lib/losant_rest/application_certificate_authorities.rb +0 -138
  166. data/lib/losant_rest/application_certificate_authority.rb +0 -176
  167. data/lib/losant_rest/application_certificates.rb +0 -138
  168. data/lib/losant_rest/application_dashboard.rb +0 -225
  169. data/lib/losant_rest/application_dashboards.rb +0 -138
  170. data/lib/losant_rest/application_key.rb +0 -176
  171. data/lib/losant_rest/application_keys.rb +0 -141
  172. data/lib/losant_rest/application_templates.rb +0 -176
  173. data/lib/losant_rest/applications.rb +0 -142
  174. data/lib/losant_rest/audit_log.rb +0 -81
  175. data/lib/losant_rest/auth.rb +0 -245
  176. data/lib/losant_rest/client.rb +0 -410
  177. data/lib/losant_rest/credential.rb +0 -224
  178. data/lib/losant_rest/credentials.rb +0 -138
  179. data/lib/losant_rest/dashboard.rb +0 -268
  180. data/lib/losant_rest/dashboards.rb +0 -136
  181. data/lib/losant_rest/data.rb +0 -176
  182. data/lib/losant_rest/data_table.rb +0 -274
  183. data/lib/losant_rest/data_table_row.rb +0 -182
  184. data/lib/losant_rest/data_table_rows.rb +0 -343
  185. data/lib/losant_rest/data_tables.rb +0 -138
  186. data/lib/losant_rest/device.rb +0 -749
  187. data/lib/losant_rest/device_recipe.rb +0 -234
  188. data/lib/losant_rest/device_recipes.rb +0 -146
  189. data/lib/losant_rest/devices.rb +0 -707
  190. data/lib/losant_rest/edge_deployment.rb +0 -81
  191. data/lib/losant_rest/edge_deployments.rb +0 -236
  192. data/lib/losant_rest/embedded_deployment.rb +0 -81
  193. data/lib/losant_rest/embedded_deployments.rb +0 -280
  194. data/lib/losant_rest/error.rb +0 -34
  195. data/lib/losant_rest/event.rb +0 -176
  196. data/lib/losant_rest/events.rb +0 -341
  197. data/lib/losant_rest/experience.rb +0 -142
  198. data/lib/losant_rest/experience_domain.rb +0 -176
  199. data/lib/losant_rest/experience_domains.rb +0 -126
  200. data/lib/losant_rest/experience_endpoint.rb +0 -230
  201. data/lib/losant_rest/experience_endpoints.rb +0 -200
  202. data/lib/losant_rest/experience_group.rb +0 -180
  203. data/lib/losant_rest/experience_groups.rb +0 -141
  204. data/lib/losant_rest/experience_slug.rb +0 -176
  205. data/lib/losant_rest/experience_slugs.rb +0 -126
  206. data/lib/losant_rest/experience_user.rb +0 -176
  207. data/lib/losant_rest/experience_users.rb +0 -142
  208. data/lib/losant_rest/experience_version.rb +0 -176
  209. data/lib/losant_rest/experience_versions.rb +0 -138
  210. data/lib/losant_rest/experience_view.rb +0 -228
  211. data/lib/losant_rest/experience_views.rb +0 -142
  212. data/lib/losant_rest/file.rb +0 -226
  213. data/lib/losant_rest/files.rb +0 -144
  214. data/lib/losant_rest/flow.rb +0 -580
  215. data/lib/losant_rest/flow_version.rb +0 -352
  216. data/lib/losant_rest/flow_versions.rb +0 -201
  217. data/lib/losant_rest/flows.rb +0 -310
  218. data/lib/losant_rest/instance.rb +0 -377
  219. data/lib/losant_rest/instance_api_token.rb +0 -176
  220. data/lib/losant_rest/instance_api_tokens.rb +0 -136
  221. data/lib/losant_rest/instance_custom_node.rb +0 -282
  222. data/lib/losant_rest/instance_custom_nodes.rb +0 -136
  223. data/lib/losant_rest/instance_member.rb +0 -176
  224. data/lib/losant_rest/instance_members.rb +0 -134
  225. data/lib/losant_rest/instance_org.rb +0 -336
  226. data/lib/losant_rest/instance_org_invite.rb +0 -182
  227. data/lib/losant_rest/instance_org_invites.rb +0 -138
  228. data/lib/losant_rest/instance_org_member.rb +0 -182
  229. data/lib/losant_rest/instance_org_members.rb +0 -138
  230. data/lib/losant_rest/instance_orgs.rb +0 -139
  231. data/lib/losant_rest/instance_sandbox.rb +0 -181
  232. data/lib/losant_rest/instance_sandboxes.rb +0 -98
  233. data/lib/losant_rest/instances.rb +0 -88
  234. data/lib/losant_rest/integration.rb +0 -178
  235. data/lib/losant_rest/integrations.rb +0 -138
  236. data/lib/losant_rest/me.rb +0 -790
  237. data/lib/losant_rest/notebook.rb +0 -423
  238. data/lib/losant_rest/notebooks.rb +0 -138
  239. data/lib/losant_rest/org.rb +0 -663
  240. data/lib/losant_rest/org_invites.rb +0 -124
  241. data/lib/losant_rest/orgs.rb +0 -140
  242. data/lib/losant_rest/resource_job.rb +0 -326
  243. data/lib/losant_rest/resource_jobs.rb +0 -138
  244. data/lib/losant_rest/user_api_token.rb +0 -170
  245. data/lib/losant_rest/user_api_tokens.rb +0 -132
  246. data/lib/losant_rest/utils.rb +0 -44
  247. data/lib/losant_rest/webhook.rb +0 -178
  248. data/lib/losant_rest/webhooks.rb +0 -138
  249. data/lib/losant_rest.rb +0 -129
@@ -1,790 +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 Me Resource
28
- class Me
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Adds an item to a recent item list
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, me.*, or me.addRecentItem.
41
- #
42
- # Parameters:
43
- # * {hash} data - Object containing recent item info (https://api.losant.com/#/definitions/recentItem)
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 - Updated recent item list (https://api.losant.com/#/definitions/recentItemList)
51
- #
52
- # Errors:
53
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
54
- def add_recent_item(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("data is required") unless params.has_key?(:data)
61
-
62
- body = params[:data] if params.has_key?(:data)
63
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
64
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
65
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
66
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
67
-
68
- path = "/me/recentItems"
69
-
70
- @client.request(
71
- method: :post,
72
- path: path,
73
- query: query_params,
74
- headers: headers,
75
- body: body)
76
- end
77
-
78
- # Changes the current user's password and optionally logs out all other sessions
79
- #
80
- # Authentication:
81
- # The client must be configured with a valid api
82
- # access token to call this action. The token
83
- # must include at least one of the following scopes:
84
- # all.User, me.*, or me.changePassword.
85
- #
86
- # Parameters:
87
- # * {hash} data - Object containing the password change info (https://api.losant.com/#/definitions/changePassword)
88
- # * {string} losantdomain - Domain scope of request (rarely needed)
89
- # * {boolean} _actions - Return resource actions in response
90
- # * {boolean} _links - Return resource link in response
91
- # * {boolean} _embedded - Return embedded resources in response
92
- #
93
- # Responses:
94
- # * 200 - A new, valid, auth token (potentially all previous tokens are now invalid) (https://api.losant.com/#/definitions/authedUser)
95
- #
96
- # Errors:
97
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
98
- def change_password(params = {})
99
- params = Utils.symbolize_hash_keys(params)
100
- query_params = { _actions: false, _links: true, _embedded: true }
101
- headers = {}
102
- body = nil
103
-
104
- raise ArgumentError.new("data is required") unless params.has_key?(:data)
105
-
106
- body = params[:data] if params.has_key?(:data)
107
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
108
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
109
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
110
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
111
-
112
- path = "/me/changePassword"
113
-
114
- @client.request(
115
- method: :patch,
116
- path: path,
117
- query: query_params,
118
- headers: headers,
119
- body: body)
120
- end
121
-
122
- # Deletes the current user
123
- #
124
- # Authentication:
125
- # The client must be configured with a valid api
126
- # access token to call this action. The token
127
- # must include at least one of the following scopes:
128
- # all.User, me.*, or me.delete.
129
- #
130
- # Parameters:
131
- # * {hash} credentials - User authentication credentials (https://api.losant.com/#/definitions/userCredentials)
132
- # * {string} losantdomain - Domain scope of request (rarely needed)
133
- # * {boolean} _actions - Return resource actions in response
134
- # * {boolean} _links - Return resource link in response
135
- # * {boolean} _embedded - Return embedded resources in response
136
- #
137
- # Responses:
138
- # * 200 - If the user was successfully deleted (https://api.losant.com/#/definitions/success)
139
- #
140
- # Errors:
141
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
142
- def delete(params = {})
143
- params = Utils.symbolize_hash_keys(params)
144
- query_params = { _actions: false, _links: true, _embedded: true }
145
- headers = {}
146
- body = nil
147
-
148
- raise ArgumentError.new("credentials is required") unless params.has_key?(:credentials)
149
-
150
- body = params[:credentials] if params.has_key?(:credentials)
151
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
152
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
153
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
154
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
155
-
156
- path = "/me/delete"
157
-
158
- @client.request(
159
- method: :post,
160
- path: path,
161
- query: query_params,
162
- headers: headers,
163
- body: body)
164
- end
165
-
166
- # Returns device counts by day for the time range specified for all applications the current user owns
167
- #
168
- # Authentication:
169
- # The client must be configured with a valid api
170
- # access token to call this action. The token
171
- # must include at least one of the following scopes:
172
- # all.User, all.User.read, me.*, or me.deviceCounts.
173
- #
174
- # Parameters:
175
- # * {string} start - Start of range for device count query (ms since epoch)
176
- # * {string} end - End of range for device count query (ms since epoch)
177
- # * {string} losantdomain - Domain scope of request (rarely needed)
178
- # * {boolean} _actions - Return resource actions in response
179
- # * {boolean} _links - Return resource link in response
180
- # * {boolean} _embedded - Return embedded resources in response
181
- #
182
- # Responses:
183
- # * 200 - Device counts by day (https://api.losant.com/#/definitions/deviceCounts)
184
- #
185
- # Errors:
186
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
187
- def device_counts(params = {})
188
- params = Utils.symbolize_hash_keys(params)
189
- query_params = { _actions: false, _links: true, _embedded: true }
190
- headers = {}
191
- body = nil
192
-
193
-
194
- query_params[:start] = params[:start] if params.has_key?(:start)
195
- query_params[:end] = params[:end] if params.has_key?(:end)
196
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
197
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
198
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
199
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
200
-
201
- path = "/me/deviceCounts"
202
-
203
- @client.request(
204
- method: :get,
205
- path: path,
206
- query: query_params,
207
- headers: headers,
208
- body: body)
209
- end
210
-
211
- # Disables two factor auth for the current user
212
- #
213
- # Authentication:
214
- # The client must be configured with a valid api
215
- # access token to call this action. The token
216
- # must include at least one of the following scopes:
217
- # all.User, me.*, or me.disableTwoFactorAuth.
218
- #
219
- # Parameters:
220
- # * {hash} data - Object containing two factor auth properties (https://api.losant.com/#/definitions/disableTwoFactorAuth)
221
- # * {string} losantdomain - Domain scope of request (rarely needed)
222
- # * {boolean} _actions - Return resource actions in response
223
- # * {boolean} _links - Return resource link in response
224
- # * {boolean} _embedded - Return embedded resources in response
225
- #
226
- # Responses:
227
- # * 200 - Updated user information (https://api.losant.com/#/definitions/me)
228
- #
229
- # Errors:
230
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
231
- def disable_two_factor_auth(params = {})
232
- params = Utils.symbolize_hash_keys(params)
233
- query_params = { _actions: false, _links: true, _embedded: true }
234
- headers = {}
235
- body = nil
236
-
237
- raise ArgumentError.new("data is required") unless params.has_key?(:data)
238
-
239
- body = params[:data] if params.has_key?(:data)
240
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
241
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
242
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
243
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
244
-
245
- path = "/me/disableTwoFactorAuth"
246
-
247
- @client.request(
248
- method: :patch,
249
- path: path,
250
- query: query_params,
251
- headers: headers,
252
- body: body)
253
- end
254
-
255
- # Disconnects the user from Github
256
- #
257
- # Authentication:
258
- # The client must be configured with a valid api
259
- # access token to call this action. The token
260
- # must include at least one of the following scopes:
261
- # all.User, me.*, or me.disconnectGithub.
262
- #
263
- # Parameters:
264
- # * {string} losantdomain - Domain scope of request (rarely needed)
265
- # * {boolean} _actions - Return resource actions in response
266
- # * {boolean} _links - Return resource link in response
267
- # * {boolean} _embedded - Return embedded resources in response
268
- #
269
- # Responses:
270
- # * 200 - Updated user information (https://api.losant.com/#/definitions/me)
271
- #
272
- # Errors:
273
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
274
- def disconnect_github(params = {})
275
- params = Utils.symbolize_hash_keys(params)
276
- query_params = { _actions: false, _links: true, _embedded: true }
277
- headers = {}
278
- body = nil
279
-
280
-
281
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
282
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
283
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
284
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
285
-
286
- path = "/me/disconnectGithub"
287
-
288
- @client.request(
289
- method: :patch,
290
- path: path,
291
- query: query_params,
292
- headers: headers,
293
- body: body)
294
- end
295
-
296
- # Enables two factor auth for the current user
297
- #
298
- # Authentication:
299
- # The client must be configured with a valid api
300
- # access token to call this action. The token
301
- # must include at least one of the following scopes:
302
- # all.User, me.*, or me.enableTwoFactorAuth.
303
- #
304
- # Parameters:
305
- # * {hash} data - Object containing two factor auth properties (https://api.losant.com/#/definitions/enableTwoFactorAuth)
306
- # * {string} losantdomain - Domain scope of request (rarely needed)
307
- # * {boolean} _actions - Return resource actions in response
308
- # * {boolean} _links - Return resource link in response
309
- # * {boolean} _embedded - Return embedded resources in response
310
- #
311
- # Responses:
312
- # * 200 - Updated user information (https://api.losant.com/#/definitions/me)
313
- #
314
- # Errors:
315
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
316
- def enable_two_factor_auth(params = {})
317
- params = Utils.symbolize_hash_keys(params)
318
- query_params = { _actions: false, _links: true, _embedded: true }
319
- headers = {}
320
- body = nil
321
-
322
- raise ArgumentError.new("data is required") unless params.has_key?(:data)
323
-
324
- body = params[:data] if params.has_key?(:data)
325
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
326
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
327
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
328
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
329
-
330
- path = "/me/enableTwoFactorAuth"
331
-
332
- @client.request(
333
- method: :patch,
334
- path: path,
335
- query: query_params,
336
- headers: headers,
337
- body: body)
338
- end
339
-
340
- # Gets a recent item list
341
- #
342
- # Authentication:
343
- # The client must be configured with a valid api
344
- # access token to call this action. The token
345
- # must include at least one of the following scopes:
346
- # all.User, all.User.read, me.*, or me.fetchRecentItems.
347
- #
348
- # Parameters:
349
- # * {string} parentId - Parent id of the recent list
350
- # * {undefined} itemType - Item type to get the recent list of. Accepted values are: application, device, flow, dashboard, organization
351
- # * {string} losantdomain - Domain scope of request (rarely needed)
352
- # * {boolean} _actions - Return resource actions in response
353
- # * {boolean} _links - Return resource link in response
354
- # * {boolean} _embedded - Return embedded resources in response
355
- #
356
- # Responses:
357
- # * 200 - Recent item list (https://api.losant.com/#/definitions/recentItemList)
358
- #
359
- # Errors:
360
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
361
- def fetch_recent_items(params = {})
362
- params = Utils.symbolize_hash_keys(params)
363
- query_params = { _actions: false, _links: true, _embedded: true }
364
- headers = {}
365
- body = nil
366
-
367
- raise ArgumentError.new("itemType is required") unless params.has_key?(:itemType)
368
-
369
- query_params[:parentId] = params[:parentId] if params.has_key?(:parentId)
370
- query_params[:itemType] = params[:itemType] if params.has_key?(:itemType)
371
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
372
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
373
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
374
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
375
-
376
- path = "/me/recentItems"
377
-
378
- @client.request(
379
- method: :get,
380
- path: path,
381
- query: query_params,
382
- headers: headers,
383
- body: body)
384
- end
385
-
386
- # Returns the two factor auth key for a user
387
- #
388
- # Authentication:
389
- # The client must be configured with a valid api
390
- # access token to call this action. The token
391
- # must include at least one of the following scopes:
392
- # all.User, me.*, or me.generateTwoFactorAuth.
393
- #
394
- # Parameters:
395
- # * {string} losantdomain - Domain scope of request (rarely needed)
396
- # * {boolean} _actions - Return resource actions in response
397
- # * {boolean} _links - Return resource link in response
398
- # * {boolean} _embedded - Return embedded resources in response
399
- #
400
- # Responses:
401
- # * 200 - Updated user information (https://api.losant.com/#/definitions/twoFactorAuthInfo)
402
- #
403
- # Errors:
404
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
405
- def generate_two_factor_auth(params = {})
406
- params = Utils.symbolize_hash_keys(params)
407
- query_params = { _actions: false, _links: true, _embedded: true }
408
- headers = {}
409
- body = nil
410
-
411
-
412
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
413
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
414
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
415
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
416
-
417
- path = "/me/generateTwoFactorAuth"
418
-
419
- @client.request(
420
- method: :patch,
421
- path: path,
422
- query: query_params,
423
- headers: headers,
424
- body: body)
425
- end
426
-
427
- # Retrieves information on the current user
428
- #
429
- # Authentication:
430
- # The client must be configured with a valid api
431
- # access token to call this action. The token
432
- # must include at least one of the following scopes:
433
- # all.User, all.User.read, me.*, or me.get.
434
- #
435
- # Parameters:
436
- # * {undefined} includeRecent - Should the user include recent app/dashboard info
437
- # * {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
438
- # * {string} summaryInclude - Comma-separated list of summary fields to include in user summary
439
- # * {string} losantdomain - Domain scope of request (rarely needed)
440
- # * {boolean} _actions - Return resource actions in response
441
- # * {boolean} _links - Return resource link in response
442
- # * {boolean} _embedded - Return embedded resources in response
443
- #
444
- # Responses:
445
- # * 200 - Current user information (https://api.losant.com/#/definitions/me)
446
- #
447
- # Errors:
448
- def get(params = {})
449
- params = Utils.symbolize_hash_keys(params)
450
- query_params = { _actions: false, _links: true, _embedded: true }
451
- headers = {}
452
- body = nil
453
-
454
-
455
- query_params[:includeRecent] = params[:includeRecent] if params.has_key?(:includeRecent)
456
- query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
457
- query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
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 = "/me"
464
-
465
- @client.request(
466
- method: :get,
467
- path: path,
468
- query: query_params,
469
- headers: headers,
470
- body: body)
471
- end
472
-
473
- # Returns notebook execution usage by day for the time range specified for all applications the current user owns
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.User, all.User.read, me.*, or me.notebookMinuteCounts.
480
- #
481
- # Parameters:
482
- # * {string} start - Start of range for notebook execution query (ms since epoch)
483
- # * {string} end - End of range for notebook execution query (ms since epoch)
484
- # * {string} losantdomain - Domain scope of request (rarely needed)
485
- # * {boolean} _actions - Return resource actions in response
486
- # * {boolean} _links - Return resource link in response
487
- # * {boolean} _embedded - Return embedded resources in response
488
- #
489
- # Responses:
490
- # * 200 - Notebook usage information (https://api.losant.com/#/definitions/notebookMinuteCounts)
491
- #
492
- # Errors:
493
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
494
- def notebook_minute_counts(params = {})
495
- params = Utils.symbolize_hash_keys(params)
496
- query_params = { _actions: false, _links: true, _embedded: true }
497
- headers = {}
498
- body = nil
499
-
500
-
501
- query_params[:start] = params[:start] if params.has_key?(:start)
502
- query_params[:end] = params[:end] if params.has_key?(:end)
503
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
504
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
505
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
506
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
507
-
508
- path = "/me/notebookMinuteCounts"
509
-
510
- @client.request(
511
- method: :get,
512
- path: path,
513
- query: query_params,
514
- headers: headers,
515
- body: body)
516
- end
517
-
518
- # Updates information about the current user
519
- #
520
- # Authentication:
521
- # The client must be configured with a valid api
522
- # access token to call this action. The token
523
- # must include at least one of the following scopes:
524
- # all.User, me.*, or me.patch.
525
- #
526
- # Parameters:
527
- # * {hash} user - Object containing new user properties (https://api.losant.com/#/definitions/mePatch)
528
- # * {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
529
- # * {string} summaryInclude - Comma-separated list of summary fields to include in user 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 user information (https://api.losant.com/#/definitions/me)
537
- #
538
- # Errors:
539
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
540
- def patch(params = {})
541
- params = Utils.symbolize_hash_keys(params)
542
- query_params = { _actions: false, _links: true, _embedded: true }
543
- headers = {}
544
- body = nil
545
-
546
- raise ArgumentError.new("user is required") unless params.has_key?(:user)
547
-
548
- body = params[:user] if params.has_key?(:user)
549
- query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
550
- query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
551
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
552
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
553
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
554
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
555
-
556
- path = "/me"
557
-
558
- @client.request(
559
- method: :patch,
560
- path: path,
561
- query: query_params,
562
- headers: headers,
563
- body: body)
564
- end
565
-
566
- # Returns payload counts for the time range specified for all applications the current user owns
567
- #
568
- # Authentication:
569
- # The client must be configured with a valid api
570
- # access token to call this action. The token
571
- # must include at least one of the following scopes:
572
- # all.User, all.User.read, me.*, or me.payloadCounts.
573
- #
574
- # Parameters:
575
- # * {string} start - Start of range for payload count query (ms since epoch)
576
- # * {string} end - End of range for payload count query (ms since epoch)
577
- # * {string} losantdomain - Domain scope of request (rarely needed)
578
- # * {boolean} _actions - Return resource actions in response
579
- # * {boolean} _links - Return resource link in response
580
- # * {boolean} _embedded - Return embedded resources in response
581
- #
582
- # Responses:
583
- # * 200 - Payload counts, by type and source (https://api.losant.com/#/definitions/payloadStats)
584
- #
585
- # Errors:
586
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
587
- def payload_counts(params = {})
588
- params = Utils.symbolize_hash_keys(params)
589
- query_params = { _actions: false, _links: true, _embedded: true }
590
- headers = {}
591
- body = nil
592
-
593
-
594
- query_params[:start] = params[:start] if params.has_key?(:start)
595
- query_params[:end] = params[:end] if params.has_key?(:end)
596
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
597
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
598
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
599
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
600
-
601
- path = "/me/payloadCounts"
602
-
603
- @client.request(
604
- method: :get,
605
- path: path,
606
- query: query_params,
607
- headers: headers,
608
- body: body)
609
- end
610
-
611
- # Returns payload counts per resolution in the time range specified for all applications the current user owns
612
- #
613
- # Authentication:
614
- # The client must be configured with a valid api
615
- # access token to call this action. The token
616
- # must include at least one of the following scopes:
617
- # all.User, all.User.read, me.*, or me.payloadCountsBreakdown.
618
- #
619
- # Parameters:
620
- # * {string} start - Start of range for payload count query (ms since epoch)
621
- # * {string} end - End of range for payload count query (ms since epoch)
622
- # * {string} resolution - Resolution in milliseconds. Accepted values are: 86400000, 3600000
623
- # * {string} asBytes - If the resulting stats should be returned as bytes
624
- # * {string} includeNonBillable - If non-billable payloads should be included in the result
625
- # * {string} losantdomain - Domain scope of request (rarely needed)
626
- # * {boolean} _actions - Return resource actions in response
627
- # * {boolean} _links - Return resource link in response
628
- # * {boolean} _embedded - Return embedded resources in response
629
- #
630
- # Responses:
631
- # * 200 - Sum of payload counts by date (https://api.losant.com/#/definitions/payloadCountsBreakdown)
632
- #
633
- # Errors:
634
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
635
- def payload_counts_breakdown(params = {})
636
- params = Utils.symbolize_hash_keys(params)
637
- query_params = { _actions: false, _links: true, _embedded: true }
638
- headers = {}
639
- body = nil
640
-
641
-
642
- query_params[:start] = params[:start] if params.has_key?(:start)
643
- query_params[:end] = params[:end] if params.has_key?(:end)
644
- query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
645
- query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
646
- query_params[:includeNonBillable] = params[:includeNonBillable] if params.has_key?(:includeNonBillable)
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 = "/me/payloadCountsBreakdown"
653
-
654
- @client.request(
655
- method: :get,
656
- path: path,
657
- query: query_params,
658
- headers: headers,
659
- body: body)
660
- end
661
-
662
- # Returns a new auth token based on the current auth token
663
- #
664
- # Authentication:
665
- # The client must be configured with a valid api
666
- # access token to call this action. The token
667
- # must include at least one of the following scopes:
668
- # all.User, or me.*.
669
- #
670
- # Parameters:
671
- # * {string} losantdomain - Domain scope of request (rarely needed)
672
- # * {boolean} _actions - Return resource actions in response
673
- # * {boolean} _links - Return resource link in response
674
- # * {boolean} _embedded - Return embedded resources in response
675
- #
676
- # Responses:
677
- # * 200 - Successful token regeneration (https://api.losant.com/#/definitions/authedUser)
678
- #
679
- # Errors:
680
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
681
- # * 401 - Unauthorized error if authentication fails (https://api.losant.com/#/definitions/error)
682
- def refresh_token(params = {})
683
- params = Utils.symbolize_hash_keys(params)
684
- query_params = { _actions: false, _links: true, _embedded: true }
685
- headers = {}
686
- body = nil
687
-
688
-
689
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
690
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
691
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
692
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
693
-
694
- path = "/me/refreshToken"
695
-
696
- @client.request(
697
- method: :get,
698
- path: path,
699
- query: query_params,
700
- headers: headers,
701
- body: body)
702
- end
703
-
704
- # Moves resources to a new owner
705
- #
706
- # Authentication:
707
- # The client must be configured with a valid api
708
- # access token to call this action. The token
709
- # must include at least one of the following scopes:
710
- # all.User, me.*, or me.transferResources.
711
- #
712
- # Parameters:
713
- # * {hash} transfer - Object containing properties of the transfer (https://api.losant.com/#/definitions/resourceTransfer)
714
- # * {string} losantdomain - Domain scope of request (rarely needed)
715
- # * {boolean} _actions - Return resource actions in response
716
- # * {boolean} _links - Return resource link in response
717
- # * {boolean} _embedded - Return embedded resources in response
718
- #
719
- # Responses:
720
- # * 200 - If resource transfer was successful (https://api.losant.com/#/definitions/success)
721
- #
722
- # Errors:
723
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
724
- def transfer_resources(params = {})
725
- params = Utils.symbolize_hash_keys(params)
726
- query_params = { _actions: false, _links: true, _embedded: true }
727
- headers = {}
728
- body = nil
729
-
730
- raise ArgumentError.new("transfer is required") unless params.has_key?(:transfer)
731
-
732
- body = params[:transfer] if params.has_key?(:transfer)
733
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
734
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
735
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
736
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
737
-
738
- path = "/me/transferResources"
739
-
740
- @client.request(
741
- method: :patch,
742
- path: path,
743
- query: query_params,
744
- headers: headers,
745
- body: body)
746
- end
747
-
748
- # Sends an email verification to the user
749
- #
750
- # Authentication:
751
- # The client must be configured with a valid api
752
- # access token to call this action. The token
753
- # must include at least one of the following scopes:
754
- # all.User, me.*, or me.verifyEmail.
755
- #
756
- # Parameters:
757
- # * {string} losantdomain - Domain scope of request (rarely needed)
758
- # * {boolean} _actions - Return resource actions in response
759
- # * {boolean} _links - Return resource link in response
760
- # * {boolean} _embedded - Return embedded resources in response
761
- #
762
- # Responses:
763
- # * 200 - If email verification was successfully sent (https://api.losant.com/#/definitions/success)
764
- #
765
- # Errors:
766
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
767
- def verify_email(params = {})
768
- params = Utils.symbolize_hash_keys(params)
769
- query_params = { _actions: false, _links: true, _embedded: true }
770
- headers = {}
771
- body = nil
772
-
773
-
774
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
775
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
776
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
777
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
778
-
779
- path = "/me/verify-email"
780
-
781
- @client.request(
782
- method: :post,
783
- path: path,
784
- query: query_params,
785
- headers: headers,
786
- body: body)
787
- end
788
-
789
- end
790
- end