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/flowPatch.json CHANGED
@@ -289,6 +289,145 @@
289
289
  ],
290
290
  "additionalProperties": false
291
291
  },
292
+ {
293
+ "type": "object",
294
+ "properties": {
295
+ "key": {
296
+ "type": "string",
297
+ "maxLength": 1024
298
+ },
299
+ "type": {
300
+ "type": "string",
301
+ "enum": [
302
+ "beckhoff"
303
+ ]
304
+ },
305
+ "config": {
306
+ "type": "object",
307
+ "properties": {
308
+ "localAmsNetId": {
309
+ "type": "string",
310
+ "maxLength": 1024
311
+ },
312
+ "localAdsPort": {
313
+ "type": "string",
314
+ "maxLength": 1024
315
+ },
316
+ "targetAmsNetId": {
317
+ "type": "string",
318
+ "maxLength": 1024
319
+ },
320
+ "targetAdsPort": {
321
+ "type": "string",
322
+ "maxLength": 1024
323
+ },
324
+ "routerHost": {
325
+ "type": "string",
326
+ "maxLength": 1024
327
+ },
328
+ "routerTcpPort": {
329
+ "type": "string",
330
+ "maxLength": 1024
331
+ },
332
+ "cycleTimeMs": {
333
+ "type": "integer",
334
+ "minimum": 10,
335
+ "maximum": 3600000
336
+ },
337
+ "subscriptions": {
338
+ "type": "array",
339
+ "items": {
340
+ "type": "object",
341
+ "properties": {
342
+ "name": {
343
+ "type": "string",
344
+ "maxLength": 1024
345
+ }
346
+ }
347
+ },
348
+ "maxItems": 100
349
+ },
350
+ "configName": {
351
+ "type": "string",
352
+ "maxLength": 1024
353
+ }
354
+ },
355
+ "additionalProperties": false
356
+ },
357
+ "meta": {
358
+ "type": "object",
359
+ "properties": {
360
+ "category": {
361
+ "type": "string",
362
+ "enum": [
363
+ "trigger"
364
+ ]
365
+ },
366
+ "name": {
367
+ "type": "string",
368
+ "enum": [
369
+ "beckhoff"
370
+ ]
371
+ },
372
+ "label": {
373
+ "type": "string",
374
+ "minLength": 1,
375
+ "maxLength": 255
376
+ },
377
+ "x": {
378
+ "type": "number"
379
+ },
380
+ "y": {
381
+ "type": "number"
382
+ },
383
+ "uiId": {
384
+ "type": "string",
385
+ "maxLength": 48
386
+ },
387
+ "description": {
388
+ "type": "string",
389
+ "maxLength": 32767
390
+ },
391
+ "icon": {
392
+ "type": "string",
393
+ "maxLength": 1024
394
+ },
395
+ "color": {
396
+ "type": "string",
397
+ "maxLength": 1024
398
+ },
399
+ "inputCount": {
400
+ "type": "number"
401
+ },
402
+ "outputCount": {
403
+ "type": "number"
404
+ },
405
+ "id": {
406
+ "type": "string",
407
+ "maxLength": 48
408
+ }
409
+ },
410
+ "additionalProperties": false
411
+ },
412
+ "outputIds": {
413
+ "type": "array",
414
+ "items": {
415
+ "type": "array",
416
+ "items": {
417
+ "type": "string",
418
+ "maxLength": 48,
419
+ "minLength": 1
420
+ },
421
+ "maxItems": 100
422
+ },
423
+ "maxItems": 100
424
+ }
425
+ },
426
+ "required": [
427
+ "type"
428
+ ],
429
+ "additionalProperties": false
430
+ },
292
431
  {
293
432
  "type": "object",
294
433
  "properties": {
@@ -558,6 +697,9 @@
558
697
  "once",
559
698
  "each"
560
699
  ]
700
+ },
701
+ "allowInvalid": {
702
+ "type": "boolean"
561
703
  }
562
704
  },
563
705
  "additionalProperties": false
data/schemas/flowPost.json CHANGED
@@ -278,6 +278,145 @@
278
278
  ],
