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
@@ -245,9 +245,14 @@
245
245
  "enum": [
246
246
  "public",
247
247
  "authenticated",
248
- "group"
248
+ "group",
249
+ "device"
249
250
  ]
250
251
  },
252
+ "deviceIdTemplate": {
253
+ "type": "string",
254
+ "maxLength": 255
255
+ },
251
256
  "endpointTags": {
252
257
  "type": "object",
253
258
  "patternProperties": {
@@ -723,6 +728,145 @@
723
728
  ],
724
729
  "additionalProperties": false
725
730
  },
731
+ {
732
+ "type": "object",
733
+ "properties": {
734
+ "key": {
735
+ "type": "string",
736
+ "maxLength": 1024
737
+ },
738
+ "type": {
739
+ "type": "string",
740
+ "enum": [
741
+ "beckhoff"
742
+ ]
743
+ },
744
+ "config": {
745
+ "type": "object",
746
+ "properties": {
747
+ "localAmsNetId": {
748
+ "type": "string",
749
+ "maxLength": 1024
750
+ },
751
+ "localAdsPort": {
752
+ "type": "string",
753
+ "maxLength": 1024
754
+ },
755
+ "targetAmsNetId": {
756
+ "type": "string",
757
+ "maxLength": 1024
758
+ },
759
+ "targetAdsPort": {
760
+ "type": "string",
761
+ "maxLength": 1024
762
+ },
763
+ "routerHost": {
764
+ "type": "string",
765
+ "maxLength": 1024
766
+ },
767
+ "routerTcpPort": {
768
+ "type": "string",
769
+ "maxLength": 1024
770
+ },
771
+ "cycleTimeMs": {
772
+ "type": "integer",
773
+ "minimum": 10,
774
+ "maximum": 3600000
775
+ },
776
+ "subscriptions": {
777
+ "type": "array",
778
+ "items": {
779
+ "type": "object",
780
+ "properties": {
781
+ "name": {
782
+ "type": "string",
783
+ "maxLength": 1024
784
+ }
785
+ }
786
+ },
787
+ "maxItems": 100
788
+ },
789
+ "configName": {
790
+ "type": "string",
791
+ "maxLength": 1024
792
+ }
793
+ },
794
+ "additionalProperties": false
795
+ },
796
+ "meta": {
797
+ "type": "object",
798
+ "properties": {
799
+ "category": {
800
+ "type": "string",
801
+ "enum": [
802
+ "trigger"
803
+ ]
804
+ },
805
+ "name": {
806
+ "type": "string",
807
+ "enum": [
808
+ "beckhoff"
809
+ ]
810
+ },
811
+ "label": {
812
+ "type": "string",
813
+ "minLength": 1,
814
+ "maxLength": 255
815
+ },
816
+ "x": {
817
+ "type": "number"
818
+ },
819
+ "y": {
820
+ "type": "number"
821
+ },
822
+ "uiId": {
823
+ "type": "string",
824
+ "maxLength": 48
825
+ },
826
+ "description": {
827
+ "type": "string",
828
+ "maxLength": 32767
829
+ },
830
+ "icon": {
831
+ "type": "string",
832
+ "maxLength": 1024
833
+ },
834
+ "color": {
835
+ "type": "string",
836
+ "maxLength": 1024
837
+ },
838
+ "inputCount": {
839
+ "type": "number"
840
+ },
841
+ "outputCount": {
842
+ "type": "number"
843
+ },
844
+ "id": {
845
+ "type": "string",
846
+ "maxLength": 48
847
+ }
848
+ },
849
+ "additionalProperties": false
850
+ },
851
+ "outputIds": {
852
+ "type": "array",
853
+ "items": {
854
+ "type": "array",
855
+ "items": {
856
+ "type": "string",
857
+ "maxLength": 48,
858
+ "minLength": 1
859
+ },
860
+ "maxItems": 100
861
+ },
862
+ "maxItems": 100
863
+ }
864
+ },
865
+ "required": [
866
+ "type"
867
+ ],
868
+ "additionalProperties": false
869
+ },
726
870
  {
727
871
  "type": "object",
728
872
  "properties": {
@@ -992,6 +1136,9 @@
992
1136
  "once",
993
1137
  "each"
994
1138
  ]
1139
+ },
1140
+ "allowInvalid": {
1141
+ "type": "boolean"
995
1142
  }
