losant_rest 1.13.0 → 1.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (172) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +19437 -10622
  3. data/docs/application.md +6 -6
  4. data/docs/applicationApiTokens.md +1 -1
  5. data/docs/applications.md +1 -1
  6. data/docs/dataTable.md +1 -1
  7. data/docs/dataTableRows.md +1 -1
  8. data/docs/dataTables.md +1 -1
  9. data/docs/device.md +43 -0
  10. data/docs/devices.md +41 -2
  11. data/docs/edgeDeployment.md +49 -0
  12. data/docs/embeddedDeployment.md +49 -0
  13. data/docs/embeddedDeployments.md +215 -0
  14. data/docs/experience.md +1 -1
  15. data/docs/experienceDomains.md +1 -1
  16. data/docs/experienceGroup.md +2 -0
  17. data/docs/experienceSlugs.md +1 -1
  18. data/docs/experienceVersion.md +3 -3
  19. data/docs/experienceVersions.md +2 -2
  20. data/docs/experienceView.md +4 -4
  21. data/docs/experienceViews.md +2 -2
  22. data/docs/file.md +5 -5
  23. data/docs/files.md +2 -2
  24. data/docs/flow.md +3 -3
  25. data/docs/flowVersions.md +44 -0
  26. data/docs/flows.md +2 -2
  27. data/docs/instance.md +40 -0
  28. data/docs/instanceApiToken.md +133 -0
  29. data/docs/instanceApiTokens.md +91 -0
  30. data/docs/instanceMembers.md +1 -1
  31. data/docs/instanceOrg.md +2 -0
  32. data/docs/instanceOrgInvite.md +139 -0
  33. data/docs/instanceOrgInvites.md +96 -0
  34. data/docs/instanceOrgMembers.md +3 -3
  35. data/docs/instanceOrgs.md +1 -1
  36. data/docs/me.md +1 -1
  37. data/docs/org.md +1 -1
  38. data/docs/userApiToken.md +125 -0
  39. data/docs/userApiTokens.md +87 -0
  40. data/lib/losant_rest/application.rb +5 -5
  41. data/lib/losant_rest/application_api_tokens.rb +1 -1
  42. data/lib/losant_rest/applications.rb +1 -1
  43. data/lib/losant_rest/client.rb +38 -2
  44. data/lib/losant_rest/data_table.rb +1 -1
  45. data/lib/losant_rest/data_table_rows.rb +1 -1
  46. data/lib/losant_rest/data_tables.rb +1 -1
  47. data/lib/losant_rest/device.rb +50 -0
  48. data/lib/losant_rest/devices.rb +48 -2
  49. data/lib/losant_rest/edge_deployment.rb +81 -0
  50. data/lib/losant_rest/embedded_deployment.rb +81 -0
  51. data/lib/losant_rest/embedded_deployments.rb +280 -0
  52. data/lib/losant_rest/experience.rb +1 -1
  53. data/lib/losant_rest/experience_domains.rb +1 -1
  54. data/lib/losant_rest/experience_group.rb +4 -0
  55. data/lib/losant_rest/experience_slugs.rb +1 -1
  56. data/lib/losant_rest/experience_version.rb +3 -3
  57. data/lib/losant_rest/experience_versions.rb +2 -2
  58. data/lib/losant_rest/experience_view.rb +4 -4
  59. data/lib/losant_rest/experience_views.rb +2 -2
  60. data/lib/losant_rest/file.rb +4 -4
  61. data/lib/losant_rest/files.rb +2 -2
  62. data/lib/losant_rest/flow.rb +3 -3
  63. data/lib/losant_rest/flow_versions.rb +50 -0
  64. data/lib/losant_rest/flows.rb +2 -2
  65. data/lib/losant_rest/instance.rb +47 -1
  66. data/lib/losant_rest/instance_api_token.rb +176 -0
  67. data/lib/losant_rest/instance_api_tokens.rb +136 -0
  68. data/lib/losant_rest/instance_member.rb +1 -1
  69. data/lib/losant_rest/instance_members.rb +2 -2
  70. data/lib/losant_rest/instance_org.rb +5 -1
  71. data/lib/losant_rest/instance_org_invite.rb +182 -0
  72. data/lib/losant_rest/instance_org_invites.rb +138 -0
  73. data/lib/losant_rest/instance_org_member.rb +1 -1
  74. data/lib/losant_rest/instance_org_members.rb +4 -4
  75. data/lib/losant_rest/instance_orgs.rb +3 -3
  76. data/lib/losant_rest/instances.rb +1 -1
  77. data/lib/losant_rest/user_api_token.rb +170 -0
  78. data/lib/losant_rest/user_api_tokens.rb +132 -0
  79. data/lib/losant_rest/version.rb +1 -1
  80. data/lib/losant_rest.rb +9 -0
  81. data/schemas/apiToken.json +2 -1
  82. data/schemas/apiTokenPost.json +439 -0
  83. data/schemas/apiTokens.json +4 -2
  84. data/schemas/application.json +32 -32
  85. data/schemas/applicationCreationByTemplateResult.json +32 -32
  86. data/schemas/applicationDashboardPost.json +28 -21
  87. data/schemas/applicationPatch.json +13 -13
  88. data/schemas/applicationPost.json +13 -13
  89. data/schemas/applicationTemplate.json +16 -16
  90. data/schemas/applicationTemplates.json +16 -16
  91. data/schemas/applications.json +32 -32
  92. data/schemas/auditLog.json +4 -0
  93. data/schemas/auditLogFilter.json +4 -0
  94. data/schemas/auditLogs.json +4 -0
  95. data/schemas/authedDevice.json +2 -1
  96. data/schemas/bulkDeleteResponse.json +12 -0
  97. data/schemas/dashboard.json +28 -21
  98. data/schemas/dashboardPatch.json +28 -21
  99. data/schemas/dashboardPost.json +28 -21
  100. data/schemas/dashboardSendReport.json +9 -5
  101. data/schemas/dashboards.json +28 -21
  102. data/schemas/dataTableRowsDelete.json +1 -1
  103. data/schemas/device.json +2 -1
  104. data/schemas/deviceClassFilter.json +4 -2
  105. data/schemas/devicePatch.json +2 -1
  106. data/schemas/devicePayloadCounts.json +24 -0
  107. data/schemas/devicePost.json +2 -1
  108. data/schemas/deviceRecipe.json +2 -1
  109. data/schemas/deviceRecipePatch.json +2 -1
  110. data/schemas/deviceRecipePost.json +2 -1
  111. data/schemas/deviceRecipes.json +2 -1
  112. data/schemas/devices.json +4 -2
  113. data/schemas/devicesExportPayloadCountPost.json +1350 -0
  114. data/schemas/devicesPatch.json +4 -2
  115. data/schemas/edgeDeployment.json +20 -0
  116. data/schemas/edgeDeployments.json +20 -0
  117. data/schemas/embeddedDeployment.json +179 -0
  118. data/schemas/embeddedDeploymentExport.json +44 -0
  119. data/schemas/embeddedDeploymentRelease.json +58 -0
  120. data/schemas/embeddedDeploymentRemove.json +25 -0
  121. data/schemas/embeddedDeploymentReplace.json +29 -0
  122. data/schemas/embeddedDeployments.json +212 -0
  123. data/schemas/eventsDeleted.json +1 -1
  124. data/schemas/experienceEndpoint.json +6 -8
  125. data/schemas/experienceEndpointPatch.json +6 -8
  126. data/schemas/experienceEndpointPost.json +6 -8
  127. data/schemas/experienceEndpoints.json +6 -8
  128. data/schemas/experienceGroup.json +6 -0
  129. data/schemas/experienceGroups.json +6 -0
  130. data/schemas/experienceLinkedResources.json +790 -85
  131. data/schemas/flow.json +252 -16
  132. data/schemas/flowPatch.json +251 -16
  133. data/schemas/flowPost.json +252 -16
  134. data/schemas/flowVersion.json +503 -33
  135. data/schemas/flowVersionPost.json +251 -16
  136. data/schemas/flowVersions.json +503 -33
  137. data/schemas/flowVersionsDeletePost.json +941 -0
  138. data/schemas/flows.json +253 -16
  139. data/schemas/flowsImportPost.json +503 -32
  140. data/schemas/flowsImportResult.json +785 -79
  141. data/schemas/githubLogin.json +38 -1
  142. data/schemas/historicalSummary.json +150 -102
  143. data/schemas/instance.json +150 -77
  144. data/schemas/instanceMember.json +10 -0
  145. data/schemas/instanceMemberPost.json +18 -3
  146. data/schemas/instanceMembers.json +14 -0
  147. data/schemas/instanceOrg.json +87 -74
  148. data/schemas/instanceOrgMember.json +14 -0
  149. data/schemas/instanceOrgMembers.json +8 -0
  150. data/schemas/instanceOrgPatch.json +64 -26
  151. data/schemas/instanceOrgPost.json +229 -25
  152. data/schemas/instanceOrgs.json +91 -74
  153. data/schemas/instancePatch.json +67 -0
  154. data/schemas/instanceReportOptionsPost.json +1 -0
  155. data/schemas/me.json +134 -105
  156. data/schemas/notebook.json +45 -0
  157. data/schemas/notebookPatch.json +30 -0
  158. data/schemas/notebookPost.json +30 -0
  159. data/schemas/notebooks.json +45 -0
  160. data/schemas/org.json +145 -110
  161. data/schemas/orgInvite.json +90 -0
  162. data/schemas/orgInviteCollection.json +130 -0
  163. data/schemas/orgInvites.json +82 -77
  164. data/schemas/orgRoleInfo.json +69 -0
  165. data/schemas/orgs.json +145 -110
  166. data/schemas/payloadStats.json +28 -12
  167. data/schemas/userCredentials.json +38 -1
  168. data/schemas/userPost.json +38 -1
  169. data/schemas/validateContextError.json +34 -0
  170. data/schemas/validateContextSuccess.json +34 -0
  171. data/schemas/virtualButtonPress.json +4 -0
  172. metadata +39 -6
