losant_rest 1.19.8 → 1.20.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (69) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/test.yml +1 -1
  3. data/docs/_schemas.md +9774 -1641
  4. data/lib/platform_rest/client.rb +2 -2
  5. data/lib/platform_rest/version.rb +1 -1
  6. data/losant_rest.gemspec +2 -2
  7. data/schemas/advancedApplicationKeyQuery.json +360 -18
  8. data/schemas/advancedDeviceQuery.json +360 -18
  9. data/schemas/advancedEventQuery.json +360 -18
  10. data/schemas/advancedExperienceGroupQuery.json +360 -18
  11. data/schemas/advancedExperienceUserQuery.json +360 -18
  12. data/schemas/advancedInstanceOrgQuery.json +360 -18
  13. data/schemas/apiTokenPost.json +1 -1
  14. data/schemas/application.json +28 -4
  15. data/schemas/applicationCreationByTemplateResult.json +28 -4
  16. data/schemas/applicationDashboardPost.json +2 -1
  17. data/schemas/applicationTemplate.json +4 -0
  18. data/schemas/applicationTemplates.json +4 -0
  19. data/schemas/applications.json +28 -4
  20. data/schemas/credential.json +7 -1
  21. data/schemas/credentialLinkedResources.json +336 -18
  22. data/schemas/credentialPatch.json +11 -0
  23. data/schemas/credentialPost.json +16 -1
  24. data/schemas/credentials.json +7 -1
  25. data/schemas/dashboard.json +2 -1
  26. data/schemas/dashboardPatch.json +2 -1
  27. data/schemas/dashboardPost.json +2 -1
  28. data/schemas/dashboards.json +2 -1
  29. data/schemas/dataExport.json +360 -18
  30. data/schemas/devicesDeletePost.json +360 -18
  31. data/schemas/devicesExportPayloadCountPost.json +360 -18
  32. data/schemas/devicesExportPost.json +360 -18
  33. data/schemas/devicesPatch.json +360 -18
  34. data/schemas/devicesRemoveDataPost.json +360 -18
  35. data/schemas/eventsExport.json +360 -18
  36. data/schemas/experienceLinkedResources.json +336 -18
  37. data/schemas/flow.json +112 -6
  38. data/schemas/flowPatch.json +112 -6
  39. data/schemas/flowPost.json +112 -6
  40. data/schemas/flowVersion.json +224 -12
  41. data/schemas/flowVersionPost.json +112 -6
  42. data/schemas/flowVersions.json +224 -12
  43. data/schemas/flows.json +112 -6
  44. data/schemas/flowsImportPost.json +224 -12
  45. data/schemas/flowsImportResult.json +336 -18
  46. data/schemas/githubLogin.json +1 -1
  47. data/schemas/historicalSummaries.json +56 -8
  48. data/schemas/historicalSummary.json +56 -8
  49. data/schemas/instanceCustomNodePatch.json +10 -6
  50. data/schemas/instanceCustomNodePost.json +10 -6
  51. data/schemas/instanceOrg.json +63 -4
  52. data/schemas/instanceOrgs.json +63 -4
  53. data/schemas/instanceSandbox.json +28 -4
  54. data/schemas/instanceSandboxes.json +28 -4
  55. data/schemas/lastValueQuery.json +360 -18
  56. data/schemas/me.json +28 -4
  57. data/schemas/multiDeviceCommand.json +360 -18
  58. data/schemas/org.json +28 -4
  59. data/schemas/orgs.json +28 -4
  60. data/schemas/payloadStats.json +28 -4
  61. data/schemas/samlResponse.json +1 -1
  62. data/schemas/timeSeriesQuery.json +360 -18
  63. data/schemas/userCredentials.json +1 -1
  64. data/schemas/userPost.json +1 -1
  65. data/schemas/webhook.json +13 -0
  66. data/schemas/webhookPatch.json +13 -0
  67. data/schemas/webhookPost.json +13 -0
  68. data/schemas/webhooks.json +13 -0
  69. metadata +5 -5
