losant_rest 1.0.5 → 1.0.6
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 +580 -11
- data/docs/device.md +40 -1
- data/docs/me.md +34 -4
- data/docs/org.md +38 -3
- data/lib/losant_rest/client.rb +2 -2
- data/lib/losant_rest/device.rb +49 -1
- data/lib/losant_rest/me.rb +39 -2
- data/lib/losant_rest/org.rb +42 -1
- data/lib/losant_rest/version.rb +1 -1
- data/schemas/compositeDeviceState.json +44 -0
- data/schemas/me.json +140 -5
- data/schemas/org.json +131 -2
- data/schemas/orgPatch.json +16 -0
- data/schemas/orgPost.json +16 -0
- data/schemas/orgs.json +131 -2
- data/schemas/recentItem.json +2 -1
- data/schemas/recentItemList.json +2 -1
- data/schemas/resourceTransfer.json +46 -0
- data/schemas/timeSeriesQuery.json +3 -0
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c11a85f0b5a6200a2ea9aa541eb96aee3ba5a376
|
|
4
|
+
data.tar.gz: d3f145e28a8e00dc74d2745881c51201c8569a9b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: cac9c0ec1272db66322919234c75292d3bb9e5dd0eeee4846d5fb298f434eeabee9ff2ef467719d8ccc9d5350f92f91b011c047c378ef43021fa2e65de66e0b4
|
|
7
|
+
data.tar.gz: 2e6d8b88d29de4d78dc8dd088f83d171aa196d9d5e8ad4348c7bbf45a766d0c38e811943da3cbf220f1f750fd0628e9eabe6572f1d5703c8b665322a1c86ab82
|
data/docs/_schemas.md
CHANGED
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
* [Authenticated Device](#authenticated-device)
|
|
16
16
|
* [Authenticated Solution User](#authenticated-solution-user)
|
|
17
17
|
* [Authenticated User](#authenticated-user)
|
|
18
|
+
* [Composite Device State](#composite-device-state)
|
|
18
19
|
* [Dashboard](#dashboard)
|
|
19
20
|
* [Dashboard Patch](#dashboard-patch)
|
|
20
21
|
* [Dashboard Post](#dashboard-post)
|
|
@@ -66,6 +67,7 @@
|
|
|
66
67
|
* [Payload Counts](#payload-counts)
|
|
67
68
|
* [Recent Item](#recent-item)
|
|
68
69
|
* [Recent Item List](#recent-item-list)
|
|
70
|
+
* [Resource Transfer](#resource-transfer)
|
|
69
71
|
* [Solution](#solution)
|
|
70
72
|
* [Solution Patch](#solution-patch)
|
|
71
73
|
* [Solution Post](#solution-post)
|
|
@@ -1141,6 +1143,75 @@ Schema for the sucessful response when authenticating a User
|
|
|
1141
1143
|
|
|
1142
1144
|
<br/>
|
|
1143
1145
|
|
|
1146
|
+
## Composite Device State
|
|
1147
|
+
|
|
1148
|
+
Schema for a composite Device state
|
|
1149
|
+
|
|
1150
|
+
### <a name="composite-device-state-schema"></a> Schema
|
|
1151
|
+
|
|
1152
|
+
```json
|
|
1153
|
+
{
|
|
1154
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
1155
|
+
"type": "object",
|
|
1156
|
+
"patternProperties": {
|
|
1157
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
1158
|
+
"type": "object",
|
|
1159
|
+
"properties": {
|
|
1160
|
+
"value": {
|
|
1161
|
+
"type": [
|
|
1162
|
+
"number",
|
|
1163
|
+
"string",
|
|
1164
|
+
"boolean"
|
|
1165
|
+
]
|
|
1166
|
+
},
|
|
1167
|
+
"time": {
|
|
1168
|
+
"oneOf": [
|
|
1169
|
+
{
|
|
1170
|
+
"type": "string"
|
|
1171
|
+
},
|
|
1172
|
+
{
|
|
1173
|
+
"type": "number"
|
|
1174
|
+
},
|
|
1175
|
+
{
|
|
1176
|
+
"type": "object",
|
|
1177
|
+
"properties": {
|
|
1178
|
+
"$date": {
|
|
1179
|
+
"type": "string"
|
|
1180
|
+
}
|
|
1181
|
+
},
|
|
1182
|
+
"additionalProperties": false,
|
|
1183
|
+
"required": [
|
|
1184
|
+
"$date"
|
|
1185
|
+
]
|
|
1186
|
+
}
|
|
1187
|
+
]
|
|
1188
|
+
},
|
|
1189
|
+
"relayId": {
|
|
1190
|
+
"type": "string"
|
|
1191
|
+
}
|
|
1192
|
+
}
|
|
1193
|
+
}
|
|
1194
|
+
},
|
|
1195
|
+
"additionalProperties": false
|
|
1196
|
+
}
|
|
1197
|
+
```
|
|
1198
|
+
### <a name="composite-device-state-example"></a> Example
|
|
1199
|
+
|
|
1200
|
+
```json
|
|
1201
|
+
{
|
|
1202
|
+
"voltage": {
|
|
1203
|
+
"time": "2016-06-13T04:00:00.000Z",
|
|
1204
|
+
"value": 22.4
|
|
1205
|
+
},
|
|
1206
|
+
"loaded": {
|
|
1207
|
+
"time": "2016-06-13T03:00:00.000Z",
|
|
1208
|
+
"value": false
|
|
1209
|
+
}
|
|
1210
|
+
}
|
|
1211
|
+
```
|
|
1212
|
+
|
|
1213
|
+
<br/>
|
|
1214
|
+
|
|
1144
1215
|
## Dashboard
|
|
1145
1216
|
|
|
1146
1217
|
Schema for a single Dashboard
|
|
@@ -5030,6 +5101,9 @@ Schema for information about the currently authenticated user
|
|
|
5030
5101
|
},
|
|
5031
5102
|
"dataTTL": {
|
|
5032
5103
|
"type": "number"
|
|
5104
|
+
},
|
|
5105
|
+
"payload": {
|
|
5106
|
+
"type": "number"
|
|
5033
5107
|
}
|
|
5034
5108
|
},
|
|
5035
5109
|
"recentDashboards": {
|
|
@@ -5043,7 +5117,8 @@ Schema for information about the currently authenticated user
|
|
|
5043
5117
|
"application",
|
|
5044
5118
|
"device",
|
|
5045
5119
|
"flow",
|
|
5046
|
-
"dashboard"
|
|
5120
|
+
"dashboard",
|
|
5121
|
+
"organization"
|
|
5047
5122
|
]
|
|
5048
5123
|
},
|
|
5049
5124
|
"parentId": {
|
|
@@ -5080,7 +5155,46 @@ Schema for information about the currently authenticated user
|
|
|
5080
5155
|
"application",
|
|
5081
5156
|
"device",
|
|
5082
5157
|
"flow",
|
|
5083
|
-
"dashboard"
|
|
5158
|
+
"dashboard",
|
|
5159
|
+
"organization"
|
|
5160
|
+
]
|
|
5161
|
+
},
|
|
5162
|
+
"parentId": {
|
|
5163
|
+
"type": "string",
|
|
5164
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
5165
|
+
},
|
|
5166
|
+
"items": {
|
|
5167
|
+
"type": "array",
|
|
5168
|
+
"items": {
|
|
5169
|
+
"type": "object",
|
|
5170
|
+
"properties": {
|
|
5171
|
+
"id": {
|
|
5172
|
+
"type": "string",
|
|
5173
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
5174
|
+
},
|
|
5175
|
+
"name": {
|
|
5176
|
+
"type": "string",
|
|
5177
|
+
"minLength": 1,
|
|
5178
|
+
"maxLength": 255
|
|
5179
|
+
}
|
|
5180
|
+
}
|
|
5181
|
+
}
|
|
5182
|
+
}
|
|
5183
|
+
}
|
|
5184
|
+
},
|
|
5185
|
+
"recentOrganizations": {
|
|
5186
|
+
"title": "Recent Item List",
|
|
5187
|
+
"description": "Schema for an array of recent items",
|
|
5188
|
+
"type": "object",
|
|
5189
|
+
"properties": {
|
|
5190
|
+
"itemType": {
|
|
5191
|
+
"type": "string",
|
|
5192
|
+
"enum": [
|
|
5193
|
+
"application",
|
|
5194
|
+
"device",
|
|
5195
|
+
"flow",
|
|
5196
|
+
"dashboard",
|
|
5197
|
+
"organization"
|
|
5084
5198
|
]
|
|
5085
5199
|
},
|
|
5086
5200
|
"parentId": {
|
|
@@ -5130,13 +5244,105 @@ Schema for information about the currently authenticated user
|
|
|
5130
5244
|
"keyCount": {
|
|
5131
5245
|
"type": "number"
|
|
5132
5246
|
},
|
|
5133
|
-
"eventCount": {
|
|
5134
|
-
"type": "number"
|
|
5135
|
-
},
|
|
5136
5247
|
"deviceRecipeCount": {
|
|
5137
5248
|
"type": "number"
|
|
5249
|
+
},
|
|
5250
|
+
"payloadCount": {
|
|
5251
|
+
"title": "Payload Counts",
|
|
5252
|
+
"description": "Schema the result of a payload count request",
|
|
5253
|
+
"type": "object",
|
|
5254
|
+
"properties": {
|
|
5255
|
+
"mqttOut": {
|
|
5256
|
+
"type": "object",
|
|
5257
|
+
"patternProperties": {
|
|
5258
|
+
".*": {
|
|
5259
|
+
"type": "number"
|
|
5260
|
+
}
|
|
5261
|
+
}
|
|
5262
|
+
},
|
|
5263
|
+
"mqttIn": {
|
|
5264
|
+
"type": "object",
|
|
5265
|
+
"patternProperties": {
|
|
5266
|
+
".*": {
|
|
5267
|
+
"type": "number"
|
|
5268
|
+
}
|
|
5269
|
+
}
|
|
5270
|
+
},
|
|
5271
|
+
"deviceState": {
|
|
5272
|
+
"type": "object",
|
|
5273
|
+
"patternProperties": {
|
|
5274
|
+
".*": {
|
|
5275
|
+
"type": "number"
|
|
5276
|
+
}
|
|
5277
|
+
}
|
|
5278
|
+
},
|
|
5279
|
+
"deviceCommand": {
|
|
5280
|
+
"type": "object",
|
|
5281
|
+
"patternProperties": {
|
|
5282
|
+
".*": {
|
|
5283
|
+
"type": "number"
|
|
5284
|
+
}
|
|
5285
|
+
}
|
|
5286
|
+
},
|
|
5287
|
+
"webhook": {
|
|
5288
|
+
"type": "object",
|
|
5289
|
+
"patternProperties": {
|
|
5290
|
+
".*": {
|
|
5291
|
+
"type": "number"
|
|
5292
|
+
}
|
|
5293
|
+
}
|
|
5294
|
+
},
|
|
5295
|
+
"timer": {
|
|
5296
|
+
"type": "object",
|
|
5297
|
+
"patternProperties": {
|
|
5298
|
+
".*": {
|
|
5299
|
+
"type": "number"
|
|
5300
|
+
}
|
|
5301
|
+
}
|
|
5302
|
+
},
|
|
5303
|
+
"event": {
|
|
5304
|
+
"type": "object",
|
|
5305
|
+
"patternProperties": {
|
|
5306
|
+
".*": {
|
|
5307
|
+
"type": "number"
|
|
5308
|
+
}
|
|
5309
|
+
}
|
|
5310
|
+
},
|
|
5311
|
+
"virtualButton": {
|
|
5312
|
+
"type": "object",
|
|
5313
|
+
"patternProperties": {
|
|
5314
|
+
".*": {
|
|
5315
|
+
"type": "number"
|
|
5316
|
+
}
|
|
5317
|
+
}
|
|
5318
|
+
},
|
|
5319
|
+
"deviceConnect": {
|
|
5320
|
+
"type": "object",
|
|
5321
|
+
"patternProperties": {
|
|
5322
|
+
".*": {
|
|
5323
|
+
"type": "number"
|
|
5324
|
+
}
|
|
5325
|
+
}
|
|
5326
|
+
},
|
|
5327
|
+
"deviceDisconnect": {
|
|
5328
|
+
"type": "object",
|
|
5329
|
+
"patternProperties": {
|
|
5330
|
+
".*": {
|
|
5331
|
+
"type": "number"
|
|
5332
|
+
}
|
|
5333
|
+
}
|
|
5334
|
+
}
|
|
5335
|
+
}
|
|
5138
5336
|
}
|
|
5139
5337
|
}
|
|
5338
|
+
},
|
|
5339
|
+
"currentPeriodStart": {
|
|
5340
|
+
"type": "string",
|
|
5341
|
+
"format": "date-time"
|
|
5342
|
+
},
|
|
5343
|
+
"currentPeriodEnd": {
|
|
5344
|
+
"type": "string",
|
|
5345
|
+
"format": "date-time"
|
|
5140
5346
|
}
|
|
5141
5347
|
}
|
|
5142
5348
|
}
|
|
@@ -5439,6 +5645,12 @@ Schema for a single Organization
|
|
|
5439
5645
|
},
|
|
5440
5646
|
"dataTTL": {
|
|
5441
5647
|
"type": "number"
|
|
5648
|
+
},
|
|
5649
|
+
"member": {
|
|
5650
|
+
"type": "number"
|
|
5651
|
+
},
|
|
5652
|
+
"payload": {
|
|
5653
|
+
"type": "number"
|
|
5442
5654
|
}
|
|
5443
5655
|
},
|
|
5444
5656
|
"summary": {
|
|
@@ -5465,13 +5677,136 @@ Schema for a single Organization
|
|
|
5465
5677
|
"keyCount": {
|
|
5466
5678
|
"type": "number"
|
|
5467
5679
|
},
|
|
5468
|
-
"
|
|
5680
|
+
"deviceRecipeCount": {
|
|
5469
5681
|
"type": "number"
|
|
5470
5682
|
},
|
|
5471
|
-
"
|
|
5683
|
+
"payloadCount": {
|
|
5684
|
+
"title": "Payload Counts",
|
|
5685
|
+
"description": "Schema the result of a payload count request",
|
|
5686
|
+
"type": "object",
|
|
5687
|
+
"properties": {
|
|
5688
|
+
"mqttOut": {
|
|
5689
|
+
"type": "object",
|
|
5690
|
+
"patternProperties": {
|
|
5691
|
+
".*": {
|
|
5692
|
+
"type": "number"
|
|
5693
|
+
}
|
|
5694
|
+
}
|
|
5695
|
+
},
|
|
5696
|
+
"mqttIn": {
|
|
5697
|
+
"type": "object",
|
|
5698
|
+
"patternProperties": {
|
|
5699
|
+
".*": {
|
|
5700
|
+
"type": "number"
|
|
5701
|
+
}
|
|
5702
|
+
}
|
|
5703
|
+
},
|
|
5704
|
+
"deviceState": {
|
|
5705
|
+
"type": "object",
|
|
5706
|
+
"patternProperties": {
|
|
5707
|
+
".*": {
|
|
5708
|
+
"type": "number"
|
|
5709
|
+
}
|
|
5710
|
+
}
|
|
5711
|
+
},
|
|
5712
|
+
"deviceCommand": {
|
|
5713
|
+
"type": "object",
|
|
5714
|
+
"patternProperties": {
|
|
5715
|
+
".*": {
|
|
5716
|
+
"type": "number"
|
|
5717
|
+
}
|
|
5718
|
+
}
|
|
5719
|
+
},
|
|
5720
|
+
"webhook": {
|
|
5721
|
+
"type": "object",
|
|
5722
|
+
"patternProperties": {
|
|
5723
|
+
".*": {
|
|
5724
|
+
"type": "number"
|
|
5725
|
+
}
|
|
5726
|
+
}
|
|
5727
|
+
},
|
|
5728
|
+
"timer": {
|
|
5729
|
+
"type": "object",
|
|
5730
|
+
"patternProperties": {
|
|
5731
|
+
".*": {
|
|
5732
|
+
"type": "number"
|
|
5733
|
+
}
|
|
5734
|
+
}
|
|
5735
|
+
},
|
|
5736
|
+
"event": {
|
|
5737
|
+
"type": "object",
|
|
5738
|
+
"patternProperties": {
|
|
5739
|
+
".*": {
|
|
5740
|
+
"type": "number"
|
|
5741
|
+
}
|
|
5742
|
+
}
|
|
5743
|
+
},
|
|
5744
|
+
"virtualButton": {
|
|
5745
|
+
"type": "object",
|
|
5746
|
+
"patternProperties": {
|
|
5747
|
+
".*": {
|
|
5748
|
+
"type": "number"
|
|
5749
|
+
}
|
|
5750
|
+
}
|
|
5751
|
+
},
|
|
5752
|
+
"deviceConnect": {
|
|
5753
|
+
"type": "object",
|
|
5754
|
+
"patternProperties": {
|
|
5755
|
+
".*": {
|
|
5756
|
+
"type": "number"
|
|
5757
|
+
}
|
|
5758
|
+
}
|
|
5759
|
+
},
|
|
5760
|
+
"deviceDisconnect": {
|
|
5761
|
+
"type": "object",
|
|
5762
|
+
"patternProperties": {
|
|
5763
|
+
".*": {
|
|
5764
|
+
"type": "number"
|
|
5765
|
+
}
|
|
5766
|
+
}
|
|
5767
|
+
}
|
|
5768
|
+
}
|
|
5769
|
+
},
|
|
5770
|
+
"pendingInviteCount": {
|
|
5771
|
+
"type": "number"
|
|
5772
|
+
},
|
|
5773
|
+
"memberCount": {
|
|
5472
5774
|
"type": "number"
|
|
5473
5775
|
}
|
|
5474
5776
|
}
|
|
5777
|
+
},
|
|
5778
|
+
"planId": {
|
|
5779
|
+
"type": "string",
|
|
5780
|
+
"maxLength": 1024
|
|
5781
|
+
},
|
|
5782
|
+
"billingEmail": {
|
|
5783
|
+
"type": "string",
|
|
5784
|
+
"format": "email",
|
|
5785
|
+
"maxLength": 1024
|
|
5786
|
+
},
|
|
5787
|
+
"subscriptionStatus": {
|
|
5788
|
+
"type": "string",
|
|
5789
|
+
"enum": [
|
|
5790
|
+
"trialing",
|
|
5791
|
+
"active",
|
|
5792
|
+
"past_due",
|
|
5793
|
+
"canceled",
|
|
5794
|
+
"unpaid"
|
|
5795
|
+
]
|
|
5796
|
+
},
|
|
5797
|
+
"currentPeriodStart": {
|
|
5798
|
+
"type": "string",
|
|
5799
|
+
"format": "date-time"
|
|
5800
|
+
},
|
|
5801
|
+
"currentPeriodEnd": {
|
|
5802
|
+
"type": "string",
|
|
5803
|
+
"format": "date-time"
|
|
5804
|
+
},
|
|
5805
|
+
"isEnterprise": {
|
|
5806
|
+
"type": "boolean"
|
|
5807
|
+
},
|
|
5808
|
+
"iconColor": {
|
|
5809
|
+
"type": "string"
|
|
5475
5810
|
}
|
|
5476
5811
|
}
|
|
5477
5812
|
}
|
|
@@ -5682,6 +6017,22 @@ Schema for the body of an Organization modification request
|
|
|
5682
6017
|
"description": {
|
|
5683
6018
|
"type": "string",
|
|
5684
6019
|
"maxLength": 32767
|
|
6020
|
+
},
|
|
6021
|
+
"planId": {
|
|
6022
|
+
"type": "string",
|
|
6023
|
+
"maxLength": 1024
|
|
6024
|
+
},
|
|
6025
|
+
"billingEmail": {
|
|
6026
|
+
"type": "string",
|
|
6027
|
+
"format": "email",
|
|
6028
|
+
"maxLength": 1024
|
|
6029
|
+
},
|
|
6030
|
+
"cardToken": {
|
|
6031
|
+
"type": "string",
|
|
6032
|
+
"maxLength": 1024
|
|
6033
|
+
},
|
|
6034
|
+
"iconColor": {
|
|
6035
|
+
"type": "string"
|
|
5685
6036
|
}
|
|
5686
6037
|
},
|
|
5687
6038
|
"additionalProperties": false
|
|
@@ -5717,6 +6068,22 @@ Schema for the body of an Organization creation request
|
|
|
5717
6068
|
"description": {
|
|
5718
6069
|
"type": "string",
|
|
5719
6070
|
"maxLength": 32767
|
|
6071
|
+
},
|
|
6072
|
+
"planId": {
|
|
6073
|
+
"type": "string",
|
|
6074
|
+
"maxLength": 1024
|
|
6075
|
+
},
|
|
6076
|
+
"billingEmail": {
|
|
6077
|
+
"type": "string",
|
|
6078
|
+
"format": "email",
|
|
6079
|
+
"maxLength": 1024
|
|
6080
|
+
},
|
|
6081
|
+
"cardToken": {
|
|
6082
|
+
"type": "string",
|
|
6083
|
+
"maxLength": 1024
|
|
6084
|
+
},
|
|
6085
|
+
"iconColor": {
|
|
6086
|
+
"type": "string"
|
|
5720
6087
|
}
|
|
5721
6088
|
},
|
|
5722
6089
|
"additionalProperties": false,
|
|
@@ -5848,6 +6215,12 @@ Schema for a collection of Organizations
|
|
|
5848
6215
|
},
|
|
5849
6216
|
"dataTTL": {
|
|
5850
6217
|
"type": "number"
|
|
6218
|
+
},
|
|
6219
|
+
"member": {
|
|
6220
|
+
"type": "number"
|
|
6221
|
+
},
|
|
6222
|
+
"payload": {
|
|
6223
|
+
"type": "number"
|
|
5851
6224
|
}
|
|
5852
6225
|
},
|
|
5853
6226
|
"summary": {
|
|
@@ -5874,13 +6247,136 @@ Schema for a collection of Organizations
|
|
|
5874
6247
|
"keyCount": {
|
|
5875
6248
|
"type": "number"
|
|
5876
6249
|
},
|
|
5877
|
-
"
|
|
6250
|
+
"deviceRecipeCount": {
|
|
5878
6251
|
"type": "number"
|
|
5879
6252
|
},
|
|
5880
|
-
"
|
|
6253
|
+
"payloadCount": {
|
|
6254
|
+
"title": "Payload Counts",
|
|
6255
|
+
"description": "Schema the result of a payload count request",
|
|
6256
|
+
"type": "object",
|
|
6257
|
+
"properties": {
|
|
6258
|
+
"mqttOut": {
|
|
6259
|
+
"type": "object",
|
|
6260
|
+
"patternProperties": {
|
|
6261
|
+
".*": {
|
|
6262
|
+
"type": "number"
|
|
6263
|
+
}
|
|
6264
|
+
}
|
|
6265
|
+
},
|
|
6266
|
+
"mqttIn": {
|
|
6267
|
+
"type": "object",
|
|
6268
|
+
"patternProperties": {
|
|
6269
|
+
".*": {
|
|
6270
|
+
"type": "number"
|
|
6271
|
+
}
|
|
6272
|
+
}
|
|
6273
|
+
},
|
|
6274
|
+
"deviceState": {
|
|
6275
|
+
"type": "object",
|
|
6276
|
+
"patternProperties": {
|
|
6277
|
+
".*": {
|
|
6278
|
+
"type": "number"
|
|
6279
|
+
}
|
|
6280
|
+
}
|
|
6281
|
+
},
|
|
6282
|
+
"deviceCommand": {
|
|
6283
|
+
"type": "object",
|
|
6284
|
+
"patternProperties": {
|
|
6285
|
+
".*": {
|
|
6286
|
+
"type": "number"
|
|
6287
|
+
}
|
|
6288
|
+
}
|
|
6289
|
+
},
|
|
6290
|
+
"webhook": {
|
|
6291
|
+
"type": "object",
|
|
6292
|
+
"patternProperties": {
|
|
6293
|
+
".*": {
|
|
6294
|
+
"type": "number"
|
|
6295
|
+
}
|
|
6296
|
+
}
|
|
6297
|
+
},
|
|
6298
|
+
"timer": {
|
|
6299
|
+
"type": "object",
|
|
6300
|
+
"patternProperties": {
|
|
6301
|
+
".*": {
|
|
6302
|
+
"type": "number"
|
|
6303
|
+
}
|
|
6304
|
+
}
|
|
6305
|
+
},
|
|
6306
|
+
"event": {
|
|
6307
|
+
"type": "object",
|
|
6308
|
+
"patternProperties": {
|
|
6309
|
+
".*": {
|
|
6310
|
+
"type": "number"
|
|
6311
|
+
}
|
|
6312
|
+
}
|
|
6313
|
+
},
|
|
6314
|
+
"virtualButton": {
|
|
6315
|
+
"type": "object",
|
|
6316
|
+
"patternProperties": {
|
|
6317
|
+
".*": {
|
|
6318
|
+
"type": "number"
|
|
6319
|
+
}
|
|
6320
|
+
}
|
|
6321
|
+
},
|
|
6322
|
+
"deviceConnect": {
|
|
6323
|
+
"type": "object",
|
|
6324
|
+
"patternProperties": {
|
|
6325
|
+
".*": {
|
|
6326
|
+
"type": "number"
|
|
6327
|
+
}
|
|
6328
|
+
}
|
|
6329
|
+
},
|
|
6330
|
+
"deviceDisconnect": {
|
|
6331
|
+
"type": "object",
|
|
6332
|
+
"patternProperties": {
|
|
6333
|
+
".*": {
|
|
6334
|
+
"type": "number"
|
|
6335
|
+
}
|
|
6336
|
+
}
|
|
6337
|
+
}
|
|
6338
|
+
}
|
|
6339
|
+
},
|
|
6340
|
+
"pendingInviteCount": {
|
|
6341
|
+
"type": "number"
|
|
6342
|
+
},
|
|
6343
|
+
"memberCount": {
|
|
5881
6344
|
"type": "number"
|
|
5882
6345
|
}
|
|
5883
6346
|
}
|
|
6347
|
+
},
|
|
6348
|
+
"planId": {
|
|
6349
|
+
"type": "string",
|
|
6350
|
+
"maxLength": 1024
|
|
6351
|
+
},
|
|
6352
|
+
"billingEmail": {
|
|
6353
|
+
"type": "string",
|
|
6354
|
+
"format": "email",
|
|
6355
|
+
"maxLength": 1024
|
|
6356
|
+
},
|
|
6357
|
+
"subscriptionStatus": {
|
|
6358
|
+
"type": "string",
|
|
6359
|
+
"enum": [
|
|
6360
|
+
"trialing",
|
|
6361
|
+
"active",
|
|
6362
|
+
"past_due",
|
|
6363
|
+
"canceled",
|
|
6364
|
+
"unpaid"
|
|
6365
|
+
]
|
|
6366
|
+
},
|
|
6367
|
+
"currentPeriodStart": {
|
|
6368
|
+
"type": "string",
|
|
6369
|
+
"format": "date-time"
|
|
6370
|
+
},
|
|
6371
|
+
"currentPeriodEnd": {
|
|
6372
|
+
"type": "string",
|
|
6373
|
+
"format": "date-time"
|
|
6374
|
+
},
|
|
6375
|
+
"isEnterprise": {
|
|
6376
|
+
"type": "boolean"
|
|
6377
|
+
},
|
|
6378
|
+
"iconColor": {
|
|
6379
|
+
"type": "string"
|
|
5884
6380
|
}
|
|
5885
6381
|
}
|
|
5886
6382
|
}
|
|
@@ -6106,7 +6602,8 @@ Schema for the body of a request to add a recent item
|
|
|
6106
6602
|
"application",
|
|
6107
6603
|
"device",
|
|
6108
6604
|
"flow",
|
|
6109
|
-
"dashboard"
|
|
6605
|
+
"dashboard",
|
|
6606
|
+
"organization"
|
|
6110
6607
|
]
|
|
6111
6608
|
},
|
|
6112
6609
|
"parentId": {
|
|
@@ -6153,7 +6650,8 @@ Schema for an array of recent items
|
|
|
6153
6650
|
"application",
|
|
6154
6651
|
"device",
|
|
6155
6652
|
"flow",
|
|
6156
|
-
"dashboard"
|
|
6653
|
+
"dashboard",
|
|
6654
|
+
"organization"
|
|
6157
6655
|
]
|
|
6158
6656
|
},
|
|
6159
6657
|
"parentId": {
|
|
@@ -6200,6 +6698,74 @@ Schema for an array of recent items
|
|
|
6200
6698
|
|
|
6201
6699
|
<br/>
|
|
6202
6700
|
|
|
6701
|
+
## Resource Transfer
|
|
6702
|
+
|
|
6703
|
+
Schema for the body of a resource transfer request
|
|
6704
|
+
|
|
6705
|
+
### <a name="resource-transfer-schema"></a> Schema
|
|
6706
|
+
|
|
6707
|
+
```json
|
|
6708
|
+
{
|
|
6709
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
6710
|
+
"type": "object",
|
|
6711
|
+
"properties": {
|
|
6712
|
+
"destinationId": {
|
|
6713
|
+
"type": "string",
|
|
6714
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
6715
|
+
},
|
|
6716
|
+
"destinationType": {
|
|
6717
|
+
"type": "string",
|
|
6718
|
+
"enum": [
|
|
6719
|
+
"user",
|
|
6720
|
+
"organization"
|
|
6721
|
+
]
|
|
6722
|
+
},
|
|
6723
|
+
"applicationIds": {
|
|
6724
|
+
"type": "array",
|
|
6725
|
+
"items": {
|
|
6726
|
+
"type": "string",
|
|
6727
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
6728
|
+
}
|
|
6729
|
+
},
|
|
6730
|
+
"dashboardIds": {
|
|
6731
|
+
"type": "array",
|
|
6732
|
+
"items": {
|
|
6733
|
+
"type": "string",
|
|
6734
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
6735
|
+
}
|
|
6736
|
+
},
|
|
6737
|
+
"solutionIds": {
|
|
6738
|
+
"type": "array",
|
|
6739
|
+
"items": {
|
|
6740
|
+
"type": "string",
|
|
6741
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
6742
|
+
}
|
|
6743
|
+
},
|
|
6744
|
+
"strict": {
|
|
6745
|
+
"type": "boolean"
|
|
6746
|
+
}
|
|
6747
|
+
},
|
|
6748
|
+
"additionalProperties": false,
|
|
6749
|
+
"required": [
|
|
6750
|
+
"destinationId",
|
|
6751
|
+
"destinationType"
|
|
6752
|
+
]
|
|
6753
|
+
}
|
|
6754
|
+
```
|
|
6755
|
+
### <a name="resource-transfer-example"></a> Example
|
|
6756
|
+
|
|
6757
|
+
```json
|
|
6758
|
+
{
|
|
6759
|
+
"destinationId": "575ed6e87ae143cd83dc4aa8",
|
|
6760
|
+
"destinationType": "organization",
|
|
6761
|
+
"applicationIds": [
|
|
6762
|
+
"575ec8687ae143cd83dc4a97"
|
|
6763
|
+
]
|
|
6764
|
+
}
|
|
6765
|
+
```
|
|
6766
|
+
|
|
6767
|
+
<br/>
|
|
6768
|
+
|
|
6203
6769
|
## Solution
|
|
6204
6770
|
|
|
6205
6771
|
Schema for a single Solution
|
|
@@ -7392,6 +7958,9 @@ Schema for the body of a time series query request
|
|
|
7392
7958
|
"type": "string",
|
|
7393
7959
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
7394
7960
|
}
|
|
7961
|
+
},
|
|
7962
|
+
"limit": {
|
|
7963
|
+
"type": "number"
|
|
7395
7964
|
}
|
|
7396
7965
|
},
|
|
7397
7966
|
"additionalProperties": false
|