996
1143
  },
997
1144
  "additionalProperties": false
@@ -3712,6 +3859,145 @@
3712
3859
  ],
3713
3860
  "additionalProperties": false
3714
3861
  },
3862
+ {
3863
+ "type": "object",
3864
+ "properties": {
3865
+ "key": {
3866
+ "type": "string",
3867
+ "maxLength": 1024
3868
+ },
3869
+ "type": {
3870
+ "type": "string",
3871
+ "enum": [
3872
+ "beckhoff"
3873
+ ]
3874
+ },
3875
+ "config": {
3876
+ "type": "object",
3877
+ "properties": {
3878
+ "localAmsNetId": {
3879
+ "type": "string",
3880
+ "maxLength": 1024
3881
+ },
3882
+ "localAdsPort": {
3883
+ "type": "string",
3884
+ "maxLength": 1024
3885
+ },
3886
+ "targetAmsNetId": {
3887
+ "type": "string",
3888
+ "maxLength": 1024
3889
+ },
3890
+ "targetAdsPort": {
3891
+ "type": "string",
3892
+ "maxLength": 1024
3893
+ },
3894
+ "routerHost": {
3895
+ "type": "string",
3896
+ "maxLength": 1024
3897
+ },
3898
+ "routerTcpPort": {
3899
+ "type": "string",
3900
+ "maxLength": 1024
3901
+ },
3902
+ "cycleTimeMs": {
3903
+ "type": "integer",
3904
+ "minimum": 10,
3905
+ "maximum": 3600000
3906
+ },
3907
+ "subscriptions": {
3908
+ "type": "array",
3909
+ "items": {
3910
+ "type": "object",
3911
+ "properties": {
3912
+ "name": {
3913
+ "type": "string",
3914
+ "maxLength": 1024
3915
+ }
3916
+ }
3917
+ },
3918
+ "maxItems": 100
3919
+ },
3920
+ "configName": {
3921
+ "type": "string",
3922
+ "maxLength": 1024
3923
+ }
3924
+ },
3925
+ "additionalProperties": false
3926
+ },
3927
+ "meta": {
3928
+ "type": "object",
3929
+ "properties": {
3930
+ "category": {
3931
+ "type": "string",
3932
+ "enum": [
3933
+ "trigger"
3934
+ ]
3935
+ },
3936
+ "name": {
3937
+ "type": "string",
3938
+ "enum": [
3939
+ "beckhoff"
3940
+ ]
3941
+ },
3942
+ "label": {
3943
+ "type": "string",
3944
+ "minLength": 1,
3945
+ "maxLength": 255
3946
+ },
3947
+ "x": {
3948
+ "type": "number"
3949
+ },
3950
+ "y": {
3951
+ "type": "number"
3952
+ },
3953
+ "uiId": {
3954
+ "type": "string",
3955
+ "maxLength": 48
3956
+ },
3957
+ "description": {
3958
+ "type": "string",
3959
+ "maxLength": 32767
3960
+ },
3961
+ "icon": {
3962
+ "type": "string",
3963
+ "maxLength": 1024
3964
+ },
3965
+ "color": {
3966
+ "type": "string",
3967
+ "maxLength": 1024
3968
+ },
3969
+ "inputCount": {
3970
+ "type": "number"
3971
+ },
3972
+ "outputCount": {
3973
+ "type": "number"
3974
+ },
3975
+ "id": {
3976
+ "type": "string",
3977
+ "maxLength": 48
3978
+ }
3979
+ },
3980
+ "additionalProperties": false
3981
+ },
3982
+ "outputIds": {
3983
+ "type": "array",
3984
+ "items": {
3985
+ "type": "array",
3986
+ "items": {
3987
+ "type": "string",
3988
+ "maxLength": 48,
3989
+ "minLength": 1
3990
+ },
3991
+ "maxItems": 100
3992
+ },
3993
+ "maxItems": 100
3994
+ }
3995
+ },
3996
+ "required": [
3997
+ "type"
3998
+ ],
3999
+ "additionalProperties": false
4000
+ },
3715
4001
  {
3716
4002
  "type": "object",
3717
4003
  "properties": {
@@ -3981,6 +4267,9 @@
3981
4267
  "once",
3982
4268
  "each"
3983
4269
  ]
4270
+ },
4271
+ "allowInvalid": {
4272
+ "type": "boolean"
3984
4273
  }