data/schemas/instance.json CHANGED
@@ -26,85 +26,158 @@
26
26
  "allowAuditLogging": {
27
27
  "type": "boolean"
28
28
  },
29
+ "reportConfigs": {
30
+ "type": "array",
31
+ "maxItems": 10,
32
+ "items": {
33
+ "type": "object",
34
+ "properties": {
35
+ "id": {
36
+ "type": "string",
37
+ "maxLength": 48
38
+ },
39
+ "cron": {
40
+ "type": "string",
41
+ "maxLength": 255
42
+ },
43
+ "timezone": {
44
+ "type": "string",
45
+ "maxLength": 255
46
+ },
47
+ "emails": {
48
+ "type": "array",
49
+ "maxItems": 10,
50
+ "items": {
51
+ "type": "string",
52
+ "format": "email",
53
+ "maxLength": 1024
54
+ }
55
+ },
56
+ "callbackUrl": {
57
+ "type": "string",
58
+ "maxLength": 1024
59
+ },
60
+ "resourceGroupBy": {
61
+ "type": "string",
62
+ "enum": [
63
+ "application",
64
+ "organization"
65
+ ]
66
+ },
67
+ "dateGroupBy": {
68
+ "type": "string",
69
+ "enum": [
70
+ "day",
71
+ "month"
72
+ ]
73
+ },
74
+ "periods": {
75
+ "type": "integer",
76
+ "minimum": 1,
77
+ "maximum": 90
78
+ },
79
+ "includeSandbox": {
80
+ "type": "boolean"
81
+ }
82
+ },
83
+ "required": [
84
+ "cron"
85
+ ],
86
+ "additionalProperties": false
87
+ }
88
+ },
29
89
  "limits": {
30
- "organization": {
31
- "type": "number"
32
- },
33
- "apitoken": {
34
- "type": "number"
35
- },
36
- "application": {
37
- "type": "number"
38
- },
39
- "applicationkey": {
40
- "type": "number"
41
- },
42
- "dashboard": {
43
- "type": "number"
44
- },
45
- "datatable": {
46
- "type": "number"
47
- },
48
- "device": {
49
- "type": "number"
50
- },
51
- "devicerecipe": {
52
- "type": "number"
53
- },
54
- "experiencedomain": {
55
- "type": "number"
56
- },
57
- "experienceendpoint": {
58
- "type": "number"
59
- },
60
- "experiencegroup": {
61
- "type": "number"
62
- },
63
- "experienceslug": {
64
- "type": "number"
65
- },
66
- "experienceuser": {
67
- "type": "number"
68
- },
69
- "experienceversion": {
70
- "type": "number"
71
- },
72
- "experienceview": {
73
- "type": "number"
74
- },
75
- "file": {
76
- "type": "number"
77
- },
78
- "flow": {
79
- "type": "number"
80
- },
81
- "integration": {
82
- "type": "number"
83
- },
84
- "notebook": {
85
- "type": "number"
86
- },
87
- "webhook": {
88
- "type": "number"
89
- },
90
- "dataTTL": {
91
- "type": "number"
92
- },
93
- "member": {
94
- "type": "number"
95
- },
96
- "payload": {
97
- "type": "number"
98
- },
99
- "notebookMinutesPerRun": {
100
- "type": "number"
101
- },
102
- "notebookMinutesPerMonth": {
103
- "type": "number"
90
+ "type": "object",
91
+ "properties": {
92
+ "organization": {
93
+ "type": "integer"
94
+ },
95
+ "apitoken": {
96
+ "type": "integer"
97
+ },
98
+ "application": {
99
+ "type": "integer"
100
+ },
101
+ "applicationkey": {
102
+ "type": "integer"
103
+ },
104
+ "dashboard": {
105
+ "type": "integer"
106
+ },
107
+ "datatable": {
108
+ "type": "integer"
109
+ },
110
+ "device": {
111
+ "type": "integer"
112
+ },
113
+ "devicerecipe": {
114
+ "type": "integer"
115
+ },
116
+ "experiencedomain": {
117
+ "type": "integer"
118
+ },
119
+ "experienceendpoint": {
120
+ "type": "integer"
121
+ },
122
+ "experiencegroup": {
123
+ "type": "integer"
124
+ },
125
+ "experienceslug": {
126
+ "type": "integer"
127
+ },
128
+ "experienceuser": {
129
+ "type": "integer"
130
+ },
131
+ "experienceversion": {
132
+ "type": "integer"
133
+ },
134
+ "experienceview": {
135
+ "type": "integer"
136
+ },
137
+ "file": {
138
+ "type": "integer"
139
+ },
140
+ "flow": {
141
+ "type": "integer"
142
+ },
143
+ "integration": {
144
+ "type": "integer"
145
+ },
146
+ "notebook": {
147
+ "type": "integer"
148
+ },
149
+ "webhook": {
150
+ "type": "integer"
151
+ },
152
+ "dataTTL": {
153
+ "type": "integer"
154
+ },
155
+ "member": {
156
+ "type": "integer"
157
+ },
158
+ "payload": {
159
+ "type": "integer"
160
+ },
161
+ "storage": {
162
+ "type": "integer"
163
+ },
164
+ "notebookMinutesPerRun": {
165
+ "type": "integer"
166
+ },
167
+ "notebookMinutesPerMonth": {
168
+ "type": "integer"
169
+ },
170
+ "notebookInParallel": {
171
+ "type": "integer"
172
+ },
173
+ "experienceFlowSlots": {
174
+ "type": "integer"
175
+ },
176
+ "applicationFlowSlots": {
177
+ "type": "integer"
178
+ }
104
179
  },
105
- "notebookInParallel": {
106
- "type": "number"
107
- }
180
+ "additionalProperties": false
108
181
  },
109
182
  "members": {
110
183
  "type": "array",
data/schemas/instanceMember.json CHANGED
@@ -2,6 +2,10 @@
2
2
  "$schema": "http://json-schema.org/draft-04/schema#",
3
3
  "type": "object",
4
4
  "properties": {
5
+ "instanceId": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
5
9
  "userId": {
6
10
  "type": "string",
7
11
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -31,6 +35,12 @@
31
35
  "avatarUrl": {
32
36
  "type": "string",
33
37
  "format": "url"
38
+ },
39
+ "twoFactorAuthEnabled": {
40
+ "type": "boolean"
41
+ },
42
+ "ssoLinked": {
43
+ "type": "boolean"
34
44
  }
35
45
  },
36
46
  "additionalProperties": false
data/schemas/instanceMemberPost.json CHANGED
@@ -6,6 +6,11 @@
6
6
  "type": "string",
7
7
  "pattern": "^[A-Fa-f\\d]{24}$"
8
8
  },
9
+ "email": {
10
+ "type": "string",
11
+ "format": "email",
12
+ "maxLength": 1024
13
+ },
9
14
  "role": {
10
15
  "type": "string",
11
16
  "enum": [
@@ -15,8 +20,18 @@
15
20
  }
16
21
  },
17
22
  "additionalProperties": false,
18
- "required": [
19
- "userId",
20
- "role"
23
+ "anyOf": [
24
+ {
25
+ "required": [
26
+ "email",
27
+ "role"
28
+ ]
29
+ },
30
+ {
31
+ "required": [
32
+ "userId",
33
+ "role"
34
+ ]
35
+ }
21
36
  ]
22
37
  }
data/schemas/instanceMembers.json CHANGED
@@ -9,6 +9,10 @@
9
9
  "description": "Schema for an Instance member",
10
10
  "type": "object",
11
11
  "properties": {
12
+ "instanceId": {
13
+ "type": "string",
14
+ "pattern": "^[A-Fa-f\\d]{24}$"
15
+ },
12
16
  "userId": {
13
17
  "type": "string",
14
18
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -38,11 +42,21 @@
38
42
  "avatarUrl": {
39
43
  "type": "string",
40
44
  "format": "url"
45
+ },
46
+ "twoFactorAuthEnabled": {
47
+ "type": "boolean"
48
+ },
49
+ "ssoLinked": {
50
+ "type": "boolean"
41
51
  }
42
52
  },
43
53
  "additionalProperties": false
44
54
  }
45
55
  },
56
+ "instanceId": {
57
+ "type": "string",
58
+ "pattern": "^[A-Fa-f\\d]{24}$"
59
+ },
46
60
  "count": {
47
61
  "type": "integer"
48
62
  },
data/schemas/instanceOrg.json CHANGED
@@ -24,81 +24,94 @@
24
24
  "maxLength": 64
25
25
  },
