losant_rest 1.14.1 → 1.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (77) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +4268 -1402
  3. data/docs/embeddedDeployment.md +49 -0
  4. data/docs/embeddedDeployments.md +215 -0
  5. data/docs/flow.md +2 -2
  6. data/docs/flows.md +2 -2
  7. data/lib/losant_rest/client.rb +10 -2
  8. data/lib/losant_rest/embedded_deployment.rb +81 -0
  9. data/lib/losant_rest/embedded_deployments.rb +280 -0
  10. data/lib/losant_rest/flow.rb +2 -2
  11. data/lib/losant_rest/flows.rb +2 -2
  12. data/lib/losant_rest/version.rb +1 -1
  13. data/lib/losant_rest.rb +2 -0
  14. data/schemas/apiTokenPost.json +8 -0
  15. data/schemas/application.json +32 -32
  16. data/schemas/applicationCreationByTemplateResult.json +32 -32
  17. data/schemas/applicationDashboardPost.json +8 -5
  18. data/schemas/applicationPatch.json +13 -13
  19. data/schemas/applicationPost.json +13 -13
  20. data/schemas/applicationTemplate.json +16 -16
  21. data/schemas/applicationTemplates.json +16 -16
  22. data/schemas/applications.json +32 -32
  23. data/schemas/authedDevice.json +2 -1
  24. data/schemas/dashboard.json +8 -5
  25. data/schemas/dashboardPatch.json +8 -5
  26. data/schemas/dashboardPost.json +8 -5
  27. data/schemas/dashboardSendReport.json +6 -6
  28. data/schemas/dashboards.json +8 -5
  29. data/schemas/device.json +2 -1
  30. data/schemas/deviceClassFilter.json +4 -2
  31. data/schemas/devicePatch.json +2 -1
  32. data/schemas/devicePost.json +2 -1
  33. data/schemas/deviceRecipe.json +2 -1
  34. data/schemas/deviceRecipePatch.json +2 -1
  35. data/schemas/deviceRecipePost.json +2 -1
  36. data/schemas/deviceRecipes.json +2 -1
  37. data/schemas/devices.json +4 -2
  38. data/schemas/devicesPatch.json +4 -2
  39. data/schemas/edgeDeployment.json +4 -0
  40. data/schemas/edgeDeployments.json +4 -0
  41. data/schemas/embeddedDeployment.json +179 -0
  42. data/schemas/embeddedDeploymentExport.json +44 -0
  43. data/schemas/embeddedDeploymentRelease.json +58 -0
  44. data/schemas/embeddedDeploymentRemove.json +25 -0
  45. data/schemas/embeddedDeploymentReplace.json +29 -0
  46. data/schemas/embeddedDeployments.json +212 -0
  47. data/schemas/experienceEndpoint.json +6 -8
  48. data/schemas/experienceEndpointPatch.json +6 -8
  49. data/schemas/experienceEndpointPost.json +6 -8
  50. data/schemas/experienceEndpoints.json +6 -8
  51. data/schemas/experienceLinkedResources.json +387 -57
  52. data/schemas/flow.json +127 -16
  53. data/schemas/flowPatch.json +126 -16
  54. data/schemas/flowPost.json +127 -16
  55. data/schemas/flowVersion.json +253 -33
  56. data/schemas/flowVersionPost.json +126 -16
  57. data/schemas/flowVersions.json +253 -33
  58. data/schemas/flows.json +128 -16
  59. data/schemas/flowsImportPost.json +253 -32
  60. data/schemas/flowsImportResult.json +380 -49
  61. data/schemas/githubLogin.json +8 -0
  62. data/schemas/historicalSummary.json +87 -74
  63. data/schemas/instance.json +92 -79
  64. data/schemas/instanceMember.json +6 -0
  65. data/schemas/instanceMembers.json +6 -0
  66. data/schemas/instanceOrg.json +87 -74
  67. data/schemas/instanceOrgMember.json +6 -0
  68. data/schemas/instanceOrgPatch.json +64 -26
  69. data/schemas/instanceOrgPost.json +65 -27
  70. data/schemas/instanceOrgs.json +87 -74
  71. data/schemas/instancePatch.json +2 -2
  72. data/schemas/me.json +104 -91
  73. data/schemas/org.json +115 -96
  74. data/schemas/orgs.json +115 -96
  75. data/schemas/userCredentials.json +8 -0
  76. data/schemas/userPost.json +8 -0
  77. metadata +16 -6