3985
4274
  },
3986
4275
  "additionalProperties": false
@@ -6610,6 +6899,145 @@
6610
6899
  ],
6611
6900
  "additionalProperties": false
6612
6901
  },
6902
+ {
6903
+ "type": "object",
6904
+ "properties": {
6905
+ "key": {
6906
+ "type": "string",
6907
+ "maxLength": 1024
6908
+ },
6909
+ "type": {
6910
+ "type": "string",
6911
+ "enum": [
6912
+ "beckhoff"
6913
+ ]
6914
+ },
6915
+ "config": {
6916
+ "type": "object",
6917
+ "properties": {
6918
+ "localAmsNetId": {
6919
+ "type": "string",
6920
+ "maxLength": 1024
6921
+ },
6922
+ "localAdsPort": {
6923
+ "type": "string",
6924
+ "maxLength": 1024
6925
+ },
6926
+ "targetAmsNetId": {
6927
+ "type": "string",
6928
+ "maxLength": 1024
6929
+ },
6930
+ "targetAdsPort": {
6931
+ "type": "string",
6932
+ "maxLength": 1024
6933
+ },
6934
+ "routerHost": {
6935
+ "type": "string",
6936
+ "maxLength": 1024
6937
+ },
6938
+ "routerTcpPort": {
6939
+ "type": "string",
6940
+ "maxLength": 1024
6941
+ },
6942
+ "cycleTimeMs": {
6943
+ "type": "integer",
6944
+ "minimum": 10,
6945
+ "maximum": 3600000
6946
+ },
6947
+ "subscriptions": {
6948
+ "type": "array",
6949
+ "items": {
6950
+ "type": "object",
6951
+ "properties": {
6952
+ "name": {
6953
+ "type": "string",
6954
+ "maxLength": 1024
6955
+ }
6956
+ }
6957
+ },
6958
+ "maxItems": 100
6959
+ },
6960
+ "configName": {
6961
+ "type": "string",
6962
+ "maxLength": 1024
6963
+ }
6964
+ },
6965
+ "additionalProperties": false
6966
+ },
6967
+ "meta": {
6968
+ "type": "object",
6969
+ "properties": {
6970
+ "category": {
6971
+ "type": "string",
6972
+ "enum": [
6973
+ "trigger"
6974
+ ]
6975
+ },
6976
+ "name": {
6977
+ "type": "string",
6978
+ "enum": [
6979
+ "beckhoff"
6980
+ ]
6981
+ },
6982
+ "label": {
6983
+ "type": "string",
6984
+ "minLength": 1,
6985
+ "maxLength": 255
6986
+ },
6987
+ "x": {
6988
+ "type": "number"
6989
+ },
6990
+ "y": {
6991
+ "type": "number"
6992
+ },
6993
+ "uiId": {
6994
+ "type": "string",
6995
+ "maxLength": 48
6996
+ },
6997
+ "description": {
6998
+ "type": "string",
6999
+ "maxLength": 32767
7000
+ },
7001
+ "icon": {
7002
+ "type": "string",
7003
+ "maxLength": 1024
7004
+ },
7005
+ "color": {
7006
+ "type": "string",
7007
+ "maxLength": 1024
7008
+ },
7009
+ "inputCount": {
7010
+ "type": "number"
7011
+ },
7012
+ "outputCount": {
7013
+ "type": "number"
7014
+ },
7015
+ "id": {
7016
+ "type": "string",
7017
+ "maxLength": 48
7018
+ }
7019
+ },
7020
+ "additionalProperties": false
7021
+ },
7022
+ "outputIds": {
7023
+ "type": "array",
7024
+ "items": {
7025
+ "type": "array",
7026
+ "items": {
7027
+ "type": "string",
7028
+ "maxLength": 48,
7029
+ "minLength": 1
7030
+ },
7031
+ "maxItems": 100
7032
+ },
7033
+ "maxItems": 100
7034
+ }
7035
+ },
7036
+ "required": [
7037
+ "type"
7038
+ ],
7039
+ "additionalProperties": false
7040
+ },
6613
7041
  {
6614
7042
  "type": "object",
6615
7043
  "properties": {
@@ -6879,6 +7307,9 @@
6879
7307
  "once",
6880
7308
  "each"
6881
7309
  ]
7310
+ },
7311
+ "allowInvalid": {
7312
+ "type": "boolean"
6882
7313
  }
