losant_rest 1.13.0 → 1.13.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (89) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +2317 -650
  3. data/docs/application.md +5 -5
  4. data/docs/applicationApiTokens.md +1 -1
  5. data/docs/applications.md +1 -1
  6. data/docs/dataTable.md +1 -1
  7. data/docs/dataTableRows.md +1 -1
  8. data/docs/dataTables.md +1 -1
  9. data/docs/devices.md +2 -2
  10. data/docs/experience.md +1 -1
  11. data/docs/experienceDomains.md +1 -1
  12. data/docs/experienceGroup.md +2 -0
  13. data/docs/experienceSlugs.md +1 -1
  14. data/docs/experienceVersion.md +3 -3
  15. data/docs/experienceVersions.md +2 -2
  16. data/docs/experienceView.md +4 -4
  17. data/docs/experienceViews.md +2 -2
  18. data/docs/file.md +5 -5
  19. data/docs/files.md +2 -2
  20. data/docs/flowVersions.md +44 -0
  21. data/docs/instance.md +38 -0
  22. data/docs/instanceApiToken.md +133 -0
  23. data/docs/instanceApiTokens.md +91 -0
  24. data/docs/instanceMembers.md +1 -1
  25. data/docs/instanceOrgMembers.md +1 -1
  26. data/docs/userApiToken.md +125 -0
  27. data/docs/userApiTokens.md +87 -0
  28. data/lib/losant_rest.rb +4 -0
  29. data/lib/losant_rest/application.rb +5 -5
  30. data/lib/losant_rest/application_api_tokens.rb +1 -1
  31. data/lib/losant_rest/applications.rb +1 -1
  32. data/lib/losant_rest/client.rb +18 -2
  33. data/lib/losant_rest/data_table.rb +1 -1
  34. data/lib/losant_rest/data_table_rows.rb +1 -1
  35. data/lib/losant_rest/data_tables.rb +1 -1
  36. data/lib/losant_rest/devices.rb +2 -2
  37. data/lib/losant_rest/experience.rb +1 -1
  38. data/lib/losant_rest/experience_domains.rb +1 -1
  39. data/lib/losant_rest/experience_group.rb +4 -0
  40. data/lib/losant_rest/experience_slugs.rb +1 -1
  41. data/lib/losant_rest/experience_version.rb +3 -3
  42. data/lib/losant_rest/experience_versions.rb +2 -2
  43. data/lib/losant_rest/experience_view.rb +4 -4
  44. data/lib/losant_rest/experience_views.rb +2 -2
  45. data/lib/losant_rest/file.rb +4 -4
  46. data/lib/losant_rest/files.rb +2 -2
  47. data/lib/losant_rest/flow_versions.rb +50 -0
  48. data/lib/losant_rest/instance.rb +46 -1
  49. data/lib/losant_rest/instance_api_token.rb +176 -0
  50. data/lib/losant_rest/instance_api_tokens.rb +136 -0
  51. data/lib/losant_rest/instance_member.rb +1 -1
  52. data/lib/losant_rest/instance_members.rb +2 -2
  53. data/lib/losant_rest/instance_org.rb +1 -1
  54. data/lib/losant_rest/instance_org_member.rb +1 -1
  55. data/lib/losant_rest/instance_org_members.rb +2 -2
  56. data/lib/losant_rest/instance_orgs.rb +1 -1
  57. data/lib/losant_rest/instances.rb +1 -1
  58. data/lib/losant_rest/user_api_token.rb +170 -0
  59. data/lib/losant_rest/user_api_tokens.rb +132 -0
  60. data/lib/losant_rest/version.rb +1 -1
  61. data/schemas/apiToken.json +2 -1
  62. data/schemas/apiTokenPost.json +420 -0
  63. data/schemas/apiTokens.json +4 -2
  64. data/schemas/applicationDashboardPost.json +20 -16
  65. data/schemas/auditLog.json +4 -0
  66. data/schemas/auditLogFilter.json +4 -0
  67. data/schemas/auditLogs.json +4 -0
  68. data/schemas/bulkDeleteResponse.json +12 -0
  69. data/schemas/dashboard.json +20 -16
  70. data/schemas/dashboardPatch.json +20 -16
  71. data/schemas/dashboardPost.json +20 -16
  72. data/schemas/dashboardSendReport.json +4 -0
  73. data/schemas/dashboards.json +20 -16
  74. data/schemas/experienceGroup.json +6 -0
  75. data/schemas/experienceGroups.json +6 -0
  76. data/schemas/flowVersionsDeletePost.json +941 -0
  77. data/schemas/githubLogin.json +19 -1
  78. data/schemas/historicalSummary.json +3 -0
  79. data/schemas/instance.json +60 -0
  80. data/schemas/instanceOrgPost.json +166 -0
  81. data/schemas/instancePatch.json +67 -0
  82. data/schemas/instanceReportOptionsPost.json +1 -0
  83. data/schemas/notebook.json +15 -0
  84. data/schemas/notebooks.json +15 -0
  85. data/schemas/userCredentials.json +19 -1
  86. data/schemas/userPost.json +19 -1
  87. data/schemas/validateContextError.json +34 -0
  88. data/schemas/validateContextSuccess.json +34 -0
  89. metadata +15 -3
