losant_rest 1.14.0 → 1.15.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (171) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/docs/_schemas.md +10590 -3153
  4. data/docs/devices.md +40 -0
  5. data/docs/embeddedDeployment.md +49 -0
  6. data/docs/embeddedDeployments.md +215 -0
  7. data/docs/flow.md +2 -2
  8. data/docs/flows.md +2 -2
  9. data/docs/instance.md +4 -2
  10. data/lib/losant_rest/application.rb +1 -1
  11. data/lib/losant_rest/application_api_token.rb +1 -1
  12. data/lib/losant_rest/application_api_tokens.rb +1 -1
  13. data/lib/losant_rest/application_certificate.rb +1 -1
  14. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  15. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  16. data/lib/losant_rest/application_certificates.rb +1 -1
  17. data/lib/losant_rest/application_dashboard.rb +1 -1
  18. data/lib/losant_rest/application_dashboards.rb +1 -1
  19. data/lib/losant_rest/application_key.rb +1 -1
  20. data/lib/losant_rest/application_keys.rb +1 -1
  21. data/lib/losant_rest/application_template.rb +1 -1
  22. data/lib/losant_rest/application_templates.rb +1 -1
  23. data/lib/losant_rest/applications.rb +1 -1
  24. data/lib/losant_rest/audit_log.rb +1 -1
  25. data/lib/losant_rest/audit_logs.rb +1 -1
  26. data/lib/losant_rest/auth.rb +1 -1
  27. data/lib/losant_rest/client.rb +11 -3
  28. data/lib/losant_rest/dashboard.rb +1 -1
  29. data/lib/losant_rest/dashboards.rb +1 -1
  30. data/lib/losant_rest/data.rb +1 -1
  31. data/lib/losant_rest/data_table.rb +1 -1
  32. data/lib/losant_rest/data_table_row.rb +1 -1
  33. data/lib/losant_rest/data_table_rows.rb +1 -1
  34. data/lib/losant_rest/data_tables.rb +1 -1
  35. data/lib/losant_rest/device.rb +1 -1
  36. data/lib/losant_rest/device_recipe.rb +1 -1
  37. data/lib/losant_rest/device_recipes.rb +1 -1
  38. data/lib/losant_rest/devices.rb +50 -1
  39. data/lib/losant_rest/edge_deployment.rb +1 -1
  40. data/lib/losant_rest/edge_deployments.rb +1 -1
  41. data/lib/losant_rest/embedded_deployment.rb +81 -0
  42. data/lib/losant_rest/embedded_deployments.rb +280 -0
  43. data/lib/losant_rest/error.rb +1 -1
  44. data/lib/losant_rest/event.rb +1 -1
  45. data/lib/losant_rest/events.rb +1 -1
  46. data/lib/losant_rest/experience.rb +1 -1
  47. data/lib/losant_rest/experience_domain.rb +1 -1
  48. data/lib/losant_rest/experience_domains.rb +1 -1
  49. data/lib/losant_rest/experience_endpoint.rb +1 -1
  50. data/lib/losant_rest/experience_endpoints.rb +1 -1
  51. data/lib/losant_rest/experience_group.rb +1 -1
  52. data/lib/losant_rest/experience_groups.rb +1 -1
  53. data/lib/losant_rest/experience_slug.rb +1 -1
  54. data/lib/losant_rest/experience_slugs.rb +1 -1
  55. data/lib/losant_rest/experience_user.rb +1 -1
  56. data/lib/losant_rest/experience_users.rb +1 -1
  57. data/lib/losant_rest/experience_version.rb +1 -1
  58. data/lib/losant_rest/experience_versions.rb +1 -1
  59. data/lib/losant_rest/experience_view.rb +1 -1
  60. data/lib/losant_rest/experience_views.rb +1 -1
  61. data/lib/losant_rest/file.rb +1 -1
  62. data/lib/losant_rest/files.rb +1 -1
  63. data/lib/losant_rest/flow.rb +3 -3
  64. data/lib/losant_rest/flow_version.rb +1 -1
  65. data/lib/losant_rest/flow_versions.rb +1 -1
  66. data/lib/losant_rest/flows.rb +3 -3
  67. data/lib/losant_rest/instance.rb +2 -1
  68. data/lib/losant_rest/instance_api_token.rb +1 -1
  69. data/lib/losant_rest/instance_api_tokens.rb +1 -1
  70. data/lib/losant_rest/instance_member.rb +1 -1
  71. data/lib/losant_rest/instance_members.rb +1 -1
  72. data/lib/losant_rest/instance_org.rb +1 -1
  73. data/lib/losant_rest/instance_org_invite.rb +1 -1
  74. data/lib/losant_rest/instance_org_invites.rb +1 -1
  75. data/lib/losant_rest/instance_org_member.rb +1 -1
  76. data/lib/losant_rest/instance_org_members.rb +1 -1
  77. data/lib/losant_rest/instance_orgs.rb +1 -1
  78. data/lib/losant_rest/instances.rb +1 -1
  79. data/lib/losant_rest/integration.rb +1 -1
  80. data/lib/losant_rest/integrations.rb +1 -1
  81. data/lib/losant_rest/me.rb +1 -1
  82. data/lib/losant_rest/notebook.rb +1 -1
  83. data/lib/losant_rest/notebooks.rb +1 -1
  84. data/lib/losant_rest/org.rb +1 -1
  85. data/lib/losant_rest/org_invites.rb +1 -1
  86. data/lib/losant_rest/orgs.rb +1 -1
  87. data/lib/losant_rest/user_api_token.rb +1 -1
  88. data/lib/losant_rest/user_api_tokens.rb +1 -1
  89. data/lib/losant_rest/utils.rb +1 -1
  90. data/lib/losant_rest/version.rb +2 -2
  91. data/lib/losant_rest/webhook.rb +1 -1
  92. data/lib/losant_rest/webhooks.rb +1 -1
  93. data/lib/losant_rest.rb +3 -1
  94. data/schemas/apiTokenPost.json +9 -0
  95. data/schemas/application.json +32 -32
  96. data/schemas/applicationCreationByTemplateResult.json +32 -32
  97. data/schemas/applicationDashboardPost.json +8 -5
  98. data/schemas/applicationPatch.json +13 -13
  99. data/schemas/applicationPost.json +13 -13
  100. data/schemas/applicationTemplate.json +16 -16
  101. data/schemas/applicationTemplates.json +16 -16
  102. data/schemas/applications.json +32 -32
  103. data/schemas/authedDevice.json +2 -1
  104. data/schemas/dashboard.json +8 -5
  105. data/schemas/dashboardPatch.json +8 -5
  106. data/schemas/dashboardPost.json +8 -5
  107. data/schemas/dashboardSendReport.json +6 -6
  108. data/schemas/dashboards.json +8 -5
  109. data/schemas/dataTableRowsDelete.json +1 -1
  110. data/schemas/device.json +2 -1
  111. data/schemas/deviceClassFilter.json +4 -2
  112. data/schemas/deviceNamesResponse.json +36 -0
  113. data/schemas/devicePatch.json +2 -1
  114. data/schemas/devicePost.json +2 -1
  115. data/schemas/deviceRecipe.json +2 -1
  116. data/schemas/deviceRecipePatch.json +2 -1
  117. data/schemas/deviceRecipePost.json +2 -1
  118. data/schemas/deviceRecipes.json +2 -1
  119. data/schemas/devices.json +4 -2
  120. data/schemas/devicesPatch.json +4 -2
  121. data/schemas/edgeDeployment.json +4 -0
  122. data/schemas/edgeDeployments.json +4 -0
  123. data/schemas/embeddedDeployment.json +179 -0
  124. data/schemas/embeddedDeploymentExport.json +44 -0
  125. data/schemas/embeddedDeploymentRelease.json +58 -0
  126. data/schemas/embeddedDeploymentRemove.json +25 -0
  127. data/schemas/embeddedDeploymentReplace.json +29 -0
  128. data/schemas/embeddedDeployments.json +212 -0
  129. data/schemas/eventsDeleted.json +1 -1
  130. data/schemas/eventsExport.json +4 -0
  131. data/schemas/experienceEndpoint.json +6 -8
  132. data/schemas/experienceEndpointPatch.json +6 -8
  133. data/schemas/experienceEndpointPost.json +6 -8
  134. data/schemas/experienceEndpoints.json +6 -8
  135. data/schemas/experienceLinkedResources.json +1292 -167
  136. data/schemas/flow.json +391 -15
  137. data/schemas/flowPatch.json +390 -15
  138. data/schemas/flowPost.json +391 -15
  139. data/schemas/flowVersion.json +821 -71
  140. data/schemas/flowVersionPost.json +390 -15
  141. data/schemas/flowVersions.json +821 -71
  142. data/schemas/flows.json +392 -15
  143. data/schemas/flowsImportPost.json +821 -70
  144. data/schemas/flowsImportResult.json +1392 -266
  145. data/schemas/githubLogin.json +9 -0
  146. data/schemas/historicalSummary.json +87 -74
  147. data/schemas/instance.json +92 -79
  148. data/schemas/instanceMember.json +6 -1
  149. data/schemas/instanceMembers.json +6 -1
  150. data/schemas/instanceOrg.json +87 -74
  151. data/schemas/instanceOrgMember.json +6 -1
  152. data/schemas/instanceOrgPatch.json +64 -26
  153. data/schemas/instanceOrgPost.json +65 -27
  154. data/schemas/instanceOrgs.json +87 -74
  155. data/schemas/instancePatch.json +2 -2
  156. data/schemas/integration.json +1 -1
  157. data/schemas/integrationPatch.json +1 -1
  158. data/schemas/integrationPost.json +1 -1
  159. data/schemas/integrations.json +1 -1
  160. data/schemas/me.json +104 -92
  161. data/schemas/mePatch.json +0 -1
  162. data/schemas/notebook.json +2 -1
  163. data/schemas/notebookExecutionLogs.json +2 -1
  164. data/schemas/notebookPatch.json +2 -1
  165. data/schemas/notebookPost.json +2 -1
  166. data/schemas/notebooks.json +2 -1
  167. data/schemas/org.json +115 -97
  168. data/schemas/orgs.json +115 -97
  169. data/schemas/userCredentials.json +9 -0
  170. data/schemas/userPost.json +9 -1
  171. metadata +17 -6
