losant_rest 1.19.4 → 1.19.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 290872b441c2d0c25ae6f96c0478f828fac67ce601fd775ca4f57a13c24e800d
4
- data.tar.gz: f8f59d360a74a0c0c0ddb000e02cb2c9c0a19f598a3c3ff4bd7c4421b2209868
3
+ metadata.gz: 8eff8a92a173bce4e3fce2590775a7446146c18a1960fc2e0aa40fe6701c3f6e
4
+ data.tar.gz: c7808635ff3bcce9ffe4806196d8a6ed735106ce642d19bfbf92a5980ab6bf32
5
5
  SHA512:
6
- metadata.gz: b0b75679785a3856db495be7b12184e7023fe5be36825b8abe76056b495ec7d9de21ce1ee5d98c815198524f4a59f304e110e73bb8f87c10adb3a371584018f8
7
- data.tar.gz: 2cde825988d5ec40144ab9a0e881e7a82ff69dd90744d1299cba31dcebc690220469b911112e7496b4a574a629ddaf10983e72113f239d3d76143c08a1585345
6
+ metadata.gz: 2a645538e8fc373af09bd747e36b35024f0e875cb4ee77036ded298ec5062bd1a3aef6423739fa9878c849f8fdec7b62409849d5b16b0043b7c818768dd0d5be
7
+ data.tar.gz: f72cc2a295e3f37b875655aa2869bc13e56e6dec21be1321c868b266ef208146c537c2636a8b8465041aee4284ff7903f7fed4f4c608f3dc8967116534dcd1d0
data/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) 2023 Losant IoT, Inc.
3
+ Copyright (c) 2024 Losant IoT, Inc.
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
data/README.md CHANGED
@@ -25,17 +25,17 @@ Below is a high-level example of using the Losant Ruby REST API client to authen
25
25
  ```ruby
26
26
  require "losant_rest"
27
27
 
28
- response = LosantRest.auth.authenticate_device(credentials: {
28
+ response = PlatformRest.auth.authenticate_device(credentials: {
29
29
  deviceId: "my-device-id",
30
30
  key: "my-app-access-key",
31
31
  secret: "my-app-access-secret"
32
32
  })
33
33
 
34
- LosantRest.auth_token = response["token"]
34
+ PlatformRest.auth_token = response["token"]
35
35
  app_id = response["applicationId"]
36
36
 
37
37
  state = { data: { temperature: AnalogSensor.read } }
38
- response = LosantRest.device.send_state(deviceId: "my-device-id",
38
+ response = PlatformRest.device.send_state(deviceId: "my-device-id",
39
39
  applicationId: app_id, deviceState: state)
40
40
 
41
41
  puts response
@@ -46,13 +46,13 @@ puts response
46
46
 
47
47
  ## API Documentation
48
48
 
49
- ### LosantRest
49
+ ### PlatformRest
50
50
 
51
- LosantRest is the wrapping module, but it also acts as a singleton [Client](#losantrestclient) instance. So if you only need a single client instance, you do not need to instantiate one yourself - the LosantRest module will act exactly like an instance of LosantRest::Client.
51
+ PlatformRest is the wrapping module, but it also acts as a singleton [Client](#PlatformRestclient) instance. So if you only need a single client instance, you do not need to instantiate one yourself - the PlatformRest module will act exactly like an instance of PlatformRest::Client.
52
52
 
53
53
  <br/>
54
54
 
55
- ### LosantRest::Client
55
+ ### PlatformRest::Client
56
56
 
57
57
  A client is a single api instance. By default, it is unauthenticated, but can
58
58
  be given an access token to perform authenticated requests.
@@ -60,7 +60,7 @@ be given an access token to perform authenticated requests.
60
60
  #### Initializer
61
61
 
62
62
  ```ruby
63
- LosantRest::Client.new(auth_token: nil, url: "https://api.losant.com")
63
+ PlatformRest::Client.new(auth_token: nil, url: "https://api.losant.com")
64
64
  ```
65
65
 
66
66
  The ``Client()`` initializer takes the following arguments:
@@ -232,7 +232,7 @@ Each of the following is a method on the client object, and returns a wrapper fo
232
232
 
233
233
  <br/>
234
234
 
235
- ### LosantRest::ResponseError
235
+ ### PlatformRest::ResponseError
236
236
 
237
237
  When the Losant API returns a unsuccessful response, an instance of ResponseError is thrown.
238
238
 
@@ -251,6 +251,6 @@ When the Losant API returns a unsuccessful response, an instance of ResponseErro
251
251
 
252
252
  *****
253
253
 
254
- Copyright (c) 2023 Losant IoT, Inc
254
+ Copyright (c) 2024 Losant IoT, Inc
255
255
 
256
256
  <https://www.losant.com>