losant_rest 1.10.2 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (143) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/docs/_schemas.md +21561 -8561
  4. data/docs/application.md +83 -0
  5. data/docs/applicationApiTokens.md +2 -2
  6. data/docs/applicationCertificateAuthorities.md +1 -1
  7. data/docs/applicationCertificates.md +1 -1
  8. data/docs/applicationDashboard.md +133 -0
  9. data/docs/applicationDashboards.md +93 -0
  10. data/docs/applicationKeys.md +4 -3
  11. data/docs/applicationTemplate.md +46 -0
  12. data/docs/applicationTemplates.md +77 -2
  13. data/docs/applications.md +1 -1
  14. data/docs/auditLogs.md +1 -1
  15. data/docs/dashboards.md +1 -1
  16. data/docs/dataTables.md +1 -1
  17. data/docs/device.md +6 -3
  18. data/docs/deviceRecipes.md +1 -1
  19. data/docs/devices.md +130 -4
  20. data/docs/edgeDeployments.md +1 -1
  21. data/docs/events.md +1 -1
  22. data/docs/experienceEndpoint.md +1 -0
  23. data/docs/experienceEndpoints.md +1 -0
  24. data/docs/experienceGroups.md +1 -1
  25. data/docs/experienceUsers.md +1 -1
  26. data/docs/experienceVersions.md +1 -1
  27. data/docs/experienceViews.md +1 -1
  28. data/docs/file.md +4 -4
  29. data/docs/files.md +1 -1
  30. data/docs/flow.md +94 -1
  31. data/docs/flowVersion.md +96 -1
  32. data/docs/flowVersions.md +2 -1
  33. data/docs/flows.md +5 -2
  34. data/docs/integration.md +1 -0
  35. data/docs/integrations.md +1 -1
  36. data/docs/me.md +0 -36
  37. data/docs/notebooks.md +1 -1
  38. data/docs/orgs.md +1 -1
  39. data/docs/webhook.md +1 -0
  40. data/docs/webhooks.md +1 -1
  41. data/lib/losant_rest.rb +3 -0
  42. data/lib/losant_rest/application.rb +95 -0
  43. data/lib/losant_rest/application_api_tokens.rb +1 -1
  44. data/lib/losant_rest/application_dashboard.rb +176 -0
  45. data/lib/losant_rest/application_dashboards.rb +138 -0
  46. data/lib/losant_rest/application_keys.rb +3 -0
  47. data/lib/losant_rest/application_template.rb +79 -0
  48. data/lib/losant_rest/application_templates.rb +89 -1
  49. data/lib/losant_rest/client.rb +14 -2
  50. data/lib/losant_rest/device.rb +9 -3
  51. data/lib/losant_rest/devices.rb +154 -1
  52. data/lib/losant_rest/experience_endpoint.rb +2 -0
  53. data/lib/losant_rest/experience_endpoints.rb +2 -0
  54. data/lib/losant_rest/file.rb +3 -3
  55. data/lib/losant_rest/flow.rb +115 -1
  56. data/lib/losant_rest/flow_version.rb +115 -1
  57. data/lib/losant_rest/flow_versions.rb +3 -0
  58. data/lib/losant_rest/flows.rb +8 -0
  59. data/lib/losant_rest/integration.rb +2 -0
  60. data/lib/losant_rest/me.rb +0 -41
  61. data/lib/losant_rest/version.rb +1 -1
  62. data/lib/losant_rest/webhook.rb +2 -0
  63. data/schemas/advancedApplicationKeyQuery.json +1082 -0
  64. data/schemas/advancedFlowByVersionQuery.json +665 -0
  65. data/schemas/advancedFlowQuery.json +883 -0
  66. data/schemas/advancedFlowVersionQuery.json +925 -0
  67. data/schemas/application.json +8 -0
  68. data/schemas/applicationApiTokenPost.json +16 -1
  69. data/schemas/applicationApplyTemplatePatch.json +19 -0
  70. data/schemas/applicationCreationByTemplateResult.json +8 -0
  71. data/schemas/applicationDashboardPost.json +5665 -0
  72. data/schemas/applicationGlobalPatch.json +33 -0
  73. data/schemas/applicationPost.json +8 -0
  74. data/schemas/applicationTemplate.json +20 -0
  75. data/schemas/applicationTemplateCategories.json +43 -0
  76. data/schemas/applicationTemplateCategory.json +23 -0
  77. data/schemas/applicationTemplates.json +32 -0
  78. data/schemas/applications.json +8 -0
  79. data/schemas/attributeNamesResponse.json +14 -0
  80. data/schemas/authedUser.json +3 -0
  81. data/schemas/changePassword.json +2 -2
  82. data/schemas/dashboard.json +195 -26
  83. data/schemas/dashboardPatch.json +195 -26
  84. data/schemas/dashboardPost.json +195 -26
  85. data/schemas/dashboards.json +195 -26
  86. data/schemas/dataExport.json +132 -1
  87. data/schemas/deviceAttributeDataTypeFilter.json +29 -0
  88. data/schemas/deviceClassFilter.json +1 -2
  89. data/schemas/eventPost.json +22 -0
  90. data/schemas/experienceDomain.json +1 -1
  91. data/schemas/experienceDomainPatch.json +1 -1
  92. data/schemas/experienceDomainPost.json +1 -1
  93. data/schemas/experienceDomains.json +1 -1
  94. data/schemas/experienceLinkedResources.json +96 -0
  95. data/schemas/experienceVersion.json +10 -1
  96. data/schemas/experienceVersionPatch.json +9 -0
  97. data/schemas/experienceVersions.json +10 -1
  98. data/schemas/files.json +3 -0
  99. data/schemas/flow.json +32 -0
  100. data/schemas/flowErrors.json +87 -0
  101. data/schemas/flowPatch.json +32 -0
  102. data/schemas/flowPost.json +32 -0
  103. data/schemas/flowStats.json +54 -0
  104. data/schemas/flowVersion.json +64 -0
  105. data/schemas/flowVersionPost.json +32 -0
  106. data/schemas/flowVersions.json +64 -0
  107. data/schemas/flows.json +32 -0
  108. data/schemas/flowsImportPost.json +64 -0
  109. data/schemas/flowsImportResult.json +96 -0
  110. data/schemas/githubLogin.json +33 -4
  111. data/schemas/instance.json +132 -0
  112. data/schemas/instanceOrg.json +119 -0
  113. data/schemas/instanceOrgPatch.json +103 -0
  114. data/schemas/instanceOrgPost.json +114 -0
  115. data/schemas/instanceOrgs.json +160 -0
  116. data/schemas/instances.json +43 -0
  117. data/schemas/integration.json +3 -0
  118. data/schemas/integrationPatch.json +3 -0
  119. data/schemas/integrationPost.json +3 -0
  120. data/schemas/integrations.json +3 -0
  121. data/schemas/me.json +3 -3
  122. data/schemas/mePatch.json +2 -2
  123. data/schemas/notebook.json +96 -0
  124. data/schemas/notebookExecutionLogs.json +7 -0
  125. data/schemas/notebookPatch.json +96 -0
  126. data/schemas/notebookPost.json +96 -0
  127. data/schemas/notebooks.json +96 -0
  128. data/schemas/org.json +1 -1
  129. data/schemas/orgInviteInfo.json +3 -0
  130. data/schemas/orgInvitePost.json +3 -0
  131. data/schemas/orgInvites.json +3 -0
  132. data/schemas/orgPatch.json +1 -1
  133. data/schemas/orgs.json +1 -1
  134. data/schemas/passwordResetFinish.json +2 -2
  135. data/schemas/samlResponse.json +1 -1
  136. data/schemas/tagKeysResponse.json +14 -0
  137. data/schemas/tagValuesResponse.json +19 -0
  138. data/schemas/templateKeywords.json +14 -0
  139. data/schemas/timeSeriesData.json +12 -2
  140. data/schemas/timeSeriesQuery.json +94 -14
  141. data/schemas/userCredentials.json +31 -3
  142. data/schemas/userPost.json +39 -7
  143. metadata +34 -6