279
279
  "additionalProperties": false
280
280
  },
281
+ {
282
+ "type": "object",
283
+ "properties": {
284
+ "key": {
285
+ "type": "string",
286
+ "maxLength": 1024
287
+ },
288
+ "type": {
289
+ "type": "string",
290
+ "enum": [
291
+ "beckhoff"
292
+ ]
293
+ },
294
+ "config": {
295
+ "type": "object",
296
+ "properties": {
297
+ "localAmsNetId": {
298
+ "type": "string",
299
+ "maxLength": 1024
300
+ },
301
+ "localAdsPort": {
302
+ "type": "string",
303
+ "maxLength": 1024
304
+ },
305
+ "targetAmsNetId": {
306
+ "type": "string",
307
+ "maxLength": 1024
308
+ },
309
+ "targetAdsPort": {
310
+ "type": "string",
311
+ "maxLength": 1024
312
+ },
313
+ "routerHost": {
314
+ "type": "string",
315
+ "maxLength": 1024
316
+ },
317
+ "routerTcpPort": {
318
+ "type": "string",
319
+ "maxLength": 1024
320
+ },
321
+ "cycleTimeMs": {
322
+ "type": "integer",
323
+ "minimum": 10,
324
+ "maximum": 3600000
325
+ },
326
+ "subscriptions": {
327
+ "type": "array",
328
+ "items": {
329
+ "type": "object",
330
+ "properties": {
331
+ "name": {
332
+ "type": "string",
333
+ "maxLength": 1024
334
+ }
335
+ }
336
+ },
337
+ "maxItems": 100
338
+ },
339
+ "configName": {
340
+ "type": "string",
341
+ "maxLength": 1024
342
+ }
343
+ },
344
+ "additionalProperties": false
345
+ },
346
+ "meta": {
347
+ "type": "object",
348
+ "properties": {
349
+ "category": {
350
+ "type": "string",
351
+ "enum": [
352
+ "trigger"
353
+ ]
354
+ },
355
+ "name": {
356
+ "type": "string",
357
+ "enum": [
358
+ "beckhoff"
359
+ ]
360
+ },
361
+ "label": {
362
+ "type": "string",
363
+ "minLength": 1,
364
+ "maxLength": 255
365
+ },
366
+ "x": {
367
+ "type": "number"
368
+ },
369
+ "y": {
370
+ "type": "number"
371
+ },
372
+ "uiId": {
373
+ "type": "string",
374
+ "maxLength": 48
375
+ },
376
+ "description": {
377
+ "type": "string",
378
+ "maxLength": 32767
379
+ },
380
+ "icon": {
381
+ "type": "string",
382
+ "maxLength": 1024
383
+ },
384
+ "color": {
385
+ "type": "string",
386
+ "maxLength": 1024
387
+ },
388
+ "inputCount": {
389
+ "type": "number"
390
+ },
391
+ "outputCount": {
392
+ "type": "number"
393
+ },
394
+ "id": {
395
+ "type": "string",
396
+ "maxLength": 48
397
+ }
398
+ },
399
+ "additionalProperties": false
400
+ },
401
+ "outputIds": {
402
+ "type": "array",
403
+ "items": {
404
+ "type": "array",
405
+ "items": {
406
+ "type": "string",
407
+ "maxLength": 48,
408
+ "minLength": 1
409
+ },
410
+ "maxItems": 100
411
+ },
412
+ "maxItems": 100
413
+ }
414
+ },
415
+ "required": [
416
+ "type"
417
+ ],
418
+ "additionalProperties": false
419
+ },
281
420
  {
282
421
  "type": "object",
283
422
  "properties": {
@@ -547,6 +686,9 @@
547
686
  "once",
548
687
  "each"
549
688
  ]
689
+ },
690
+ "allowInvalid": {
691
+ "type": "boolean"
550
692
  }
551
693
  },
552
694
  "additionalProperties": false
data/schemas/flowVersion.json CHANGED
@@ -307,6 +307,145 @@
307
307
  ],
308
308
  "additionalProperties": false
309
309
  },