data/schemas/githubLogin.json CHANGED
@@ -19,6 +19,7 @@
19
19
  "enum": [
20
20
  "all.Application",
21
21
  "all.Application.read",
22
+ "all.Application.cli",
22
23
  "all.Device",
23
24
  "all.Device.read",
24
25
  "application.*",
@@ -250,6 +251,7 @@
250
251
  "flowVersion.log",
251
252
  "flowVersion.patch",
252
253
  "flowVersion.stats",
254
+ "flowVersions.delete",
253
255
  "flowVersions.get",
254
256
  "flowVersions.post",
255
257
  "integration.delete",
@@ -319,6 +321,7 @@
319
321
  "all.Instance.read",
320
322
  "instance.*",
321
323
  "instance.get",
324
+ "instance.patch",
322
325
  "instance.historicalSummaries",
323
326
  "instance.generateReport",
324
327
  "instanceOrg.*",
@@ -341,7 +344,14 @@
341
344
  "instanceOrgMember.delete",
342
345
  "instanceOrgMembers.*",
343
346
  "instanceOrgMembers.get",
344
- "instanceOrgMembers.post"
347
+ "instanceOrgMembers.post",
348
+ "instanceApiTokens.*",
349
+ "instanceApiTokens.get",
350
+ "instanceApiTokens.post",
351
+ "instanceApiToken.*",
352
+ "instanceApiToken.get",
353
+ "instanceApiToken.patch",
354
+ "instanceApiToken.delete"
345
355
  ]
346
356
  },