data/schemas/instanceOrgs.json ADDED
@@ -0,0 +1,160 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "title": "Instance Organization",
9
+ "description": "Schema for the body of an Organization owned by an instance",
10
+ "type": "object",
11
+ "properties": {
12
+ "name": {
13
+ "type": "string",
14
+ "minLength": 1,
15
+ "maxLength": 255
16
+ },
17
+ "id": {
18
+ "type": "string",
19
+ "pattern": "^[A-Fa-f\\d]{24}$"
20
+ },
21
+ "instanceId": {
22
+ "type": "string",
23
+ "pattern": "^[A-Fa-f\\d]{24}$"
24
+ },
25
+ "description": {
26
+ "type": "string",
27
+ "maxLength": 32767
28
+ },
29
+ "iconColor": {
30
+ "type": "string",
31
+ "maxLength": 64
32
+ },
33
+ "limits": {
34
+ "apitoken": {
35
+ "type": "number"
36
+ },
37
+ "application": {
38
+ "type": "number"
39
+ },
40
+ "applicationkey": {
41
+ "type": "number"
42
+ },
43
+ "dashboard": {
44
+ "type": "number"
45
+ },
46
+ "datatable": {
47
+ "type": "number"
48
+ },
49
+ "device": {
50
+ "type": "number"
51
+ },
52
+ "devicerecipe": {
53
+ "type": "number"
54
+ },
55
+ "experiencedomain": {
56
+ "type": "number"
57
+ },
58
+ "experienceendpoint": {
59
+ "type": "number"
60
+ },
61
+ "experiencegroup": {
62
+ "type": "number"
63
+ },
64
+ "experienceslug": {
65
+ "type": "number"
66
+ },
67
+ "experienceuser": {
68
+ "type": "number"
69
+ },
70
+ "experienceversion": {
71
+ "type": "number"
72
+ },
73
+ "experienceview": {
74
+ "type": "number"
75
+ },
76
+ "file": {
77
+ "type": "number"
78
+ },
79
+ "flow": {
80
+ "type": "number"
81
+ },
82
+ "integration": {
83
+ "type": "number"
84
+ },
85
+ "notebook": {
86
+ "type": "number"
87
+ },
88
+ "webhook": {
89
+ "type": "number"
90
+ },
91
+ "dataTTL": {
92
+ "type": "number"
93
+ },
94
+ "member": {
95
+ "type": "number"
96
+ },
97
+ "payload": {
98
+ "type": "number"
99
+ },
100
+ "notebookMinutesPerRun": {
101
+ "type": "number"
102
+ },
103
+ "notebookMinutesPerMonth": {
104
+ "type": "number"
105
+ },
106
+ "notebookInParallel": {
107
+ "type": "number"
108
+ }
109
+ },
110
+ "whitelistedEmailDomains": {
111
+ "type": "array",
112
+ "items": {
113
+ "type": "string",
114
+ "maxLength": 45,
115
+ "minLength": 3
116
+ }
117
+ },
118
+ "auditLogEnabled": {
119
+ "type": "boolean"
120
+ }
121
+ },
122
+ "additionalProperties": false,
123
+ "required": [
124
+ "name"
125
+ ]
126
+ }
127
+ },
128
+ "count": {
129
+ "type": "integer"
130
+ },
131
+ "totalCount": {
132
+ "type": "integer"
133
+ },
134
+ "perPage": {
135
+ "type": "integer"
136
+ },
137
+ "page": {
138
+ "type": "integer"
139
+ },
140
+ "filter": {
141
+ "type": "string"
142
+ },
143
+ "filterField": {
144
+ "type": "string"
145
+ },
146
+ "sortField": {
147
+ "type": "string"
148
+ },
149
+ "sortDirection": {
150
+ "type": "string",
151
+ "enum": [
152
+ "asc",
153
+ "desc",
154
+ "ASC",
155
+ "DESC",
156
+ ""
157
+ ]
158
+ }
159
+ }
160
+ }
data/schemas/instances.json ADDED
@@ -0,0 +1,43 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "type": "#/definitions/instance"
9
+ }
10
+ },
11
+ "count": {
12
+ "type": "integer"
13
+ },
14
+ "totalCount": {
15
+ "type": "integer"
16
+ },
17
+ "perPage": {
18
+ "type": "integer"
19
+ },
20
+ "page": {
21
+ "type": "integer"
22
+ },
23
+ "filter": {
24
+ "type": "string"
25
+ },
26
+ "filterField": {
27
+ "type": "string"
28
+ },
29
+ "sortField": {
30
+ "type": "string"
31
+ },
32
+ "sortDirection": {
33
+ "type": "string",
34
+ "enum": [
35
+ "asc",
36
+ "desc",
37
+ "ASC",
38
+ "DESC",
39
+ ""
40
+ ]
41
+ }
42
+ }
43
+ }
data/schemas/integration.json CHANGED
@@ -121,6 +121,9 @@
121
121
  "type": "string",
