losant_rest 1.20.0 → 1.21.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +139 -13
  3. data/docs/_schemas.md +7585 -2999
  4. data/docs/instanceNotificationRule.md +219 -0
  5. data/docs/instanceNotificationRules.md +91 -0
  6. data/lib/platform_rest/client.rb +10 -2
  7. data/lib/platform_rest/instance_notification_rule.rb +275 -0
  8. data/lib/platform_rest/instance_notification_rules.rb +136 -0
  9. data/lib/platform_rest/version.rb +1 -1
  10. data/lib/platform_rest.rb +2 -0
  11. data/schemas/apiTokenPost.json +9 -0
  12. data/schemas/applicationDashboardPost.json +94 -8
  13. data/schemas/applicationSearchResult.json +46 -6
  14. data/schemas/credentialLinkedResources.json +426 -0
  15. data/schemas/dashboard.json +94 -8
  16. data/schemas/dashboardPatch.json +94 -8
  17. data/schemas/dashboardPost.json +94 -8
  18. data/schemas/dashboards.json +94 -8
  19. data/schemas/experienceEndpoint.json +6 -1
  20. data/schemas/experienceEndpointPatch.json +6 -1
  21. data/schemas/experienceEndpointPost.json +6 -1
  22. data/schemas/experienceEndpoints.json +6 -1
  23. data/schemas/experienceLinkedResources.json +432 -1
  24. data/schemas/flow.json +142 -0
  25. data/schemas/flowPatch.json +142 -0
  26. data/schemas/flowPost.json +142 -0
  27. data/schemas/flowVersion.json +284 -0
  28. data/schemas/flowVersionPost.json +142 -0
  29. data/schemas/flowVersions.json +284 -0
  30. data/schemas/flows.json +142 -0
  31. data/schemas/flowsImportPost.json +284 -0
  32. data/schemas/flowsImportResult.json +426 -0
  33. data/schemas/githubLogin.json +9 -0
  34. data/schemas/instance.json +9 -0
  35. data/schemas/instanceAuditLog.json +2 -1
  36. data/schemas/instanceAuditLogFilter.json +2 -1
  37. data/schemas/instanceOrg.json +4 -0
  38. data/schemas/instanceOrgs.json +4 -0
  39. data/schemas/instances.json +9 -0
  40. data/schemas/notificationRule.json +161 -0
  41. data/schemas/notificationRuleDeliveryLogs.json +123 -0
  42. data/schemas/notificationRuleEvaluationOptions.json +10 -0
  43. data/schemas/notificationRulePatch.json +128 -0
  44. data/schemas/notificationRulePost.json +140 -0
  45. data/schemas/notificationRules.json +212 -0
  46. data/schemas/samlResponse.json +9 -0
  47. data/schemas/userCredentials.json +9 -0
  48. data/schemas/userPost.json +9 -0
  49. metadata +12 -2
data/schemas/flowVersionPost.json CHANGED
@@ -247,6 +247,145 @@
247
247
  ],
248
248
  "additionalProperties": false
249
249
  },
