losant_rest 1.0.5 → 1.0.6
Sign up to get free protection for your applications and to get access to all the features.
- 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
data/schemas/me.json
CHANGED
|
@@ -96,6 +96,9 @@
|
|
|
96
96
|
},
|
|
97
97
|
"dataTTL": {
|
|
98
98
|
"type": "number"
|
|
99
|
+
},
|
|
100
|
+
"payload": {
|
|
101
|
+
"type": "number"
|
|
99
102
|
}
|
|
100
103
|
},
|
|
101
104
|
"recentDashboards": {
|
|
@@ -109,7 +112,8 @@
|
|
|
109
112
|
"application",
|
|
110
113
|
"device",
|
|
111
114
|
"flow",
|
|
112
|
-
"dashboard"
|
|
115
|
+
"dashboard",
|
|
116
|
+
"organization"
|
|
113
117
|
]
|
|
114
118
|
},
|
|
115
119
|
"parentId": {
|
|
@@ -146,7 +150,46 @@
|
|
|
146
150
|
"application",
|
|
147
151
|
"device",
|
|
148
152
|
"flow",
|
|
149
|
-
"dashboard"
|
|
153
|
+
"dashboard",
|
|
154
|
+
"organization"
|
|
155
|
+
]
|
|
156
|
+
},
|
|
157
|
+
"parentId": {
|
|
158
|
+
"type": "string",
|
|
159
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
160
|
+
},
|
|
161
|
+
"items": {
|
|
162
|
+
"type": "array",
|
|
163
|
+
"items": {
|
|
164
|
+
"type": "object",
|
|
165
|
+
"properties": {
|
|
166
|
+
"id": {
|
|
167
|
+
"type": "string",
|
|
168
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
169
|
+
},
|
|
170
|
+
"name": {
|
|
171
|
+
"type": "string",
|
|
172
|
+
"minLength": 1,
|
|
173
|
+
"maxLength": 255
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
},
|
|
180
|
+
"recentOrganizations": {
|
|
181
|
+
"title": "Recent Item List",
|
|
182
|
+
"description": "Schema for an array of recent items",
|
|
183
|
+
"type": "object",
|
|
184
|
+
"properties": {
|
|
185
|
+
"itemType": {
|
|
186
|
+
"type": "string",
|
|
187
|
+
"enum": [
|
|
188
|
+
"application",
|
|
189
|
+
"device",
|
|
190
|
+
"flow",
|
|
191
|
+
"dashboard",
|
|
192
|
+
"organization"
|
|
150
193
|
]
|
|
151
194
|
},
|
|
152
195
|
"parentId": {
|
|
@@ -196,13 +239,105 @@
|
|
|
196
239
|
"keyCount": {
|
|
197
240
|
"type": "number"
|
|
198
241
|
},
|
|
199
|
-
"eventCount": {
|
|
200
|
-
"type": "number"
|
|
201
|
-
},
|
|
202
242
|
"deviceRecipeCount": {
|
|
203
243
|
"type": "number"
|
|
244
|
+
},
|
|
245
|
+
"payloadCount": {
|
|
246
|
+
"title": "Payload Counts",
|
|
247
|
+
"description": "Schema the result of a payload count request",
|
|
248
|
+
"type": "object",
|
|
249
|
+
"properties": {
|
|
250
|
+
"mqttOut": {
|
|
251
|
+
"type": "object",
|
|
252
|
+
"patternProperties": {
|
|
253
|
+
".*": {
|
|
254
|
+
"type": "number"
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
},
|
|
258
|
+
"mqttIn": {
|
|
259
|
+
"type": "object",
|
|
260
|
+
"patternProperties": {
|
|
261
|
+
".*": {
|
|
262
|
+
"type": "number"
|
|
263
|
+
}
|
|
264
|
+
}
|
|
265
|
+
},
|
|
266
|
+
"deviceState": {
|
|
267
|
+
"type": "object",
|
|
268
|
+
"patternProperties": {
|
|
269
|
+
".*": {
|
|
270
|
+
"type": "number"
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
},
|
|
274
|
+
"deviceCommand": {
|
|
275
|
+
"type": "object",
|
|
276
|
+
"patternProperties": {
|
|
277
|
+
".*": {
|
|
278
|
+
"type": "number"
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
},
|
|
282
|
+
"webhook": {
|
|
283
|
+
"type": "object",
|
|
284
|
+
"patternProperties": {
|
|
285
|
+
".*": {
|
|
286
|
+
"type": "number"
|
|
287
|
+
}
|
|
288
|
+
}
|
|
289
|
+
},
|
|
290
|
+
"timer": {
|
|
291
|
+
"type": "object",
|
|
292
|
+
"patternProperties": {
|
|
293
|
+
".*": {
|
|
294
|
+
"type": "number"
|
|
295
|
+
}
|
|
296
|
+
}
|
|
297
|
+
},
|
|
298
|
+
"event": {
|
|
299
|
+
"type": "object",
|
|
300
|
+
"patternProperties": {
|
|
301
|
+
".*": {
|
|
302
|
+
"type": "number"
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
},
|
|
306
|
+
"virtualButton": {
|
|
307
|
+
"type": "object",
|
|
308
|
+
"patternProperties": {
|
|
309
|
+
".*": {
|
|
310
|
+
"type": "number"
|
|
311
|
+
}
|
|
312
|
+
}
|
|
313
|
+
},
|
|
314
|
+
"deviceConnect": {
|
|
315
|
+
"type": "object",
|
|
316
|
+
"patternProperties": {
|
|
317
|
+
".*": {
|
|
318
|
+
"type": "number"
|
|
319
|
+
}
|
|
320
|
+
}
|
|
321
|
+
},
|
|
322
|
+
"deviceDisconnect": {
|
|
323
|
+
"type": "object",
|
|
324
|
+
"patternProperties": {
|
|
325
|
+
".*": {
|
|
326
|
+
"type": "number"
|
|
327
|
+
}
|
|
328
|
+
}
|
|
329
|
+
}
|
|
330
|
+
}
|
|
204
331
|
}
|
|
205
332
|
}
|
|
333
|
+
},
|
|
334
|
+
"currentPeriodStart": {
|
|
335
|
+
"type": "string",
|
|
336
|
+
"format": "date-time"
|
|
337
|
+
},
|
|
338
|
+
"currentPeriodEnd": {
|
|
339
|
+
"type": "string",
|
|
340
|
+
"format": "date-time"
|
|
206
341
|
}
|
|
207
342
|
}
|
|
208
343
|
}
|
data/schemas/org.json
CHANGED
|
@@ -96,6 +96,12 @@
|
|
|
96
96
|
},
|
|
97
97
|
"dataTTL": {
|
|
98
98
|
"type": "number"
|
|
99
|
+
},
|
|
100
|
+
"member": {
|
|
101
|
+
"type": "number"
|
|
102
|
+
},
|
|
103
|
+
"payload": {
|
|
104
|
+
"type": "number"
|
|
99
105
|
}
|
|
100
106
|
},
|
|
101
107
|
"summary": {
|
|
@@ -122,13 +128,136 @@
|
|
|
122
128
|
"keyCount": {
|
|
123
129
|
"type": "number"
|
|
124
130
|
},
|
|
125
|
-
"
|
|
131
|
+
"deviceRecipeCount": {
|
|
126
132
|
"type": "number"
|
|
127
133
|
},
|
|
128
|
-
"
|
|
134
|
+
"payloadCount": {
|
|
135
|
+
"title": "Payload Counts",
|
|
136
|
+
"description": "Schema the result of a payload count request",
|
|
137
|
+
"type": "object",
|
|
138
|
+
"properties": {
|
|
139
|
+
"mqttOut": {
|
|
140
|
+
"type": "object",
|
|
141
|
+
"patternProperties": {
|
|
142
|
+
".*": {
|
|
143
|
+
"type": "number"
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
},
|
|
147
|
+
"mqttIn": {
|
|
148
|
+
"type": "object",
|
|
149
|
+
"patternProperties": {
|
|
150
|
+
".*": {
|
|
151
|
+
"type": "number"
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
"deviceState": {
|
|
156
|
+
"type": "object",
|
|
157
|
+
"patternProperties": {
|
|
158
|
+
".*": {
|
|
159
|
+
"type": "number"
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
},
|
|
163
|
+
"deviceCommand": {
|
|
164
|
+
"type": "object",
|
|
165
|
+
"patternProperties": {
|
|
166
|
+
".*": {
|
|
167
|
+
"type": "number"
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
},
|
|
171
|
+
"webhook": {
|
|
172
|
+
"type": "object",
|
|
173
|
+
"patternProperties": {
|
|
174
|
+
".*": {
|
|
175
|
+
"type": "number"
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
},
|
|
179
|
+
"timer": {
|
|
180
|
+
"type": "object",
|
|
181
|
+
"patternProperties": {
|
|
182
|
+
".*": {
|
|
183
|
+
"type": "number"
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
},
|
|
187
|
+
"event": {
|
|
188
|
+
"type": "object",
|
|
189
|
+
"patternProperties": {
|
|
190
|
+
".*": {
|
|
191
|
+
"type": "number"
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
},
|
|
195
|
+
"virtualButton": {
|
|
196
|
+
"type": "object",
|
|
197
|
+
"patternProperties": {
|
|
198
|
+
".*": {
|
|
199
|
+
"type": "number"
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
},
|
|
203
|
+
"deviceConnect": {
|
|
204
|
+
"type": "object",
|
|
205
|
+
"patternProperties": {
|
|
206
|
+
".*": {
|
|
207
|
+
"type": "number"
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
},
|
|
211
|
+
"deviceDisconnect": {
|
|
212
|
+
"type": "object",
|
|
213
|
+
"patternProperties": {
|
|
214
|
+
".*": {
|
|
215
|
+
"type": "number"
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
},
|
|
221
|
+
"pendingInviteCount": {
|
|
222
|
+
"type": "number"
|
|
223
|
+
},
|
|
224
|
+
"memberCount": {
|
|
129
225
|
"type": "number"
|
|
130
226
|
}
|
|
131
227
|
}
|
|
228
|
+
},
|
|
229
|
+
"planId": {
|
|
230
|
+
"type": "string",
|
|
231
|
+
"maxLength": 1024
|
|
232
|
+
},
|
|
233
|
+
"billingEmail": {
|
|
234
|
+
"type": "string",
|
|
235
|
+
"format": "email",
|
|
236
|
+
"maxLength": 1024
|
|
237
|
+
},
|
|
238
|
+
"subscriptionStatus": {
|
|
239
|
+
"type": "string",
|
|
240
|
+
"enum": [
|
|
241
|
+
"trialing",
|
|
242
|
+
"active",
|
|
243
|
+
"past_due",
|
|
244
|
+
"canceled",
|
|
245
|
+
"unpaid"
|
|
246
|
+
]
|
|
247
|
+
},
|
|
248
|
+
"currentPeriodStart": {
|
|
249
|
+
"type": "string",
|
|
250
|
+
"format": "date-time"
|
|
251
|
+
},
|
|
252
|
+
"currentPeriodEnd": {
|
|
253
|
+
"type": "string",
|
|
254
|
+
"format": "date-time"
|
|
255
|
+
},
|
|
256
|
+
"isEnterprise": {
|
|
257
|
+
"type": "boolean"
|
|
258
|
+
},
|
|
259
|
+
"iconColor": {
|
|
260
|
+
"type": "string"
|
|
132
261
|
}
|
|
133
262
|
}
|
|
134
263
|
}
|
data/schemas/orgPatch.json
CHANGED
|
@@ -10,6 +10,22 @@
|
|
|
10
10
|
"description": {
|
|
11
11
|
"type": "string",
|
|
12
12
|
"maxLength": 32767
|
|
13
|
+
},
|
|
14
|
+
"planId": {
|
|
15
|
+
"type": "string",
|
|
16
|
+
"maxLength": 1024
|
|
17
|
+
},
|
|
18
|
+
"billingEmail": {
|
|
19
|
+
"type": "string",
|
|
20
|
+
"format": "email",
|
|
21
|
+
"maxLength": 1024
|
|
22
|
+
},
|
|
23
|
+
"cardToken": {
|
|
24
|
+
"type": "string",
|
|
25
|
+
"maxLength": 1024
|
|
26
|
+
},
|
|
27
|
+
"iconColor": {
|
|
28
|
+
"type": "string"
|
|
13
29
|
}
|
|
14
30
|
},
|
|
15
31
|
"additionalProperties": false
|
data/schemas/orgPost.json
CHANGED
|
@@ -10,6 +10,22 @@
|
|
|
10
10
|
"description": {
|
|
11
11
|
"type": "string",
|
|
12
12
|
"maxLength": 32767
|
|
13
|
+
},
|
|
14
|
+
"planId": {
|
|
15
|
+
"type": "string",
|
|
16
|
+
"maxLength": 1024
|
|
17
|
+
},
|
|
18
|
+
"billingEmail": {
|
|
19
|
+
"type": "string",
|
|
20
|
+
"format": "email",
|
|
21
|
+
"maxLength": 1024
|
|
22
|
+
},
|
|
23
|
+
"cardToken": {
|
|
24
|
+
"type": "string",
|
|
25
|
+
"maxLength": 1024
|
|
26
|
+
},
|
|
27
|
+
"iconColor": {
|
|
28
|
+
"type": "string"
|
|
13
29
|
}
|
|
14
30
|
},
|
|
15
31
|
"additionalProperties": false,
|
data/schemas/orgs.json
CHANGED
|
@@ -103,6 +103,12 @@
|
|
|
103
103
|
},
|
|
104
104
|
"dataTTL": {
|
|
105
105
|
"type": "number"
|
|
106
|
+
},
|
|
107
|
+
"member": {
|
|
108
|
+
"type": "number"
|
|
109
|
+
},
|
|
110
|
+
"payload": {
|
|
111
|
+
"type": "number"
|
|
106
112
|
}
|
|
107
113
|
},
|
|
108
114
|
"summary": {
|
|
@@ -129,13 +135,136 @@
|
|
|
129
135
|
"keyCount": {
|
|
130
136
|
"type": "number"
|
|
131
137
|
},
|
|
132
|
-
"
|
|
138
|
+
"deviceRecipeCount": {
|
|
133
139
|
"type": "number"
|
|
134
140
|
},
|
|
135
|
-
"
|
|
141
|
+
"payloadCount": {
|
|
142
|
+
"title": "Payload Counts",
|
|
143
|
+
"description": "Schema the result of a payload count request",
|
|
144
|
+
"type": "object",
|
|
145
|
+
"properties": {
|
|
146
|
+
"mqttOut": {
|
|
147
|
+
"type": "object",
|
|
148
|
+
"patternProperties": {
|
|
149
|
+
".*": {
|
|
150
|
+
"type": "number"
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
},
|
|
154
|
+
"mqttIn": {
|
|
155
|
+
"type": "object",
|
|
156
|
+
"patternProperties": {
|
|
157
|
+
".*": {
|
|
158
|
+
"type": "number"
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
},
|
|
162
|
+
"deviceState": {
|
|
163
|
+
"type": "object",
|
|
164
|
+
"patternProperties": {
|
|
165
|
+
".*": {
|
|
166
|
+
"type": "number"
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
},
|
|
170
|
+
"deviceCommand": {
|
|
171
|
+
"type": "object",
|
|
172
|
+
"patternProperties": {
|
|
173
|
+
".*": {
|
|
174
|
+
"type": "number"
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
},
|
|
178
|
+
"webhook": {
|
|
179
|
+
"type": "object",
|
|
180
|
+
"patternProperties": {
|
|
181
|
+
".*": {
|
|
182
|
+
"type": "number"
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
},
|
|
186
|
+
"timer": {
|
|
187
|
+
"type": "object",
|
|
188
|
+
"patternProperties": {
|
|
189
|
+
".*": {
|
|
190
|
+
"type": "number"
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
},
|
|
194
|
+
"event": {
|
|
195
|
+
"type": "object",
|
|
196
|
+
"patternProperties": {
|
|
197
|
+
".*": {
|
|
198
|
+
"type": "number"
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
},
|
|
202
|
+
"virtualButton": {
|
|
203
|
+
"type": "object",
|
|
204
|
+
"patternProperties": {
|
|
205
|
+
".*": {
|
|
206
|
+
"type": "number"
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
},
|
|
210
|
+
"deviceConnect": {
|
|
211
|
+
"type": "object",
|
|
212
|
+
"patternProperties": {
|
|
213
|
+
".*": {
|
|
214
|
+
"type": "number"
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
},
|
|
218
|
+
"deviceDisconnect": {
|
|
219
|
+
"type": "object",
|
|
220
|
+
"patternProperties": {
|
|
221
|
+
".*": {
|
|
222
|
+
"type": "number"
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
},
|
|
228
|
+
"pendingInviteCount": {
|
|
229
|
+
"type": "number"
|
|
230
|
+
},
|
|
231
|
+
"memberCount": {
|
|
136
232
|
"type": "number"
|
|
137
233
|
}
|
|
138
234
|
}
|
|
235
|
+
},
|
|
236
|
+
"planId": {
|
|
237
|
+
"type": "string",
|
|
238
|
+
"maxLength": 1024
|
|
239
|
+
},
|
|
240
|
+
"billingEmail": {
|
|
241
|
+
"type": "string",
|
|
242
|
+
"format": "email",
|
|
243
|
+
"maxLength": 1024
|
|
244
|
+
},
|
|
245
|
+
"subscriptionStatus": {
|
|
246
|
+
"type": "string",
|
|
247
|
+
"enum": [
|
|
248
|
+
"trialing",
|
|
249
|
+
"active",
|
|
250
|
+
"past_due",
|
|
251
|
+
"canceled",
|
|
252
|
+
"unpaid"
|
|
253
|
+
]
|
|
254
|
+
},
|
|
255
|
+
"currentPeriodStart": {
|
|
256
|
+
"type": "string",
|
|
257
|
+
"format": "date-time"
|
|
258
|
+
},
|
|
259
|
+
"currentPeriodEnd": {
|
|
260
|
+
"type": "string",
|
|
261
|
+
"format": "date-time"
|
|
262
|
+
},
|
|
263
|
+
"isEnterprise": {
|
|
264
|
+
"type": "boolean"
|
|
265
|
+
},
|
|
266
|
+
"iconColor": {
|
|
267
|
+
"type": "string"
|
|
139
268
|
}
|
|
140
269
|
}
|
|
141
270
|
}
|