losant_rest 1.21.3 → 1.22.0
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 +893 -15
- data/docs/deviceAttribute.md +139 -0
- data/docs/deviceAttributes.md +96 -0
- data/lib/platform_rest/client.rb +10 -2
- data/lib/platform_rest/device_attribute.rb +182 -0
- data/lib/platform_rest/device_attributes.rb +138 -0
- data/lib/platform_rest/version.rb +1 -1
- data/lib/platform_rest.rb +2 -0
- data/schemas/apiTokenPost.json +7 -0
- data/schemas/applicationExportPost.json +29 -0
- data/schemas/applicationImportExecutions.json +18 -1
- data/schemas/credential.json +39 -1
- data/schemas/credentialPatch.json +37 -0
- data/schemas/credentialPost.json +54 -1
- data/schemas/credentials.json +39 -1
- data/schemas/device.json +0 -1
- data/schemas/deviceAttribute.json +128 -0
- data/schemas/deviceAttributePatch.json +111 -0
- data/schemas/deviceAttributePost.json +125 -0
- data/schemas/deviceAttributes.json +171 -0
- data/schemas/devicePatch.json +0 -1
- data/schemas/devicePost.json +0 -1
- data/schemas/deviceRecipe.json +0 -1
- data/schemas/deviceRecipePatch.json +0 -1
- data/schemas/deviceRecipePost.json +0 -1
- data/schemas/deviceRecipes.json +0 -1
- data/schemas/devices.json +0 -1
- data/schemas/devicesPatch.json +0 -3
- data/schemas/githubLogin.json +7 -0
- data/schemas/importIntoApplicationOptions.json +17 -0
- data/schemas/samlResponse.json +7 -0
- data/schemas/userCredentials.json +7 -0
- data/schemas/userPost.json +7 -0
- metadata +10 -2
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"items": {
|
|
6
|
+
"type": "array",
|
|
7
|
+
"items": {
|
|
8
|
+
"title": "Device Attribute",
|
|
9
|
+
"description": "Schema for a single Device Attribute",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"properties": {
|
|
12
|
+
"name": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
15
|
+
},
|
|
16
|
+
"dataType": {
|
|
17
|
+
"type": "string",
|
|
18
|
+
"enum": [
|
|
19
|
+
"string",
|
|
20
|
+
"number",
|
|
21
|
+
"gps",
|
|
22
|
+
"boolean",
|
|
23
|
+
"blob"
|
|
24
|
+
]
|
|
25
|
+
},
|
|
26
|
+
"contentType": {
|
|
27
|
+
"type": "string",
|
|
28
|
+
"maxLength": 64
|
|
29
|
+
},
|
|
30
|
+
"description": {
|
|
31
|
+
"type": "string",
|
|
32
|
+
"maxLength": 32767
|
|
33
|
+
},
|
|
34
|
+
"attributeTags": {
|
|
35
|
+
"type": "object",
|
|
36
|
+
"patternProperties": {
|
|
37
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
38
|
+
"type": "string",
|
|
39
|
+
"minLength": 1,
|
|
40
|
+
"maxLength": 255
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
"additionalProperties": false
|
|
44
|
+
},
|
|
45
|
+
"system": {
|
|
46
|
+
"type": "object",
|
|
47
|
+
"properties": {
|
|
48
|
+
"aggregation": {
|
|
49
|
+
"type": "string",
|
|
50
|
+
"enum": [
|
|
51
|
+
"FIRST",
|
|
52
|
+
"LAST",
|
|
53
|
+
"COUNT",
|
|
54
|
+
"MAX",
|
|
55
|
+
"MIN",
|
|
56
|
+
"MEDIAN",
|
|
57
|
+
"MEAN",
|
|
58
|
+
"SUM",
|
|
59
|
+
"STD_DEV"
|
|
60
|
+
]
|
|
61
|
+
},
|
|
62
|
+
"aggregationOptions": {
|
|
63
|
+
"type": "array",
|
|
64
|
+
"items": {
|
|
65
|
+
"type": "object",
|
|
66
|
+
"additionalProperties": false
|
|
67
|
+
},
|
|
68
|
+
"maxItems": 0
|
|
69
|
+
},
|
|
70
|
+
"childAttributes": {
|
|
71
|
+
"type": "array",
|
|
72
|
+
"items": {
|
|
73
|
+
"type": "object",
|
|
74
|
+
"properties": {
|
|
75
|
+
"name": {
|
|
76
|
+
"type": "string",
|
|
77
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
78
|
+
},
|
|
79
|
+
"mode": {
|
|
80
|
+
"type": "string",
|
|
81
|
+
"enum": [
|
|
82
|
+
"all",
|
|
83
|
+
"whitelist",
|
|
84
|
+
"blacklist"
|
|
85
|
+
]
|
|
86
|
+
},
|
|
87
|
+
"deviceIds": {
|
|
88
|
+
"type": "array",
|
|
89
|
+
"items": {
|
|
90
|
+
"type": "string",
|
|
91
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
92
|
+
},
|
|
93
|
+
"maxItems": 1000
|
|
94
|
+
},
|
|
95
|
+
"deviceTags": {
|
|
96
|
+
"type": "array",
|
|
97
|
+
"items": {
|
|
98
|
+
"type": "object",
|
|
99
|
+
"properties": {
|
|
100
|
+
"key": {
|
|
101
|
+
"type": "string",
|
|
102
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
103
|
+
},
|
|
104
|
+
"value": {
|
|
105
|
+
"type": "string",
|
|
106
|
+
"minLength": 1,
|
|
107
|
+
"maxLength": 255
|
|
108
|
+
}
|
|
109
|
+
},
|
|
110
|
+
"additionalProperties": false
|
|
111
|
+
},
|
|
112
|
+
"maxItems": 100
|
|
113
|
+
}
|
|
114
|
+
},
|
|
115
|
+
"required": [
|
|
116
|
+
"name",
|
|
117
|
+
"mode"
|
|
118
|
+
],
|
|
119
|
+
"additionalProperties": false
|
|
120
|
+
},
|
|
121
|
+
"maxItems": 256
|
|
122
|
+
}
|
|
123
|
+
},
|
|
124
|
+
"additionalProperties": false
|
|
125
|
+
},
|
|
126
|
+
"applicationId": {
|
|
127
|
+
"type": "string",
|
|
128
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
129
|
+
},
|
|
130
|
+
"deviceId": {
|
|
131
|
+
"type": "string",
|
|
132
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
},
|
|
137
|
+
"count": {
|
|
138
|
+
"type": "integer"
|
|
139
|
+
},
|
|
140
|
+
"totalCount": {
|
|
141
|
+
"type": "integer"
|
|
142
|
+
},
|
|
143
|
+
"filter": {
|
|
144
|
+
"type": "string"
|
|
145
|
+
},
|
|
146
|
+
"filterField": {
|
|
147
|
+
"type": "string"
|
|
148
|
+
},
|
|
149
|
+
"sortField": {
|
|
150
|
+
"type": "string"
|
|
151
|
+
},
|
|
152
|
+
"sortDirection": {
|
|
153
|
+
"type": "string",
|
|
154
|
+
"enum": [
|
|
155
|
+
"asc",
|
|
156
|
+
"desc",
|
|
157
|
+
"ASC",
|
|
158
|
+
"DESC",
|
|
159
|
+
""
|
|
160
|
+
]
|
|
161
|
+
},
|
|
162
|
+
"applicationId": {
|
|
163
|
+
"type": "string",
|
|
164
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
165
|
+
},
|
|
166
|
+
"deviceId": {
|
|
167
|
+
"type": "string",
|
|
168
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
}
|
data/schemas/devicePatch.json
CHANGED
data/schemas/devicePost.json
CHANGED
data/schemas/deviceRecipe.json
CHANGED
data/schemas/deviceRecipes.json
CHANGED
data/schemas/devices.json
CHANGED
data/schemas/devicesPatch.json
CHANGED
|
@@ -100,7 +100,6 @@
|
|
|
100
100
|
"type": "object",
|
|
101
101
|
"additionalProperties": false
|
|
102
102
|
},
|
|
103
|
-
"additionalProperties": false,
|
|
104
103
|
"maxItems": 0
|
|
105
104
|
},
|
|
106
105
|
"childAttributes": {
|
|
@@ -2759,7 +2758,6 @@
|
|
|
2759
2758
|
"type": "object",
|
|
2760
2759
|
"additionalProperties": false
|
|
2761
2760
|
},
|
|
2762
|
-
"additionalProperties": false,
|
|
2763
2761
|
"maxItems": 0
|
|
2764
2762
|
},
|
|
2765
2763
|
"childAttributes": {
|
|
@@ -2907,7 +2905,6 @@
|
|
|
2907
2905
|
"type": "object",
|
|
2908
2906
|
"additionalProperties": false
|
|
2909
2907
|
},
|
|
2910
|
-
"additionalProperties": false,
|
|
2911
2908
|
"maxItems": 0
|
|
2912
2909
|
},
|
|
2913
2910
|
"childAttributes": {
|
data/schemas/githubLogin.json
CHANGED
|
@@ -44,6 +44,8 @@
|
|
|
44
44
|
"deviceRecipe.*",
|
|
45
45
|
"deviceRecipes.*",
|
|
46
46
|
"devices.*",
|
|
47
|
+
"deviceAttribute.*",
|
|
48
|
+
"deviceAttributes.*",
|
|
47
49
|
"edgeDeployment.*",
|
|
48
50
|
"edgeDeployments.*",
|
|
49
51
|
"embeddedDeployment.*",
|
|
@@ -190,6 +192,11 @@
|
|
|
190
192
|
"devices.sendCommand",
|
|
191
193
|
"devices.tagKeys",
|
|
192
194
|
"devices.tagValues",
|
|
195
|
+
"deviceAttribute.get",
|
|
196
|
+
"deviceAttribute.patch",
|
|
197
|
+
"deviceAttribute.delete",
|
|
198
|
+
"deviceAttributes.get",
|
|
199
|
+
"deviceAttributes.post",
|
|
193
200
|
"edgeDeployment.get",
|
|
194
201
|
"edgeDeployments.get",
|
|
195
202
|
"edgeDeployments.release",
|
|
@@ -62,6 +62,23 @@
|
|
|
62
62
|
]
|
|
63
63
|
},
|
|
64
64
|
"uniqueItems": true
|
|
65
|
+
},
|
|
66
|
+
"credentialName": {
|
|
67
|
+
"type": "string",
|
|
68
|
+
"maxLength": 255
|
|
69
|
+
},
|
|
70
|
+
"repo": {
|
|
71
|
+
"type": "object",
|
|
72
|
+
"properties": {
|
|
73
|
+
"branch": {
|
|
74
|
+
"type": "string",
|
|
75
|
+
"maxLength": 255
|
|
76
|
+
},
|
|
77
|
+
"directory": {
|
|
78
|
+
"type": "string",
|
|
79
|
+
"maxLength": 1024
|
|
80
|
+
}
|
|
81
|
+
}
|
|
65
82
|
}
|
|
66
83
|
},
|
|
67
84
|
"additionalProperties": false
|
data/schemas/samlResponse.json
CHANGED
|
@@ -49,6 +49,8 @@
|
|
|
49
49
|
"deviceRecipe.*",
|
|
50
50
|
"deviceRecipes.*",
|
|
51
51
|
"devices.*",
|
|
52
|
+
"deviceAttribute.*",
|
|
53
|
+
"deviceAttributes.*",
|
|
52
54
|
"edgeDeployment.*",
|
|
53
55
|
"edgeDeployments.*",
|
|
54
56
|
"embeddedDeployment.*",
|
|
@@ -195,6 +197,11 @@
|
|
|
195
197
|
"devices.sendCommand",
|
|
196
198
|
"devices.tagKeys",
|
|
197
199
|
"devices.tagValues",
|
|
200
|
+
"deviceAttribute.get",
|
|
201
|
+
"deviceAttribute.patch",
|
|
202
|
+
"deviceAttribute.delete",
|
|
203
|
+
"deviceAttributes.get",
|
|
204
|
+
"deviceAttributes.post",
|
|
198
205
|
"edgeDeployment.get",
|
|
199
206
|
"edgeDeployments.get",
|
|
200
207
|
"edgeDeployments.release",
|
|
@@ -53,6 +53,8 @@
|
|
|
53
53
|
"deviceRecipe.*",
|
|
54
54
|
"deviceRecipes.*",
|
|
55
55
|
"devices.*",
|
|
56
|
+
"deviceAttribute.*",
|
|
57
|
+
"deviceAttributes.*",
|
|
56
58
|
"edgeDeployment.*",
|
|
57
59
|
"edgeDeployments.*",
|
|
58
60
|
"embeddedDeployment.*",
|
|
@@ -199,6 +201,11 @@
|
|
|
199
201
|
"devices.sendCommand",
|
|
200
202
|
"devices.tagKeys",
|
|
201
203
|
"devices.tagValues",
|
|
204
|
+
"deviceAttribute.get",
|
|
205
|
+
"deviceAttribute.patch",
|
|
206
|
+
"deviceAttribute.delete",
|
|
207
|
+
"deviceAttributes.get",
|
|
208
|
+
"deviceAttributes.post",
|
|
202
209
|
"edgeDeployment.get",
|
|
203
210
|
"edgeDeployments.get",
|
|
204
211
|
"edgeDeployments.release",
|
data/schemas/userPost.json
CHANGED
|
@@ -111,6 +111,8 @@
|
|
|
111
111
|
"deviceRecipe.*",
|
|
112
112
|
"deviceRecipes.*",
|
|
113
113
|
"devices.*",
|
|
114
|
+
"deviceAttribute.*",
|
|
115
|
+
"deviceAttributes.*",
|
|
114
116
|
"edgeDeployment.*",
|
|
115
117
|
"edgeDeployments.*",
|
|
116
118
|
"embeddedDeployment.*",
|
|
@@ -257,6 +259,11 @@
|
|
|
257
259
|
"devices.sendCommand",
|
|
258
260
|
"devices.tagKeys",
|
|
259
261
|
"devices.tagValues",
|
|
262
|
+
"deviceAttribute.get",
|
|
263
|
+
"deviceAttribute.patch",
|
|
264
|
+
"deviceAttribute.delete",
|
|
265
|
+
"deviceAttributes.get",
|
|
266
|
+
"deviceAttributes.post",
|
|
260
267
|
"edgeDeployment.get",
|
|
261
268
|
"edgeDeployments.get",
|
|
262
269
|
"edgeDeployments.release",
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: losant_rest
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.22.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Michael Kuehl
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2025-
|
|
11
|
+
date: 2025-04-24 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: httparty
|
|
@@ -109,6 +109,8 @@ files:
|
|
|
109
109
|
- docs/dataTableRows.md
|
|
110
110
|
- docs/dataTables.md
|
|
111
111
|
- docs/device.md
|
|
112
|
+
- docs/deviceAttribute.md
|
|
113
|
+
- docs/deviceAttributes.md
|
|
112
114
|
- docs/deviceRecipe.md
|
|
113
115
|
- docs/deviceRecipes.md
|
|
114
116
|
- docs/devices.md
|
|
@@ -204,6 +206,8 @@ files:
|
|
|
204
206
|
- lib/platform_rest/data_table_rows.rb
|
|
205
207
|
- lib/platform_rest/data_tables.rb
|
|
206
208
|
- lib/platform_rest/device.rb
|
|
209
|
+
- lib/platform_rest/device_attribute.rb
|
|
210
|
+
- lib/platform_rest/device_attributes.rb
|
|
207
211
|
- lib/platform_rest/device_recipe.rb
|
|
208
212
|
- lib/platform_rest/device_recipes.rb
|
|
209
213
|
- lib/platform_rest/devices.rb
|
|
@@ -361,7 +365,11 @@ files:
|
|
|
361
365
|
- schemas/debugExcludeIds.json
|
|
362
366
|
- schemas/debugLevels.json
|
|
363
367
|
- schemas/device.json
|
|
368
|
+
- schemas/deviceAttribute.json
|
|
364
369
|
- schemas/deviceAttributeDataTypeFilter.json
|
|
370
|
+
- schemas/deviceAttributePatch.json
|
|
371
|
+
- schemas/deviceAttributePost.json
|
|
372
|
+
- schemas/deviceAttributes.json
|
|
365
373
|
- schemas/deviceClassFilter.json
|
|
366
374
|
- schemas/deviceCommand.json
|
|
367
375
|
- schemas/deviceCommands.json
|