122
122
  "maxLength": 32767,
123
123
  "minLength": 4
124
+ },
125
+ "disableSSLVerification": {
126
+ "type": "boolean"
124
127
  }
125
128
  },
126
129
  "additionalProperties": false,
data/schemas/integrationPatch.json CHANGED
@@ -101,6 +101,9 @@
101
101
  "type": "string",
102
102
  "maxLength": 32767,
103
103
  "minLength": 4
104
+ },
105
+ "disableSSLVerification": {
106
+ "type": "boolean"
104
107
  }
105
108
  },
106
109
  "additionalProperties": false,
data/schemas/integrationPost.json CHANGED
@@ -101,6 +101,9 @@
101
101
  "type": "string",
102
102
  "maxLength": 32767,
103
103
  "minLength": 4
104
+ },
105
+ "disableSSLVerification": {
106
+ "type": "boolean"
104
107
  }
105
108
  },
106
109
  "additionalProperties": false,
data/schemas/integrations.json CHANGED
@@ -128,6 +128,9 @@
128
128
  "type": "string",
129
129
  "maxLength": 32767,
130
130
  "minLength": 4
131
+ },
132
+ "disableSSLVerification": {
133
+ "type": "boolean"
131
134
  }
132
135
  },
133
136
  "additionalProperties": false,