310
+ {
311
+ "type": "object",
312
+ "properties": {
313
+ "key": {
314
+ "type": "string",
315
+ "maxLength": 1024
316
+ },
317
+ "type": {
318
+ "type": "string",
319
+ "enum": [
320
+ "beckhoff"
321
+ ]
322
+ },
323
+ "config": {
324
+ "type": "object",
325
+ "properties": {
326
+ "localAmsNetId": {
327
+ "type": "string",
328
+ "maxLength": 1024
329
+ },
330
+ "localAdsPort": {
331
+ "type": "string",
332
+ "maxLength": 1024
333
+ },
334
+ "targetAmsNetId": {
335
+ "type": "string",
336
+ "maxLength": 1024
337
+ },
338
+ "targetAdsPort": {
339
+ "type": "string",
340
+ "maxLength": 1024
341
+ },
342
+ "routerHost": {
343
+ "type": "string",
344
+ "maxLength": 1024
345
+ },
346
+ "routerTcpPort": {
347
+ "type": "string",
348
+ "maxLength": 1024
349
+ },
350
+ "cycleTimeMs": {
351
+ "type": "integer",
352
+ "minimum": 10,
353
+ "maximum": 3600000
354
+ },
355
+ "subscriptions": {
356
+ "type": "array",
357
+ "items": {
358
+ "type": "object",
359
+ "properties": {
360
+ "name": {
361
+ "type": "string",
362
+ "maxLength": 1024
363
+ }
364
+ }
365
+ },
366
+ "maxItems": 100
367
+ },
368
+ "configName": {
369
+ "type": "string",
370
+ "maxLength": 1024
371
+ }
372
+ },
373
+ "additionalProperties": false
374
+ },
375
+ "meta": {
376
+ "type": "object",
377
+ "properties": {
378
+ "category": {
379
+ "type": "string",
380
+ "enum": [
381
+ "trigger"
382
+ ]
383
+ },
384
+ "name": {
385
+ "type": "string",
386
+ "enum": [
387
+ "beckhoff"
388
+ ]
389
+ },
390
+ "label": {
391
+ "type": "string",
392
+ "minLength": 1,
393
+ "maxLength": 255
394
+ },
395
+ "x": {
396
+ "type": "number"
397
+ },
398
+ "y": {
399
+ "type": "number"
400
+ },
401
+ "uiId": {
402
+ "type": "string",
403
+ "maxLength": 48
404
+ },
405
+ "description": {
406
+ "type": "string",
407
+ "maxLength": 32767
408
+ },
409
+ "icon": {
410
+ "type": "string",
411
+ "maxLength": 1024
412
+ },
413
+ "color": {
414
+ "type": "string",
415
+ "maxLength": 1024
416
+ },
417
+ "inputCount": {
418
+ "type": "number"
419
+ },
420
+ "outputCount": {
421
+ "type": "number"
422
+ },
423
+ "id": {
424
+ "type": "string",
425
+ "maxLength": 48
426
+ }
427
+ },
428
+ "additionalProperties": false
429
+ },
430
+ "outputIds": {
431
+ "type": "array",
432
+ "items": {
433
+ "type": "array",
434
+ "items": {
435
+ "type": "string",
436
+ "maxLength": 48,
437
+ "minLength": 1
438
+ },
439
+ "maxItems": 100
440
+ },
441
+ "maxItems": 100
442
+ }
443
+ },
444
+ "required": [
445
+ "type"
446
+ ],
447
+ "additionalProperties": false
448
+ },
310
449
  {
311
450
  "type": "object",
312
451
  "properties": {
@@ -576,6 +715,9 @@
576
715
  "once",
577
716
  "each"
578
717
  ]
718
+ },
719
+ "allowInvalid": {
720
+ "type": "boolean"
579
721
  }
580
722
  },
581
723
  "additionalProperties": false
@@ -3205,6 +3347,145 @@
3205
3347
  ],
3206
3348
  "additionalProperties": false
3207
3349
  },