250
+ {
251
+ "type": "object",
252
+ "properties": {
253
+ "key": {
254
+ "type": "string",
255
+ "maxLength": 1024
256
+ },
257
+ "type": {
258
+ "type": "string",
259
+ "enum": [
260
+ "beckhoff"
261
+ ]
262
+ },
263
+ "config": {
264
+ "type": "object",
265
+ "properties": {
266
+ "localAmsNetId": {
267
+ "type": "string",
268
+ "maxLength": 1024
269
+ },
270
+ "localAdsPort": {
271
+ "type": "string",
272
+ "maxLength": 1024
273
+ },
274
+ "targetAmsNetId": {
275
+ "type": "string",
276
+ "maxLength": 1024
277
+ },
278
+ "targetAdsPort": {
279
+ "type": "string",
280
+ "maxLength": 1024
281
+ },
282
+ "routerHost": {
283
+ "type": "string",
284
+ "maxLength": 1024
285
+ },
286
+ "routerTcpPort": {
287
+ "type": "string",
288
+ "maxLength": 1024
289
+ },
290
+ "cycleTimeMs": {
291
+ "type": "integer",
292
+ "minimum": 10,
293
+ "maximum": 3600000
294
+ },
295
+ "subscriptions": {
296
+ "type": "array",
297
+ "items": {
298
+ "type": "object",
299
+ "properties": {
300
+ "name": {
301
+ "type": "string",
302
+ "maxLength": 1024
303
+ }
304
+ }
305
+ },
306
+ "maxItems": 100
307
+ },
308
+ "configName": {
309
+ "type": "string",
310
+ "maxLength": 1024
311
+ }
312
+ },
313
+ "additionalProperties": false
314
+ },
315
+ "meta": {
316
+ "type": "object",
317
+ "properties": {
318
+ "category": {
319
+ "type": "string",
320
+ "enum": [
321
+ "trigger"
322
+ ]
323
+ },
324
+ "name": {
325
+ "type": "string",
326
+ "enum": [
327
+ "beckhoff"
328
+ ]
329
+ },
330
+ "label": {
331
+ "type": "string",
332
+ "minLength": 1,
333
+ "maxLength": 255
334
+ },
335
+ "x": {
336
+ "type": "number"
337
+ },
338
+ "y": {
339
+ "type": "number"
340
+ },
341
+ "uiId": {
342
+ "type": "string",
343
+ "maxLength": 48
344
+ },
345
+ "description": {
346
+ "type": "string",
347
+ "maxLength": 32767
348
+ },
349
+ "icon": {
350
+ "type": "string",
351
+ "maxLength": 1024
352
+ },
353
+ "color": {
354
+ "type": "string",
355
+ "maxLength": 1024
356
+ },
357
+ "inputCount": {
358
+ "type": "number"
359
+ },
360
+ "outputCount": {
361
+ "type": "number"
362
+ },
363
+ "id": {
364
+ "type": "string",
365
+ "maxLength": 48
366
+ }
367
+ },
368
+ "additionalProperties": false
369
+ },
370
+ "outputIds": {
371
+ "type": "array",
372
+ "items": {
373
+ "type": "array",
374
+ "items": {
375
+ "type": "string",
376
+ "maxLength": 48,
377
+ "minLength": 1
378
+ },
379
+ "maxItems": 100
380
+ },
381
+ "maxItems": 100
382
+ }
383
+ },
384
+ "required": [
385
+ "type"
386
+ ],
387
+ "additionalProperties": false
388
+ },
250
389
  {
251
390
  "type": "object",
252
391
  "properties": {
@@ -516,6 +655,9 @@
516
655
  "once",
517
656
  "each"
518
657
  ]
658
+ },
659
+ "allowInvalid": {
660
+ "type": "boolean"
519
661
  }
520
662
  },
521
663
  "additionalProperties": false
data/schemas/flowVersions.json CHANGED
@@ -314,6 +314,145 @@
314
314
  ],
315
315
  "additionalProperties": false
316
316
  },
317
+ {
318
+ "type": "object",
319
+ "properties": {
320
+ "key": {
321
+ "type": "string",
322
+ "maxLength": 1024
323
+ },
324
+ "type": {
325
+ "type": "string",
326
+ "enum": [
327
+ "beckhoff"
328
+ ]
329
+ },
330
+ "config": {
331
+ "type": "object",
332
+ "properties": {
333
+ "localAmsNetId": {
334
+ "type": "string",
335
+ "maxLength": 1024
336
+ },
337
+ "localAdsPort": {
338
+ "type": "string",
339
+ "maxLength": 1024
340
+ },
341
+ "targetAmsNetId": {
342
+ "type": "string",
343
+ "maxLength": 1024
344
+ },
345
+ "targetAdsPort": {
346
+ "type": "string",
347
+ "maxLength": 1024
348
+ },
349
+ "routerHost": {
350
+ "type": "string",
351
+ "maxLength": 1024
352
+ },
353
+ "routerTcpPort": {
354
+ "type": "string",
355
+ "maxLength": 1024
356
+ },
357
+ "cycleTimeMs": {
358
+ "type": "integer",
359
+ "minimum": 10,
360
+ "maximum": 3600000
361
+ },
362
+ "subscriptions": {
363
+ "type": "array",
364
+ "items": {
365
+ "type": "object",
366
+ "properties": {
367
+ "name": {
368
+ "type": "string",
369
+ "maxLength": 1024
370
+ }
371
+ }
372
+ },
373
+ "maxItems": 100
374
+ },
375
+ "configName": {
376
+ "type": "string",
377
+ "maxLength": 1024
378
+ }
379
+ },
380
+ "additionalProperties": false
381
+ },
382
+ "meta": {
383
+ "type": "object",
384
+ "properties": {
385
+ "category": {
386
+ "type": "string",
387
+ "enum": [
388
+ "trigger"
389
+ ]
390
+ },
391
+ "name": {
392
+ "type": "string",
393
+ "enum": [
394
+ "beckhoff"
395
+ ]
396
+ },
397
+ "label": {
398
+ "type": "string",
399
+ "minLength": 1,
400
+ "maxLength": 255
401
+ },
402
+ "x": {
403
+ "type": "number"
404
+ },
405
+ "y": {
406
+ "type": "number"
407
+ },
408
+ "uiId": {
409
+ "type": "string",
410
+ "maxLength": 48
411
+ },
412
+ "description": {
413
+ "type": "string",
414
+ "maxLength": 32767
415
+ },
416
+ "icon": {
417
+ "type": "string",
418
+ "maxLength": 1024
419
+ },
420
+ "color": {
421
+ "type": "string",
422
+ "maxLength": 1024
423
+ },
424
+ "inputCount": {
425
+ "type": "number"
426
+ },
427
+ "outputCount": {
428
+ "type": "number"
429
+ },
430
+ "id": {
431
+ "type": "string",
432
+ "maxLength": 48
433
+ }
434
+ },
435
+ "additionalProperties": false
436
+ },
437
+ "outputIds": {
438
+ "type": "array",
439
+ "items": {
440
+ "type": "array",
441
+ "items": {
442
+ "type": "string",
443
+ "maxLength": 48,
444
+ "minLength": 1
445
+ },
446
+ "maxItems": 100
447
+ },
448
+ "maxItems": 100
449
+ }
450
+ },
451
+ "required": [
452
+ "type"
453
+ ],
454
+ "additionalProperties": false
455
+ },
317
456
  {
318
457
  "type": "object",
319
458
  "properties": {
@@ -583,6 +722,9 @@
583
722
  "once",
584
723
  "each"
585
724
  ]
725
+ },
726
+ "allowInvalid": {
727
+ "type": "boolean"
586
728
  }