data/schemas/flowsImportResult.json CHANGED
@@ -111,6 +111,108 @@
111
111
  "type": "array",
112
112
  "items": {
113
113
  "oneOf": [
114
+ {
115
+ "type": "object",
116
+ "properties": {
117
+ "key": {
118
+ "type": "string",
119
+ "maxLength": 1024
120
+ },
121
+ "type": {
122
+ "type": "string",
123
+ "enum": [
124
+ "appFile"
125
+ ]
126
+ },
127
+ "config": {
128
+ "type": "object",
129
+ "properties": {
130
+ "delete": {
131
+ "type": "boolean"
132
+ },
133
+ "create": {
134
+ "type": "boolean"
135
+ },
136
+ "update": {
137
+ "type": "boolean"
138
+ }
139
+ },
140
+ "additionalProperties": false
141
+ },
142
+ "meta": {
143
+ "type": "object",
144
+ "properties": {
145
+ "category": {
146
+ "type": "string",
147
+ "enum": [
148
+ "trigger"
149
+ ]
150
+ },
151
+ "name": {
152
+ "type": "string",
153
+ "enum": [
154
+ "appFile"
155
+ ]
156
+ },
157
+ "label": {
158
+ "type": "string",
159
+ "minLength": 1,
160
+ "maxLength": 255
161
+ },
162
+ "x": {
163
+ "type": "number"
164
+ },
165
+ "y": {
166
+ "type": "number"
167
+ },
168
+ "uiId": {
169
+ "type": "string",
170
+ "maxLength": 48
171
+ },
172
+ "description": {
173
+ "type": "string",
174
+ "maxLength": 32767
175
+ },
176
+ "icon": {
177
+ "type": "string",
178
+ "maxLength": 1024
179
+ },
180
+ "color": {
181
+ "type": "string",
182
+ "maxLength": 1024
183
+ },
184
+ "inputCount": {
185
+ "type": "number"
186
+ },
187
+ "outputCount": {
188
+ "type": "number"
189
+ },
190
+ "id": {
191
+ "type": "string",
192
+ "maxLength": 48
193
+ }
194
+ },
195
+ "additionalProperties": false
196
+ },
197
+ "outputIds": {
198
+ "type": "array",
199
+ "items": {
200
+ "type": "array",
201
+ "items": {
202
+ "type": "string",
203
+ "maxLength": 48,
204
+ "minLength": 1
205
+ },
206
+ "maxItems": 100
207
+ },
208
+ "maxItems": 100
209
+ }
210
+ },
211
+ "required": [
212
+ "type"
213
+ ],
214
+ "additionalProperties": false
215
+ },
114
216
  {
115
217
  "type": "object",
116
218
  "properties": {
@@ -122,20 +224,22 @@
122
224
  "type": "string",
123
225
  "enum": [
124
226
  "customNodeStart",
227
+ "deviceCreate",
125
228
  "deviceCommand",
126
229
  "deviceIdConnect",
127
230
  "deviceTagConnect",
128
231
  "deviceIdDisconnect",
129
232
  "deviceTagDisconnect",
233
+ "inboundEmail",
130
234
  "notebook",
131
235
  "onBoot",
132
236
  "onConnect",
133
237
  "onDisconnect",
134
- "udp",
135
- "webhook",
238
+ "resourceJobComplete",
136
239
  "resourceJobIteration",
137
240
  "resourceJobIterationTimeout",
138
- "resourceJobComplete"
241
+ "udp",
242
+ "webhook"
139
243
  ]
140
244
  },
141
245
  "config": {
@@ -155,20 +259,22 @@
155
259
  "type": "string",
156
260
  "enum": [
157
261
  "customNodeStart",
262
+ "deviceCreate",
158
263
  "deviceCommand",
159
264
  "deviceIdsTagsConnect",
160
265
  "deviceIdsTagsDisconnect",
161
266
  "eeaInit",
162
267
  "flowError",
268
+ "inboundEmail",
163
269
  "notebook",
164
270
  "onBoot",
165
271
  "onConnect",
166
272
  "onDisconnect",
167
- "udp",
168
- "webhook",
273
+ "resourceJobComplete",
169
274
  "resourceJobIteration",
170
275
  "resourceJobIterationTimeout",
171
- "resourceJobComplete"
276
+ "udp",
277
+ "webhook"
172
278
  ]
173
279
  },
174
280
  "label": {
@@ -2943,6 +3049,108 @@
2943
3049
  "type": "array",
2944
3050
  "items": {
2945
3051
  "oneOf": [
3052
+ {
3053
+ "type": "object",
3054
+ "properties": {
3055
+ "key": {
3056
+ "type": "string",
3057
+ "maxLength": 1024
3058
+ },
3059
+ "type": {
3060
+ "type": "string",
3061
+ "enum": [
3062
+ "appFile"
3063
+ ]
3064
+ },
3065
+ "config": {
3066
+ "type": "object",
3067
+ "properties": {
3068
+ "delete": {
3069
+ "type": "boolean"
3070
+ },
3071
+ "create": {
3072
+ "type": "boolean"
3073
+ },
3074
+ "update": {
3075
+ "type": "boolean"
3076
+ }
3077
+ },
3078
+ "additionalProperties": false
3079
+ },
3080
+ "meta": {
3081
+ "type": "object",
3082
+ "properties": {
3083
+ "category": {
3084
+ "type": "string",
3085
+ "enum": [
3086
+ "trigger"
3087
+ ]
3088
+ },
3089
+ "name": {
3090
+ "type": "string",
3091
+ "enum": [
3092
+ "appFile"
3093
+ ]
3094
+ },
3095
+ "label": {
3096
+ "type": "string",
3097
+ "minLength": 1,
3098
+ "maxLength": 255
3099
+ },
3100
+ "x": {
3101
+ "type": "number"
3102
+ },
3103
+ "y": {
3104
+ "type": "number"
3105
+ },
3106
+ "uiId": {
3107
+ "type": "string",
3108
+ "maxLength": 48
3109
+ },
3110
+ "description": {
3111
+ "type": "string",
3112
+ "maxLength": 32767
3113
+ },
3114
+ "icon": {
3115
+ "type": "string",
3116
+ "maxLength": 1024
3117
+ },
3118
+ "color": {
3119
+ "type": "string",
3120
+ "maxLength": 1024
3121
+ },
3122
+ "inputCount": {
3123
+ "type": "number"
3124
+ },
3125
+ "outputCount": {
3126
+ "type": "number"
3127
+ },
3128
+ "id": {
3129
+ "type": "string",
3130
+ "maxLength": 48
3131
+ }
3132
+ },
3133
+ "additionalProperties": false
3134
+ },
3135
+ "outputIds": {
3136
+ "type": "array",
3137
+ "items": {
3138
+ "type": "array",
3139
+ "items": {
3140
+ "type": "string",
3141
+ "maxLength": 48,
3142
+ "minLength": 1
3143
+ },
3144
+ "maxItems": 100
3145
+ },
3146
+ "maxItems": 100
3147
+ }
3148
+ },
3149
+ "required": [
3150
+ "type"
3151
+ ],
3152
+ "additionalProperties": false
3153
+ },
2946
3154
  {
2947
3155
  "type": "object",
2948
3156
  "properties": {
@@ -2954,20 +3162,22 @@
2954
3162
  "type": "string",
2955
3163
  "enum": [
2956
3164
  "customNodeStart",
3165
+ "deviceCreate",
2957
3166
  "deviceCommand",
2958
3167
  "deviceIdConnect",
2959
3168
  "deviceTagConnect",
2960
3169
  "deviceIdDisconnect",
2961
3170
  "deviceTagDisconnect",
3171
+ "inboundEmail",
2962
3172
  "notebook",
2963
3173
  "onBoot",
2964
3174
  "onConnect",
2965
3175
  "onDisconnect",
2966
- "udp",
2967
- "webhook",
3176
+ "resourceJobComplete",
2968
3177
  "resourceJobIteration",
2969
3178
  "resourceJobIterationTimeout",
2970
- "resourceJobComplete"
3179
+ "udp",
3180
+ "webhook"
2971
3181
  ]
2972
3182
  },
2973
3183
  "config": {
@@ -2987,20 +3197,22 @@
2987
3197
  "type": "string",
2988
3198
  "enum": [
2989
3199
  "customNodeStart",
3200
+ "deviceCreate",
2990
3201
  "deviceCommand",
2991
3202
  "deviceIdsTagsConnect",
2992
3203
  "deviceIdsTagsDisconnect",
2993
3204
  "eeaInit",
2994
3205
  "flowError",
3206
+ "inboundEmail",
2995
3207
  "notebook",
2996
3208
  "onBoot",
2997
3209
  "onConnect",
2998
3210
  "onDisconnect",
2999
- "udp",
3000
- "webhook",
3211
+ "resourceJobComplete",
3001
3212
  "resourceJobIteration",
3002
3213
  "resourceJobIterationTimeout",
3003
- "resourceJobComplete"
3214
+ "udp",
3215
+ "webhook"
3004
3216
  ]
3005
3217
  },
3006
3218
  "label": {
@@ -5735,6 +5947,108 @@
5735
5947
  "type": "array",
5736
5948
  "items": {
5737
5949
  "oneOf": [
5950
+ {
5951
+ "type": "object",
5952
+ "properties": {
5953
+ "key": {
5954
+ "type": "string",
5955
+ "maxLength": 1024
5956
+ },
5957
+ "type": {
5958
+ "type": "string",
5959
+ "enum": [
5960
+ "appFile"
5961
+ ]
5962
+ },
5963
+ "config": {
5964
+ "type": "object",
5965
+ "properties": {
5966
+ "delete": {
5967
+ "type": "boolean"
5968
+ },
5969
+ "create": {
5970
+ "type": "boolean"
5971
+ },
5972
+ "update": {
5973
+ "type": "boolean"
5974
+ }
5975
+ },
5976
+ "additionalProperties": false
5977
+ },
5978
+ "meta": {
5979
+ "type": "object",
5980
+ "properties": {
5981
+ "category": {
5982
+ "type": "string",
5983
+ "enum": [
5984
+ "trigger"
5985
+ ]
5986
+ },
5987
+ "name": {
5988
+ "type": "string",
5989
+ "enum": [
5990
+ "appFile"
5991
+ ]
5992
+ },
5993
+ "label": {
5994
+ "type": "string",
5995
+ "minLength": 1,
5996
+ "maxLength": 255
5997
+ },
5998
+ "x": {
5999
+ "type": "number"
6000
+ },
6001
+ "y": {
6002
+ "type": "number"
6003
+ },
6004
+ "uiId": {
6005
+ "type": "string",
6006
+ "maxLength": 48
6007
+ },
6008
+ "description": {
6009
+ "type": "string",
6010
+ "maxLength": 32767
6011
+ },
6012
+ "icon": {
6013
+ "type": "string",
6014
+ "maxLength": 1024
6015
+ },
6016
+ "color": {
6017
+ "type": "string",
6018
+ "maxLength": 1024
6019
+ },
6020
+ "inputCount": {
6021
+ "type": "number"
6022
+ },
6023
+ "outputCount": {
6024
+ "type": "number"
6025
+ },
6026
+ "id": {
6027
+ "type": "string",
6028
+ "maxLength": 48
6029
+ }
6030
+ },
6031
+ "additionalProperties": false
6032
+ },
6033
+ "outputIds": {
6034
+ "type": "array",
6035
+ "items": {
6036
+ "type": "array",
6037
+ "items": {
6038
+ "type": "string",
6039
+ "maxLength": 48,
6040
+ "minLength": 1
6041
+ },
6042
+ "maxItems": 100
6043
+ },
6044
+ "maxItems": 100
6045
+ }
6046
+ },
6047
+ "required": [
6048
+ "type"
6049
+ ],
6050
+ "additionalProperties": false
6051
+ },
5738
6052
  {
5739
6053
  "type": "object",
5740
6054
  "properties": {
@@ -5746,20 +6060,22 @@
5746
6060
  "type": "string",
5747
6061
  "enum": [
5748
6062
  "customNodeStart",
6063
+ "deviceCreate",
5749
6064
  "deviceCommand",
5750
6065
  "deviceIdConnect",
5751
6066
  "deviceTagConnect",
5752
6067
  "deviceIdDisconnect",
5753
6068
  "deviceTagDisconnect",
6069
+ "inboundEmail",
5754
6070
  "notebook",
5755
6071
  "onBoot",
5756
6072
  "onConnect",
5757
6073
  "onDisconnect",
5758
- "udp",
5759
- "webhook",
6074
+ "resourceJobComplete",
5760
6075
  "resourceJobIteration",
5761
6076
  "resourceJobIterationTimeout",
5762
- "resourceJobComplete"
6077
+ "udp",
6078
+ "webhook"
5763
6079
  ]
5764
6080
  },
5765
6081
  "config": {
@@ -5779,20 +6095,22 @@
5779
6095
  "type": "string",
5780
6096
  "enum": [
5781
6097
  "customNodeStart",
6098
+ "deviceCreate",
5782
6099
  "deviceCommand",
5783
6100
  "deviceIdsTagsConnect",
5784
6101
  "deviceIdsTagsDisconnect",
5785
6102
  "eeaInit",
5786
6103
  "flowError",
6104
+ "inboundEmail",
5787
6105
  "notebook",
5788
6106
  "onBoot",
5789
6107
  "onConnect",
5790
6108
  "onDisconnect",
5791
- "udp",
5792
- "webhook",
6109
+ "resourceJobComplete",
5793
6110
  "resourceJobIteration",
5794
6111
  "resourceJobIterationTimeout",
5795
- "resourceJobComplete"
6112
+ "udp",
6113
+ "webhook"
5796
6114
  ]
5797
6115
  },
5798
6116
  "label": {
data/schemas/githubLogin.json CHANGED
@@ -356,7 +356,6 @@
356
356
  "org.notebookMinuteCounts",
357
357
  "org.invoices",
358
358
  "org.currentCard",
359
- "org.chargeDetails",
360
359
  "org.transferResources"
361
360
  ]
362
361
  }
@@ -382,6 +381,7 @@
382
381
  "instanceOrg.payloadCountsBreakdown",
383
382
  "instanceOrg.deviceCounts",
384
383
  "instanceOrg.notebookMinuteCounts",
384
+ "instanceOrg.convertToEnterprise",
385
385
  "instanceOrgs.*",
386
386
  "instanceOrgs.get",
387
387
  "instanceOrgs.post",
data/schemas/historicalSummaries.json CHANGED
@@ -311,6 +311,14 @@
311
311
  "description": "Schema for the result of a payload stats request",
312
312
  "type": "object",
313
313
  "properties": {
314
+ "appFile": {
315
+ "type": "object",
316
+ "patternProperties": {
317
+ ".*": {
318
+ "type": "number"
319
+ }
320
+ }
321
+ },
314
322
  "dataTable": {
315
323
  "type": "object",
316
324
  "patternProperties": {
@@ -319,6 +327,14 @@
319
327
  }
320
328
  }
321
329
  },
330
+ "deviceCreate": {
331
+ "type": "object",
332
+ "patternProperties": {
333
+ ".*": {
334
+ "type": "number"
335
+ }
336
+ }
337
+ },
322
338
  "deviceCommand": {
323
339
  "type": "object",
324
340
  "patternProperties": {
@@ -375,6 +391,14 @@
375
391
  }
376
392
  }
377
393
  },
394
+ "inboundEmail": {
395
+ "type": "object",
396
+ "patternProperties": {
397
+ ".*": {
398
+ "type": "number"
399
+ }
400
+ }
401
+ },
378
402
  "integration": {
379
403
  "type": "object",
380
404
  "patternProperties": {
@@ -407,7 +431,7 @@
407
431
  }
408
432
  }
409
433
  },
410
- "timer": {
434
+ "resourceJob": {
411
435
  "type": "object",
412
436
  "patternProperties": {
413
437
  ".*": {
@@ -415,7 +439,7 @@
415
439
  }
416
440
  }
417
441
  },
418
- "virtualButton": {
442
+ "timer": {
419
443
  "type": "object",
420
444
  "patternProperties": {
421
445
  ".*": {
@@ -423,7 +447,7 @@
423
447
  }
424
448
  }
425
449
  },
426
- "webhook": {
450
+ "virtualButton": {
427
451
  "type": "object",
428
452
  "patternProperties": {
429
453
  ".*": {
@@ -431,7 +455,7 @@
431
455
  }
432
456
  }
433
457
  },
434
- "resourceJob": {
458
+ "webhook": {
435
459
  "type": "object",
436
460
  "patternProperties": {
437
461
  ".*": {
@@ -446,6 +470,14 @@
446
470
  "description": "Schema for the result of a payload stats request",
447
471
  "type": "object",
448
472
  "properties": {
473
+ "appFile": {
474
+ "type": "object",
475
+ "patternProperties": {
476
+ ".*": {
477
+ "type": "number"
478
+ }
479
+ }
480
+ },
449
481
  "dataTable": {
450
482
  "type": "object",
451
483
  "patternProperties": {
@@ -454,6 +486,14 @@
454
486
  }
455
487
  }
456
488
  },
489
+ "deviceCreate": {
490
+ "type": "object",
491
+ "patternProperties": {
492
+ ".*": {
493
+ "type": "number"
494
+ }
495
+ }
496
+ },
457
497
  "deviceCommand": {
458
498
  "type": "object",
459
499
  "patternProperties": {
@@ -510,6 +550,14 @@
510
550
  }
511
551
  }
512
552
  },
553
+ "inboundEmail": {
554
+ "type": "object",
555
+ "patternProperties": {
556
+ ".*": {
557
+ "type": "number"
558
+ }
559
+ }
560
+ },
513
561
  "integration": {
514
562
  "type": "object",
515
563
  "patternProperties": {
@@ -542,7 +590,7 @@
542
590
  }
543
591
  }
544
592
  },
545
- "timer": {
593
+ "resourceJob": {
546
594
  "type": "object",
547
595
  "patternProperties": {
548
596
  ".*": {
@@ -550,7 +598,7 @@
550
598
  }
551
599
  }
552
600
  },
553
- "virtualButton": {
601
+ "timer": {
554
602
  "type": "object",
555
603
  "patternProperties": {
556
604
  ".*": {
@@ -558,7 +606,7 @@
558
606
  }
559
607
  }
560
608
  },
561
- "webhook": {
609
+ "virtualButton": {
562
610
  "type": "object",
563
611
  "patternProperties": {
564
612
  ".*": {
@@ -566,7 +614,7 @@
566
614
  }
567
615
  }
568
616
  },
569
- "resourceJob": {
617
+ "webhook": {
570
618
  "type": "object",
571
619
  "patternProperties": {
572
620
  ".*": {