@@ -0,0 +1,212 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "title": "Embedded Deployment",
9
+ "description": "Schema for a single deployment of embedded workflows to embedded devices",
10
+ "type": "object",
11
+ "properties": {
12
+ "id": {
13
+ "type": "string",
14
+ "pattern": "^[A-Fa-f\\d]{24}$"
15
+ },
16
+ "embeddedDeploymentId": {
17
+ "type": "string",
18
+ "pattern": "^[A-Fa-f\\d]{24}$"
19
+ },
20
+ "applicationId": {
21
+ "type": "string",
22
+ "pattern": "^[A-Fa-f\\d]{24}$"
23
+ },
24
+ "creationDate": {
25
+ "type": "string",
26
+ "format": "date-time"
27
+ },
28
+ "lastUpdated": {
29
+ "type": "string",
30
+ "format": "date-time"
31
+ },
32
+ "deviceId": {
33
+ "type": "string",
34
+ "pattern": "^[A-Fa-f\\d]{24}$"
35
+ },
36
+ "deviceName": {
37
+ "type": "string",
38
+ "minLength": 1,
39
+ "maxLength": 255
40
+ },
41
+ "deviceConnectionInfo": {
42
+ "type": "object",
43
+ "properties": {
44
+ "time": {
45
+ "type": "string",
46
+ "format": "date-time"
47
+ },
48
+ "connected": {
49
+ "enum": [
50
+ 1,
51
+ 0,
52
+ null
53
+ ]
54
+ }
55
+ }
56
+ },
57
+ "flows": {
58
+ "type": "object",
59
+ "patternProperties": {
60
+ "^[A-Fa-f\\d]{24}$": {
61
+ "type": "object",
62
+ "properties": {
63
+ "flowName": {
64
+ "type": "string",
65
+ "minLength": 1,
66
+ "maxLength": 255
67
+ },
68
+ "currentVersion": {
69
+ "type": [
70
+ "string",
71
+ "null"
72
+ ],
73
+ "minLength": 1,
74
+ "maxLength": 255
75
+ },
76
+ "desiredVersion": {
77
+ "type": [
78
+ "string",
79
+ "null"
80
+ ],
81
+ "minLength": 1,
82
+ "maxLength": 255
83
+ }
84
+ }
85
+ }
86
+ },
87
+ "additionalProperties": false
88
+ },
89
+ "currentBundleVersion": {
90
+ "type": [
91
+ "string",
92
+ "null"
93
+ ],
94
+ "minLength": 1,
95
+ "maxLength": 255
96
+ },
97
+ "desiredBundleVersion": {
98
+ "type": [
99
+ "string",
100
+ "null"
101
+ ],
102
+ "minLength": 1,
103
+ "maxLength": 255
104
+ },
105
+ "unknownBundle": {
106
+ "type": "boolean"
107
+ },
108
+ "logs": {
109
+ "type": "array",
110
+ "items": {
111
+ "type": "object",
112
+ "properties": {
113
+ "sourceType": {
114
+ "type": "string",
115
+ "enum": [
116
+ "flow",
117
+ "user",
118
+ "device",
119
+ "apiToken",
120
+ "notebook"
121
+ ]
122
+ },
123
+ "sourceId": {
124
+ "type": "string",
125
+ "pattern": "^[A-Fa-f\\d]{24}$"
126
+ },
127
+ "date": {
128
+ "type": "string",
129
+ "format": "date-time"
130
+ },
131
+ "changeType": {
132
+ "type": "string",
133
+ "enum": [
134
+ "current",
135
+ "desired"
136
+ ]
137
+ },
138
+ "updateType": {
139
+ "type": "string",
140
+ "enum": [
141
+ "newFlow",
142
+ "replaceFlow",
143
+ "removeFlow",
144
+ "clear",
145
+ "globals",
146
+ "device",
147
+ "unknownBundle",
148
+ "knownBundle"
149
+ ]
150
+ },
151
+ "updateFlowId": {
152
+ "type": "string",
153
+ "pattern": "^[A-Fa-f\\d]{24}$"
154
+ },
155
+ "desiredVersion": {
156
+ "type": [
157
+ "string",
158
+ "null"
159
+ ],
160
+ "minLength": 1,
161
+ "maxLength": 255
162
+ },
163
+ "newBundle": {
164
+ "type": [
165
+ "string",
166
+ "null"
167
+ ],
168
+ "minLength": 1,
169
+ "maxLength": 255
170
+ },
171
+ "attemptedBundle": {
172
+ "type": [
173
+ "string",
174
+ "null"
175
+ ],
176
+ "minLength": 1,
177
+ "maxLength": 255
178
+ },
179
+ "error": {
180
+ "type": "string"
181
+ }
182
+ }
183
+ }
184
+ }
185
+ }
186
+ }
187
+ },
188
+ "count": {
189
+ "type": "integer"
190
+ },
191
+ "totalCount": {
192
+ "type": "integer"
193
+ },
194
+ "applicationId": {
195
+ "type": "string",
196
+ "pattern": "^[A-Fa-f\\d]{24}$"
197
+ },
198
+ "deviceId": {
199
+ "type": "string",
200
+ "pattern": "^[A-Fa-f\\d]{24}$"
201
+ },
202
+ "flowId": {
203
+ "type": "string",
204
+ "pattern": "^[A-Fa-f\\d]{24}$"
205
+ },
206
+ "version": {
207
+ "type": "string",
208
+ "minLength": 1,
209
+ "maxLength": 255
210
+ }
211
+ }
212
+ }
@@ -97,10 +97,9 @@
97
97
  "type": "string"