587
729
  },
588
730
  "additionalProperties": false
@@ -3212,6 +3354,145 @@
3212
3354
  ],
3213
3355
  "additionalProperties": false
3214
3356
  },
3357
+ {
3358
+ "type": "object",
3359
+ "properties": {
3360
+ "key": {
3361
+ "type": "string",
3362
+ "maxLength": 1024
3363
+ },
3364
+ "type": {
3365
+ "type": "string",
3366
+ "enum": [
3367
+ "beckhoff"
3368
+ ]
3369
+ },
3370
+ "config": {
3371
+ "type": "object",
3372
+ "properties": {
3373
+ "localAmsNetId": {
3374
+ "type": "string",
3375
+ "maxLength": 1024
3376
+ },
3377
+ "localAdsPort": {
3378
+ "type": "string",
3379
+ "maxLength": 1024
3380
+ },
3381
+ "targetAmsNetId": {
3382
+ "type": "string",
3383
+ "maxLength": 1024
3384
+ },
3385
+ "targetAdsPort": {
3386
+ "type": "string",
3387
+ "maxLength": 1024
3388
+ },
3389
+ "routerHost": {
3390
+ "type": "string",
3391
+ "maxLength": 1024
3392
+ },
3393
+ "routerTcpPort": {
3394
+ "type": "string",
3395
+ "maxLength": 1024
3396
+ },
3397
+ "cycleTimeMs": {
3398
+ "type": "integer",
3399
+ "minimum": 10,
3400
+ "maximum": 3600000
3401
+ },
3402
+ "subscriptions": {
3403
+ "type": "array",
3404
+ "items": {
3405
+ "type": "object",
3406
+ "properties": {
3407
+ "name": {
3408
+ "type": "string",
3409
+ "maxLength": 1024
3410
+ }
3411
+ }
3412
+ },
3413
+ "maxItems": 100
3414
+ },
3415
+ "configName": {
3416
+ "type": "string",
3417
+ "maxLength": 1024
3418
+ }
3419
+ },
3420
+ "additionalProperties": false
3421
+ },
3422
+ "meta": {
3423
+ "type": "object",
3424
+ "properties": {
3425
+ "category": {
3426
+ "type": "string",
3427
+ "enum": [
3428
+ "trigger"
3429
+ ]
3430
+ },
3431
+ "name": {
3432
+ "type": "string",
3433
+ "enum": [
3434
+ "beckhoff"
3435
+ ]
3436
+ },
3437
+ "label": {
3438
+ "type": "string",
3439
+ "minLength": 1,
3440
+ "maxLength": 255
3441
+ },
3442
+ "x": {
3443
+ "type": "number"
3444
+ },
3445
+ "y": {
3446
+ "type": "number"
3447
+ },
3448
+ "uiId": {
3449
+ "type": "string",
3450
+ "maxLength": 48
3451
+ },
3452
+ "description": {
3453
+ "type": "string",
3454
+ "maxLength": 32767
3455
+ },
3456
+ "icon": {
3457
+ "type": "string",
3458
+ "maxLength": 1024
3459
+ },
3460
+ "color": {
3461
+ "type": "string",
3462
+ "maxLength": 1024
3463
+ },
3464
+ "inputCount": {
3465
+ "type": "number"
3466
+ },
3467
+ "outputCount": {
3468
+ "type": "number"
3469
+ },
3470
+ "id": {
3471
+ "type": "string",
3472
+ "maxLength": 48
3473
+ }
3474
+ },
3475
+ "additionalProperties": false
3476
+ },
3477
+ "outputIds": {
3478
+ "type": "array",
3479
+ "items": {
3480
+ "type": "array",
3481
+ "items": {
3482
+ "type": "string",
3483
+ "maxLength": 48,
3484
+ "minLength": 1
3485
+ },
3486
+ "maxItems": 100
3487
+ },
3488
+ "maxItems": 100
3489
+ }
3490
+ },
3491
+ "required": [
3492
+ "type"
3493
+ ],
3494
+ "additionalProperties": false
3495
+ },
3215
3496
  {
3216
3497
  "type": "object",
3217
3498
  "properties": {
@@ -3481,6 +3762,9 @@
3481
3762
  "once",
3482
3763
  "each"
3483
3764
  ]
3765
+ },
3766
+ "allowInvalid": {
3767
+ "type": "boolean"
3484
3768
  }