6883
7314
  },
6884
7315
  "additionalProperties": false
data/schemas/flow.json CHANGED
@@ -332,6 +332,145 @@
332
332
  ],
333
333
  "additionalProperties": false
334
334
  },
335
+ {
336
+ "type": "object",
337
+ "properties": {
338
+ "key": {
339
+ "type": "string",
340
+ "maxLength": 1024
341
+ },
342
+ "type": {
343
+ "type": "string",
344
+ "enum": [
345
+ "beckhoff"
346
+ ]
347
+ },
348
+ "config": {
349
+ "type": "object",
350
+ "properties": {
351
+ "localAmsNetId": {
352
+ "type": "string",
353
+ "maxLength": 1024
354
+ },
355
+ "localAdsPort": {
356
+ "type": "string",
357
+ "maxLength": 1024
358
+ },
359
+ "targetAmsNetId": {
360
+ "type": "string",
361
+ "maxLength": 1024
362
+ },
363
+ "targetAdsPort": {
364
+ "type": "string",
365
+ "maxLength": 1024
366
+ },
367
+ "routerHost": {
368
+ "type": "string",
369
+ "maxLength": 1024
370
+ },
371
+ "routerTcpPort": {
372
+ "type": "string",
373
+ "maxLength": 1024
374
+ },
375
+ "cycleTimeMs": {
376
+ "type": "integer",
377
+ "minimum": 10,
378
+ "maximum": 3600000
379
+ },
380
+ "subscriptions": {
381
+ "type": "array",
382
+ "items": {
383
+ "type": "object",
384
+ "properties": {
385
+ "name": {
386
+ "type": "string",
387
+ "maxLength": 1024
388
+ }
389
+ }
390
+ },
391
+ "maxItems": 100
392
+ },
393
+ "configName": {
394
+ "type": "string",
395
+ "maxLength": 1024
396
+ }
397
+ },
398
+ "additionalProperties": false
399
+ },
400
+ "meta": {
401
+ "type": "object",
402
+ "properties": {
403
+ "category": {
404
+ "type": "string",
405
+ "enum": [
406
+ "trigger"
407
+ ]
408
+ },
409
+ "name": {
410
+ "type": "string",
411
+ "enum": [
412
+ "beckhoff"
413
+ ]
414
+ },
415
+ "label": {
416
+ "type": "string",
417
+ "minLength": 1,
418
+ "maxLength": 255
419
+ },
420
+ "x": {
421
+ "type": "number"
422
+ },
423
+ "y": {
424
+ "type": "number"
425
+ },
426
+ "uiId": {
427
+ "type": "string",
428
+ "maxLength": 48
429
+ },
430
+ "description": {
431
+ "type": "string",
432
+ "maxLength": 32767
433
+ },
434
+ "icon": {
435
+ "type": "string",
436
+ "maxLength": 1024
437
+ },
438
+ "color": {
439
+ "type": "string",
440
+ "maxLength": 1024
441
+ },
442
+ "inputCount": {
443
+ "type": "number"
444
+ },
445
+ "outputCount": {
446
+ "type": "number"
447
+ },
448
+ "id": {
449
+ "type": "string",
450
+ "maxLength": 48
451
+ }
452
+ },
453
+ "additionalProperties": false
454
+ },
455
+ "outputIds": {
456
+ "type": "array",
457
+ "items": {
458
+ "type": "array",
459
+ "items": {
460
+ "type": "string",
461
+ "maxLength": 48,
462
+ "minLength": 1
463
+ },
464
+ "maxItems": 100
465
+ },
466
+ "maxItems": 100
467
+ }
468
+ },
469
+ "required": [
470
+ "type"
471
+ ],
472
+ "additionalProperties": false
473
+ },
335
474
  {
336
475
  "type": "object",
337
476
  "properties": {
@@ -601,6 +740,9 @@
601
740
  "once",
602
741
  "each"
603
742
  ]
743
+ },
744
+ "allowInvalid": {
745
+ "type": "boolean"
604
746
  }
605
747
  },
606
748
  "additionalProperties": false