347
357
  {
@@ -349,6 +359,14 @@
349
359
  "enum": [
350
360
  "all.User",
351
361
  "all.User.read",
362
+ "all.User.cli",
363
+ "userApiToken.*",
364
+ "userApiToken.get",
365
+ "userApiToken.patch",
366
+ "userApiToken.delete",
367
+ "userApiTokens.*",
368
+ "userApiTokens.get",
369
+ "userApiTokens.post",
352
370
  "applicationTemplate.*",
353
371
  "applicationTemplate.get",
354
372
  "applicationTemplates.*",
data/schemas/historicalSummary.json CHANGED
@@ -150,6 +150,9 @@
150
150
  "dashboardCount": {
151
151
  "type": "number"
152
152
  },
153
+ "dashboardCountProrated": {
154
+ "type": "number"
155
+ },
153
156
  "dataTableCount": {
154
157
  "type": "number"
155
158
  },
data/schemas/instance.json CHANGED
@@ -26,6 +26,66 @@
26
26
  "allowAuditLogging": {
27
27
  "type": "boolean"
28
28
  },
29
+ "reportConfigs": {
30
+ "type": "array",
31
+ "items": {
32
+ "type": "object",
33
+ "max": 10,
34
+ "properties": {
35
+ "id": {
36
+ "type": "string",
37
+ "maxLength": 48
38
+ },
39
+ "cron": {
40
+ "type": "string",
41
+ "maxLength": 255
42
+ },
43
+ "timezone": {
44
+ "type": "string",
45
+ "maxLength": 255
46
+ },
47
+ "emails": {
48
+ "type": "array",
49
+ "max": 10,
50
+ "items": {
51
+ "type": "string",
52
+ "format": "email",
53
+ "maxLength": 1024
54
+ }
55
+ },
56
+ "callbackUrl": {
57
+ "type": "string",
58
+ "maxLength": 1024
59
+ },
60
+ "resourceGroupBy": {
61
+ "type": "string",
62
+ "enum": [
63
+ "application",
64
+ "organization"
65
+ ]
66
+ },
67
+ "dateGroupBy": {
68
+ "type": "string",
69
+ "enum": [
70
+ "day",
71
+ "month"
72
+ ]
73
+ },
74
+ "periods": {
75
+ "type": "integer",
76
+ "minimum": 1,
77
+ "maximum": 90
78
+ },
79
+ "includeSandbox": {
80
+ "type": "boolean"
81
+ }
82
+ },
83
+ "required": [
84
+ "cron"
85
+ ],
86
+ "additionalProperties": false
87
+ }
88
+ },
29
89
  "limits": {
30
90
  "organization": {
31
91
  "type": "number"
data/schemas/instanceOrgPost.json CHANGED
@@ -95,6 +95,172 @@
95
95
  }
96
96
  }
97
97
  },
98
+ "members": {
99
+ "type": "array",
100
+ "max": "10",
101
+ "items": {
102
+ "title": "Instance Org Member Post",
103
+ "description": "Schema for an Instance Organization member creation request",
104
+ "oneOf": [
105
+ {
106
+ "type": "object",
107
+ "properties": {
108
+ "userId": {
109
+ "type": "string",
110
+ "pattern": "^[A-Fa-f\\d]{24}$"
111
+ },
112
+ "role": {
113
+ "type": "string",
114
+ "enum": [
115
+ "admin",
116
+ "edit",
117
+ "collaborate",
118
+ "view",
119
+ "none"
120
+ ]
121
+ },
122
+ "applicationRoles": {
123
+ "type": "array",
124
+ "items": {
125
+ "type": "object",
126
+ "properties": {
127
+ "resourceId": {
128
+ "type": "string",
129
+ "pattern": "^[A-Fa-f\\d]{24}$"
130
+ },
131
+ "role": {
132
+ "type": "string",
133
+ "enum": [
134
+ "collaborate",
135
+ "view",
136
+ "none"
137
+ ]
138
+ }
139
+ },
140
+ "required": [
141
+ "resourceId",
142
+ "role"
143
+ ],
144
+ "additionalProperties": false
145
+ },
146
+ "maxItems": 1000
147
+ },
148
+ "dashboardRoles": {
149
+ "type": "array",
150
+ "items": {
151
+ "type": "object",
152
+ "properties": {
153
+ "resourceId": {
154
+ "type": "string",
155
+ "pattern": "^[A-Fa-f\\d]{24}$"
156
+ },
157
+ "role": {
158
+ "type": "string",
159
+ "enum": [
160
+ "collaborate",
161
+ "view",
162
+ "none"
163
+ ]
164
+ }
165
+ },
166
+ "required": [
167
+ "resourceId",
168
+ "role"
169
+ ],
170
+ "additionalProperties": false
171
+ },
172
+ "maxItems": 1000
173
+ }
174
+ },
175
+ "additionalProperties": false,
176
+ "required": [
177
+ "userId",
178
+ "role"
179
+ ]
180
+ },
181
+ {
182
+ "type": "object",
183
+ "properties": {
184
+ "email": {
185
+ "type": "string",
186
+ "format": "email",
187
+ "maxLength": 1024
188
+ },
189
+ "role": {
190
+ "type": "string",
191
+ "enum": [
192
+ "admin",
193
+ "edit",
194
+ "collaborate",
195
+ "view",
196
+ "none"
197
+ ]
198
+ },
199
+ "applicationRoles": {
200
+ "type": "array",
201
+ "items": {
202
+ "type": "object",
203
+ "properties": {
204
+ "resourceId": {
205
+ "type": "string",
206
+ "pattern": "^[A-Fa-f\\d]{24}$"
207
+ },
208
+ "role": {
209
+ "type": "string",
210
+ "enum": [
211
+ "collaborate",
212
+ "view",
213
+ "none"
214
+ ]
215
+ }
216
+ },
217
+ "required": [
218
+ "resourceId",
219
+ "role"
220
+ ],
221
+ "additionalProperties": false
222
+ },
223
+ "maxItems": 1000
224
+ },
225
+ "dashboardRoles": {
226
+ "type": "array",
227
+ "items": {
228
+ "type": "object",
229
+ "properties": {
230
+ "resourceId": {
231
+ "type": "string",
232
+ "pattern": "^[A-Fa-f\\d]{24}$"
233
+ },
234
+ "role": {
235
+ "type": "string",
236
+ "enum": [
237
+ "collaborate",
238
+ "view",
239
+ "none"
240
+ ]
241
+ }
242
+ },
243
+ "required": [
244
+ "resourceId",
245
+ "role"
246
+ ],
247
+ "additionalProperties": false
248
+ },
249
+ "maxItems": 1000
250
+ },
251
+ "disallowTransfer": {
252
+ "type": "boolean"
253
+ }
254
+ },
255
+ "additionalProperties": false,
256
+ "required": [
257
+ "email",
258
+ "role"
259
+ ]
260
+ }
261
+ ]
262
+ }
263
+ },
98
264
  "whitelistedEmailDomains": {
99
265
  "type": "array",
100
266
  "items": {
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 CHANGED
@@ -21,6 +21,7 @@
21
21
  "dateGroupBy": {
22
22
  "type": "string",
23
23
  "enum": [
24
+ "day",
24
25
  "month"
25
26
  ]
26
27
  },
data/schemas/notebook.json CHANGED
@@ -611,6 +611,21 @@
611
611
  }
612
612
  ]
613
613
  }