3485
3769
  },
3486
3770
  "additionalProperties": false
data/schemas/flows.json CHANGED
@@ -339,6 +339,145 @@
339
339
  ],
340
340
  "additionalProperties": false
341
341
  },
342
+ {
343
+ "type": "object",
344
+ "properties": {
345
+ "key": {
346
+ "type": "string",
347
+ "maxLength": 1024
348
+ },
349
+ "type": {
350
+ "type": "string",
351
+ "enum": [
352
+ "beckhoff"
353
+ ]
354
+ },
355
+ "config": {
356
+ "type": "object",
357
+ "properties": {
358
+ "localAmsNetId": {
359
+ "type": "string",
360
+ "maxLength": 1024
361
+ },
362
+ "localAdsPort": {
363
+ "type": "string",
364
+ "maxLength": 1024
365
+ },
366
+ "targetAmsNetId": {
367
+ "type": "string",
368
+ "maxLength": 1024
369
+ },
370
+ "targetAdsPort": {
371
+ "type": "string",
372
+ "maxLength": 1024
373
+ },
374
+ "routerHost": {
375
+ "type": "string",
376
+ "maxLength": 1024
377
+ },
378
+ "routerTcpPort": {
379
+ "type": "string",
380
+ "maxLength": 1024
381
+ },
382
+ "cycleTimeMs": {
383
+ "type": "integer",
384
+ "minimum": 10,
385
+ "maximum": 3600000
386
+ },
387
+ "subscriptions": {
388
+ "type": "array",
389
+ "items": {
390
+ "type": "object",
391
+ "properties": {
392
+ "name": {
393
+ "type": "string",
394
+ "maxLength": 1024
395
+ }
396
+ }
397
+ },
398
+ "maxItems": 100
399
+ },
400
+ "configName": {
401
+ "type": "string",
402
+ "maxLength": 1024
403
+ }
404
+ },
405
+ "additionalProperties": false
406
+ },
407
+ "meta": {
408
+ "type": "object",
409
+ "properties": {
410
+ "category": {
411
+ "type": "string",
412
+ "enum": [
413
+ "trigger"
414
+ ]
415
+ },
416
+ "name": {
417
+ "type": "string",
418
+ "enum": [
419
+ "beckhoff"
420
+ ]
421
+ },
422
+ "label": {
423
+ "type": "string",
424
+ "minLength": 1,
425
+ "maxLength": 255
426
+ },
427
+ "x": {
428
+ "type": "number"
429
+ },
430
+ "y": {
431
+ "type": "number"
432
+ },
433
+ "uiId": {
434
+ "type": "string",
435
+ "maxLength": 48
436
+ },
437
+ "description": {
438
+ "type": "string",
439
+ "maxLength": 32767
440
+ },
441
+ "icon": {
442
+ "type": "string",
443
+ "maxLength": 1024
444
+ },
445
+ "color": {
446
+ "type": "string",
447
+ "maxLength": 1024
448
+ },
449
+ "inputCount": {
450
+ "type": "number"
451
+ },
452
+ "outputCount": {
453
+ "type": "number"
454
+ },
455
+ "id": {
456
+ "type": "string",
457
+ "maxLength": 48
458
+ }
459
+ },
460
+ "additionalProperties": false
461
+ },
462
+ "outputIds": {
463
+ "type": "array",
464
+ "items": {
465
+ "type": "array",
466
+ "items": {
467
+ "type": "string",
468
+ "maxLength": 48,
469
+ "minLength": 1
470
+ },
471
+ "maxItems": 100
472
+ },
473
+ "maxItems": 100
474
+ }
475
+ },
476
+ "required": [
477
+ "type"
478
+ ],
479
+ "additionalProperties": false
480
+ },
342
481
  {
343
482
  "type": "object",
344
483
  "properties": {
@@ -608,6 +747,9 @@
608
747
  "once",
609
748
  "each"
610
749
  ]
750
+ },
751
+ "allowInvalid": {
752
+ "type": "boolean"
611
753
  }
612
754
  },
613
755
  "additionalProperties": false