losant_rest 1.13.1 → 1.15.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +10817 -3660
  3. data/docs/application.md +1 -1
  4. data/docs/device.md +43 -0
  5. data/docs/devices.md +39 -0
  6. data/docs/edgeDeployment.md +49 -0
  7. data/docs/embeddedDeployment.md +49 -0
  8. data/docs/embeddedDeployments.md +215 -0
  9. data/docs/flow.md +3 -3
  10. data/docs/flows.md +2 -2
  11. data/docs/instance.md +4 -2
  12. data/docs/instanceOrg.md +2 -0
  13. data/docs/instanceOrgInvite.md +139 -0
  14. data/docs/instanceOrgInvites.md +96 -0
  15. data/docs/instanceOrgMembers.md +2 -2
  16. data/docs/instanceOrgs.md +1 -1
  17. data/docs/me.md +1 -1
  18. data/docs/org.md +1 -1
  19. data/lib/losant_rest/client.rb +22 -2
  20. data/lib/losant_rest/device.rb +50 -0
  21. data/lib/losant_rest/devices.rb +46 -0
  22. data/lib/losant_rest/edge_deployment.rb +81 -0
  23. data/lib/losant_rest/embedded_deployment.rb +81 -0
  24. data/lib/losant_rest/embedded_deployments.rb +280 -0
  25. data/lib/losant_rest/flow.rb +3 -3
  26. data/lib/losant_rest/flows.rb +2 -2
  27. data/lib/losant_rest/instance.rb +1 -0
  28. data/lib/losant_rest/instance_org.rb +4 -0
  29. data/lib/losant_rest/instance_org_invite.rb +182 -0
  30. data/lib/losant_rest/instance_org_invites.rb +138 -0
  31. data/lib/losant_rest/instance_org_members.rb +2 -2
  32. data/lib/losant_rest/instance_orgs.rb +2 -2
  33. data/lib/losant_rest/version.rb +1 -1
  34. data/lib/losant_rest.rb +5 -0
  35. data/schemas/apiTokenPost.json +19 -0
  36. data/schemas/application.json +32 -32
  37. data/schemas/applicationCreationByTemplateResult.json +32 -32
  38. data/schemas/applicationDashboardPost.json +8 -5
  39. data/schemas/applicationPatch.json +13 -13
  40. data/schemas/applicationPost.json +13 -13
  41. data/schemas/applicationTemplate.json +16 -16
  42. data/schemas/applicationTemplates.json +16 -16
  43. data/schemas/applications.json +32 -32
  44. data/schemas/authedDevice.json +2 -1
  45. data/schemas/dashboard.json +8 -5
  46. data/schemas/dashboardPatch.json +8 -5
  47. data/schemas/dashboardPost.json +8 -5
  48. data/schemas/dashboardSendReport.json +6 -6
  49. data/schemas/dashboards.json +8 -5
  50. data/schemas/dataTableRowsDelete.json +1 -1
  51. data/schemas/device.json +2 -1
  52. data/schemas/deviceClassFilter.json +4 -2
  53. data/schemas/devicePatch.json +2 -1
  54. data/schemas/devicePayloadCounts.json +24 -0
  55. data/schemas/devicePost.json +2 -1
  56. data/schemas/deviceRecipe.json +2 -1
  57. data/schemas/deviceRecipePatch.json +2 -1
  58. data/schemas/deviceRecipePost.json +2 -1
  59. data/schemas/deviceRecipes.json +2 -1
  60. data/schemas/devices.json +4 -2
  61. data/schemas/devicesExportPayloadCountPost.json +1350 -0
  62. data/schemas/devicesPatch.json +4 -2
  63. data/schemas/edgeDeployment.json +20 -0
  64. data/schemas/edgeDeployments.json +20 -0
  65. data/schemas/embeddedDeployment.json +179 -0
  66. data/schemas/embeddedDeploymentExport.json +44 -0
  67. data/schemas/embeddedDeploymentRelease.json +58 -0
  68. data/schemas/embeddedDeploymentRemove.json +25 -0
  69. data/schemas/embeddedDeploymentReplace.json +29 -0
  70. data/schemas/embeddedDeployments.json +212 -0
  71. data/schemas/eventsDeleted.json +1 -1
  72. data/schemas/eventsExport.json +4 -0
  73. data/schemas/experienceEndpoint.json +6 -8
  74. data/schemas/experienceEndpointPatch.json +6 -8
  75. data/schemas/experienceEndpointPost.json +6 -8
  76. data/schemas/experienceEndpoints.json +6 -8
  77. data/schemas/experienceLinkedResources.json +790 -85
  78. data/schemas/flow.json +252 -16
  79. data/schemas/flowPatch.json +251 -16
  80. data/schemas/flowPost.json +252 -16
  81. data/schemas/flowVersion.json +503 -33
  82. data/schemas/flowVersionPost.json +251 -16
  83. data/schemas/flowVersions.json +503 -33
  84. data/schemas/flows.json +253 -16
  85. data/schemas/flowsImportPost.json +503 -32
  86. data/schemas/flowsImportResult.json +785 -79
  87. data/schemas/githubLogin.json +19 -0
  88. data/schemas/historicalSummary.json +147 -102
  89. data/schemas/instance.json +92 -79
  90. data/schemas/instanceMember.json +10 -0
  91. data/schemas/instanceMemberPost.json +18 -3
  92. data/schemas/instanceMembers.json +14 -0
  93. data/schemas/instanceOrg.json +87 -74
  94. data/schemas/instanceOrgMember.json +14 -0
  95. data/schemas/instanceOrgMembers.json +8 -0
  96. data/schemas/instanceOrgPatch.json +64 -26
  97. data/schemas/instanceOrgPost.json +65 -27
  98. data/schemas/instanceOrgs.json +91 -74
  99. data/schemas/instancePatch.json +2 -2
  100. data/schemas/me.json +134 -105
  101. data/schemas/notebook.json +32 -1
  102. data/schemas/notebookExecutionLogs.json +2 -1
  103. data/schemas/notebookPatch.json +32 -1
  104. data/schemas/notebookPost.json +32 -1
  105. data/schemas/notebooks.json +32 -1
  106. data/schemas/org.json +145 -110
  107. data/schemas/orgInvite.json +90 -0
  108. data/schemas/orgInviteCollection.json +130 -0
  109. data/schemas/orgInvites.json +82 -77
  110. data/schemas/orgRoleInfo.json +69 -0
  111. data/schemas/orgs.json +145 -110
  112. data/schemas/payloadStats.json +28 -12
  113. data/schemas/userCredentials.json +19 -0
  114. data/schemas/userPost.json +19 -0
  115. data/schemas/virtualButtonPress.json +4 -0
  116. metadata +27 -6