3350
+ {
3351
+ "type": "object",
3352
+ "properties": {
3353
+ "key": {
3354
+ "type": "string",
3355
+ "maxLength": 1024
3356
+ },
3357
+ "type": {
3358
+ "type": "string",
3359
+ "enum": [
3360
+ "beckhoff"
3361
+ ]
3362
+ },
3363
+ "config": {
3364
+ "type": "object",
3365
+ "properties": {
3366
+ "localAmsNetId": {
3367
+ "type": "string",
3368
+ "maxLength": 1024
3369
+ },
3370
+ "localAdsPort": {
3371
+ "type": "string",
3372
+ "maxLength": 1024
3373
+ },
3374
+ "targetAmsNetId": {
3375
+ "type": "string",
3376
+ "maxLength": 1024
3377
+ },
3378
+ "targetAdsPort": {
3379
+ "type": "string",
3380
+ "maxLength": 1024
3381
+ },
3382
+ "routerHost": {
3383
+ "type": "string",
3384
+ "maxLength": 1024
3385
+ },
3386
+ "routerTcpPort": {
3387
+ "type": "string",
3388
+ "maxLength": 1024
3389
+ },
3390
+ "cycleTimeMs": {
3391
+ "type": "integer",
3392
+ "minimum": 10,
3393
+ "maximum": 3600000
3394
+ },
3395
+ "subscriptions": {
3396
+ "type": "array",
3397
+ "items": {
3398
+ "type": "object",
3399
+ "properties": {
3400
+ "name": {
3401
+ "type": "string",
3402
+ "maxLength": 1024
3403
+ }
3404
+ }
3405
+ },
3406
+ "maxItems": 100
3407
+ },
3408
+ "configName": {
3409
+ "type": "string",
3410
+ "maxLength": 1024
3411
+ }
3412
+ },
3413
+ "additionalProperties": false
3414
+ },
3415
+ "meta": {
3416
+ "type": "object",
3417
+ "properties": {
3418
+ "category": {
3419
+ "type": "string",
3420
+ "enum": [
3421
+ "trigger"
3422
+ ]
3423
+ },
3424
+ "name": {
3425
+ "type": "string",
3426
+ "enum": [
3427
+ "beckhoff"
3428
+ ]
3429
+ },
3430
+ "label": {
3431
+ "type": "string",
3432
+ "minLength": 1,
3433
+ "maxLength": 255
3434
+ },
3435
+ "x": {
3436
+ "type": "number"
3437
+ },
3438
+ "y": {
3439
+ "type": "number"
3440
+ },
3441
+ "uiId": {
3442
+ "type": "string",
3443
+ "maxLength": 48
3444
+ },
3445
+ "description": {
3446
+ "type": "string",
3447
+ "maxLength": 32767
3448
+ },
3449
+ "icon": {
3450
+ "type": "string",
3451
+ "maxLength": 1024
3452
+ },
3453
+ "color": {
3454
+ "type": "string",
3455
+ "maxLength": 1024
3456
+ },
3457
+ "inputCount": {
3458
+ "type": "number"
3459
+ },
3460
+ "outputCount": {
3461
+ "type": "number"
3462
+ },
3463
+ "id": {
3464
+ "type": "string",
3465
+ "maxLength": 48
3466
+ }
3467
+ },
3468
+ "additionalProperties": false
3469
+ },
3470
+ "outputIds": {
3471
+ "type": "array",
3472
+ "items": {
3473
+ "type": "array",
3474
+ "items": {
3475
+ "type": "string",
3476
+ "maxLength": 48,
3477
+ "minLength": 1
3478
+ },
3479
+ "maxItems": 100
3480
+ },
3481
+ "maxItems": 100
3482
+ }
3483
+ },
3484
+ "required": [
3485
+ "type"
3486
+ ],
3487
+ "additionalProperties": false
3488
+ },
3208
3489
  {
3209
3490
  "type": "object",
3210
3491
  "properties": {
@@ -3474,6 +3755,9 @@
3474
3755
  "once",
3475
3756
  "each"
3476
3757
  ]
3758
+ },
3759
+ "allowInvalid": {
3760
+ "type": "boolean"
3477
3761
  }
3478
3762
  },
3479
3763
  "additionalProperties": false