losant_rest 1.6.0 → 1.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +5644 -846
  3. data/docs/applicationApiTokens.md +1 -1
  4. data/docs/applicationKeys.md +1 -1
  5. data/docs/applications.md +1 -1
  6. data/docs/dataTables.md +1 -1
  7. data/docs/deviceRecipes.md +1 -1
  8. data/docs/devices.md +1 -1
  9. data/docs/experienceEndpoints.md +1 -1
  10. data/docs/experienceGroups.md +1 -1
  11. data/docs/experienceUsers.md +1 -1
  12. data/docs/flow.md +2 -0
  13. data/docs/flowVersion.md +6 -4
  14. data/docs/flowVersions.md +4 -2
  15. data/docs/flows.md +44 -2
  16. data/docs/integrations.md +1 -1
  17. data/docs/orgs.md +1 -1
  18. data/docs/solutionUsers.md +1 -1
  19. data/docs/solutions.md +1 -1
  20. data/docs/webhooks.md +1 -1
  21. data/lib/losant_rest/application_api_tokens.rb +1 -1
  22. data/lib/losant_rest/application_keys.rb +1 -1
  23. data/lib/losant_rest/applications.rb +1 -1
  24. data/lib/losant_rest/client.rb +2 -2
  25. data/lib/losant_rest/data_tables.rb +1 -1
  26. data/lib/losant_rest/device_recipes.rb +1 -1
  27. data/lib/losant_rest/devices.rb +1 -1
  28. data/lib/losant_rest/experience_endpoints.rb +1 -1
  29. data/lib/losant_rest/experience_groups.rb +1 -1
  30. data/lib/losant_rest/experience_users.rb +1 -1
  31. data/lib/losant_rest/flow.rb +4 -0
  32. data/lib/losant_rest/flow_version.rb +8 -4
  33. data/lib/losant_rest/flow_versions.rb +6 -2
  34. data/lib/losant_rest/flows.rb +53 -2
  35. data/lib/losant_rest/integrations.rb +1 -1
  36. data/lib/losant_rest/orgs.rb +1 -1
  37. data/lib/losant_rest/solution_users.rb +1 -1
  38. data/lib/losant_rest/solutions.rb +1 -1
  39. data/lib/losant_rest/version.rb +1 -1
  40. data/lib/losant_rest/webhooks.rb +1 -1
  41. data/schemas/applicationApiTokenPost.json +2 -0
  42. data/schemas/auditLog.json +1 -0
  43. data/schemas/auditLogFilter.json +1 -0
  44. data/schemas/auditLogs.json +1 -0
  45. data/schemas/dashboard.json +7 -0
  46. data/schemas/dashboardPatch.json +7 -0
  47. data/schemas/dashboardPost.json +7 -0
  48. data/schemas/dashboards.json +7 -0
  49. data/schemas/deviceState.json +54 -0
  50. data/schemas/flow.json +334 -1
  51. data/schemas/flowPatch.json +327 -0
  52. data/schemas/flowPost.json +338 -1
  53. data/schemas/flowVersion.json +315 -0
  54. data/schemas/flowVersionPost.json +315 -0
  55. data/schemas/flowVersions.json +315 -0
  56. data/schemas/flows.json +336 -2
  57. data/schemas/flowsImportPost.json +994 -0
  58. data/schemas/flowsImportResult.json +1048 -0
  59. data/schemas/org.json +59 -1
  60. data/schemas/orgInviteInfo.json +3 -1
  61. data/schemas/orgInvitePost.json +59 -1
  62. data/schemas/orgInvites.json +59 -1
  63. data/schemas/orgMemberPatch.json +60 -3
  64. data/schemas/orgs.json +59 -1
  65. metadata +5 -2
data/docs/applicationApiTokens.md CHANGED
@@ -31,7 +31,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
31
31
  | Name | Type | Required | Description | Default | Example |
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
33
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
34
- | sortField | string | N | Field to sort the results by. Accepted values are: name, status, id, creationDate | name | name |
34
+ | sortField | string | N | Field to sort the results by. Accepted values are: name, status, 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
37
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/docs/applicationKeys.md CHANGED
@@ -31,7 +31,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
31
31
  | Name | Type | Required | Description | Default | Example |
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
33
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
34
- | sortField | string | N | Field to sort the results by. Accepted values are: key, status, id, creationDate | name | name |
34
+ | sortField | string | N | Field to sort the results by. Accepted values are: key, status, 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
37
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/docs/applications.md CHANGED
@@ -30,7 +30,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, applications.*
30
30
 