data/schemas/me.json CHANGED
@@ -64,6 +64,9 @@
64
64
  "emailVerified": {
65
65
  "type": "boolean"
66
66
  },
67
+ "needsToVerifyEmail": {
68
+ "type": "boolean"
69
+ },
67
70
  "twoFactorAuthEnabled": {
68
71
  "type": "boolean"
69
72
  },
@@ -73,9 +76,6 @@
73
76
  "githubName": {
74
77
  "type": "string"
75
78
  },
76
- "twitterName": {
77
- "type": "string"
78
- },
79
79
  "avatarUrl": {
80
80
  "type": "string",
81
81
  "format": "url"
data/schemas/mePatch.json CHANGED
@@ -39,9 +39,9 @@
39
39
  },
40
40
  "password": {
41
41
  "type": "string",
42
- "minLength": 8,
42
+ "minLength": 12,
43
43
  "maxLength": 2048,
44
- "pattern": "^(?=.*[A-Z])(?=.*[^A-z0-9])(?=.*[0-9])(?=.*[a-z]).{8,}$"
44
+ "pattern": "^(?=.*[A-Z])(?=.*[^A-Za-z0-9])(?=.*[0-9])(?=.*[a-z]).{12,}$"
45
45
  },
46
46
  "tokenCutoff": {
47
47
  "type": "string",
data/schemas/notebook.json CHANGED
@@ -39,6 +39,13 @@
39
39
  "jupyterFileUrl": {
40
40
  "type": "string"
41
41
  },
42
+ "imageVersion": {
43
+ "type": "string",
44
+ "enum": [
45
+ "v1",
46
+ "v2"
47
+ ]
48
+ },
42
49
  "inputs": {
43
50
  "type": "array",
44
51
  "items": {
@@ -141,6 +148,95 @@
141
148
  ],
142
149
  "additionalProperties": false
143
150
  },
151
+ {
152
+ "type": "object",
153
+ "properties": {
154
+ "inputType": {
155
+ "type": "string",
156
+ "enum": [
157
+ "deviceConnectionHistory"
158
+ ]
159
+ },
160
+ "fileName": {
161
+ "oneOf": [
162
+ {
163
+ "type": "string",
164
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
165
+ },
166
+ {
167
+ "type": "string",
168
+ "minLength": 4,
169
+ "maxLength": 255,
170
+ "pattern": ".*{{.+}}.*"
171
+ }
172
+ ]
173
+ },
174
+ "deviceTags": {
175
+ "type": "array",
176
+ "maxItems": 100,
177
+ "items": {
178
+ "type": "object",
179
+ "properties": {
180
+ "key": {
181
+ "oneOf": [
182
+ {
183
+ "type": "string",
184
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
185
+ },
186
+ {
187
+ "type": "string",
188
+ "minLength": 4,
189
+ "maxLength": 255,
190
+ "pattern": ".*{{.+}}.*"
191
+ }
192
+ ]
193
+ },
194
+ "value": {
195
+ "type": "string",
196
+ "minLength": 1,
197
+ "maxLength": 255
198
+ }
199
+ },
200
+ "additionalProperties": false
201
+ }
202
+ },
203
+ "deviceIds": {
204
+ "type": "array",
205
+ "maxItems": 100,
206
+ "items": {
207
+ "oneOf": [
208
+ {
209
+ "type": "string",
210
+ "pattern": "^[A-Fa-f\\d]{24}$"
211
+ },
212
+ {
213
+ "type": "string",
214
+ "minLength": 4,
215
+ "maxLength": 255,
216
+ "pattern": ".*{{.+}}.*"
217
+ }
218
+ ]
219
+ }
220
+ },
221
+ "queryJson": {
222
+ "type": "string",
223
+ "maxLength": 8192
224
+ },
225
+ "start": {
226
+ "type": "number"
227
+ },
228
+ "end": {
229
+ "type": "number"
230
+ }
231
+ },
232
+ "required": [
233
+ "inputType",
234
+ "fileName",
235
+ "start",
236
+ "end"
237
+ ],
238
+ "additionalProperties": false
239
+ },
144
240
  {
145
241
  "type": "object",
146
242
  "properties": {
data/schemas/notebookExecutionLogs.json CHANGED
@@ -16,6 +16,13 @@
16
16
  "type": "string",
17
17
  "pattern": "^[A-Fa-f\\d]{24}$"
18
18
  },
19
+ "imageVersion": {
20
+ "type": "string",
21
+ "enum": [
22
+ "v1",
23
+ "v2"
24
+ ]
25
+ },
19
26
  "applicationId": {
20
27
  "type": "string",
21
28
  "pattern": "^[A-Fa-f\\d]{24}$"
data/schemas/notebookPatch.json CHANGED
@@ -113,6 +113,95 @@
113
113
  ],
114
114
  "additionalProperties": false
115
115
  },
116
+ {
117
+ "type": "object",
118
+ "properties": {
119
+ "inputType": {
120
+ "type": "string",
121
+ "enum": [
122
+ "deviceConnectionHistory"
123
+ ]
124
+ },
125
+ "fileName": {
126
+ "oneOf": [
127
+ {
128
+ "type": "string",
129
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
130
+ },
131
+ {
132
+ "type": "string",
133
+ "minLength": 4,
134
+ "maxLength": 255,
135
+ "pattern": ".*{{.+}}.*"
136
+ }
137
+ ]
138
+ },
139
+ "deviceTags": {
140
+ "type": "array",
141
+ "maxItems": 100,
142
+ "items": {
143
+ "type": "object",
144
+ "properties": {
145
+ "key": {
146
+ "oneOf": [
147
+ {
148
+ "type": "string",
149
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
150
+ },
151
+ {
152
+ "type": "string",
153
+ "minLength": 4,
154
+ "maxLength": 255,
155
+ "pattern": ".*{{.+}}.*"
156
+ }
157
+ ]
158
+ },
159
+ "value": {
160
+ "type": "string",
161
+ "minLength": 1,
162
+ "maxLength": 255
163
+ }
164
+ },
165
+ "additionalProperties": false
166
+ }
167
+ },
168
+ "deviceIds": {
169
+ "type": "array",
170
+ "maxItems": 100,
171
+ "items": {
172
+ "oneOf": [
173
+ {
174
+ "type": "string",
175
+ "pattern": "^[A-Fa-f\\d]{24}$"
176
+ },
177
+ {
178
+ "type": "string",
179
+ "minLength": 4,
180
+ "maxLength": 255,
181
+ "pattern": ".*{{.+}}.*"
182
+ }
183
+ ]
184
+ }
185
+ },
186
+ "queryJson": {
187
+ "type": "string",
188
+ "maxLength": 8192
189
+ },
190
+ "start": {
191
+ "type": "number"
192
+ },
193
+ "end": {
194
+ "type": "number"
195
+ }
196
+ },
197
+ "required": [
198
+ "inputType",
199
+ "fileName",
200
+ "start",
201
+ "end"
202
+ ],
203
+ "additionalProperties": false
204
+ },
116
205
  {
117
206
  "type": "object",
118
207
  "properties": {
@@ -487,6 +576,13 @@
487
576
  }
488
577
  ]
489
578
  }
579
+ },
580
+ "imageVersion": {
581
+ "type": "string",
582
+ "enum": [
583
+ "v1",
584
+ "v2"
585
+ ]
490
586
  }
491
587
  },
492
588
  "additionalProperties": false