98
98
  },
99
99
  "statusCode": {
100
- "type": "number",
101
- "min": 100,
102
- "max": 599,
103
- "integer": true
100
+ "type": "integer",
101
+ "minimum": 100,
102
+ "maximum": 599
104
103
  },
105
104
  "type": {
106
105
  "type": "string",
@@ -130,10 +129,9 @@
130
129
  "type": "string"
131
130
  },
132
131
  "statusCode": {
133
- "type": "number",
134
- "min": 100,
135
- "max": 599,
136
- "integer": true
132
+ "type": "integer",
133
+ "minimum": 100,
134
+ "maximum": 599
137
135
  },
138
136
  "type": {
139
137
  "type": "string",
@@ -61,10 +61,9 @@
61
61
  "type": "string"
62
62
  },
63
63
  "statusCode": {
64
- "type": "number",
65
- "min": 100,
66
- "max": 599,
67
- "integer": true
64
+ "type": "integer",
65
+ "minimum": 100,
66
+ "maximum": 599
68
67
  },
69
68
  "type": {
70
69
  "type": "string",
@@ -94,10 +93,9 @@
94
93
  "type": "string"
95
94
  },
96
95
  "statusCode": {
97
- "type": "number",
98
- "min": 100,
99
- "max": 599,
100
- "integer": true
96
+ "type": "integer",
97
+ "minimum": 100,
98
+ "maximum": 599
101
99
  },
102
100
  "type": {
103
101
  "type": "string",
@@ -61,10 +61,9 @@
61
61
  "type": "string"
62
62
  },
63
63
  "statusCode": {
64
- "type": "number",
65
- "min": 100,
66
- "max": 599,
67
- "integer": true
64
+ "type": "integer",
65
+ "minimum": 100,
66
+ "maximum": 599
68
67
  },
69
68
  "type": {
70
69
  "type": "string",
@@ -94,10 +93,9 @@
94
93
  "type": "string"
95
94
  },
96
95
  "statusCode": {
97
- "type": "number",
98
- "min": 100,
99
- "max": 599,
100
- "integer": true
96
+ "type": "integer",
97
+ "minimum": 100,
98
+ "maximum": 599
101
99
  },
102
100
  "type": {
103
101
  "type": "string",
@@ -104,10 +104,9 @@
104
104
  "type": "string"
105
105
  },
106
106
  "statusCode": {
107
- "type": "number",
108
- "min": 100,
109
- "max": 599,
110
- "integer": true
107
+ "type": "integer",
108
+ "minimum": 100,
109
+ "maximum": 599
111
110
  },
112
111
  "type": {
113
112
  "type": "string",
@@ -137,10 +136,9 @@
137
136
  "type": "string"
138
137
  },
139
138
  "statusCode": {
140
- "type": "number",
141
- "min": 100,
142
- "max": 599,
143
- "integer": true
139
+ "type": "integer",
140
+ "minimum": 100,
141
+ "maximum": 599
144
142
  },
145
143
  "type": {
146
144
  "type": "string",