26
26
  "limits": {
27
- "apitoken": {
28
- "type": "number"
29
- },
30
- "application": {
31
- "type": "number"
32
- },
33
- "applicationkey": {
34
- "type": "number"
35
- },
36
- "dashboard": {
37
- "type": "number"
38
- },
39
- "datatable": {
40
- "type": "number"
41
- },
42
- "device": {
43
- "type": "number"
44
- },
45
- "devicerecipe": {
46
- "type": "number"
47
- },
48
- "experiencedomain": {
49
- "type": "number"
50
- },
51
- "experienceendpoint": {
52
- "type": "number"
53
- },
54
- "experiencegroup": {
55
- "type": "number"
56
- },
57
- "experienceslug": {
58
- "type": "number"
59
- },
60
- "experienceuser": {
61
- "type": "number"
62
- },
63
- "experienceversion": {
64
- "type": "number"
65
- },
66
- "experienceview": {
67
- "type": "number"
68
- },
69
- "file": {
70
- "type": "number"
71
- },
72
- "flow": {
73
- "type": "number"
74
- },
75
- "integration": {
76
- "type": "number"
77
- },
78
- "notebook": {
79
- "type": "number"
80
- },
81
- "webhook": {
82
- "type": "number"
83
- },
84
- "dataTTL": {
85
- "type": "number"
86
- },
87
- "member": {
88
- "type": "number"
89
- },
90
- "payload": {
91
- "type": "number"
92
- },
93
- "notebookMinutesPerRun": {
94
- "type": "number"
95
- },
96
- "notebookMinutesPerMonth": {
97
- "type": "number"
27
+ "type": "object",
28
+ "properties": {
29
+ "apitoken": {
30
+ "type": "integer"
31
+ },
32
+ "application": {
33
+ "type": "integer"
34
+ },
35
+ "applicationkey": {
36
+ "type": "integer"
37
+ },
38
+ "dashboard": {
39
+ "type": "integer"
40
+ },
41
+ "datatable": {
42
+ "type": "integer"
43
+ },
44
+ "device": {
45
+ "type": "integer"
46
+ },
47
+ "devicerecipe": {
48
+ "type": "integer"
49
+ },
50
+ "experiencedomain": {
51
+ "type": "integer"
52
+ },
53
+ "experienceendpoint": {
54
+ "type": "integer"
55
+ },
56
+ "experiencegroup": {
57
+ "type": "integer"
58
+ },
59
+ "experienceslug": {
60
+ "type": "integer"
61
+ },
62
+ "experienceuser": {
63
+ "type": "integer"
64
+ },
65
+ "experienceversion": {
66
+ "type": "integer"
67
+ },
68
+ "experienceview": {
69
+ "type": "integer"
70
+ },
71
+ "file": {
72
+ "type": "integer"
73
+ },
74
+ "flow": {
75
+ "type": "integer"
76
+ },
77
+ "integration": {
78
+ "type": "integer"
79
+ },
80
+ "notebook": {
81
+ "type": "integer"
82
+ },
83
+ "webhook": {
84
+ "type": "integer"
85
+ },
86
+ "dataTTL": {
87
+ "type": "integer"
88
+ },
89
+ "member": {
90
+ "type": "integer"
91
+ },
92
+ "payload": {
93
+ "type": "integer"
94
+ },
95
+ "storage": {
96
+ "type": "integer"
97
+ },
98
+ "notebookMinutesPerRun": {
99
+ "type": "integer"
100
+ },
101
+ "notebookMinutesPerMonth": {
102
+ "type": "integer"
103
+ },
104
+ "notebookInParallel": {
105
+ "type": "integer"
106
+ },
107
+ "experienceFlowSlots": {
108
+ "type": "integer"
109
+ },
110
+ "applicationFlowSlots": {
111
+ "type": "integer"
112
+ }
98
113
  },
99
- "notebookInParallel": {
100
- "type": "number"
101
- }
114
+ "additionalProperties": false
102
115
  },
103
116
  "whitelistedEmailDomains": {
104
117
  "type": "array",
data/schemas/instanceOrgMember.json CHANGED
@@ -2,6 +2,14 @@
2
2
  "$schema": "http://json-schema.org/draft-04/schema#",
3
3
  "type": "object",
4
4
  "properties": {
5
+ "instanceId": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "orgId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
5
13
  "userId": {
6
14
  "type": "string",
7
15
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -31,6 +39,12 @@
31
39
  "avatarUrl": {
32
40
  "type": "string",
33
41
  "format": "url"
42
+ },
43
+ "twoFactorAuthEnabled": {
44
+ "type": "boolean"
45
+ },
46
+ "ssoLinked": {
47
+ "type": "boolean"
34
48
  }
35
49
  },
36
50
  "additionalProperties": false
data/schemas/instanceOrgMembers.json CHANGED
@@ -8,6 +8,14 @@
8
8
  "$ref": "#/definitions/instanceOrgMembers"
9
9
  }
10
10
  },
11
+ "instanceId": {
12
+ "type": "string",
13
+ "pattern": "^[A-Fa-f\\d]{24}$"
14
+ },
15
+ "orgId": {
16
+ "type": "string",
17
+ "pattern": "^[A-Fa-f\\d]{24}$"
18
+ },
11
19
  "count": {
12
20
  "type": "integer"
13
21
  },