data/docs/application.md CHANGED
@@ -568,7 +568,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
568
568
 
569
569
  | Code | Type | Description |
570
570
  | ---- | ---- | ----------- |
571
- | 200 | [Payload Counts](_schemas.md#payload-counts) | Payload counts, by type and source |
571
+ | 200 | [Payload Stats](_schemas.md#payload-stats) | Payload counts, by type and source |
572
572
 
573
573
  #### Error Responses
574
574
 
data/docs/device.md CHANGED
@@ -14,6 +14,7 @@ parameters and the potential responses.
14
14
  * [Get Log Entries](#get-log-entries)
15
15
  * [Get State](#get-state)
16
16
  * [Patch](#patch)
17
+ * [Payload Counts](#payload-counts)
17
18
  * [Remove Data](#remove-data)
18
19
  * [Send Command](#send-command)
19
20
  * [Send State](#send-state)
@@ -361,6 +362,48 @@ all.Application, all.Organization, all.User, device.*, or device.patch.
361
362
 
362
363
  <br/>
363
364
 
365
+ ## Payload Counts
366
+
367
+ Returns payload counts for the time range specified for this device
368
+
369
+ ```ruby
370
+ result = client.device.payload_counts(
371
+ applicationId: my_application_id,
372
+ deviceId: my_device_id)
373
+
374
+ puts result
375
+ ```
376
+
377
+ #### Authentication
378
+ The client must be configured with a valid api access token to call this
379
+ action. The token must include at least one of the following scopes:
380
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.payloadCounts.
381
+
382
+ #### Available Parameters
383
+
384
+ | Name | Type | Required | Description | Default | Example |
385
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
386
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
387
+ | deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
388
+ | start | string | N | Start of range for payload count query (ms since epoch) | -2592000000 | 0 |
389
+ | end | string | N | End of range for payload count query (ms since epoch) | 0 | 1465790400000 |
390
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
391
+
392
+ #### Successful Responses
393
+
394
+ | Code | Type | Description |
395
+ | ---- | ---- | ----------- |
396
+ | 200 | [Device Payload Counts](_schemas.md#device-payload-counts) | Payload counts, by type |
397
+
398
+ #### Error Responses
399
+
400
+ | Code | Type | Description |
401
+ | ---- | ---- | ----------- |
402
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
403
+ | 404 | [Error](_schemas.md#error) | Error if device was not found |
404
+
405
+ <br/>
406
+
364
407
  ## Remove Data
365
408
 
366
409
  Removes all device data for the specified time range. Defaults to all data.
data/docs/devices.md CHANGED
@@ -11,6 +11,7 @@ parameters and the potential responses.
11
11
  * [Export](#export)
12
12
  * [Get](#get)
13
13
  * [Patch](#patch)
14
+ * [Payload Counts](#payload-counts)
14
15
  * [Post](#post)
15
16
  * [Remove Data](#remove-data)
16
17
  * [Send Command](#send-command)
@@ -229,6 +230,44 @@ all.Application, all.Organization, all.User, devices.*, or devices.patch.
229
230
 
230
231
  <br/>
231
232
 
233
+ ## Payload Counts
234
+
235
+ Creates an export of payload count information for the matching devices
236
+
237
+ ```ruby
238
+ result = client.devices.payload_counts(applicationId: my_application_id)
239
+
240
+ puts result
241
+ ```
242
+
243
+ #### Authentication
244
+ The client must be configured with a valid api access token to call this
245
+ action. The token must include at least one of the following scopes:
246
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.payloadCounts.
247
+
248
+ #### Available Parameters
249
+
250
+ | Name | Type | Required | Description | Default | Example |
251
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
252
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
253
+ | options | [Devices Payload Count Export Post](_schemas.md#devices-payload-count-export-post) | N | Object containing export configuration | | [Devices Payload Count Export Post Example](_schemas.md#devices-payload-count-export-post-example) |
254
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
255
+
256
+ #### Successful Responses
257
+
258
+ | Code | Type | Description |
259
+ | ---- | ---- | ----------- |
260
+ | 200 | [Success](_schemas.md#success) | If generation of export was successfully started |
261
+
262
+ #### Error Responses
263
+
264
+ | Code | Type | Description |
265
+ | ---- | ---- | ----------- |
266
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
267
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
268
+
269
+ <br/>
270
+
232
271
  ## Post
233
272
 
234
273
  Create a new device for an application
@@ -0,0 +1,49 @@
1
+ # Edge Deployment Actions
2
+
3
+ Details on the various actions that can be performed on the
4
+ Edge Deployment resource, including the expected
5
+ parameters and the potential responses.
6
+
7
+ ##### Contents
8
+
9
+ * [Get](#get)
10
+
11
+ <br/>
12
+
13
+ ## Get
14
+
15
+ Retrieves information on an edge deployment
16
+
17
+ ```ruby
18
+ result = client.edge_deployment.get(
19
+ applicationId: my_application_id,
20
+ edgeDeploymentId: my_edge_deployment_id)
21
+
22
+ puts result
23
+ ```
24
+
25
+ #### Authentication
26
+ The client must be configured with a valid api access token to call this
27
+ action. The token must include at least one of the following scopes:
28
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, edgeDeployment.*, or edgeDeployment.get.
29
+
30
+ #### Available Parameters
31
+
32
+ | Name | Type | Required | Description | Default | Example |
33
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
34
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
35
+ | edgeDeploymentId | string | Y | ID associated with the edge deployment | | 575ed78e7ae143cd83dc4aab |
36
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
37
+
38
+ #### Successful Responses
39
+
40
+ | Code | Type | Description |
41
+ | ---- | ---- | ----------- |
42
+ | 200 | [Edge Deployment](_schemas.md#edge-deployment) | Edge deployment information |
43
+
44
+ #### Error Responses
45
+
46
+ | Code | Type | Description |
47
+ | ---- | ---- | ----------- |
48
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
49
+ | 404 | [Error](_schemas.md#error) | Error if edge deployment was not found |
@@ -0,0 +1,49 @@
1
+ # Embedded Deployment Actions
2
+
3
+ Details on the various actions that can be performed on the
4
+ Embedded Deployment resource, including the expected
5
+ parameters and the potential responses.
6
+
7
+ ##### Contents
8
+
9
+ * [Get](#get)
10
+
11
+ <br/>
12
+
13
+ ## Get
14
+
15
+ Retrieves information on an embedded deployment
16
+
17
+ ```ruby
18
+ result = client.embedded_deployment.get(
19
+ applicationId: my_application_id,
20
+ embeddedDeploymentId: my_embedded_deployment_id)
21
+
22
+ puts result
23
+ ```
24
+
25
+ #### Authentication
26
+ The client must be configured with a valid api access token to call this
27
+ action. The token must include at least one of the following scopes:
28
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, embeddedDeployment.*, or embeddedDeployment.get.
29
+
30
+ #### Available Parameters
31
+
32
+ | Name | Type | Required | Description | Default | Example |
33
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
34
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
35
+ | embeddedDeploymentId | string | Y | ID associated with the embedded deployment | | 575ed78e7ae143cd83dc4aab |
36
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
37
+
38
+ #### Successful Responses
39
+
40
+ | Code | Type | Description |
41
+ | ---- | ---- | ----------- |
42
+ | 200 | [Embedded Deployment](_schemas.md#embedded-deployment) | Embedded deployment information |
43
+
44
+ #### Error Responses
45
+
46
+ | Code | Type | Description |
47
+ | ---- | ---- | ----------- |
48
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
49
+ | 404 | [Error](_schemas.md#error) | Error if embedded deployment was not found |
@@ -0,0 +1,215 @@
1
+ # Embedded Deployments Actions
2
+
3
+ Details on the various actions that can be performed on the
4
+ Embedded Deployments resource, including the expected
5
+ parameters and the potential responses.
6
+
7
+ ##### Contents
8
+
9
+ * [Export](#export)
10
+ * [Get](#get)
11
+ * [Release](#release)
12
+ * [Remove](#remove)
13
+ * [Replace](#replace)
14
+
15
+ <br/>
16
+
17
+ ## Export
18
+
19
+ Request an export of the compiled WASM files for a current deployment
20
+
21
+ ```ruby
22
+ result = client.embedded_deployments.export(applicationId: my_application_id)
23
+
24
+ puts result
25
+ ```
26
+
27
+ #### Authentication
28
+ The client must be configured with a valid api access token to call this
29
+ action. The token must include at least one of the following scopes:
30
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, embeddedDeployments.*, or embeddedDeployments.export.
31
+
32
+ #### Available Parameters
33
+
34
+ | Name | Type | Required | Description | Default | Example |
35
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
36
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
37
+ | options | [Embedded Deployment Export](_schemas.md#embedded-deployment-export) | N | Export options for embedded deployment | | [Embedded Deployment Export Example](_schemas.md#embedded-deployment-export-example) |
38
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
39
+
40
+ #### Successful Responses
41
+
42
+ | Code | Type | Description |
43
+ | ---- | ---- | ----------- |
44
+ | 200 | [Success](_schemas.md#success) | If generation of export was successfully started |
45
+
46
+ #### Error Responses
47
+
48
+ | Code | Type | Description |
49
+ | ---- | ---- | ----------- |
50
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
51
+ | 404 | [Error](_schemas.md#error) | Error if deployment was not found |
52
+
53
+ <br/>
54
+
55
+ ## Get
56
+
57
+ Returns the embedded deployments for an application
58
+
59
+ ```ruby
60
+ result = client.embedded_deployments.get(applicationId: my_application_id)
61
+
62
+ puts result
63
+ ```
64
+
65
+ #### Authentication
66
+ The client must be configured with a valid api access token to call this
67
+ action. The token must include at least one of the following scopes:
68
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, embeddedDeployments.*, or embeddedDeployments.get.
69
+
70
+ #### Available Parameters
71
+
72
+ | Name | Type | Required | Description | Default | Example |
73
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
74
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
75
+ | sortField | string | N | Field to sort the results by. Accepted values are: id, creationDate, lastUpdated | lastUpdated | creationDate |
76
+ | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | asc |
77
+ | page | string | N | Which page of results to return | 0 | 0 |
78
+ | perPage | string | N | How many items to return per page | 1000 | 10 |
79
+ | deviceId | string | N | Filter deployments to the given Device ID | | 575ecf887ae143cd83dc4aa2 |
80
+ | version | string | N | Filter deployments to the given Workflow Version (matches against both current and desired) | | myFlowVersion |
81
+ | flowId | string | N | Filter deployments to the given Workflow ID | | 575ed18f7ae143cd83dc4aa6 |
82
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
83
+
84
+ #### Successful Responses
85
+
86
+ | Code | Type | Description |
87
+ | ---- | ---- | ----------- |
88
+ | 200 | [Embedded Deployments](_schemas.md#embedded-deployments) | Collection of embedded deployments |
89
+
90
+ #### Error Responses
91
+
92
+ | Code | Type | Description |
93
+ | ---- | ---- | ----------- |
94
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
95
+ | 404 | [Error](_schemas.md#error) | Error if application or device was not found |
96
+
97
+ <br/>
98
+
99
+ ## Release
100
+
101
+ Deploy an embedded workflow version to one or more embedded devices. Version can be blank, if removal is desired.
102
+
103
+ ```ruby
104
+ result = client.embedded_deployments.release(
105
+ applicationId: my_application_id,
106
+ deployment: my_deployment)
107
+
108
+ puts result
109
+ ```
110
+
111
+ #### Authentication
112
+ The client must be configured with a valid api access token to call this
113
+ action. The token must include at least one of the following scopes:
114
+ all.Application, all.Organization, all.User, embeddedDeployments.*, or embeddedDeployments.release.
115
+
116
+ #### Available Parameters
117
+
118
+ | Name | Type | Required | Description | Default | Example |
119
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
120
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
121
+ | deployment | [Embedded Deployment Release](_schemas.md#embedded-deployment-release) | Y | Deployment release information | | [Embedded Deployment Release Example](_schemas.md#embedded-deployment-release-example) |
122
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
123
+
124
+ #### Successful Responses
125
+
126
+ | Code | Type | Description |
127
+ | ---- | ---- | ----------- |
128
+ | 201 | [Success](_schemas.md#success) | If deployment release has been initiated successfully |
129
+
130
+ #### Error Responses
131
+
132
+ | Code | Type | Description |
133
+ | ---- | ---- | ----------- |
134
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
135
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
136
+
137
+ <br/>
138
+
139
+ ## Remove
140
+
141
+ Remove all embedded deployments from a device, remove all embedded deployments of a workflow, or remove a specific workflow from a specific device
142
+
143
+ ```ruby
144
+ result = client.embedded_deployments.remove(
145
+ applicationId: my_application_id,
146
+ deployment: my_deployment)
147
+
148
+ puts result
149
+ ```
150
+
151
+ #### Authentication
152
+ The client must be configured with a valid api access token to call this
153
+ action. The token must include at least one of the following scopes:
154
+ all.Application, all.Organization, all.User, embeddedDeployments.*, or embeddedDeployments.remove.
155
+
156
+ #### Available Parameters
157
+
158
+ | Name | Type | Required | Description | Default | Example |
159
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
160
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
161
+ | deployment | [Embedded Deployment Remove](_schemas.md#embedded-deployment-remove) | Y | Deployment removal information | | [Embedded Deployment Remove Example](_schemas.md#embedded-deployment-remove-example) |
162
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
163
+
164
+ #### Successful Responses
165
+
166
+ | Code | Type | Description |
167
+ | ---- | ---- | ----------- |
168
+ | 201 | [Success](_schemas.md#success) | If deployment removal has been initiated successfully |
169
+
170
+ #### Error Responses
171
+
172
+ | Code | Type | Description |
173
+ | ---- | ---- | ----------- |
174
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
175
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
176
+
177
+ <br/>
178
+
179
+ ## Replace
180
+
181
+ Replace deployments of an embedded workflow version with a new version. New version can be blank, if removal is desired.
182
+
183
+ ```ruby
184
+ result = client.embedded_deployments.replace(
185
+ applicationId: my_application_id,
186
+ deployment: my_deployment)
187
+
188
+ puts result
189
+ ```
190
+
191
+ #### Authentication
192
+ The client must be configured with a valid api access token to call this
193
+ action. The token must include at least one of the following scopes:
194
+ all.Application, all.Organization, all.User, embeddedDeployments.*, or embeddedDeployments.replace.
195
+
196
+ #### Available Parameters
197
+
198
+ | Name | Type | Required | Description | Default | Example |
199
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
200
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
201
+ | deployment | [Embedded Deployment Replace](_schemas.md#embedded-deployment-replace) | Y | Deployment replacement information | | [Embedded Deployment Replace Example](_schemas.md#embedded-deployment-replace-example) |
202
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
203
+
204
+ #### Successful Responses
205
+
206
+ | Code | Type | Description |
207
+ | ---- | ---- | ----------- |
208
+ | 201 | [Success](_schemas.md#success) | If deployment replacement has been initiated successfully |
209
+
210
+ #### Error Responses
211
+
212
+ | Code | Type | Description |
213
+ | ---- | ---- | ----------- |
214
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
215
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
data/docs/flow.md CHANGED
@@ -128,7 +128,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
128
128
  | limit | string | N | Maximum number of errors to return | 25 | 25 |
129
129
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | desc |
130
130
  | flowVersion | string | N | Flow version name or ID. When not included, will be errors for all versions. Pass develop for just the develop version. | | develop |
131
- | deviceId | string | N | For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
131
+ | deviceId | string | N | For edge or embedded workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
132
132
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
133
133
 
134
134
  #### Successful Responses
@@ -284,7 +284,7 @@ puts result
284
284
  #### Authentication
285
285
  The client must be configured with a valid api access token to call this
286
286
  action. The token must include at least one of the following scopes:
287
- all.Application, all.Organization, all.User, flow.*, or flow.getStorageEntriesMetadata.
287
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.getStorageEntriesMetadata.
288
288
 
289
289
  #### Available Parameters
290
290
 
@@ -463,7 +463,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
463
463
  | end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
464
464
  | resolution | string | N | Resolution in milliseconds | 3600000 | 3600000 |
465
465
  | flowVersion | string | N | Flow version name or ID. When not included, will be aggregate for all versions. Pass develop for just the develop version. | | develop |
466
- | deviceId | string | N | For edge workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
466
+ | deviceId | string | N | For edge or embedded workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
467
467
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
468
468
 
469
469
  #### Successful Responses
data/docs/flows.md CHANGED
@@ -39,7 +39,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
39
39
  | perPage | string | N | How many items to return per page | 100 | 10 |
40
40
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
41
41
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*flow |
42
- | flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience | cloud | cloud |
42
+ | flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience | cloud | cloud |
43
43
  | triggerFilter | [Workflow Trigger Filter](_schemas.md#workflow-trigger-filter) | N | Array of triggers to filter by - always filters against default flow version. | | [Workflow Trigger Filter Example](_schemas.md#workflow-trigger-filter-example) |
44
44
  | includeCustomNodes | string | N | If the result of the request should also include the details of any custom nodes referenced by the returned workflows | false | true |
45
45
  | query | [Advanced Workflow Query](_schemas.md#advanced-workflow-query) | N | Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. | | [Advanced Workflow Query Example](_schemas.md#advanced-workflow-query-example) |
@@ -89,7 +89,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
89
89
  | perPage | string | N | How many items to return per page | 100 | 10 |
90
90
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
91
91
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*flow |
92
- | flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience | cloud | cloud |
92
+ | flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience | cloud | cloud |
93
93
  | version | string | Y | Return the workflow versions for the given version. | | myVersion |
94
94
  | triggerFilter | [Workflow Trigger Filter](_schemas.md#workflow-trigger-filter) | N | Array of triggers to filter by - always filters against default flow version. | | [Workflow Trigger Filter Example](_schemas.md#workflow-trigger-filter-example) |
95
95
  | includeCustomNodes | string | N | If the result of the request should also include the details of any custom nodes referenced by the returned workflows | false | true |
data/docs/instance.md CHANGED
@@ -135,7 +135,9 @@ all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instanc
135
135
  Updates information about an instance
136
136
 
137
137
  ```ruby
138
- result = client.instance.patch(instanceId: my_instance_id)
138
+ result = client.instance.patch(
139
+ instanceId: my_instance_id,
140
+ instance: my_instance)
139
141
 
140
142
  puts result
141
143
  ```
@@ -150,7 +152,7 @@ all.Instance, all.User, instance.*, or instance.patch.
150
152
  | Name | Type | Required | Description | Default | Example |
151
153
  | ---- | ---- | -------- | ----------- | ------- | ------- |
152
154
  | instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
153
- | instance | [Instance Patch](_schemas.md#instance-patch) | N | Updated instance information | | [Instance Patch Example](_schemas.md#instance-patch-example) |
155
+ | instance | [Instance Patch](_schemas.md#instance-patch) | Y | Updated instance information | | [Instance Patch Example](_schemas.md#instance-patch-example) |
154
156
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
155
157
 
156
158
  #### Successful Responses
data/docs/instanceOrg.md CHANGED
@@ -75,6 +75,7 @@ all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or inst
75
75
  | ---- | ---- | -------- | ----------- | ------- | ------- |
76
76
  | instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
77
77
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
78
+ | summaryInclude | string | N | Comma-separated list of summary fields to include in org summary | | payloadCount |
78
79
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
79
80
 
80
81
  #### Successful Responses
@@ -116,6 +117,7 @@ all.Instance, all.User, instanceOrg.*, or instanceOrg.patch.
116
117
  | ---- | ---- | -------- | ----------- | ------- | ------- |
117
118
  | instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
118
119
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
120
+ | summaryInclude | string | N | Comma-separated list of summary fields to include in org summary | | payloadCount |
119
121
  | organization | [Instance Owned Organization Patch](_schemas.md#instance-owned-organization-patch) | Y | Object containing new organization properties | | [Instance Owned Organization Patch Example](_schemas.md#instance-owned-organization-patch-example) |
120
122
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
121
123
 
@@ -0,0 +1,139 @@
1
+ # Instance Org Invite Actions
2
+
3
+ Details on the various actions that can be performed on the
4
+ Instance Org Invite resource, including the expected
5
+ parameters and the potential responses.
6
+
7
+ ##### Contents
8
+
9
+ * [Delete](#delete)
10
+ * [Get](#get)
11
+ * [Resend Invite](#resend-invite)
12
+
13
+ <br/>
14
+
15
+ ## Delete
16
+
17
+ Revokes an instance org invitation
18
+
19
+ ```ruby
20
+ result = client.instance_org_invite.delete(
21
+ instanceId: my_instance_id,
22
+ orgId: my_org_id,
23
+ inviteId: my_invite_id)
24
+
25
+ puts result
26
+ ```
27
+
28
+ #### Authentication
29
+ The client must be configured with a valid api access token to call this
30
+ action. The token must include at least one of the following scopes:
31
+ all.Instance, all.User, instanceOrgInvite.*, or instanceOrgInvite.delete.
32
+
33
+ #### Available Parameters
34
+
35
+ | Name | Type | Required | Description | Default | Example |
36
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
37
+ | instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a95 |
38
+ | orgId | string | Y | ID associated with the organization | | 575ec8687ae143cd83dc4a97 |
39
+ | inviteId | string | Y | ID associated with the organization invite | | 575ec8687ae143cd83dc4a94 |
40
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
41
+
42
+ #### Successful Responses
43
+
44
+ | Code | Type | Description |
45
+ | ---- | ---- | ----------- |
46
+ | 200 | [Success](_schemas.md#success) | If an invite was successfully deleted |
47
+
48
+ #### Error Responses
49
+
50
+ | Code | Type | Description |
51
+ | ---- | ---- | ----------- |
52
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
53
+ | 404 | [Error](_schemas.md#error) | Error if instance, organization or invite was not found |
54
+
55
+ <br/>
56
+
57
+ ## Get
58
+
59
+ Returns an organization invite
60
+
61
+ ```ruby
62
+ result = client.instance_org_invite.get(
63
+ instanceId: my_instance_id,
64
+ orgId: my_org_id,
65
+ inviteId: my_invite_id)
66
+
67
+ puts result
68
+ ```
69
+
70
+ #### Authentication
71
+ The client must be configured with a valid api access token to call this
72
+ action. The token must include at least one of the following scopes:
73
+ all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgInvite.*, or instanceOrgInvite.get.
74
+
75
+ #### Available Parameters
76
+
77
+ | Name | Type | Required | Description | Default | Example |
78
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
79
+ | instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a95 |
80
+ | orgId | string | Y | ID associated with the organization | | 575ec8687ae143cd83dc4a97 |
81
+ | inviteId | string | Y | ID associated with the organization invite | | 575ec8687ae143cd83dc4a94 |
82
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
83
+
84
+ #### Successful Responses
85
+
86
+ | Code | Type | Description |
87
+ | ---- | ---- | ----------- |
88
+ | 200 | [Organization Invitation](_schemas.md#organization-invitation) | A single organization invite |
89
+
90
+ #### Error Responses
91
+
92
+ | Code | Type | Description |
93
+ | ---- | ---- | ----------- |
94
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
95
+ | 404 | [Error](_schemas.md#error) | Error if instance, organization, or invite was not found |
96
+
97
+ <br/>
98
+
99
+ ## Resend Invite
100
+
101
+ Resend an organization invite with modified role info
102
+
103
+ ```ruby
104
+ result = client.instance_org_invite.resend_invite(
105
+ instanceId: my_instance_id,
106
+ orgId: my_org_id,
107
+ inviteId: my_invite_id,
108
+ roleInfo: my_role_info)
109
+
110
+ puts result
111
+ ```
112
+
113
+ #### Authentication
114
+ The client must be configured with a valid api access token to call this
115
+ action. The token must include at least one of the following scopes:
116
+ all.Instance, all.User, instanceOrgInvite.*, or instanceOrgInvite.resendInvite.
117
+
118
+ #### Available Parameters
119
+
120
+ | Name | Type | Required | Description | Default | Example |
121
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
122
+ | instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a95 |
123
+ | orgId | string | Y | ID associated with the organization | | 575ec8687ae143cd83dc4a97 |
124
+ | inviteId | string | Y | ID associated with the organization invite | | 575ec8687ae143cd83dc4a94 |
125
+ | roleInfo | [Organization Role Info](_schemas.md#organization-role-info) | Y | Object containing updated role info | | [Organization Role Info Example](_schemas.md#organization-role-info-example) |
126
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
127
+
128
+ #### Successful Responses
129
+
130
+ | Code | Type | Description |
131
+ | ---- | ---- | ----------- |
132
+ | 201 | [Organization Invitation](_schemas.md#organization-invitation) | The new org invite |
133
+
134
+ #### Error Responses
135
+
136
+ | Code | Type | Description |
137
+ | ---- | ---- | ----------- |
138
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
139
+ | 404 | [Error](_schemas.md#error) | Error if instance, organization, or invite was not found |