data/docs/devices.md CHANGED
@@ -8,6 +8,7 @@ parameters and the potential responses.
8
8
 
9
9
  * [Attribute Names](#attribute-names)
10
10
  * [Delete](#delete)
11
+ * [Device Names](#device-names)
11
12
  * [Export](#export)
12
13
  * [Get](#get)
13
14
  * [Patch](#patch)
@@ -101,6 +102,45 @@ all.Application, all.Organization, all.User, devices.*, or devices.delete.
101
102
 
102
103
  <br/>
103
104
 
105
+ ## Device Names
106
+
107
+ Gets the device names that match the given query. Maximum 1K returned.
108
+
109
+ ```ruby
110
+ result = client.devices.device_names(applicationId: my_application_id)
111
+
112
+ puts result
113
+ ```
114
+
115
+ #### Authentication
116
+ The client must be configured with a valid api access token to call this
117
+ action. The token must include at least one of the following scopes:
118
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.deviceNames.
119
+
120
+ #### Available Parameters
121
+
122
+ | Name | Type | Required | Description | Default | Example |
123
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
124
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
125
+ | query | [Advanced Device Query](_schemas.md#advanced-device-query) | N | Device filter JSON object | | [Advanced Device Query Example](_schemas.md#advanced-device-query-example) |
126
+ | startsWith | string | N | Filter devices down to those that have names starting with the given string. Case insensitive. | | temper |
127
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
128
+
129
+ #### Successful Responses
130
+
131
+ | Code | Type | Description |
132
+ | ---- | ---- | ----------- |
133
+ | 200 | [Device Names Response](_schemas.md#device-names-response) | The matching device names |
134
+
135
+ #### Error Responses
136
+
137
+ | Code | Type | Description |
138
+ | ---- | ---- | ----------- |
139
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
140
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
141
+
142
+ <br/>
143
+
104
144
  ## Export
105
145
 
106
146
  Creates an export of all device metadata
@@ -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
@@ -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
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -27,7 +27,7 @@ module LosantRest
27
27
  #
28
28
  # User API for accessing Losant data
29
29
  #
30
- # Built For Version 1.21.0
30
+ # Built For Version 1.22.2
31
31
  class Client
32
32
  attr_accessor :auth_token, :url
33
33
 
@@ -156,6 +156,14 @@ module LosantRest
156
156
  @edge_deployments ||= EdgeDeployments.new(self)
157
157
  end
158
158
 
159
+ def embedded_deployment
160
+ @embedded_deployment ||= EmbeddedDeployment.new(self)
161
+ end
162
+
163
+ def embedded_deployments
164
+ @embedded_deployments ||= EmbeddedDeployments.new(self)
165
+ end
166
+
159
167
  def event
160
168
  @event ||= Event.new(self)
161
169
  end
@@ -350,7 +358,7 @@ module LosantRest
350
358
 
351
359
  headers["Accept"] = "application/json"
352
360
  headers["Content-Type"] = "application/json"
353
- headers["Accept-Version"] = "^1.21.0"
361
+ headers["Accept-Version"] = "^1.22.2"
354
362
  headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
355
363
  path = self.url + options.fetch(:path, "")
356
364
 
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal