losant_rest 2.1.1 → 2.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/_schemas.md +1391 -55
- data/lib/platform_rest/client.rb +2 -2
- data/lib/platform_rest/version.rb +1 -1
- data/schemas/apiTokenPost.json +4 -0
- data/schemas/applicationDashboardPost.json +142 -11
- data/schemas/dashboard.json +142 -11
- data/schemas/dashboardPatch.json +142 -11
- data/schemas/dashboardPost.json +142 -11
- data/schemas/dashboards.json +142 -11
- data/schemas/githubLogin.json +4 -0
- data/schemas/instance.json +6 -0
- data/schemas/instanceOrg.json +12 -0
- data/schemas/instanceOrgEntitlement.json +182 -0
- data/schemas/instanceOrgEntitlementSync.json +64 -0
- data/schemas/instanceOrgs.json +12 -0
- data/schemas/instances.json +6 -0
- data/schemas/meEntitlements.json +194 -0
- data/schemas/org.json +16 -0
- data/schemas/orgPost.json +4 -0
- data/schemas/orgs.json +16 -0
- data/schemas/samlResponse.json +4 -0
- data/schemas/userCredentials.json +4 -0
- data/schemas/userPost.json +4 -0
- data/schemas/validateContextError.json +28 -0
- data/schemas/validateContextSuccess.json +28 -0
- metadata +4 -1
data/lib/platform_rest/client.rb
CHANGED
|
@@ -27,7 +27,7 @@ module PlatformRest
|
|
|
27
27
|
#
|
|
28
28
|
# User API for accessing platform data
|
|
29
29
|
#
|
|
30
|
-
# Built For Version 1.30.
|
|
30
|
+
# Built For Version 1.30.2
|
|
31
31
|
class Client
|
|
32
32
|
attr_accessor :auth_token, :url
|
|
33
33
|
|
|
@@ -438,7 +438,7 @@ module PlatformRest
|
|
|
438
438
|
|
|
439
439
|
headers["Accept"] = "application/json"
|
|
440
440
|
headers["Content-Type"] = "application/json"
|
|
441
|
-
headers["Accept-Version"] = "^1.30.
|
|
441
|
+
headers["Accept-Version"] = "^1.30.2"
|
|
442
442
|
headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
|
|
443
443
|
path = self.url + options.fetch(:path, "")
|
|
444
444
|
|
data/schemas/apiTokenPost.json
CHANGED
|
@@ -511,6 +511,7 @@
|
|
|
511
511
|
"instance.payloadCountsBreakdown",
|
|
512
512
|
"instance.deviceCounts",
|
|
513
513
|
"instance.notebookMinuteCounts",
|
|
514
|
+
"instance.entitlements",
|
|
514
515
|
"instanceOrg.*",
|
|
515
516
|
"instanceOrg.get",
|
|
516
517
|
"instanceOrg.patch",
|
|
@@ -519,6 +520,8 @@
|
|
|
519
520
|
"instanceOrg.payloadCountsBreakdown",
|
|
520
521
|
"instanceOrg.deviceCounts",
|
|
521
522
|
"instanceOrg.notebookMinuteCounts",
|
|
523
|
+
"instanceOrg.entitlement",
|
|
524
|
+
"instanceOrg.entitlementSync",
|
|
522
525
|
"instanceOrg.convertToEnterprise",
|
|
523
526
|
"instanceOrgs.*",
|
|
524
527
|
"instanceOrgs.get",
|
|
@@ -639,6 +642,7 @@
|
|
|
639
642
|
"me.invites",
|
|
640
643
|
"me.respondToInvite",
|
|
641
644
|
"me.refreshToken",
|
|
645
|
+
"me.entitlements",
|
|
642
646
|
"orgs.*",
|
|
643
647
|
"orgs.get",
|
|
644
648
|
"orgs.post"
|
|
@@ -1266,7 +1266,8 @@
|
|
|
1266
1266
|
"triangle-down",
|
|
1267
1267
|
"triangle-up",
|
|
1268
1268
|
"octagon"
|
|
1269
|
-
]
|
|
1269
|
+
],
|
|
1270
|
+
"default": "circle"
|
|
1270
1271
|
}
|
|
1271
1272
|
},
|
|
1272
1273
|
"additionalProperties": false
|
|
@@ -2234,7 +2235,8 @@
|
|
|
2234
2235
|
"triangle-down",
|
|
2235
2236
|
"triangle-up",
|
|
2236
2237
|
"octagon"
|
|
2237
|
-
]
|
|
2238
|
+
],
|
|
2239
|
+
"default": "circle"
|
|
2238
2240
|
}
|
|
2239
2241
|
},
|
|
2240
2242
|
"additionalProperties": false
|
|
@@ -3276,7 +3278,6 @@
|
|
|
3276
3278
|
"type": {
|
|
3277
3279
|
"type": "string",
|
|
3278
3280
|
"enum": [
|
|
3279
|
-
"indicator",
|
|
3280
3281
|
"label",
|
|
3281
3282
|
"image"
|
|
3282
3283
|
]
|
|
@@ -3332,7 +3333,8 @@
|
|
|
3332
3333
|
"triangle-down",
|
|
3333
3334
|
"triangle-up",
|
|
3334
3335
|
"octagon"
|
|
3335
|
-
]
|
|
3336
|
+
],
|
|
3337
|
+
"default": "circle"
|
|
3336
3338
|
}
|
|
3337
3339
|
},
|
|
3338
3340
|
"additionalProperties": false
|
|
@@ -3369,7 +3371,8 @@
|
|
|
3369
3371
|
"triangle-down",
|
|
3370
3372
|
"triangle-up",
|
|
3371
3373
|
"octagon"
|
|
3372
|
-
]
|
|
3374
|
+
],
|
|
3375
|
+
"default": "circle"
|
|
3373
3376
|
}
|
|
3374
3377
|
},
|
|
3375
3378
|
"additionalProperties": false
|
|
@@ -3383,6 +3386,125 @@
|
|
|
3383
3386
|
],
|
|
3384
3387
|
"additionalProperties": false
|
|
3385
3388
|
},
|
|
3389
|
+
{
|
|
3390
|
+
"type": "object",
|
|
3391
|
+
"properties": {
|
|
3392
|
+
"type": {
|
|
3393
|
+
"type": "string",
|
|
3394
|
+
"enum": [
|
|
3395
|
+
"indicator"
|
|
3396
|
+
]
|
|
3397
|
+
},
|
|
3398
|
+
"size": {
|
|
3399
|
+
"type": "string",
|
|
3400
|
+
"enum": [
|
|
3401
|
+
"small",
|
|
3402
|
+
"medium",
|
|
3403
|
+
"large"
|
|
3404
|
+
]
|
|
3405
|
+
},
|
|
3406
|
+
"position": {
|
|
3407
|
+
"type": "string",
|
|
3408
|
+
"minLength": 3,
|
|
3409
|
+
"maxLength": 255
|
|
3410
|
+
},
|
|
3411
|
+
"popupTemplate": {
|
|
3412
|
+
"type": "string",
|
|
3413
|
+
"maxLength": 32767
|
|
3414
|
+
},
|
|
3415
|
+
"conditions": {
|
|
3416
|
+
"type": "array",
|
|
3417
|
+
"maxItems": 100,
|
|
3418
|
+
"items": {
|
|
3419
|
+
"type": "object",
|
|
3420
|
+
"properties": {
|
|
3421
|
+
"color": {
|
|
3422
|
+
"type": "string",
|
|
3423
|
+
"maxLength": 64
|
|
3424
|
+
},
|
|
3425
|
+
"id": {
|
|
3426
|
+
"type": "string",
|
|
3427
|
+
"maxLength": 48
|
|
3428
|
+
},
|
|
3429
|
+
"label": {
|
|
3430
|
+
"type": "string",
|
|
3431
|
+
"maxLength": 32767
|
|
3432
|
+
},
|
|
3433
|
+
"condition": {
|
|
3434
|
+
"type": "string",
|
|
3435
|
+
"maxLength": 2048
|
|
3436
|
+
},
|
|
3437
|
+
"imageUrl": {
|
|
3438
|
+
"type": "string",
|
|
3439
|
+
"maxLength": 32767
|
|
3440
|
+
},
|
|
3441
|
+
"shape": {
|
|
3442
|
+
"type": "string",
|
|
3443
|
+
"enum": [
|
|
3444
|
+
"circle",
|
|
3445
|
+
"square",
|
|
3446
|
+
"triangle-down",
|
|
3447
|
+
"triangle-up",
|
|
3448
|
+
"octagon"
|
|
3449
|
+
],
|
|
3450
|
+
"default": "circle"
|
|
3451
|
+
}
|
|
3452
|
+
},
|
|
3453
|
+
"additionalProperties": false,
|
|
3454
|
+
"required": [
|
|
3455
|
+
"shape"
|
|
3456
|
+
]
|
|
3457
|
+
}
|
|
3458
|
+
},
|
|
3459
|
+
"defaultCondition": {
|
|
3460
|
+
"type": "object",
|
|
3461
|
+
"properties": {
|
|
3462
|
+
"color": {
|
|
3463
|
+
"type": "string",
|
|
3464
|
+
"maxLength": 64
|
|
3465
|
+
},
|
|
3466
|
+
"id": {
|
|
3467
|
+
"type": "string",
|
|
3468
|
+
"maxLength": 48
|
|
3469
|
+
},
|
|
3470
|
+
"label": {
|
|
3471
|
+
"type": "string",
|
|
3472
|
+
"maxLength": 32767
|
|
3473
|
+
},
|
|
3474
|
+
"condition": {
|
|
3475
|
+
"type": "string",
|
|
3476
|
+
"maxLength": 2048
|
|
3477
|
+
},
|
|
3478
|
+
"imageUrl": {
|
|
3479
|
+
"type": "string",
|
|
3480
|
+
"maxLength": 32767
|
|
3481
|
+
},
|
|
3482
|
+
"shape": {
|
|
3483
|
+
"type": "string",
|
|
3484
|
+
"enum": [
|
|
3485
|
+
"circle",
|
|
3486
|
+
"square",
|
|
3487
|
+
"triangle-down",
|
|
3488
|
+
"triangle-up",
|
|
3489
|
+
"octagon"
|
|
3490
|
+
],
|
|
3491
|
+
"default": "circle"
|
|
3492
|
+
}
|
|
3493
|
+
},
|
|
3494
|
+
"additionalProperties": false,
|
|
3495
|
+
"required": [
|
|
3496
|
+
"shape"
|
|
3497
|
+
]
|
|
3498
|
+
}
|
|
3499
|
+
},
|
|
3500
|
+
"required": [
|
|
3501
|
+
"type",
|
|
3502
|
+
"position",
|
|
3503
|
+
"size",
|
|
3504
|
+
"defaultCondition"
|
|
3505
|
+
],
|
|
3506
|
+
"additionalProperties": false
|
|
3507
|
+
},
|
|
3386
3508
|
{
|
|
3387
3509
|
"type": "object",
|
|
3388
3510
|
"properties": {
|
|
@@ -3443,7 +3565,8 @@
|
|
|
3443
3565
|
"triangle-down",
|
|
3444
3566
|
"triangle-up",
|
|
3445
3567
|
"octagon"
|
|
3446
|
-
]
|
|
3568
|
+
],
|
|
3569
|
+
"default": "circle"
|
|
3447
3570
|
}
|
|
3448
3571
|
},
|
|
3449
3572
|
"additionalProperties": false
|
|
@@ -3480,7 +3603,8 @@
|
|
|
3480
3603
|
"triangle-down",
|
|
3481
3604
|
"triangle-up",
|
|
3482
3605
|
"octagon"
|
|
3483
|
-
]
|
|
3606
|
+
],
|
|
3607
|
+
"default": "circle"
|
|
3484
3608
|
}
|
|
3485
3609
|
},
|
|
3486
3610
|
"additionalProperties": false
|
|
@@ -3558,7 +3682,8 @@
|
|
|
3558
3682
|
"triangle-down",
|
|
3559
3683
|
"triangle-up",
|
|
3560
3684
|
"octagon"
|
|
3561
|
-
]
|
|
3685
|
+
],
|
|
3686
|
+
"default": "circle"
|
|
3562
3687
|
}
|
|
3563
3688
|
},
|
|
3564
3689
|
"additionalProperties": false
|
|
@@ -3595,7 +3720,8 @@
|
|
|
3595
3720
|
"triangle-down",
|
|
3596
3721
|
"triangle-up",
|
|
3597
3722
|
"octagon"
|
|
3598
|
-
]
|
|
3723
|
+
],
|
|
3724
|
+
"default": "circle"
|
|
3599
3725
|
}
|
|
3600
3726
|
},
|
|
3601
3727
|
"additionalProperties": false
|
|
@@ -3939,7 +4065,8 @@
|
|
|
3939
4065
|
"triangle-down",
|
|
3940
4066
|
"triangle-up",
|
|
3941
4067
|
"octagon"
|
|
3942
|
-
]
|
|
4068
|
+
],
|
|
4069
|
+
"default": "circle"
|
|
3943
4070
|
}
|
|
3944
4071
|
},
|
|
3945
4072
|
"additionalProperties": false
|
|
@@ -3976,7 +4103,8 @@
|
|
|
3976
4103
|
"triangle-down",
|
|
3977
4104
|
"triangle-up",
|
|
3978
4105
|
"octagon"
|
|
3979
|
-
]
|
|
4106
|
+
],
|
|
4107
|
+
"default": "circle"
|
|
3980
4108
|
}
|
|
3981
4109
|
},
|
|
3982
4110
|
"additionalProperties": false
|
|
@@ -6435,6 +6563,9 @@
|
|
|
6435
6563
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
6436
6564
|
},
|
|
6437
6565
|
"maxItems": 1000
|
|
6566
|
+
},
|
|
6567
|
+
"includeExperienceGroups": {
|
|
6568
|
+
"type": "boolean"
|
|
6438
6569
|
}
|
|
6439
6570
|
},
|
|
6440
6571
|
"additionalProperties": false
|
data/schemas/dashboard.json
CHANGED
|
@@ -1491,7 +1491,8 @@
|
|
|
1491
1491
|
"triangle-down",
|
|
1492
1492
|
"triangle-up",
|
|
1493
1493
|
"octagon"
|
|
1494
|
-
]
|
|
1494
|
+
],
|
|
1495
|
+
"default": "circle"
|
|
1495
1496
|
}
|
|
1496
1497
|
},
|
|
1497
1498
|
"additionalProperties": false
|
|
@@ -2459,7 +2460,8 @@
|
|
|
2459
2460
|
"triangle-down",
|
|
2460
2461
|
"triangle-up",
|
|
2461
2462
|
"octagon"
|
|
2462
|
-
]
|
|
2463
|
+
],
|
|
2464
|
+
"default": "circle"
|
|
2463
2465
|
}
|
|
2464
2466
|
},
|
|
2465
2467
|
"additionalProperties": false
|
|
@@ -3501,7 +3503,6 @@
|
|
|
3501
3503
|
"type": {
|
|
3502
3504
|
"type": "string",
|
|
3503
3505
|
"enum": [
|
|
3504
|
-
"indicator",
|
|
3505
3506
|
"label",
|
|
3506
3507
|
"image"
|
|
3507
3508
|
]
|
|
@@ -3557,7 +3558,8 @@
|
|
|
3557
3558
|
"triangle-down",
|
|
3558
3559
|
"triangle-up",
|
|
3559
3560
|
"octagon"
|
|
3560
|
-
]
|
|
3561
|
+
],
|
|
3562
|
+
"default": "circle"
|
|
3561
3563
|
}
|
|
3562
3564
|
},
|
|
3563
3565
|
"additionalProperties": false
|
|
@@ -3594,7 +3596,8 @@
|
|
|
3594
3596
|
"triangle-down",
|
|
3595
3597
|
"triangle-up",
|
|
3596
3598
|
"octagon"
|
|
3597
|
-
]
|
|
3599
|
+
],
|
|
3600
|
+
"default": "circle"
|
|
3598
3601
|
}
|
|
3599
3602
|
},
|
|
3600
3603
|
"additionalProperties": false
|
|
@@ -3608,6 +3611,125 @@
|
|
|
3608
3611
|
],
|
|
3609
3612
|
"additionalProperties": false
|
|
3610
3613
|
},
|
|
3614
|
+
{
|
|
3615
|
+
"type": "object",
|
|
3616
|
+
"properties": {
|
|
3617
|
+
"type": {
|
|
3618
|
+
"type": "string",
|
|
3619
|
+
"enum": [
|
|
3620
|
+
"indicator"
|
|
3621
|
+
]
|
|
3622
|
+
},
|
|
3623
|
+
"size": {
|
|
3624
|
+
"type": "string",
|
|
3625
|
+
"enum": [
|
|
3626
|
+
"small",
|
|
3627
|
+
"medium",
|
|
3628
|
+
"large"
|
|
3629
|
+
]
|
|
3630
|
+
},
|
|
3631
|
+
"position": {
|
|
3632
|
+
"type": "string",
|
|
3633
|
+
"minLength": 3,
|
|
3634
|
+
"maxLength": 255
|
|
3635
|
+
},
|
|
3636
|
+
"popupTemplate": {
|
|
3637
|
+
"type": "string",
|
|
3638
|
+
"maxLength": 32767
|
|
3639
|
+
},
|
|
3640
|
+
"conditions": {
|
|
3641
|
+
"type": "array",
|
|
3642
|
+
"maxItems": 100,
|
|
3643
|
+
"items": {
|
|
3644
|
+
"type": "object",
|
|
3645
|
+
"properties": {
|
|
3646
|
+
"color": {
|
|
3647
|
+
"type": "string",
|
|
3648
|
+
"maxLength": 64
|
|
3649
|
+
},
|
|
3650
|
+
"id": {
|
|
3651
|
+
"type": "string",
|
|
3652
|
+
"maxLength": 48
|
|
3653
|
+
},
|
|
3654
|
+
"label": {
|
|
3655
|
+
"type": "string",
|
|
3656
|
+
"maxLength": 32767
|
|
3657
|
+
},
|
|
3658
|
+
"condition": {
|
|
3659
|
+
"type": "string",
|
|
3660
|
+
"maxLength": 2048
|
|
3661
|
+
},
|
|
3662
|
+
"imageUrl": {
|
|
3663
|
+
"type": "string",
|
|
3664
|
+
"maxLength": 32767
|
|
3665
|
+
},
|
|
3666
|
+
"shape": {
|
|
3667
|
+
"type": "string",
|
|
3668
|
+
"enum": [
|
|
3669
|
+
"circle",
|
|
3670
|
+
"square",
|
|
3671
|
+
"triangle-down",
|
|
3672
|
+
"triangle-up",
|
|
3673
|
+
"octagon"
|
|
3674
|
+
],
|
|
3675
|
+
"default": "circle"
|
|
3676
|
+
}
|
|
3677
|
+
},
|
|
3678
|
+
"additionalProperties": false,
|
|
3679
|
+
"required": [
|
|
3680
|
+
"shape"
|
|
3681
|
+
]
|
|
3682
|
+
}
|
|
3683
|
+
},
|
|
3684
|
+
"defaultCondition": {
|
|
3685
|
+
"type": "object",
|
|
3686
|
+
"properties": {
|
|
3687
|
+
"color": {
|
|
3688
|
+
"type": "string",
|
|
3689
|
+
"maxLength": 64
|
|
3690
|
+
},
|
|
3691
|
+
"id": {
|
|
3692
|
+
"type": "string",
|
|
3693
|
+
"maxLength": 48
|
|
3694
|
+
},
|
|
3695
|
+
"label": {
|
|
3696
|
+
"type": "string",
|
|
3697
|
+
"maxLength": 32767
|
|
3698
|
+
},
|
|
3699
|
+
"condition": {
|
|
3700
|
+
"type": "string",
|
|
3701
|
+
"maxLength": 2048
|
|
3702
|
+
},
|
|
3703
|
+
"imageUrl": {
|
|
3704
|
+
"type": "string",
|
|
3705
|
+
"maxLength": 32767
|
|
3706
|
+
},
|
|
3707
|
+
"shape": {
|
|
3708
|
+
"type": "string",
|
|
3709
|
+
"enum": [
|
|
3710
|
+
"circle",
|
|
3711
|
+
"square",
|
|
3712
|
+
"triangle-down",
|
|
3713
|
+
"triangle-up",
|
|
3714
|
+
"octagon"
|
|
3715
|
+
],
|
|
3716
|
+
"default": "circle"
|
|
3717
|
+
}
|
|
3718
|
+
},
|
|
3719
|
+
"additionalProperties": false,
|
|
3720
|
+
"required": [
|
|
3721
|
+
"shape"
|
|
3722
|
+
]
|
|
3723
|
+
}
|
|
3724
|
+
},
|
|
3725
|
+
"required": [
|
|
3726
|
+
"type",
|
|
3727
|
+
"position",
|
|
3728
|
+
"size",
|
|
3729
|
+
"defaultCondition"
|
|
3730
|
+
],
|
|
3731
|
+
"additionalProperties": false
|
|
3732
|
+
},
|
|
3611
3733
|
{
|
|
3612
3734
|
"type": "object",
|
|
3613
3735
|
"properties": {
|
|
@@ -3668,7 +3790,8 @@
|
|
|
3668
3790
|
"triangle-down",
|
|
3669
3791
|
"triangle-up",
|
|
3670
3792
|
"octagon"
|
|
3671
|
-
]
|
|
3793
|
+
],
|
|
3794
|
+
"default": "circle"
|
|
3672
3795
|
}
|
|
3673
3796
|
},
|
|
3674
3797
|
"additionalProperties": false
|
|
@@ -3705,7 +3828,8 @@
|
|
|
3705
3828
|
"triangle-down",
|
|
3706
3829
|
"triangle-up",
|
|
3707
3830
|
"octagon"
|
|
3708
|
-
]
|
|
3831
|
+
],
|
|
3832
|
+
"default": "circle"
|
|
3709
3833
|
}
|
|
3710
3834
|
},
|
|
3711
3835
|
"additionalProperties": false
|
|
@@ -3783,7 +3907,8 @@
|
|
|
3783
3907
|
"triangle-down",
|
|
3784
3908
|
"triangle-up",
|
|
3785
3909
|
"octagon"
|
|
3786
|
-
]
|
|
3910
|
+
],
|
|
3911
|
+
"default": "circle"
|
|
3787
3912
|
}
|
|
3788
3913
|
},
|
|
3789
3914
|
"additionalProperties": false
|
|
@@ -3820,7 +3945,8 @@
|
|
|
3820
3945
|
"triangle-down",
|
|
3821
3946
|
"triangle-up",
|
|
3822
3947
|
"octagon"
|
|
3823
|
-
]
|
|
3948
|
+
],
|
|
3949
|
+
"default": "circle"
|
|
3824
3950
|
}
|
|
3825
3951
|
},
|
|
3826
3952
|
"additionalProperties": false
|
|
@@ -4164,7 +4290,8 @@
|
|
|
4164
4290
|
"triangle-down",
|
|
4165
4291
|
"triangle-up",
|
|
4166
4292
|
"octagon"
|
|
4167
|
-
]
|
|
4293
|
+
],
|
|
4294
|
+
"default": "circle"
|
|
4168
4295
|
}
|
|
4169
4296
|
},
|
|
4170
4297
|
"additionalProperties": false
|
|
@@ -4201,7 +4328,8 @@
|
|
|
4201
4328
|
"triangle-down",
|
|
4202
4329
|
"triangle-up",
|
|
4203
4330
|
"octagon"
|
|
4204
|
-
]
|
|
4331
|
+
],
|
|
4332
|
+
"default": "circle"
|
|
4205
4333
|
}
|
|
4206
4334
|
},
|
|
4207
4335
|
"additionalProperties": false
|
|
@@ -6521,6 +6649,9 @@
|
|
|
6521
6649
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
6522
6650
|
},
|
|
6523
6651
|
"maxItems": 1000
|
|
6652
|
+
},
|
|
6653
|
+
"includeExperienceGroups": {
|
|
6654
|
+
"type": "boolean"
|
|
6524
6655
|
}
|
|
6525
6656
|
},
|
|
6526
6657
|
"additionalProperties": false
|