31
31
  | Name | Type | Required | Description | Default | Example |
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
- | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, ownerId | name | name |
33
+ | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, lastUpdated | name | name |
34
34
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
35
35
  | page | string | N | Which page of results to return | 0 | 0 |
36
36
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/docs/dataTables.md CHANGED
@@ -31,7 +31,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
31
31
  | Name | Type | Required | Description | Default | Example |
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
33
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
34
- | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate | name | name |
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
37
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/docs/deviceRecipes.md CHANGED
@@ -31,7 +31,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
31
31
  | Name | Type | Required | Description | Default | Example |
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
33
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
34
- | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate | name | name |
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
37
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/docs/devices.md CHANGED
@@ -71,7 +71,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
71
71
  | Name | Type | Required | Description | Default | Example |
72
72
  | ---- | ---- | -------- | ----------- | ------- | ------- |
73
73
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
74
- | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate | name | name |
74
+ | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
75
75
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
76
76
  | page | string | N | Which page of results to return | 0 | 0 |
77
77
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/docs/experienceEndpoints.md CHANGED
@@ -32,7 +32,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
32
32
  | Name | Type | Required | Description | Default | Example |
33
33
  | ---- | ---- | -------- | ----------- | ------- | ------- |
34
34
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
35
- | sortField | string | N | Field to sort the results by. Accepted values are: order, method, route, id, creationDate, requestCount | order | position |
35
+ | sortField | string | N | Field to sort the results by. Accepted values are: order, method, route, id, creationDate, requestCount, lastUpdated | order | position |
36
36
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
37
37
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: method, route | | method |
38
38
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*route |
data/docs/experienceGroups.md CHANGED
@@ -31,7 +31,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
31
31
  | Name | Type | Required | Description | Default | Example |
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
33
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
34
- | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate | name | name |
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
37
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/docs/experienceUsers.md CHANGED
@@ -31,7 +31,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
31
31
  | Name | Type | Required | Description | Default | Example |
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
33
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
34
- | sortField | string | N | Field to sort the results by. Accepted values are: firstName, lastName, email, id, creationDate, lastLogin | email | email |
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
37
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/docs/flow.md CHANGED
@@ -118,6 +118,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
118
118
  | ---- | ---- | -------- | ----------- | ------- | ------- |
119
119
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
120
120
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
121
+ | 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 |
121
122
 
122
123
  #### Successful Responses
123
124
 
@@ -238,6 +239,7 @@ all.Application, all.Organization, all.User, flow.*, or flow.patch.
238
239
  | ---- | ---- | -------- | ----------- | ------- | ------- |
239
240
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
240
241
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
242
+ | 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 |
241
243
  | flow | [Workflow Patch](_schemas.md#workflow-patch) | Y | Object containing new properties of the flow | | [Workflow Patch Example](_schemas.md#workflow-patch-example) |
242
244
 
243
245
  #### Successful Responses
data/docs/flowVersion.md CHANGED
@@ -37,7 +37,7 @@ all.Application, all.Organization, all.User, flowVersion.*, or flowVersion.delet
37
37
  | ---- | ---- | -------- | ----------- | ------- | ------- |
38
38
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
39
39
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
40
- | flowVersionId | string | Y | ID associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
40
+ | flowVersionId | string | Y | Version ID or version name associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
41
41
 
42
42
  #### Successful Responses
43
43
 
@@ -78,7 +78,8 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
78
78
  | ---- | ---- | -------- | ----------- | ------- | ------- |
79
79
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
80
80
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
81
- | flowVersionId | string | Y | ID associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
81
+ | flowVersionId | string | Y | Version ID or version name associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
82
+ | 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 |
82
83
 
83
84
  #### Successful Responses
84
85
 
@@ -119,7 +120,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
119
120
  | ---- | ---- | -------- | ----------- | ------- | ------- |
120
121
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
121
122
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
122
- | flowVersionId | string | Y | ID associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
123
+ | flowVersionId | string | Y | Version ID or version name associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
123
124
  | limit | string | N | Max log entries to return (ordered by time descending) | 1 | 10 |
124
125
  | since | string | N | Look for log entries since this time (ms since epoch) | | 1465790400000 |
125
126
 
@@ -163,7 +164,8 @@ all.Application, all.Organization, all.User, flowVersion.*, or flowVersion.patch
163
164
  | ---- | ---- | -------- | ----------- | ------- | ------- |
164
165
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
165
166
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
166
- | flowVersionId | string | Y | ID associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
167
+ | flowVersionId | string | Y | Version ID or version name associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
168
+ | 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 |
167
169
  | flowVersion | [Workflow Version Patch](_schemas.md#workflow-version-patch) | Y | Object containing new properties of the flow version | | [Workflow Version Patch Example](_schemas.md#workflow-version-patch-example) |
168
170
 
169
171
  #### Successful Responses
data/docs/flowVersions.md CHANGED
@@ -34,12 +34,13 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
34
34
  | ---- | ---- | -------- | ----------- | ------- | ------- |
35
35
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
36
36
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
37
- | sortField | string | N | Field to sort the results by. Accepted values are: version, id, creationDate | version | version |
37
+ | sortField | string | N | Field to sort the results by. Accepted values are: version, id, creationDate, lastUpdated | version | version |
38
38
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
39
39
  | page | string | N | Which page of results to return | 0 | 0 |
40
40
  | perPage | string | N | How many items to return per page | 1000 | 10 |
41
41
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: version | | version |
42
42
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*version |
43
+ | 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 |
43
44
 
44
45
  #### Successful Responses
45
46
 
@@ -81,7 +82,8 @@ all.Application, all.Organization, all.User, flowVersions.*, or flowVersions.pos
81
82
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
82
83
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
83
84
  | flowVersion | [Workflow Version Post](_schemas.md#workflow-version-post) | Y | New flow version information | | [Workflow Version Post Example](_schemas.md#workflow-version-post-example) |
84
- | allowReplacement | undefined | N | Allow replacement of an existing flow version with same version name | false | true |
85
+ | 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 |
86
+ | allowReplacement | string | N | Allow replacement of an existing flow version with same version name | false | true |
85
87
 
86
88
  #### Successful Responses
87
89
 
data/docs/flows.md CHANGED
@@ -7,6 +7,7 @@ parameters and the potential responses.
7
7
  ##### Contents
8
8
 
9
9
  * [Get](#get)
10
+ * [Import](#import)
10
11
  * [Post](#post)
11
12
 
12
13
  <br/>
@@ -31,14 +32,15 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
31
32
  | Name | Type | Required | Description | Default | Example |
32
33
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
34
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
34
- | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate | name | name |
35
+ | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
35
36
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
36
37
  | page | string | N | Which page of results to return | 0 | 0 |
37
38
  | perPage | string | N | How many items to return per page | 1000 | 10 |
38
39
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
39
40
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*flow |
40
- | flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud | | cloud |
41
+ | flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode | | cloud |
41
42
  | 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) |
43
+ | 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 |
42
44
 
43
45
  #### Successful Responses
44
46
 
@@ -55,6 +57,45 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
55
57
 
56
58
  <br/>
57
59
 
60
+ ## Import
61
+
62
+ Import a set of flows and flow versions
63
+
64
+ ```ruby
65
+ result = client.flows.import(
66
+ applicationId: my_application_id,
67
+ importData: my_import_data)
68
+
69
+ puts result
70
+ ```
71
+
72
+ #### Authentication
73
+ The client must be configured with a valid api access token to call this
74
+ action. The token must include at least one of the following scopes:
75
+ all.Application, all.Organization, all.User, flows.*, or flows.import.
76
+
77
+ #### Available Parameters
78
+
79
+ | Name | Type | Required | Description | Default | Example |
80
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
81
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
82
+ | importData | [Workflow Import](_schemas.md#workflow-import) | Y | New flow and flow version information | | [Workflow Import Example](_schemas.md#workflow-import-example) |
83
+
84
+ #### Successful Responses
85
+
86
+ | Code | Type | Description |
87
+ | ---- | ---- | ----------- |
88
+ | 201 | [Workflow Import Result](_schemas.md#workflow-import-result) | Successfully imported workflows |
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 was not found |
96
+
97
+ <br/>
98
+
58
99
  ## Post
59
100
 
60
101
  Create a new flow for an application
@@ -78,6 +119,7 @@ all.Application, all.Organization, all.User, flows.*, or flows.post.
78
119
  | ---- | ---- | -------- | ----------- | ------- | ------- |
79
120
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
80
121
  | flow | [Workflow Post](_schemas.md#workflow-post) | Y | New flow information | | [Workflow Post Example](_schemas.md#workflow-post-example) |
122
+ | 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 |
81
123
 
82
124
  #### Successful Responses
83
125
 
data/docs/integrations.md CHANGED
@@ -31,7 +31,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
31
31
  | Name | Type | Required | Description | Default | Example |
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
33
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
34
- | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, integrationType | name | name |
34
+ | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, integrationType, 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
37
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/docs/orgs.md CHANGED
@@ -30,7 +30,7 @@ all.User, all.User.read, orgs.*, or orgs.get.
30
30
 
31
31
  | Name | Type | Required | Description | Default | Example |
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
- | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate | name | name |
33
+ | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
34
34
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
35
35
  | page | string | N | Which page of results to return | 0 | 0 |
36
36
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/docs/solutionUsers.md CHANGED
@@ -34,7 +34,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, solutionUsers.
34
34
  | ---- | ---- | -------- | ----------- | ------- | ------- |
35
35
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
36
36
  | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
37
- | sortField | string | N | Field to sort the results by. Accepted values are: email, firstName, lastName, id, creationDate, lastLogin | email | email |
37
+ | sortField | string | N | Field to sort the results by. Accepted values are: email, firstName, lastName, id, creationDate, lastLogin, lastUpdated | email | email |
38
38
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
39
39
  | page | string | N | Which page of results to return | 0 | 0 |
40
40
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/docs/solutions.md CHANGED
@@ -31,7 +31,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, solutions.*, o
31
31
  | Name | Type | Required | Description | Default | Example |
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
33
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
34
- | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate | name | name |
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
37
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/docs/webhooks.md CHANGED
@@ -31,7 +31,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
31
31
  | Name | Type | Required | Description | Default | Example |
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
33
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
34
- | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate | name | name |
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
37
  | perPage | string | N | How many items to return per page | 1000 | 10 |
data/lib/losant_rest/application_api_tokens.rb CHANGED
@@ -39,7 +39,7 @@ module LosantRest
39
39
  #
40
40
  # Parameters:
41
41
  # * {string} applicationId - ID associated with the application
42
- # * {string} sortField - Field to sort the results by. Accepted values are: name, status, id, creationDate
42
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated
43
43
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
44
44
  # * {string} page - Which page of results to return
45
45
  # * {string} perPage - How many items to return per page
data/lib/losant_rest/application_keys.rb CHANGED
@@ -39,7 +39,7 @@ module LosantRest
39
39
  #
40
40
  # Parameters:
41
41
  # * {string} applicationId - ID associated with the application
42
- # * {string} sortField - Field to sort the results by. Accepted values are: key, status, id, creationDate
42
+ # * {string} sortField - Field to sort the results by. Accepted values are: key, status, id, creationDate, lastUpdated
43
43
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
44
44
  # * {string} page - Which page of results to return
45
45
  # * {string} perPage - How many items to return per page
data/lib/losant_rest/applications.rb CHANGED
@@ -38,7 +38,7 @@ module LosantRest
38
38
  # all.Organization, all.Organization.read, all.User, all.User.read, applications.*, or applications.get.
39
39
  #
40
40
  # Parameters:
41
- # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, ownerId
41
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, lastUpdated
42
42
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
43
43
  # * {string} page - Which page of results to return
44
44
  # * {string} perPage - How many items to return per page
data/lib/losant_rest/client.rb CHANGED
@@ -27,7 +27,7 @@ module LosantRest
27
27
  #
28
28
  # User API for accessing Losant data
29
29
  #
30
- # Built For Version 1.11.0
30
+ # Built For Version 1.12.0
31
31
  class Client
32
32
  attr_accessor :auth_token, :url
33
33
 
@@ -246,7 +246,7 @@ module LosantRest
246
246
 
247
247
  headers["Accept"] = "application/json"
248
248
  headers["Content-Type"] = "application/json"
249
- headers["Accept-Version"] = "^1.11.0"
249
+ headers["Accept-Version"] = "^1.12.0"
250
250
  headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
251
251
  path = self.url + options.fetch(:path, "")
252
252
 
data/lib/losant_rest/data_tables.rb CHANGED
@@ -39,7 +39,7 @@ module LosantRest
39
39
  #
40
40
  # Parameters:
41
41
  # * {string} applicationId - ID associated with the application
42
- # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate
42
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
43
43
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
44
44
  # * {string} page - Which page of results to return
45
45
  # * {string} perPage - How many items to return per page
data/lib/losant_rest/device_recipes.rb CHANGED
@@ -39,7 +39,7 @@ module LosantRest
39
39
  #
40
40
  # Parameters:
41
41
  # * {string} applicationId - ID associated with the application
42
- # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate
42
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
43
43
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
44
44
  # * {string} page - Which page of results to return
45
45
  # * {string} perPage - How many items to return per page
data/lib/losant_rest/devices.rb CHANGED
@@ -87,7 +87,7 @@ module LosantRest
87
87
  #
88
88
  # Parameters:
89
89
  # * {string} applicationId - ID associated with the application
90
- # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate
90
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
91
91
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
92
92
  # * {string} page - Which page of results to return
93
93
  # * {string} perPage - How many items to return per page
data/lib/losant_rest/experience_endpoints.rb CHANGED
@@ -39,7 +39,7 @@ module LosantRest
39
39
  #
40
40
  # Parameters:
41
41
  # * {string} applicationId - ID associated with the application
42
- # * {string} sortField - Field to sort the results by. Accepted values are: order, method, route, id, creationDate, requestCount
42
+ # * {string} sortField - Field to sort the results by. Accepted values are: order, method, route, id, creationDate, requestCount, lastUpdated
43
43
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
44
44
  # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: method, route
45
45
  # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
data/lib/losant_rest/experience_groups.rb CHANGED
@@ -39,7 +39,7 @@ module LosantRest
39
39
  #
40
40
  # Parameters:
41
41
  # * {string} applicationId - ID associated with the application
42
- # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate
42
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
43
43
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
44
44
  # * {string} page - Which page of results to return
45
45
  # * {string} perPage - How many items to return per page
data/lib/losant_rest/experience_users.rb CHANGED
@@ -39,7 +39,7 @@ module LosantRest
39
39
  #
40
40
  # Parameters:
41
41
  # * {string} applicationId - ID associated with the application
42
- # * {string} sortField - Field to sort the results by. Accepted values are: firstName, lastName, email, id, creationDate, lastLogin
42
+ # * {string} sortField - Field to sort the results by. Accepted values are: firstName, lastName, email, id, creationDate, lastLogin, lastUpdated
43
43
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
44
44
  # * {string} page - Which page of results to return
45
45
  # * {string} perPage - How many items to return per page
data/lib/losant_rest/flow.rb CHANGED
@@ -132,6 +132,7 @@ module LosantRest
132
132
  # Parameters:
133
133
  # * {string} applicationId - ID associated with the application
134
134
  # * {string} flowId - ID associated with the flow
135
+ # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
135
136
  # * {string} losantdomain - Domain scope of request (rarely needed)
136
137
  # * {boolean} _actions - Return resource actions in response
137
138
  # * {boolean} _links - Return resource link in response
@@ -152,6 +153,7 @@ module LosantRest
152
153
  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
153
154
  raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
154
155
 
156
+ query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
155
157
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
156
158
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
157
159
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -274,6 +276,7 @@ module LosantRest
274
276
  # Parameters:
275
277
  # * {string} applicationId - ID associated with the application
276
278
  # * {string} flowId - ID associated with the flow
279
+ # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
277
280
  # * {hash} flow - Object containing new properties of the flow (https://api.losant.com/#/definitions/flowPatch)
278
281
  # * {string} losantdomain - Domain scope of request (rarely needed)
279
282
  # * {boolean} _actions - Return resource actions in response
@@ -296,6 +299,7 @@ module LosantRest
296
299
  raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
297
300
  raise ArgumentError.new("flow is required") unless params.has_key?(:flow)
298
301
 
302
+ query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
299
303
  body = params[:flow] if params.has_key?(:flow)
300
304
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
301
305
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
data/lib/losant_rest/flow_version.rb CHANGED
@@ -40,7 +40,7 @@ module LosantRest
40
40
  # Parameters:
41
41
  # * {string} applicationId - ID associated with the application
42
42
  # * {string} flowId - ID associated with the flow
43
- # * {string} flowVersionId - ID associated with the flow version
43
+ # * {string} flowVersionId - Version ID or version name associated with the flow version
44
44
  # * {string} losantdomain - Domain scope of request (rarely needed)
45
45
  # * {boolean} _actions - Return resource actions in response
46
46
  # * {boolean} _links - Return resource link in response
@@ -88,7 +88,8 @@ module LosantRest
88
88
  # Parameters:
89
89
  # * {string} applicationId - ID associated with the application
90
90
  # * {string} flowId - ID associated with the flow
91
- # * {string} flowVersionId - ID associated with the flow version
91
+ # * {string} flowVersionId - Version ID or version name associated with the flow version
92
+ # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
92
93
  # * {string} losantdomain - Domain scope of request (rarely needed)
93
94
  # * {boolean} _actions - Return resource actions in response
94
95
  # * {boolean} _links - Return resource link in response
@@ -110,6 +111,7 @@ module LosantRest
110
111
  raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
111
112
  raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)
112
113
 
114
+ query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
113
115
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
114
116
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
115
117
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -136,7 +138,7 @@ module LosantRest
136
138
  # Parameters:
137
139
  # * {string} applicationId - ID associated with the application
138
140
  # * {string} flowId - ID associated with the flow
139
- # * {string} flowVersionId - ID associated with the flow version
141
+ # * {string} flowVersionId - Version ID or version name associated with the flow version
140
142
  # * {string} limit - Max log entries to return (ordered by time descending)
141
143
  # * {string} since - Look for log entries since this time (ms since epoch)
142
144
  # * {string} losantdomain - Domain scope of request (rarely needed)
@@ -188,7 +190,8 @@ module LosantRest
188
190
  # Parameters:
189
191
  # * {string} applicationId - ID associated with the application
190
192
  # * {string} flowId - ID associated with the flow
191
- # * {string} flowVersionId - ID associated with the flow version
193
+ # * {string} flowVersionId - Version ID or version name associated with the flow version
194
+ # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
192
195
  # * {hash} flowVersion - Object containing new properties of the flow version (https://api.losant.com/#/definitions/flowVersionPatch)
193
196
  # * {string} losantdomain - Domain scope of request (rarely needed)
194
197
  # * {boolean} _actions - Return resource actions in response
@@ -212,6 +215,7 @@ module LosantRest
212
215
  raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)
213
216
  raise ArgumentError.new("flowVersion is required") unless params.has_key?(:flowVersion)
214
217
 
218
+ query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
215
219
  body = params[:flowVersion] if params.has_key?(:flowVersion)
216
220
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
217
221
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
data/lib/losant_rest/flow_versions.rb CHANGED
@@ -40,12 +40,13 @@ module LosantRest
40
40
  # Parameters:
41
41
  # * {string} applicationId - ID associated with the application
42
42
  # * {string} flowId - ID associated with the flow
43
- # * {string} sortField - Field to sort the results by. Accepted values are: version, id, creationDate
43
+ # * {string} sortField - Field to sort the results by. Accepted values are: version, id, creationDate, lastUpdated
44
44
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
45
45
  # * {string} page - Which page of results to return
46
46
  # * {string} perPage - How many items to return per page
47
47
  # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: version
48
48
  # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
49
+ # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
49
50
  # * {string} losantdomain - Domain scope of request (rarely needed)
50
51
  # * {boolean} _actions - Return resource actions in response
51
52
  # * {boolean} _links - Return resource link in response
@@ -72,6 +73,7 @@ module LosantRest
72
73
  query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
73
74
  query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
74
75
  query_params[:filter] = params[:filter] if params.has_key?(:filter)
76
+ query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
75
77
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
76
78
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
77
79
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -99,7 +101,8 @@ module LosantRest
99
101
  # * {string} applicationId - ID associated with the application
100
102
  # * {string} flowId - ID associated with the flow
101
103
  # * {hash} flowVersion - New flow version information (https://api.losant.com/#/definitions/flowVersionPost)
102
- # * {undefined} allowReplacement - Allow replacement of an existing flow version with same version name
104
+ # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
105
+ # * {string} allowReplacement - Allow replacement of an existing flow version with same version name
103
106
  # * {string} losantdomain - Domain scope of request (rarely needed)
104
107
  # * {boolean} _actions - Return resource actions in response
105
108
  # * {boolean} _links - Return resource link in response
@@ -122,6 +125,7 @@ module LosantRest
122
125
  raise ArgumentError.new("flowVersion is required") unless params.has_key?(:flowVersion)
123
126
 
124
127
  body = params[:flowVersion] if params.has_key?(:flowVersion)
128
+ query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
125
129
  query_params[:allowReplacement] = params[:allowReplacement] if params.has_key?(:allowReplacement)
126
130
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
127
131
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)