losant_rest 1.10.4 → 1.13.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (224) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +2 -2
  4. data/docs/_schemas.md +35272 -19039
  5. data/docs/application.md +45 -4
  6. data/docs/applicationApiTokens.md +2 -2
  7. data/docs/applicationCertificateAuthorities.md +1 -1
  8. data/docs/applicationCertificates.md +1 -1
  9. data/docs/applicationDashboard.md +133 -0
  10. data/docs/applicationDashboards.md +93 -0
  11. data/docs/applicationKeys.md +4 -3
  12. data/docs/applicationTemplates.md +1 -1
  13. data/docs/applications.md +2 -2
  14. data/docs/auditLogs.md +1 -1
  15. data/docs/dashboards.md +1 -1
  16. data/docs/dataTable.md +1 -1
  17. data/docs/dataTableRows.md +1 -1
  18. data/docs/dataTables.md +2 -2
  19. data/docs/deviceRecipes.md +1 -1
  20. data/docs/devices.md +127 -3
  21. data/docs/edgeDeployments.md +1 -1
  22. data/docs/events.md +4 -4
  23. data/docs/experience.md +1 -1
  24. data/docs/experienceDomains.md +1 -1
  25. data/docs/experienceEndpoint.md +1 -0
  26. data/docs/experienceGroup.md +2 -0
  27. data/docs/experienceGroups.md +1 -1
  28. data/docs/experienceSlugs.md +1 -1
  29. data/docs/experienceUsers.md +1 -1
  30. data/docs/experienceVersion.md +3 -3
  31. data/docs/experienceVersions.md +3 -3
  32. data/docs/experienceView.md +4 -4
  33. data/docs/experienceViews.md +3 -3
  34. data/docs/file.md +5 -5
  35. data/docs/files.md +3 -3
  36. data/docs/flow.md +41 -0
  37. data/docs/flowVersions.md +46 -1
  38. data/docs/flows.md +5 -2
  39. data/docs/instance.md +166 -0
  40. data/docs/instanceApiToken.md +133 -0
  41. data/docs/instanceApiTokens.md +91 -0
  42. data/docs/instanceMember.md +133 -0
  43. data/docs/instanceMembers.md +91 -0
  44. data/docs/instanceOrg.md +133 -0
  45. data/docs/instanceOrgMember.md +139 -0
  46. data/docs/instanceOrgMembers.md +96 -0
  47. data/docs/instanceOrgs.md +91 -0
  48. data/docs/instances.md +50 -0
  49. data/docs/integration.md +1 -0
  50. data/docs/integrations.md +1 -1
  51. data/docs/notebooks.md +1 -1
  52. data/docs/orgs.md +1 -1
  53. data/docs/userApiToken.md +125 -0
  54. data/docs/userApiTokens.md +87 -0
  55. data/docs/webhook.md +1 -0
  56. data/docs/webhooks.md +1 -1
  57. data/lib/losant_rest.rb +15 -1
  58. data/lib/losant_rest/application.rb +53 -6
  59. data/lib/losant_rest/application_api_token.rb +1 -1
  60. data/lib/losant_rest/application_api_tokens.rb +2 -2
  61. data/lib/losant_rest/application_certificate.rb +1 -1
  62. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  63. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  64. data/lib/losant_rest/application_certificates.rb +1 -1
  65. data/lib/losant_rest/application_dashboard.rb +176 -0
  66. data/lib/losant_rest/application_dashboards.rb +138 -0
  67. data/lib/losant_rest/application_key.rb +1 -1
  68. data/lib/losant_rest/application_keys.rb +4 -1
  69. data/lib/losant_rest/application_template.rb +1 -1
  70. data/lib/losant_rest/application_templates.rb +1 -1
  71. data/lib/losant_rest/applications.rb +2 -2
  72. data/lib/losant_rest/audit_log.rb +1 -1
  73. data/lib/losant_rest/audit_logs.rb +1 -1
  74. data/lib/losant_rest/auth.rb +1 -1
  75. data/lib/losant_rest/client.rb +59 -3
  76. data/lib/losant_rest/dashboard.rb +1 -1
  77. data/lib/losant_rest/dashboards.rb +1 -1
  78. data/lib/losant_rest/data.rb +1 -1
  79. data/lib/losant_rest/data_table.rb +2 -2
  80. data/lib/losant_rest/data_table_row.rb +1 -1
  81. data/lib/losant_rest/data_table_rows.rb +2 -2
  82. data/lib/losant_rest/data_tables.rb +2 -2
  83. data/lib/losant_rest/device.rb +1 -1
  84. data/lib/losant_rest/device_recipe.rb +1 -1
  85. data/lib/losant_rest/device_recipes.rb +1 -1
  86. data/lib/losant_rest/devices.rb +155 -3
  87. data/lib/losant_rest/edge_deployments.rb +1 -1
  88. data/lib/losant_rest/error.rb +1 -1
  89. data/lib/losant_rest/event.rb +1 -1
  90. data/lib/losant_rest/events.rb +4 -4
  91. data/lib/losant_rest/experience.rb +2 -2
  92. data/lib/losant_rest/experience_domain.rb +1 -1
  93. data/lib/losant_rest/experience_domains.rb +2 -2
  94. data/lib/losant_rest/experience_endpoint.rb +3 -1
  95. data/lib/losant_rest/experience_endpoints.rb +1 -1
  96. data/lib/losant_rest/experience_group.rb +5 -1
  97. data/lib/losant_rest/experience_groups.rb +1 -1
  98. data/lib/losant_rest/experience_slug.rb +1 -1
  99. data/lib/losant_rest/experience_slugs.rb +2 -2
  100. data/lib/losant_rest/experience_user.rb +1 -1
  101. data/lib/losant_rest/experience_users.rb +1 -1
  102. data/lib/losant_rest/experience_version.rb +4 -4
  103. data/lib/losant_rest/experience_versions.rb +3 -3
  104. data/lib/losant_rest/experience_view.rb +5 -5
  105. data/lib/losant_rest/experience_views.rb +3 -3
  106. data/lib/losant_rest/file.rb +5 -5
  107. data/lib/losant_rest/files.rb +3 -3
  108. data/lib/losant_rest/flow.rb +47 -1
  109. data/lib/losant_rest/flow_version.rb +1 -1
  110. data/lib/losant_rest/flow_versions.rb +54 -1
  111. data/lib/losant_rest/flows.rb +9 -1
  112. data/lib/losant_rest/instance.rb +226 -0
  113. data/lib/losant_rest/instance_api_token.rb +176 -0
  114. data/lib/losant_rest/instance_api_tokens.rb +136 -0
  115. data/lib/losant_rest/instance_member.rb +176 -0
  116. data/lib/losant_rest/instance_members.rb +134 -0
  117. data/lib/losant_rest/instance_org.rb +176 -0
  118. data/lib/losant_rest/instance_org_member.rb +182 -0
  119. data/lib/losant_rest/instance_org_members.rb +138 -0
  120. data/lib/losant_rest/instance_orgs.rb +139 -0
  121. data/lib/losant_rest/instances.rb +88 -0
  122. data/lib/losant_rest/integration.rb +3 -1
  123. data/lib/losant_rest/integrations.rb +1 -1
  124. data/lib/losant_rest/me.rb +2 -2
  125. data/lib/losant_rest/notebook.rb +1 -1
  126. data/lib/losant_rest/notebooks.rb +1 -1
  127. data/lib/losant_rest/org.rb +2 -2
  128. data/lib/losant_rest/org_invites.rb +1 -1
  129. data/lib/losant_rest/orgs.rb +1 -1
  130. data/lib/losant_rest/user_api_token.rb +170 -0
  131. data/lib/losant_rest/user_api_tokens.rb +132 -0
  132. data/lib/losant_rest/utils.rb +1 -1
  133. data/lib/losant_rest/version.rb +2 -2
  134. data/lib/losant_rest/webhook.rb +3 -1
  135. data/lib/losant_rest/webhooks.rb +1 -1
  136. data/schemas/advancedApplicationKeyQuery.json +1082 -0
  137. data/schemas/advancedDeviceQuery.json +309 -0
  138. data/schemas/advancedFlowByVersionQuery.json +665 -0
  139. data/schemas/advancedFlowQuery.json +883 -0
  140. data/schemas/advancedFlowVersionQuery.json +925 -0
  141. data/schemas/apiToken.json +2 -1
  142. data/schemas/apiTokenPost.json +420 -0
  143. data/schemas/apiTokens.json +4 -2
  144. data/schemas/applicationApiTokenPost.json +11 -0
  145. data/schemas/applicationDashboardPost.json +5687 -0
  146. data/schemas/applicationGlobalPatch.json +33 -0
  147. data/schemas/attributeNamesResponse.json +14 -0
  148. data/schemas/auditLog.json +4 -0
  149. data/schemas/auditLogFilter.json +4 -0
  150. data/schemas/auditLogs.json +4 -0
  151. data/schemas/authedUser.json +3 -0
  152. data/schemas/bulkDeleteResponse.json +12 -0
  153. data/schemas/changePassword.json +1 -1
  154. data/schemas/dashboard.json +72 -17
  155. data/schemas/dashboardPatch.json +72 -17
  156. data/schemas/dashboardPost.json +72 -17
  157. data/schemas/dashboardSendReport.json +4 -0
  158. data/schemas/dashboards.json +72 -17
  159. data/schemas/deviceAttributeDataTypeFilter.json +29 -0
  160. data/schemas/deviceClassFilter.json +1 -2
  161. data/schemas/devicesDeletePost.json +309 -0
  162. data/schemas/devicesExportPost.json +309 -0
  163. data/schemas/devicesPatch.json +309 -0
  164. data/schemas/devicesRemoveDataPost.json +309 -0
  165. data/schemas/experienceGroup.json +6 -0
  166. data/schemas/experienceGroups.json +6 -0
  167. data/schemas/experienceLinkedResources.json +57 -0
  168. data/schemas/experienceVersion.json +9 -0
  169. data/schemas/experienceVersionPatch.json +9 -0
  170. data/schemas/experienceVersions.json +9 -0
  171. data/schemas/filePost.json +8 -2
  172. data/schemas/files.json +3 -0
  173. data/schemas/flow.json +19 -0
  174. data/schemas/flowPatch.json +19 -0
  175. data/schemas/flowPost.json +19 -0
  176. data/schemas/flowStorageMetadata.json +13 -0
  177. data/schemas/flowVersion.json +38 -0
  178. data/schemas/flowVersionPost.json +19 -0
  179. data/schemas/flowVersions.json +38 -0
  180. data/schemas/flowVersionsDeletePost.json +941 -0
  181. data/schemas/flows.json +19 -0
  182. data/schemas/flowsImportPost.json +38 -0
  183. data/schemas/flowsImportResult.json +57 -0
  184. data/schemas/githubLogin.json +64 -1
  185. data/schemas/historicalSummaries.json +43 -0
  186. data/schemas/historicalSummary.json +458 -0
  187. data/schemas/instance.json +192 -0
  188. data/schemas/instanceMember.json +37 -0
  189. data/schemas/instanceMemberPatch.json +17 -0
  190. data/schemas/instanceMemberPost.json +22 -0
  191. data/schemas/instanceMembers.json +69 -0
  192. data/schemas/instanceOrg.json +133 -0
  193. data/schemas/instanceOrgMember.json +37 -0
  194. data/schemas/instanceOrgMemberPatch.json +69 -0
  195. data/schemas/instanceOrgMemberPost.json +161 -0
  196. data/schemas/instanceOrgMembers.json +34 -0
  197. data/schemas/instanceOrgPatch.json +122 -0
  198. data/schemas/instanceOrgPost.json +291 -0
  199. data/schemas/instanceOrgs.json +174 -0
  200. data/schemas/instancePatch.json +67 -0
  201. data/schemas/instanceReportOptionsPost.json +41 -0
  202. data/schemas/instances.json +43 -0
  203. data/schemas/integration.json +3 -0
  204. data/schemas/integrationPatch.json +3 -0
  205. data/schemas/integrationPost.json +3 -0
  206. data/schemas/integrations.json +3 -0
  207. data/schemas/me.json +3 -0
  208. data/schemas/mePatch.json +1 -1
  209. data/schemas/multiDeviceCommand.json +309 -0
  210. data/schemas/notebook.json +22 -0
  211. data/schemas/notebookExecutionLogs.json +7 -0
  212. data/schemas/notebookPatch.json +7 -0
  213. data/schemas/notebookPost.json +7 -0
  214. data/schemas/notebooks.json +22 -0
  215. data/schemas/orgPatch.json +0 -9
  216. data/schemas/passwordResetFinish.json +1 -1
  217. data/schemas/payloadStats.json +110 -0
  218. data/schemas/tagKeysResponse.json +14 -0
  219. data/schemas/tagValuesResponse.json +19 -0
  220. data/schemas/userCredentials.json +64 -1
  221. data/schemas/userPost.json +65 -2
  222. data/schemas/validateContextError.json +34 -0
  223. data/schemas/validateContextSuccess.json +34 -0
  224. metadata +64 -3
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
34
34
  | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
35
35
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
36
36
  | page | string | N | Which page of results to return | 0 | 0 |
37
- | perPage | string | N | How many items to return per page | 1000 | 10 |
37
+ | perPage | string | N | How many items to return per page | 100 | 10 |
38
38
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my * recipe |
40
40
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
data/docs/devices.md CHANGED
@@ -6,6 +6,7 @@ parameters and the potential responses.
6
6
 
7
7
  ##### Contents
8
8
 
9
+ * [Attribute Names](#attribute-names)
9
10
  * [Delete](#delete)
10
11
  * [Export](#export)
11
12
  * [Get](#get)
@@ -13,6 +14,48 @@ parameters and the potential responses.
13
14
  * [Post](#post)
14
15
  * [Remove Data](#remove-data)
15
16
  * [Send Command](#send-command)
17
+ * [Tag Keys](#tag-keys)
18
+ * [Tag Values](#tag-values)
19
+
20
+ <br/>
21
+
22
+ ## Attribute Names
23
+
24
+ Gets the attribute names that match the given query. Maximum 1K returned.
25
+
26
+ ```ruby
27
+ result = client.devices.attribute_names(applicationId: my_application_id)
28
+
29
+ puts result
30
+ ```
31
+
32
+ #### Authentication
33
+ The client must be configured with a valid api access token to call this
34
+ action. The token must include at least one of the following scopes:
35
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.attributeNames.
36
+
37
+ #### Available Parameters
38
+
39
+ | Name | Type | Required | Description | Default | Example |
40
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
41
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
42
+ | query | [Advanced Device Query](_schemas.md#advanced-device-query) | N | Device filter JSON object | | [Advanced Device Query Example](_schemas.md#advanced-device-query-example) |
43
+ | dataType | [Device Attribute Data Type Filter](_schemas.md#device-attribute-data-type-filter) | N | Filter the devices by the given attribute data type or types | | [Device Attribute Data Type Filter Example](_schemas.md#device-attribute-data-type-filter-example) |
44
+ | startsWith | string | N | Filter attributes down to those that have names starting with the given string. Case insensitive. | | temper |
45
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
46
+
47
+ #### Successful Responses
48
+
49
+ | Code | Type | Description |
50
+ | ---- | ---- | ----------- |
51
+ | 200 | [Attribute Names Response](_schemas.md#attribute-names-response) | The matching attribute names |
52
+
53
+ #### Error Responses
54
+
55
+ | Code | Type | Description |
56
+ | ---- | ---- | ----------- |
57
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
58
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
16
59
 
17
60
  <br/>
18
61
 
@@ -45,7 +88,7 @@ all.Application, all.Organization, all.User, devices.*, or devices.delete.
45
88
 
46
89
  | Code | Type | Description |
47
90
  | ---- | ---- | ----------- |
48
- | 200 | [Devices Deleted](_schemas.md#devices-deleted) | Object indicating number of devices deleted or failed |
91
+ | 200 | [Bulk Deletion Response](_schemas.md#bulk-deletion-response) | Object indicating number of devices deleted or failed |
49
92
  | 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If a job was enqueued for the devices to be deleted |
50
93
 
51
94
  #### Error Responses
@@ -117,10 +160,10 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
117
160
  | Name | Type | Required | Description | Default | Example |
118
161
  | ---- | ---- | -------- | ----------- | ------- | ------- |
119
162
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
120
- | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
163
+ | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated, connectionStatus | name | name |
121
164
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
122
165
  | page | string | N | Which page of results to return | 0 | 0 |
123
- | perPage | string | N | How many items to return per page | 1000 | 10 |
166
+ | perPage | string | N | How many items to return per page | 100 | 10 |
124
167
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
125
168
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my * device |
126
169
  | deviceClass | [Device Class Filter](_schemas.md#device-class-filter) | N | Filter the devices by the given device class or classes | | [Device Class Filter Example](_schemas.md#device-class-filter-example) |
@@ -304,3 +347,84 @@ all.Application, all.Device, all.Organization, all.User, devices.*, or devices.s
304
347
  | ---- | ---- | ----------- |
305
348
  | 400 | [Error](_schemas.md#error) | Error if malformed request |
306
349
  | 404 | [Error](_schemas.md#error) | Error if application was not found |
350
+
351
+ <br/>
352
+
353
+ ## Tag Keys
354
+
355
+ Gets the unique tag keys for devices that match the given query. Maximum 1K returned.
356
+
357
+ ```ruby
358
+ result = client.devices.tag_keys(applicationId: my_application_id)
359
+
360
+ puts result
361
+ ```
362
+
363
+ #### Authentication
364
+ The client must be configured with a valid api access token to call this
365
+ action. The token must include at least one of the following scopes:
366
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.tagKeys.
367
+
368
+ #### Available Parameters
369
+
370
+ | Name | Type | Required | Description | Default | Example |
371
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
372
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
373
+ | query | [Advanced Device Query](_schemas.md#advanced-device-query) | N | Device filter JSON object | | [Advanced Device Query Example](_schemas.md#advanced-device-query-example) |
374
+ | startsWith | string | N | Filter keys down to those that start with the given string. Case insensitive. | | temper |
375
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
376
+
377
+ #### Successful Responses
378
+
379
+ | Code | Type | Description |
380
+ | ---- | ---- | ----------- |
381
+ | 200 | [Tag Keys Response](_schemas.md#tag-keys-response) | The matching tag keys |
382
+
383
+ #### Error Responses
384
+
385
+ | Code | Type | Description |
386
+ | ---- | ---- | ----------- |
387
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
388
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
389
+
390
+ <br/>
391
+
392
+ ## Tag Values
393
+
394
+ Gets the unique tag values for the given key for devices that match the given query. Maximum 1K returned.
395
+
396
+ ```ruby
397
+ result = client.devices.tag_values(
398
+ applicationId: my_application_id,
399
+ key: my_key)
400
+
401
+ puts result
402
+ ```
403
+
404
+ #### Authentication
405
+ The client must be configured with a valid api access token to call this
406
+ action. The token must include at least one of the following scopes:
407
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.tagValues.
408
+
409
+ #### Available Parameters
410
+
411
+ | Name | Type | Required | Description | Default | Example |
412
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
413
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
414
+ | query | [Advanced Device Query](_schemas.md#advanced-device-query) | N | Device filter JSON object | | [Advanced Device Query Example](_schemas.md#advanced-device-query-example) |
415
+ | key | string | Y | The tag key to get the values for | | myKey |
416
+ | startsWith | string | N | Filter values down to those that start with the given string. Case insensitive. | | temper |
417
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
418
+
419
+ #### Successful Responses
420
+
421
+ | Code | Type | Description |
422
+ | ---- | ---- | ----------- |
423
+ | 200 | [Tag Values Response](_schemas.md#tag-values-response) | The matching tag values |
424
+
425
+ #### Error Responses
426
+
427
+ | Code | Type | Description |
428
+ | ---- | ---- | ----------- |
429
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
430
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
@@ -36,7 +36,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
36
36
  | sortField | string | N | Field to sort the results by. Accepted values are: id, deviceId, flowId, desiredVersion, currentVersion, creationDate, lastUpdated | lastUpdated | creationDate |
37
37
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
38
38
  | page | string | N | Which page of results to return | 0 | 0 |
39
- | perPage | string | N | How many items to return per page | 1000 | 10 |
39
+ | perPage | string | N | How many items to return per page | 100 | 10 |
40
40
  | deviceId | string | N | Filter deployments to the given Device ID | | 575ecf887ae143cd83dc4aa2 |
41
41
  | version | string | N | Filter deployments to the given Workflow Version (matches against both current and desired) | | myFlowVersion |
42
42
  | filterEmpty | undefined | N | Filter out deployments where both the current and desired version are null. | | true |
data/docs/events.md CHANGED
@@ -114,11 +114,11 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
114
114
  | sortField | string | N | Field to sort the results by. Accepted values are: subject, id, creationDate, lastUpdated, level, state, deviceId | creationDate | subject |
115
115
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | asc |
116
116
  | page | string | N | Which page of results to return | 0 | 0 |
117
- | perPage | string | N | How many items to return per page | 1000 | 10 |
117
+ | perPage | string | N | How many items to return per page | 100 | 10 |
118
118
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: subject | | subject |
119
119
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | abnormal power to * |
120
120
  | state | string | N | If provided, return events only in the given state. Accepted values are: new, acknowledged, resolved | | new |
121
- | query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overides the filterField, filter, and state parameters. | | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
121
+ | query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overrides the filterField, filter, and state parameters. | | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
122
122
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
123
123
 
124
124
  #### Successful Responses
@@ -157,7 +157,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
157
157
  | ---- | ---- | -------- | ----------- | ------- | ------- |
158
158
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
159
159
  | filter | string | N | Filter to apply against event subjects. Supports globbing. Blank or not provided means no filtering. | | abnormal power to * |
160
- | query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overides the filter parameter. | | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
160
+ | query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overrides the filter parameter. | | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
161
161
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
162
162
 
163
163
  #### Successful Responses
@@ -199,7 +199,7 @@ all.Application, all.Organization, all.User, events.*, or events.patch.
199
199
  | filterField | string | N | Field to filter the events to act on by. Blank or not provided means no filtering. Accepted values are: subject | | subject |
200
200
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | abnormal power to * |
201
201
  | state | string | N | If provided, act on events only in the given state. Accepted values are: new, acknowledged, resolved | | new |
202
- | query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overides the filterField, filter, and state parameters. | | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
202
+ | query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overrides the filterField, filter, and state parameters. | | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
203
203
  | updates | [Event Patch](_schemas.md#event-patch) | Y | Object containing updated information for the events | | [Event Patch Example](_schemas.md#event-patch-example) |
204
204
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
205
205
 
data/docs/experience.md CHANGED
@@ -26,7 +26,7 @@ puts result
26
26
  #### Authentication
27
27
  The client must be configured with a valid api access token to call this
28
28
  action. The token must include at least one of the following scopes:
29
- all.Application, all.Organization, all.User, experience.*, or experience.bootstrap.
29
+ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, experience.*, or experience.bootstrap.
30
30
 
31
31
  #### Available Parameters
32
32
 
@@ -24,7 +24,7 @@ puts result
24
24
  #### Authentication
25
25
  The client must be configured with a valid api access token to call this
26
26
  action. The token must include at least one of the following scopes:
27
- all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceDomains.*, or experienceDomains.get.
27
+ all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceDomains.*, or experienceDomains.get.
28
28
 
29
29
  #### Available Parameters
30
30
 
@@ -36,6 +36,7 @@ all.Application, all.Organization, all.User, experienceEndpoint.*, or experience
36
36
  | ---- | ---- | -------- | ----------- | ------- | ------- |
37
37
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
38
38
  | experienceEndpointId | string | Y | ID associated with the experience endpoint | | 575ed78e7ae143cd83dc4aab |
39
+ | includeWorkflows | string | N | If the workflows that utilize this experience endpoint should also be deleted. | | true |
39
40
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
40
41
 
41
42
  #### Successful Responses
@@ -75,6 +75,8 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
75
75
  | ---- | ---- | -------- | ----------- | ------- | ------- |
76
76
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
77
77
  | experienceGroupId | string | Y | ID associated with the experience group | | 575ed78e7ae143cd83dc4aab |
78
+ | includeDirectDeviceCount | string | N | Whether or not to return count of devices associated directly with this group | false | true |
79
+ | includeTotalDeviceCount | string | N | Whether or not to return count of devices associated with this group or any of its descendents | false | true |
78
80
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
79
81
 
80
82
  #### Successful Responses
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
34
34
  | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
35
35
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
36
36
  | page | string | N | Which page of results to return | 0 | 0 |
37
- | perPage | string | N | How many items to return per page | 1000 | 10 |
37
+ | perPage | string | N | How many items to return per page | 100 | 10 |
38
38
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*group |
40
40
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
@@ -24,7 +24,7 @@ puts result
24
24
  #### Authentication
25
25
  The client must be configured with a valid api access token to call this
26
26
  action. The token must include at least one of the following scopes:
27
- all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceSlugs.*, or experienceSlugs.get.
27
+ all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceSlugs.*, or experienceSlugs.get.
28
28
 
29
29
  #### Available Parameters
30
30
 
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
34
34
  | sortField | string | N | Field to sort the results by. Accepted values are: firstName, lastName, email, id, creationDate, lastLogin, lastUpdated | email | email |
35
35
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
36
36
  | page | string | N | Which page of results to return | 0 | 0 |
37
- | perPage | string | N | How many items to return per page | 1000 | 10 |
37
+ | perPage | string | N | How many items to return per page | 100 | 10 |
38
38
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: firstName, lastName, email | | email |
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*user |
40
40
  | experienceGroupId | string | N | Filter users to those only in the specified group, special experienceGroupIds of &#x27;any&#x27; which will give users who are in at least one group and &#x27;none&#x27; will give you users who are not in any groups. | | 575ec8687ae143cd83dc4a97 |
@@ -27,7 +27,7 @@ puts result
27
27
  #### Authentication
28
28
  The client must be configured with a valid api access token to call this
29
29
  action. The token must include at least one of the following scopes:
30
- all.Application, all.Organization, all.User, experienceVersion.*, or experienceVersion.delete.
30
+ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, experienceVersion.*, or experienceVersion.delete.
31
31
 
32
32
  #### Available Parameters
33
33
 
@@ -67,7 +67,7 @@ puts result
67
67
  #### Authentication
68
68
  The client must be configured with a valid api access token to call this
69
69
  action. The token must include at least one of the following scopes:
70
- all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceVersion.*, or experienceVersion.get.
70
+ all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceVersion.*, or experienceVersion.get.
71
71
 
72
72
  #### Available Parameters
73
73
 
@@ -108,7 +108,7 @@ puts result
108
108
  #### Authentication
109
109
  The client must be configured with a valid api access token to call this
110
110
  action. The token must include at least one of the following scopes:
111
- all.Application, all.Organization, all.User, experienceVersion.*, or experienceVersion.patch.
111
+ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, experienceVersion.*, or experienceVersion.patch.
112
112
 
113
113
  #### Available Parameters
114
114
 
@@ -24,7 +24,7 @@ puts result
24
24
  #### Authentication
25
25
  The client must be configured with a valid api access token to call this
26
26
  action. The token must include at least one of the following scopes:
27
- all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceVersions.*, or experienceVersions.get.
27
+ all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceVersions.*, or experienceVersions.get.
28
28
 
29
29
  #### Available Parameters
30
30
 
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
34
34
  | sortField | string | N | Field to sort the results by. Accepted values are: version, id, creationDate, lastUpdated | version | version |
35
35
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
36
36
  | page | string | N | Which page of results to return | 0 | 0 |
37
- | perPage | string | N | How many items to return per page | 1000 | 10 |
37
+ | perPage | string | N | How many items to return per page | 100 | 10 |
38
38
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: version | | email |
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*version |
40
40
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
@@ -69,7 +69,7 @@ puts result
69
69
  #### Authentication
70
70
  The client must be configured with a valid api access token to call this
71
71
  action. The token must include at least one of the following scopes:
72
- all.Application, all.Organization, all.User, experienceVersions.*, or experienceVersions.post.
72
+ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, experienceVersions.*, or experienceVersions.post.
73
73
 
74
74
  #### Available Parameters
75
75
 
@@ -28,7 +28,7 @@ puts result
28
28
  #### Authentication
29
29
  The client must be configured with a valid api access token to call this
30
30
  action. The token must include at least one of the following scopes:
31
- all.Application, all.Organization, all.User, experienceView.*, or experienceView.delete.
31
+ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, experienceView.*, or experienceView.delete.
32
32
 
33
33
  #### Available Parameters
34
34
 
@@ -68,7 +68,7 @@ puts result
68
68
  #### Authentication
69
69
  The client must be configured with a valid api access token to call this
70
70
  action. The token must include at least one of the following scopes:
71
- all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceView.*, or experienceView.get.
71
+ all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceView.*, or experienceView.get.
72
72
 
73
73
  #### Available Parameters
74
74
 
@@ -109,7 +109,7 @@ puts result
109
109
  #### Authentication
110
110
  The client must be configured with a valid api access token to call this
111
111
  action. The token must include at least one of the following scopes:
112
- all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceView.*, or experienceView.linkedResources.
112
+ all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceView.*, or experienceView.linkedResources.
113
113
 
114
114
  #### Available Parameters
115
115
 
@@ -152,7 +152,7 @@ puts result
152
152
  #### Authentication
153
153
  The client must be configured with a valid api access token to call this
154
154
  action. The token must include at least one of the following scopes:
155
- all.Application, all.Organization, all.User, experienceView.*, or experienceView.patch.
155
+ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, experienceView.*, or experienceView.patch.
156
156
 
157
157
  #### Available Parameters
158
158
 
@@ -24,7 +24,7 @@ puts result
24
24
  #### Authentication
25
25
  The client must be configured with a valid api access token to call this
26
26
  action. The token must include at least one of the following scopes:
27
- all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceViews.*, or experienceViews.get.
27
+ all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceViews.*, or experienceViews.get.
28
28
 
29
29
  #### Available Parameters
30
30
 
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
34
34
  | sortField | string | N | Field to sort the results by. Accepted values are: id, creationDate, name, lastUpdated | name | name |
35
35
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
36
36
  | page | string | N | Which page of results to return | 0 | 0 |
37
- | perPage | string | N | How many items to return per page | 1000 | 10 |
37
+ | perPage | string | N | How many items to return per page | 100 | 10 |
38
38
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*view |
40
40
  | viewType | string | N | Filter views to those only of the given type. Accepted values are: page, layout, component | | page |
@@ -71,7 +71,7 @@ puts result
71
71
  #### Authentication
72
72
  The client must be configured with a valid api access token to call this
73
73
  action. The token must include at least one of the following scopes:
74
- all.Application, all.Organization, all.User, experienceViews.*, or experienceViews.post.
74
+ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, experienceViews.*, or experienceViews.post.
75
75
 
76
76
  #### Available Parameters
77
77
 
data/docs/file.md CHANGED
@@ -29,7 +29,7 @@ puts result
29
29
  #### Authentication
30
30
  The client must be configured with a valid api access token to call this
31
31
  action. The token must include at least one of the following scopes:
32
- all.Application, all.Organization, all.User, file.*, or file.delete.
32
+ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, file.*, or file.delete.
33
33
 
34
34
  #### Available Parameters
35
35
 
@@ -69,7 +69,7 @@ puts result
69
69
  #### Authentication
70
70
  The client must be configured with a valid api access token to call this
71
71
  action. The token must include at least one of the following scopes:
72
- all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, file.*, or file.get.
72
+ all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, file.*, or file.get.
73
73
 
74
74
  #### Available Parameters
75
75
 
@@ -109,7 +109,7 @@ puts result
109
109
  #### Authentication
110
110
  The client must be configured with a valid api access token to call this
111
111
  action. The token must include at least one of the following scopes:
112
- all.Application, all.Organization, all.User, file.*, or file.move.
112
+ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, file.*, or file.move.
113
113
 
114
114
  #### Available Parameters
115
115
 
@@ -152,7 +152,7 @@ puts result
152
152
  #### Authentication
153
153
  The client must be configured with a valid api access token to call this
154
154
  action. The token must include at least one of the following scopes:
155
- all.Application, all.Organization, all.User, file.*, or file.patch.
155
+ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, file.*, or file.patch.
156
156
 
157
157
  #### Available Parameters
158
158
 
@@ -194,7 +194,7 @@ puts result
194
194
  #### Authentication
195
195
  The client must be configured with a valid api access token to call this
196
196
  action. The token must include at least one of the following scopes:
197
- all.Application, all.Organization, all.User, file.*, or file.upload.
197
+ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, file.*, or file.upload.
198
198
 
199
199
  #### Available Parameters
200
200
 
data/docs/files.md CHANGED
@@ -24,7 +24,7 @@ puts result
24
24
  #### Authentication
25
25
  The client must be configured with a valid api access token to call this
26
26
  action. The token must include at least one of the following scopes:
27
- all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, files.*, or files.get.
27
+ all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, files.*, or files.get.
28
28
 
29
29
  #### Available Parameters
30
30
 
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
34
34
  | sortField | string | N | Field to sort the results by. Accepted values are: lastUpdated, type, name, creationDate | lastUpdated | subject |
35
35
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
36
36
  | page | string | N | Which page of results to return | 0 | 0 |
37
- | perPage | string | N | How many items to return per page | 1000 | 10 |
37
+ | perPage | string | N | How many items to return per page | 100 | 10 |
38
38
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | myFile |
40
40
  | type | string | N | Limit by the type (file or directory) of the file | | file |
@@ -72,7 +72,7 @@ puts result
72
72
  #### Authentication
73
73
  The client must be configured with a valid api access token to call this
74
74
  action. The token must include at least one of the following scopes:
75
- all.Application, all.Organization, all.User, files.*, or files.post.
75
+ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, files.*, or files.post.
76
76
 
77
77
  #### Available Parameters
78
78