losant_rest 1.11.1 → 1.14.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (213) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/docs/_schemas.md +34959 -19022
  5. data/docs/application.md +46 -5
  6. data/docs/applicationApiTokens.md +1 -1
  7. data/docs/applicationDashboard.md +133 -0
  8. data/docs/applicationDashboards.md +93 -0
  9. data/docs/applicationKeys.md +3 -2
  10. data/docs/applications.md +1 -1
  11. data/docs/dataTable.md +1 -1
  12. data/docs/dataTableRows.md +1 -1
  13. data/docs/dataTables.md +1 -1
  14. data/docs/device.md +43 -0
  15. data/docs/devices.md +41 -2
  16. data/docs/edgeDeployment.md +49 -0
  17. data/docs/events.md +3 -3
  18. data/docs/experience.md +1 -1
  19. data/docs/experienceDomains.md +1 -1
  20. data/docs/experienceEndpoint.md +1 -0
  21. data/docs/experienceGroup.md +2 -0
  22. data/docs/experienceSlugs.md +1 -1
  23. data/docs/experienceVersion.md +3 -3
  24. data/docs/experienceVersions.md +2 -2
  25. data/docs/experienceView.md +4 -4
  26. data/docs/experienceViews.md +2 -2
  27. data/docs/file.md +5 -5
  28. data/docs/files.md +2 -2
  29. data/docs/flow.md +41 -0
  30. data/docs/flowVersions.md +44 -0
  31. data/docs/flows.md +1 -0
  32. data/docs/instance.md +166 -0
  33. data/docs/instanceApiToken.md +133 -0
  34. data/docs/instanceApiTokens.md +91 -0
  35. data/docs/instanceMember.md +133 -0
  36. data/docs/instanceMembers.md +91 -0
  37. data/docs/instanceOrg.md +135 -0
  38. data/docs/instanceOrgInvite.md +139 -0
  39. data/docs/instanceOrgInvites.md +96 -0
  40. data/docs/instanceOrgMember.md +139 -0
  41. data/docs/instanceOrgMembers.md +96 -0
  42. data/docs/instanceOrgs.md +91 -0
  43. data/docs/instances.md +50 -0
  44. data/docs/integration.md +1 -0
  45. data/docs/me.md +1 -1
  46. data/docs/org.md +1 -1
  47. data/docs/userApiToken.md +125 -0
  48. data/docs/userApiTokens.md +87 -0
  49. data/docs/webhook.md +1 -0
  50. data/lib/losant_rest.rb +18 -1
  51. data/lib/losant_rest/application.rb +53 -6
  52. data/lib/losant_rest/application_api_token.rb +1 -1
  53. data/lib/losant_rest/application_api_tokens.rb +2 -2
  54. data/lib/losant_rest/application_certificate.rb +1 -1
  55. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  56. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  57. data/lib/losant_rest/application_certificates.rb +1 -1
  58. data/lib/losant_rest/application_dashboard.rb +176 -0
  59. data/lib/losant_rest/application_dashboards.rb +138 -0
  60. data/lib/losant_rest/application_key.rb +1 -1
  61. data/lib/losant_rest/application_keys.rb +4 -1
  62. data/lib/losant_rest/application_template.rb +1 -1
  63. data/lib/losant_rest/application_templates.rb +1 -1
  64. data/lib/losant_rest/applications.rb +2 -2
  65. data/lib/losant_rest/audit_log.rb +1 -1
  66. data/lib/losant_rest/audit_logs.rb +1 -1
  67. data/lib/losant_rest/auth.rb +1 -1
  68. data/lib/losant_rest/client.rb +71 -3
  69. data/lib/losant_rest/dashboard.rb +1 -1
  70. data/lib/losant_rest/dashboards.rb +1 -1
  71. data/lib/losant_rest/data.rb +1 -1
  72. data/lib/losant_rest/data_table.rb +2 -2
  73. data/lib/losant_rest/data_table_row.rb +1 -1
  74. data/lib/losant_rest/data_table_rows.rb +2 -2
  75. data/lib/losant_rest/data_tables.rb +2 -2
  76. data/lib/losant_rest/device.rb +51 -1
  77. data/lib/losant_rest/device_recipe.rb +1 -1
  78. data/lib/losant_rest/device_recipes.rb +1 -1
  79. data/lib/losant_rest/devices.rb +49 -3
  80. data/lib/losant_rest/edge_deployment.rb +81 -0
  81. data/lib/losant_rest/edge_deployments.rb +1 -1
  82. data/lib/losant_rest/error.rb +1 -1
  83. data/lib/losant_rest/event.rb +1 -1
  84. data/lib/losant_rest/events.rb +4 -4
  85. data/lib/losant_rest/experience.rb +2 -2
  86. data/lib/losant_rest/experience_domain.rb +1 -1
  87. data/lib/losant_rest/experience_domains.rb +2 -2
  88. data/lib/losant_rest/experience_endpoint.rb +3 -1
  89. data/lib/losant_rest/experience_endpoints.rb +1 -1
  90. data/lib/losant_rest/experience_group.rb +5 -1
  91. data/lib/losant_rest/experience_groups.rb +1 -1
  92. data/lib/losant_rest/experience_slug.rb +1 -1
  93. data/lib/losant_rest/experience_slugs.rb +2 -2
  94. data/lib/losant_rest/experience_user.rb +1 -1
  95. data/lib/losant_rest/experience_users.rb +1 -1
  96. data/lib/losant_rest/experience_version.rb +4 -4
  97. data/lib/losant_rest/experience_versions.rb +3 -3
  98. data/lib/losant_rest/experience_view.rb +5 -5
  99. data/lib/losant_rest/experience_views.rb +3 -3
  100. data/lib/losant_rest/file.rb +5 -5
  101. data/lib/losant_rest/files.rb +3 -3
  102. data/lib/losant_rest/flow.rb +47 -1
  103. data/lib/losant_rest/flow_version.rb +1 -1
  104. data/lib/losant_rest/flow_versions.rb +51 -1
  105. data/lib/losant_rest/flows.rb +3 -1
  106. data/lib/losant_rest/instance.rb +226 -0
  107. data/lib/losant_rest/instance_api_token.rb +176 -0
  108. data/lib/losant_rest/instance_api_tokens.rb +136 -0
  109. data/lib/losant_rest/instance_member.rb +176 -0
  110. data/lib/losant_rest/instance_members.rb +134 -0
  111. data/lib/losant_rest/instance_org.rb +180 -0
  112. data/lib/losant_rest/instance_org_invite.rb +182 -0
  113. data/lib/losant_rest/instance_org_invites.rb +138 -0
  114. data/lib/losant_rest/instance_org_member.rb +182 -0
  115. data/lib/losant_rest/instance_org_members.rb +138 -0
  116. data/lib/losant_rest/instance_orgs.rb +139 -0
  117. data/lib/losant_rest/instances.rb +88 -0
  118. data/lib/losant_rest/integration.rb +3 -1
  119. data/lib/losant_rest/integrations.rb +1 -1
  120. data/lib/losant_rest/me.rb +2 -2
  121. data/lib/losant_rest/notebook.rb +1 -1
  122. data/lib/losant_rest/notebooks.rb +1 -1
  123. data/lib/losant_rest/org.rb +2 -2
  124. data/lib/losant_rest/org_invites.rb +1 -1
  125. data/lib/losant_rest/orgs.rb +1 -1
  126. data/lib/losant_rest/user_api_token.rb +170 -0
  127. data/lib/losant_rest/user_api_tokens.rb +132 -0
  128. data/lib/losant_rest/utils.rb +1 -1
  129. data/lib/losant_rest/version.rb +2 -2
  130. data/lib/losant_rest/webhook.rb +3 -1
  131. data/lib/losant_rest/webhooks.rb +1 -1
  132. data/schemas/advancedApplicationKeyQuery.json +1082 -0
  133. data/schemas/advancedDeviceQuery.json +309 -0
  134. data/schemas/advancedFlowQuery.json +218 -0
  135. data/schemas/advancedFlowVersionQuery.json +218 -0
  136. data/schemas/apiToken.json +2 -1
  137. data/schemas/apiTokenPost.json +431 -0
  138. data/schemas/apiTokens.json +4 -2
  139. data/schemas/applicationApiTokenPost.json +8 -0
  140. data/schemas/applicationDashboardPost.json +5687 -0
  141. data/schemas/applicationGlobalPatch.json +33 -0
  142. data/schemas/auditLog.json +4 -0
  143. data/schemas/auditLogFilter.json +4 -0
  144. data/schemas/auditLogs.json +4 -0
  145. data/schemas/bulkDeleteResponse.json +12 -0
  146. data/schemas/dashboard.json +66 -17
  147. data/schemas/dashboardPatch.json +66 -17
  148. data/schemas/dashboardPost.json +66 -17
  149. data/schemas/dashboardSendReport.json +4 -0
  150. data/schemas/dashboards.json +66 -17
  151. data/schemas/devicePayloadCounts.json +24 -0
  152. data/schemas/devicesDeletePost.json +309 -0
  153. data/schemas/devicesExportPayloadCountPost.json +1350 -0
  154. data/schemas/devicesExportPost.json +309 -0
  155. data/schemas/devicesPatch.json +309 -0
  156. data/schemas/devicesRemoveDataPost.json +309 -0
  157. data/schemas/edgeDeployment.json +16 -0
  158. data/schemas/edgeDeployments.json +16 -0
  159. data/schemas/experienceGroup.json +6 -0
  160. data/schemas/experienceGroups.json +6 -0
  161. data/schemas/experienceLinkedResources.json +45 -0
  162. data/schemas/filePost.json +8 -2
  163. data/schemas/files.json +3 -0
  164. data/schemas/flow.json +15 -0
  165. data/schemas/flowPatch.json +15 -0
  166. data/schemas/flowPost.json +15 -0
  167. data/schemas/flowStorageMetadata.json +13 -0
  168. data/schemas/flowVersion.json +30 -0
  169. data/schemas/flowVersionPost.json +15 -0
  170. data/schemas/flowVersions.json +30 -0
  171. data/schemas/flowVersionsDeletePost.json +941 -0
  172. data/schemas/flows.json +15 -0
  173. data/schemas/flowsImportPost.json +30 -0
  174. data/schemas/flowsImportResult.json +45 -0
  175. data/schemas/githubLogin.json +72 -1
  176. data/schemas/historicalSummaries.json +43 -0
  177. data/schemas/historicalSummary.json +490 -0
  178. data/schemas/instance.json +192 -0
  179. data/schemas/instanceMember.json +41 -0
  180. data/schemas/instanceMemberPatch.json +17 -0
  181. data/schemas/instanceMemberPost.json +37 -0
  182. data/schemas/instanceMembers.json +77 -0
  183. data/schemas/instanceOrg.json +133 -0
  184. data/schemas/instanceOrgMember.json +45 -0
  185. data/schemas/instanceOrgMemberPatch.json +69 -0
  186. data/schemas/instanceOrgMemberPost.json +161 -0
  187. data/schemas/instanceOrgMembers.json +42 -0
  188. data/schemas/instanceOrgPatch.json +122 -0
  189. data/schemas/instanceOrgPost.json +291 -0
  190. data/schemas/instanceOrgs.json +178 -0
  191. data/schemas/instancePatch.json +67 -0
  192. data/schemas/instanceReportOptionsPost.json +41 -0
  193. data/schemas/instances.json +43 -0
  194. data/schemas/me.json +30 -14
  195. data/schemas/multiDeviceCommand.json +309 -0
  196. data/schemas/notebook.json +45 -0
  197. data/schemas/notebookPatch.json +30 -0
  198. data/schemas/notebookPost.json +30 -0
  199. data/schemas/notebooks.json +45 -0
  200. data/schemas/org.json +30 -14
  201. data/schemas/orgInvite.json +90 -0
  202. data/schemas/orgInviteCollection.json +130 -0
  203. data/schemas/orgInvites.json +82 -77
  204. data/schemas/orgPatch.json +0 -9
  205. data/schemas/orgRoleInfo.json +69 -0
  206. data/schemas/orgs.json +30 -14
  207. data/schemas/payloadStats.json +126 -0
  208. data/schemas/userCredentials.json +72 -1
  209. data/schemas/userPost.json +72 -1
  210. data/schemas/validateContextError.json +34 -0
  211. data/schemas/validateContextSuccess.json +34 -0
  212. data/schemas/virtualButtonPress.json +4 -0
  213. metadata +68 -3
data/schemas/instanceOrgs.json ADDED
@@ -0,0 +1,178 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "title": "Instance Organization",
9
+ "description": "Schema for the body of an Organization owned by an instance",
10
+ "type": "object",
11
+ "properties": {
12
+ "name": {
13
+ "type": "string",
14
+ "minLength": 1,
15
+ "maxLength": 255
16
+ },
17
+ "id": {
18
+ "type": "string",
19
+ "pattern": "^[A-Fa-f\\d]{24}$"
20
+ },
21
+ "instanceId": {
22
+ "type": "string",
23
+ "pattern": "^[A-Fa-f\\d]{24}$"
24
+ },
25
+ "description": {
26
+ "type": "string",
27
+ "maxLength": 32767
28
+ },
29
+ "iconColor": {
30
+ "type": "string",
31
+ "maxLength": 64
32
+ },
33
+ "limits": {
34
+ "apitoken": {
35
+ "type": "number"
36
+ },
37
+ "application": {
38
+ "type": "number"
39
+ },
40
+ "applicationkey": {
41
+ "type": "number"
42
+ },
43
+ "dashboard": {
44
+ "type": "number"
45
+ },
46
+ "datatable": {
47
+ "type": "number"
48
+ },
49
+ "device": {
50
+ "type": "number"
51
+ },
52
+ "devicerecipe": {
53
+ "type": "number"
54
+ },
55
+ "experiencedomain": {
56
+ "type": "number"
57
+ },
58
+ "experienceendpoint": {
59
+ "type": "number"
60
+ },
61
+ "experiencegroup": {
62
+ "type": "number"
63
+ },
64
+ "experienceslug": {
65
+ "type": "number"
66
+ },
67
+ "experienceuser": {
68
+ "type": "number"
69
+ },
70
+ "experienceversion": {
71
+ "type": "number"
72
+ },
73
+ "experienceview": {
74
+ "type": "number"
75
+ },
76
+ "file": {
77
+ "type": "number"
78
+ },
79
+ "flow": {
80
+ "type": "number"
81
+ },
82
+ "integration": {
83
+ "type": "number"
84
+ },
85
+ "notebook": {
86
+ "type": "number"
87
+ },
88
+ "webhook": {
89
+ "type": "number"
90
+ },
91
+ "dataTTL": {
92
+ "type": "number"
93
+ },
94
+ "member": {
95
+ "type": "number"
96
+ },
97
+ "payload": {
98
+ "type": "number"
99
+ },
100
+ "notebookMinutesPerRun": {
101
+ "type": "number"
102
+ },
103
+ "notebookMinutesPerMonth": {
104
+ "type": "number"
105
+ },
106
+ "notebookInParallel": {
107
+ "type": "number"
108
+ }
109
+ },
110
+ "whitelistedEmailDomains": {
111
+ "type": "array",
112
+ "items": {
113
+ "type": "string",
114
+ "maxLength": 45,
115
+ "minLength": 3
116
+ }
117
+ },
118
+ "auditLogEnabled": {
119
+ "type": "boolean"
120
+ },
121
+ "disabledAt": {
122
+ "oneOf": [
123
+ {
124
+ "type": "boolean",
125
+ "enum": [
126
+ false
127
+ ]
128
+ },
129
+ {
130
+ "type": "string",
131
+ "format": "date-time"
132
+ }
133
+ ]
134
+ }
135
+ },
136
+ "additionalProperties": false,
137
+ "required": [
138
+ "name"
139
+ ]
140
+ }
141
+ },
142
+ "instanceId": {
143
+ "type": "string",
144
+ "pattern": "^[A-Fa-f\\d]{24}$"
145
+ },
146
+ "count": {
147
+ "type": "integer"
148
+ },
149
+ "totalCount": {
150
+ "type": "integer"
151
+ },
152
+ "perPage": {
153
+ "type": "integer"
154
+ },
155
+ "page": {
156
+ "type": "integer"
157
+ },
158
+ "filter": {
159
+ "type": "string"
160
+ },
161
+ "filterField": {
162
+ "type": "string"
163
+ },
164
+ "sortField": {
165
+ "type": "string"
166
+ },
167
+ "sortDirection": {
168
+ "type": "string",
169
+ "enum": [
170
+ "asc",
171
+ "desc",
172
+ "ASC",
173
+ "DESC",
174
+ ""
175
+ ]
176
+ }
177
+ }
178
+ }
data/schemas/instancePatch.json ADDED
@@ -0,0 +1,67 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "reportConfigs": {
6
+ "type": "array",
7
+ "items": {
8
+ "type": "object",
9
+ "max": 10,
10
+ "properties": {
11
+ "id": {
12
+ "type": "string",
13
+ "maxLength": 48
14
+ },
15
+ "cron": {
16
+ "type": "string",
17
+ "maxLength": 255
18
+ },
19
+ "timezone": {
20
+ "type": "string",
21
+ "maxLength": 255
22
+ },
23
+ "emails": {
24
+ "type": "array",
25
+ "max": 10,
26
+ "items": {
27
+ "type": "string",
28
+ "format": "email",
29
+ "maxLength": 1024
30
+ }
31
+ },
32
+ "callbackUrl": {
33
+ "type": "string",
34
+ "maxLength": 1024
35
+ },
36
+ "resourceGroupBy": {
37
+ "type": "string",
38
+ "enum": [
39
+ "application",
40
+ "organization"
41
+ ]
42
+ },
43
+ "dateGroupBy": {
44
+ "type": "string",
45
+ "enum": [
46
+ "day",
47
+ "month"
48
+ ]
49
+ },
50
+ "periods": {
51
+ "type": "integer",
52
+ "minimum": 1,
53
+ "maximum": 90
54
+ },
55
+ "includeSandbox": {
56
+ "type": "boolean"
57
+ }
58
+ },
59
+ "required": [
60
+ "cron"
61
+ ],
62
+ "additionalProperties": false
63
+ }
64
+ }
65
+ },
66
+ "additionalProperties": false
67
+ }
data/schemas/instanceReportOptionsPost.json ADDED
@@ -0,0 +1,41 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "email": {
6
+ "type": "string",
7
+ "format": "email",
8
+ "maxLength": 1024
9
+ },
10
+ "callbackUrl": {
11
+ "type": "string",
12
+ "maxLength": 1024
13
+ },
14
+ "resourceGroupBy": {
15
+ "type": "string",
16
+ "enum": [
17
+ "application",
18
+ "organization"
19
+ ]
20
+ },
21
+ "dateGroupBy": {
22
+ "type": "string",
23
+ "enum": [
24
+ "day",
25
+ "month"
26
+ ]
27
+ },
28
+ "includeSandbox": {
29
+ "type": "boolean"
30
+ },
31
+ "start": {
32
+ "type": "string",
33
+ "format": "date-time"
34
+ },
35
+ "end": {
36
+ "type": "string",
37
+ "format": "date-time"
38
+ }
39
+ },
40
+ "additionalProperties": false
41
+ }
data/schemas/instances.json ADDED
@@ -0,0 +1,43 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "type": "#/definitions/instance"
9
+ }
10
+ },
11
+ "count": {
12
+ "type": "integer"
13
+ },
14
+ "totalCount": {
15
+ "type": "integer"
16
+ },
17
+ "perPage": {
18
+ "type": "integer"
19
+ },
20
+ "page": {
21
+ "type": "integer"
22
+ },
23
+ "filter": {
24
+ "type": "string"
25
+ },
26
+ "filterField": {
27
+ "type": "string"
28
+ },
29
+ "sortField": {
30
+ "type": "string"
31
+ },
32
+ "sortDirection": {
33
+ "type": "string",
34
+ "enum": [
35
+ "asc",
36
+ "desc",
37
+ "ASC",
38
+ "DESC",
39
+ ""
40
+ ]
41
+ }
42
+ }
43
+ }
data/schemas/me.json CHANGED
@@ -323,11 +323,11 @@
323
323
  "type": "number"
324
324
  },
325
325
  "payloadCount": {
326
- "title": "Payload Counts",
327
- "description": "Schema for the result of a payload count request",
326
+ "title": "Payload Stats",
327
+ "description": "Schema for the result of a payload stats request",
328
328
  "type": "object",
329
329
  "properties": {
330
- "mqttOut": {
330
+ "dataTable": {
331
331
  "type": "object",
332
332
  "patternProperties": {
333
333
  ".*": {
@@ -335,7 +335,7 @@
335
335
  }
336
336
  }
337
337
  },
338
- "mqttIn": {
338
+ "deviceCommand": {
339
339
  "type": "object",
340
340
  "patternProperties": {
341
341
  ".*": {
@@ -343,7 +343,15 @@
343
343
  }
344
344
  }
345
345
  },
346
- "dataTable": {
346
+ "deviceConnect": {
347
+ "type": "object",
348
+ "patternProperties": {
349
+ ".*": {
350
+ "type": "number"
351
+ }
352
+ }
353
+ },
354
+ "deviceDisconnect": {
347
355
  "type": "object",
348
356
  "patternProperties": {
349
357
  ".*": {
@@ -359,7 +367,7 @@
359
367
  }
360
368
  }
361
369
  },
362
- "deviceCommand": {
370
+ "endpoint": {
363
371
  "type": "object",
364
372
  "patternProperties": {
365
373
  ".*": {
@@ -367,7 +375,7 @@
367
375
  }
368
376
  }
369
377
  },
370
- "webhook": {
378
+ "event": {
371
379
  "type": "object",
372
380
  "patternProperties": {
373
381
  ".*": {
@@ -375,7 +383,7 @@
375
383
  }
376
384
  }
377
385
  },
378
- "timer": {
386
+ "flowError": {
379
387
  "type": "object",
380
388
  "patternProperties": {
381
389
  ".*": {
@@ -383,7 +391,7 @@
383
391
  }
384
392
  }
385
393
  },
386
- "event": {
394
+ "integration": {
387
395
  "type": "object",
388
396
  "patternProperties": {
389
397
  ".*": {
@@ -391,7 +399,7 @@
391
399
  }
392
400
  }
393
401
  },
394
- "virtualButton": {
402
+ "mqttIn": {
395
403
  "type": "object",
396
404
  "patternProperties": {
397
405
  ".*": {
@@ -399,7 +407,7 @@
399
407
  }
400
408
  }
401
409
  },
402
- "deviceConnect": {
410
+ "mqttOut": {
403
411
  "type": "object",
404
412
  "patternProperties": {
405
413
  ".*": {
@@ -407,7 +415,7 @@
407
415
  }
408
416
  }
409
417
  },
410
- "deviceDisconnect": {
418
+ "notebook": {
411
419
  "type": "object",
412
420
  "patternProperties": {
413
421
  ".*": {
@@ -415,7 +423,7 @@
415
423
  }
416
424
  }
417
425
  },
418
- "endpoint": {
426
+ "timer": {
419
427
  "type": "object",
420
428
  "patternProperties": {
421
429
  ".*": {
@@ -423,7 +431,15 @@
423
431
  }
424
432
  }
425
433
  },
426
- "integration": {
434
+ "virtualButton": {
435
+ "type": "object",
436
+ "patternProperties": {
437
+ ".*": {
438
+ "type": "number"
439
+ }
440
+ }
441
+ },
442
+ "webhook": {
427
443
  "type": "object",
428
444
  "patternProperties": {
429
445
  ".*": {