614
+ },
615
+ "stats": {
616
+ "type": "object",
617
+ "properties": {
618
+ "minutesThisPeriod": {
619
+ "type": "number"
620
+ },
621
+ "runsThisPeriod": {
622
+ "type": "number"
623
+ },
624
+ "errorsThisPeriod": {
625
+ "type": "number"
626
+ }
627
+ },
628
+ "additionalProperties": false
614
629
  }
615
630
  }
616
631
  }
data/schemas/notebooks.json CHANGED
@@ -618,6 +618,21 @@
618
618
  }
619
619
  ]
620
620
  }
621
+ },
622
+ "stats": {
623
+ "type": "object",
624
+ "properties": {
625
+ "minutesThisPeriod": {
626
+ "type": "number"
627
+ },
628
+ "runsThisPeriod": {
629
+ "type": "number"
630
+ },
631
+ "errorsThisPeriod": {
632
+ "type": "number"
633
+ }
634
+ },
635
+ "additionalProperties": false
621
636
  }
622
637
  }
623
638
  }
data/schemas/userCredentials.json CHANGED
@@ -28,6 +28,7 @@
28
28
  "enum": [
29
29
  "all.Application",
30
30
  "all.Application.read",
31
+ "all.Application.cli",
31
32
  "all.Device",
32
33
  "all.Device.read",
33
34
  "application.*",
@@ -259,6 +260,7 @@
259
260
  "flowVersion.log",
260
261
  "flowVersion.patch",
261
262
  "flowVersion.stats",
263
+ "flowVersions.delete",
262
264
  "flowVersions.get",
263
265
  "flowVersions.post",
264
266
  "integration.delete",
@@ -328,6 +330,7 @@
328
330
  "all.Instance.read",
329
331
  "instance.*",
330
332
  "instance.get",
333
+ "instance.patch",
331
334
  "instance.historicalSummaries",
332
335
  "instance.generateReport",
333
336
  "instanceOrg.*",
@@ -350,7 +353,14 @@
350
353
  "instanceOrgMember.delete",
351
354
  "instanceOrgMembers.*",
352
355
  "instanceOrgMembers.get",
353
- "instanceOrgMembers.post"
356
+ "instanceOrgMembers.post",
357
+ "instanceApiTokens.*",
358
+ "instanceApiTokens.get",
359
+ "instanceApiTokens.post",
360
+ "instanceApiToken.*",
361
+ "instanceApiToken.get",
362
+ "instanceApiToken.patch",
363
+ "instanceApiToken.delete"
354
364
  ]
355
365
  },
356
366
  {
@@ -358,6 +368,14 @@
358
368
  "enum": [
359
369
  "all.User",
360
370
  "all.User.read",
371
+ "all.User.cli",
372
+ "userApiToken.*",
373
+ "userApiToken.get",
374
+ "userApiToken.patch",
375
+ "userApiToken.delete",
376
+ "userApiTokens.*",
377
+ "userApiTokens.get",
378
+ "userApiTokens.post",
361
379
  "applicationTemplate.*",
362
380
  "applicationTemplate.get",
363
381
  "applicationTemplates.*",