losant_rest 1.7.2 → 1.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (119) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +7347 -4603
  3. data/docs/application.md +47 -0
  4. data/docs/applicationApiToken.md +3 -0
  5. data/docs/applicationApiTokens.md +2 -0
  6. data/docs/applicationKey.md +3 -0
  7. data/docs/applicationKeys.md +2 -0
  8. data/docs/applications.md +2 -0
  9. data/docs/auditLog.md +1 -0
  10. data/docs/auditLogs.md +1 -0
  11. data/docs/auth.md +4 -0
  12. data/docs/dashboard.md +4 -0
  13. data/docs/dashboards.md +2 -0
  14. data/docs/data.md +2 -0
  15. data/docs/dataTable.md +5 -0
  16. data/docs/dataTableRow.md +3 -0
  17. data/docs/dataTableRows.md +9 -3
  18. data/docs/dataTables.md +2 -0
  19. data/docs/device.md +12 -0
  20. data/docs/deviceRecipe.md +4 -0
  21. data/docs/deviceRecipes.md +2 -0
  22. data/docs/devices.md +4 -0
  23. data/docs/edgeDeployments.md +4 -0
  24. data/docs/event.md +3 -0
  25. data/docs/events.md +4 -0
  26. data/docs/experience.md +52 -8
  27. data/docs/experienceDomain.md +3 -0
  28. data/docs/experienceDomains.md +2 -0
  29. data/docs/experienceEndpoint.md +4 -0
  30. data/docs/experienceEndpoints.md +9 -1
  31. data/docs/experienceGroup.md +3 -0
  32. data/docs/experienceGroups.md +2 -0
  33. data/docs/experienceSlug.md +133 -0
  34. data/docs/experienceSlugs.md +87 -0
  35. data/docs/experienceUser.md +3 -0
  36. data/docs/experienceUsers.md +2 -0
  37. data/docs/experienceVersion.md +133 -0
  38. data/docs/experienceVersions.md +93 -0
  39. data/docs/experienceView.md +4 -0
  40. data/docs/experienceViews.md +3 -0
  41. data/docs/file.md +4 -0
  42. data/docs/files.md +2 -0
  43. data/docs/flow.md +8 -0
  44. data/docs/flowVersion.md +4 -0
  45. data/docs/flowVersions.md +2 -0
  46. data/docs/flows.md +54 -1
  47. data/docs/integration.md +3 -0
  48. data/docs/integrations.md +2 -0
  49. data/docs/me.md +19 -3
  50. data/docs/org.md +10 -0
  51. data/docs/orgInvites.md +2 -0
  52. data/docs/orgs.md +2 -0
  53. data/docs/solution.md +3 -0
  54. data/docs/solutionUser.md +3 -0
  55. data/docs/solutionUsers.md +2 -0
  56. data/docs/solutions.md +2 -0
  57. data/docs/webhook.md +3 -0
  58. data/docs/webhooks.md +2 -0
  59. data/lib/losant_rest/application.rb +47 -0
  60. data/lib/losant_rest/client.rb +18 -2
  61. data/lib/losant_rest/data_table_rows.rb +3 -3
  62. data/lib/losant_rest/experience.rb +62 -11
  63. data/lib/losant_rest/experience_endpoint.rb +2 -0
  64. data/lib/losant_rest/experience_endpoints.rb +11 -1
  65. data/lib/losant_rest/experience_slug.rb +174 -0
  66. data/lib/losant_rest/experience_slugs.rb +124 -0
  67. data/lib/losant_rest/experience_version.rb +174 -0
  68. data/lib/losant_rest/experience_versions.rb +136 -0
  69. data/lib/losant_rest/experience_view.rb +2 -0
  70. data/lib/losant_rest/experience_views.rb +2 -0
  71. data/lib/losant_rest/flows.rb +66 -1
  72. data/lib/losant_rest/version.rb +1 -1
  73. data/lib/losant_rest.rb +4 -0
  74. data/schemas/apiTokens.json +128 -0
  75. data/schemas/application.json +6 -0
  76. data/schemas/applicationApiTokenPost.json +18 -0
  77. data/schemas/applications.json +6 -0
  78. data/schemas/dataTableRowInMultiple.json +20 -0
  79. data/schemas/dataTableRowInsert.json +42 -0
  80. data/schemas/dataTableRowInsertResult.json +54 -0
  81. data/schemas/edgeDeployment.json +119 -0
  82. data/schemas/emailVerificationVerify.json +20 -0
  83. data/schemas/experienceBootstrapOptions.json +25 -0
  84. data/schemas/experienceBootstrapResult.json +16 -0
  85. data/schemas/experienceDomain.json +5 -0
  86. data/schemas/experienceDomainPatch.json +12 -0
  87. data/schemas/experienceDomainPost.json +12 -0
  88. data/schemas/experienceDomains.json +5 -0
  89. data/schemas/experienceSlug.json +37 -0
  90. data/schemas/experienceSlugPatch.json +25 -0
  91. data/schemas/experienceSlugPost.json +28 -0
  92. data/schemas/experienceSlugs.json +57 -0
  93. data/schemas/experienceVersion.json +82 -0
  94. data/schemas/experienceVersionPatch.json +19 -0
  95. data/schemas/experienceVersionPost.json +35 -0
  96. data/schemas/experienceVersions.json +102 -0
  97. data/schemas/file.json +3 -0
  98. data/schemas/files.json +3 -0
  99. data/schemas/flow.json +5 -0
  100. data/schemas/flowPatch.json +1 -0
  101. data/schemas/flowPost.json +2 -0
  102. data/schemas/flowVersion.json +622 -433
  103. data/schemas/flowVersionPost.json +1 -0
  104. data/schemas/flowVersions.json +622 -433
  105. data/schemas/flows.json +6 -0
  106. data/schemas/flowsImportPost.json +3 -0
  107. data/schemas/flowsImportResult.json +628 -434
  108. data/schemas/githubLogin.json +18 -0
  109. data/schemas/me.json +12 -0
  110. data/schemas/mqttPublishBody.json +20 -0
  111. data/schemas/org.json +12 -0
  112. data/schemas/orgs.json +12 -0
  113. data/schemas/passwordResetFinish.json +31 -0
  114. data/schemas/passwordResetInput.json +19 -0
  115. data/schemas/passwordResetResponse.json +18 -0
  116. data/schemas/solutionMe.json +150 -0
  117. data/schemas/userCredentials.json +18 -0
  118. data/schemas/userPost.json +388 -0
  119. metadata +32 -2
data/docs/experienceVersion.md ADDED
@@ -0,0 +1,133 @@
1
+ # Experience Version Actions
2
+
3
+ Details on the various actions that can be performed on the
4
+ Experience Version resource, including the expected
5
+ parameters and the potential responses.
6
+
7
+ ##### Contents
8
+
9
+ * [Delete](#delete)
10
+ * [Get](#get)
11
+ * [Patch](#patch)
12
+
13
+ <br/>
14
+
15
+ ## Delete
16
+
17
+ Deletes an experience version
18
+
19
+ ```ruby
20
+ result = client.experience_version.delete(
21
+ applicationId: my_application_id,
22
+ experienceVersionIdOrName: my_experience_version_id_or_name)
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.Organization, all.User, experienceVersion.*, or experienceVersion.delete.
31
+
32
+ #### Available Parameters
33
+
34
+ | Name | Type | Required | Description | Default | Example |
35
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
36
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
37
+ | experienceVersionIdOrName | string | Y | Version ID or version name associated with the experience version | | 575ed78e7ae143cd83dc4aab |
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 experience version was successfully deleted |
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 experience version was not found |
52
+
53
+ <br/>
54
+
55
+ ## Get
56
+
57
+ Retrieves information on an experience version
58
+
59
+ ```ruby
60
+ result = client.experience_version.get(
61
+ applicationId: my_application_id,
62
+ experienceVersionIdOrName: my_experience_version_id_or_name)
63
+
64
+ puts result
65
+ ```
66
+
67
+ #### Authentication
68
+ The client must be configured with a valid api access token to call this
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.
71
+
72
+ #### Available Parameters
73
+
74
+ | Name | Type | Required | Description | Default | Example |
75
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
76
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
77
+ | experienceVersionIdOrName | string | Y | Version ID or version name associated with the experience version | | 575ed78e7ae143cd83dc4aab |
78
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
79
+
80
+ #### Successful Responses
81
+
82
+ | Code | Type | Description |
83
+ | ---- | ---- | ----------- |
84
+ | 200 | [Experience Version](_schemas.md#experience-version) | Experience version information |
85
+
86
+ #### Error Responses
87
+
88
+ | Code | Type | Description |
89
+ | ---- | ---- | ----------- |
90
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
91
+ | 404 | [Error](_schemas.md#error) | Error if experience version was not found |
92
+
93
+ <br/>
94
+
95
+ ## Patch
96
+
97
+ Updates information about an experience version
98
+
99
+ ```ruby
100
+ result = client.experience_version.patch(
101
+ applicationId: my_application_id,
102
+ experienceVersionIdOrName: my_experience_version_id_or_name,
103
+ experienceVersion: my_experience_version)
104
+
105
+ puts result
106
+ ```
107
+
108
+ #### Authentication
109
+ The client must be configured with a valid api access token to call this
110
+ action. The token must include at least one of the following scopes:
111
+ all.Application, all.Organization, all.User, experienceVersion.*, or experienceVersion.patch.
112
+
113
+ #### Available Parameters
114
+
115
+ | Name | Type | Required | Description | Default | Example |
116
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
117
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
118
+ | experienceVersionIdOrName | string | Y | Version ID or version name associated with the experience version | | 575ed78e7ae143cd83dc4aab |
119
+ | experienceVersion | [Experience Version Patch](_schemas.md#experience-version-patch) | Y | Object containing new properties of the experience version | | [Experience Version Patch Example](_schemas.md#experience-version-patch-example) |
120
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
121
+
122
+ #### Successful Responses
123
+
124
+ | Code | Type | Description |
125
+ | ---- | ---- | ----------- |
126
+ | 200 | [Experience Version](_schemas.md#experience-version) | Updated experience version information |
127
+
128
+ #### Error Responses
129
+
130
+ | Code | Type | Description |
131
+ | ---- | ---- | ----------- |
132
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
133
+ | 404 | [Error](_schemas.md#error) | Error if experience version was not found |
data/docs/experienceVersions.md ADDED
@@ -0,0 +1,93 @@
1
+ # Experience Versions Actions
2
+
3
+ Details on the various actions that can be performed on the
4
+ Experience Versions resource, including the expected
5
+ parameters and the potential responses.
6
+
7
+ ##### Contents
8
+
9
+ * [Get](#get)
10
+ * [Post](#post)
11
+
12
+ <br/>
13
+
14
+ ## Get
15
+
16
+ Returns the experience versions for an application
17
+
18
+ ```ruby
19
+ result = client.experience_versions.get(applicationId: my_application_id)
20
+
21
+ puts result
22
+ ```
23
+
24
+ #### Authentication
25
+ The client must be configured with a valid api access token to call this
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.
28
+
29
+ #### Available Parameters
30
+
31
+ | Name | Type | Required | Description | Default | Example |
32
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
33
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
34
+ | sortField | string | N | Field to sort the results by. Accepted values are: version, id, creationDate, lastUpdated | version | version |
35
+ | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
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 |
38
+ | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: version | | email |
39
+ | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*version |
40
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
41
+
42
+ #### Successful Responses
43
+
44
+ | Code | Type | Description |
45
+ | ---- | ---- | ----------- |
46
+ | 200 | [Experience Versions](_schemas.md#experience-versions) | Collection of experience versions |
47
+
48
+ #### Error Responses
49
+
50
+ | Code | Type | Description |
51
+ | ---- | ---- | ----------- |
52
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
53
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
54
+
55
+ <br/>
56
+
57
+ ## Post
58
+
59
+ Create a new experience version for an application
60
+
61
+ ```ruby
62
+ result = client.experience_versions.post(
63
+ applicationId: my_application_id,
64
+ experienceVersion: my_experience_version)
65
+
66
+ puts result
67
+ ```
68
+
69
+ #### Authentication
70
+ The client must be configured with a valid api access token to call this
71
+ action. The token must include at least one of the following scopes:
72
+ all.Application, all.Organization, all.User, experienceVersions.*, or experienceVersions.post.
73
+
74
+ #### Available Parameters
75
+
76
+ | Name | Type | Required | Description | Default | Example |
77
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
78
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
79
+ | experienceVersion | [Experience Version Post](_schemas.md#experience-version-post) | Y | New experience version information | | [Experience Version Post Example](_schemas.md#experience-version-post-example) |
80
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
81
+
82
+ #### Successful Responses
83
+
84
+ | Code | Type | Description |
85
+ | ---- | ---- | ----------- |
86
+ | 201 | [Experience Version](_schemas.md#experience-version) | Successfully created experience version |
87
+
88
+ #### Error Responses
89
+
90
+ | Code | Type | Description |
91
+ | ---- | ---- | ----------- |
92
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
93
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
data/docs/experienceView.md CHANGED
@@ -35,6 +35,7 @@ all.Application, all.Organization, all.User, experienceView.*, or experienceView
35
35
  | ---- | ---- | -------- | ----------- | ------- | ------- |
36
36
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
37
37
  | experienceViewId | string | Y | ID associated with the experience view | | 575ed78e7ae143cd83dc4aab |
38
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
38
39
 
39
40
  #### Successful Responses
40
41
 
@@ -74,6 +75,8 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
74
75
  | ---- | ---- | -------- | ----------- | ------- | ------- |
75
76
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
76
77
  | experienceViewId | string | Y | ID associated with the experience view | | 575ed78e7ae143cd83dc4aab |
78
+ | version | string | N | Version of this experience view to return | develop | develop |
79
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
77
80
 
78
81
  #### Successful Responses
79
82
 
@@ -115,6 +118,7 @@ all.Application, all.Organization, all.User, experienceView.*, or experienceView
115
118
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
116
119
  | experienceViewId | string | Y | ID associated with the experience view | | 575ed78e7ae143cd83dc4aab |
117
120
  | experienceView | [Experience View Patch](_schemas.md#experience-view-patch) | Y | Object containing new properties of the experience view | | [Experience View Patch Example](_schemas.md#experience-view-patch-example) |
121
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
118
122
 
119
123
  #### Successful Responses
120
124
 
data/docs/experienceViews.md CHANGED
@@ -38,6 +38,8 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
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 |
41
+ | version | string | N | Return the experience views belonging to this version | develop | develop |
42
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
41
43
 
42
44
  #### Successful Responses
43
45
 
@@ -77,6 +79,7 @@ all.Application, all.Organization, all.User, experienceViews.*, or experienceVie
77
79
  | ---- | ---- | -------- | ----------- | ------- | ------- |
78
80
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
79
81
  | experienceView | [Experience View Post](_schemas.md#experience-view-post) | Y | New experience view information | | [Experience View Post Example](_schemas.md#experience-view-post-example) |
82
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
80
83
 
81
84
  #### Successful Responses
82
85
 
data/docs/file.md CHANGED
@@ -36,6 +36,7 @@ all.Application, all.Organization, all.User, file.*, or file.delete.
36
36
  | ---- | ---- | -------- | ----------- | ------- | ------- |
37
37
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
38
38
  | fileId | string | Y | ID associated with the file | | 575ec76c7ae143cd83dc4a96 |
39
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
39
40
 
40
41
  #### Successful Responses
41
42
 
@@ -75,6 +76,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
75
76
  | ---- | ---- | -------- | ----------- | ------- | ------- |
76
77
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
77
78
  | fileId | string | Y | ID associated with the file | | 575ec76c7ae143cd83dc4a96 |
79
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
78
80
 
79
81
  #### Successful Responses
80
82
 
@@ -116,6 +118,7 @@ all.Application, all.Organization, all.User, file.*, or file.move.
116
118
  | fileId | string | Y | ID associated with the file | | 575ec76c7ae143cd83dc4a96 |
117
119
  | name | undefined | N | The new name of the file or directory | | fileA |
118
120
  | parentDirectory | undefined | N | The new parent directory for the file or directory to move into. | | /new/location/here |
121
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
119
122
 
120
123
  #### Successful Responses
121
124
 
@@ -157,6 +160,7 @@ all.Application, all.Organization, all.User, file.*, or file.patch.
157
160
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
158
161
  | fileId | string | Y | ID associated with the file | | 575ec76c7ae143cd83dc4a96 |
159
162
  | updates | [File Patch](_schemas.md#file-patch) | Y | Reupload a file | | [File Patch Example](_schemas.md#file-patch-example) |
163
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
160
164
 
161
165
  #### Successful Responses
162
166
 
data/docs/files.md CHANGED
@@ -40,6 +40,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
40
40
  | type | string | N | Limit by the type (file or directory) of the file | | file |
41
41
  | status | string | N | Limit the result to only files of this status. Accepted values are: completed, pending | | completed |
42
42
  | directory | string | N | Get files that are inside of this directory | | /a/path/ |
43
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
43
44
 
44
45
  #### Successful Responses
45
46
 
@@ -79,6 +80,7 @@ all.Application, all.Organization, all.User, files.*, or files.post.
79
80
  | ---- | ---- | -------- | ----------- | ------- | ------- |
80
81
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
81
82
  | file | [File Post](_schemas.md#file-post) | Y | New file information | | [File Post Example](_schemas.md#file-post-example) |
83
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
82
84
 
83
85
  #### Successful Responses
84
86
 
data/docs/flow.md CHANGED
@@ -40,6 +40,7 @@ all.Application, all.Organization, all.User, flow.*, or flow.clearStorageEntries
40
40
  | ---- | ---- | -------- | ----------- | ------- | ------- |
41
41
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
42
42
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
43
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
43
44
 
44
45
  #### Successful Responses
45
46
 
@@ -79,6 +80,7 @@ all.Application, all.Organization, all.User, flow.*, or flow.delete.
79
80
  | ---- | ---- | -------- | ----------- | ------- | ------- |
80
81
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
81
82
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
83
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
82
84
 
83
85
  #### Successful Responses
84
86
 
@@ -119,6 +121,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
119
121
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
120
122
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
121
123
  | 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 |
124
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
122
125
 
123
126
  #### Successful Responses
124
127
 
@@ -160,6 +163,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
160
163
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
161
164
  | limit | string | N | Max log entries to return (ordered by time descending) | 1 | 10 |
162
165
  | since | string | N | Look for log entries since this time (ms since epoch) | | 1465790400000 |
166
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
163
167
 
164
168
  #### Successful Responses
165
169
 
@@ -199,6 +203,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
199
203
  | ---- | ---- | -------- | ----------- | ------- | ------- |
200
204
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
201
205
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
206
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
202
207
 
203
208
  #### Successful Responses
204
209
 
@@ -241,6 +246,7 @@ all.Application, all.Organization, all.User, flow.*, or flow.patch.
241
246
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
242
247
  | 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 |
243
248
  | flow | [Workflow Patch](_schemas.md#workflow-patch) | Y | Object containing new properties of the flow | | [Workflow Patch Example](_schemas.md#workflow-patch-example) |
249
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
244
250
 
245
251
  #### Successful Responses
246
252
 
@@ -282,6 +288,7 @@ all.Application, all.Organization, all.User, flow.*, or flow.pressVirtualButton.
282
288
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
283
289
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
284
290
  | button | [Virtual Button Press](_schemas.md#virtual-button-press) | Y | Object containing button key and payload | | [Virtual Button Press Example](_schemas.md#virtual-button-press-example) |
291
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
285
292
 
286
293
  #### Successful Responses
287
294
 
@@ -323,6 +330,7 @@ all.Application, all.Organization, all.User, flow.*, or flow.setStorageEntry.
323
330
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
324
331
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
325
332
  | entry | [Workflow Storage Entry](_schemas.md#workflow-storage-entry) | Y | Object containing storage entry | | [Workflow Storage Entry Example](_schemas.md#workflow-storage-entry-example) |
333
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
326
334
 
327
335
  #### Successful Responses
328
336
 
data/docs/flowVersion.md CHANGED
@@ -38,6 +38,7 @@ all.Application, all.Organization, all.User, flowVersion.*, or flowVersion.delet
38
38
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
39
39
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
40
40
  | flowVersionId | string | Y | Version ID or version name associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
41
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
41
42
 
42
43
  #### Successful Responses
43
44
 
@@ -80,6 +81,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
80
81
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
81
82
  | flowVersionId | string | Y | Version ID or version name associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
82
83
  | 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 |
84
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
83
85
 
84
86
  #### Successful Responses
85
87
 
@@ -123,6 +125,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
123
125
  | flowVersionId | string | Y | Version ID or version name associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
124
126
  | limit | string | N | Max log entries to return (ordered by time descending) | 1 | 10 |
125
127
  | since | string | N | Look for log entries since this time (ms since epoch) | | 1465790400000 |
128
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
126
129
 
127
130
  #### Successful Responses
128
131
 
@@ -167,6 +170,7 @@ all.Application, all.Organization, all.User, flowVersion.*, or flowVersion.patch
167
170
  | flowVersionId | string | Y | Version ID or version name associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
168
171
  | 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 |
169
172
  | 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) |
173
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
170
174
 
171
175
  #### Successful Responses
172
176
 
data/docs/flowVersions.md CHANGED
@@ -41,6 +41,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
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
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 |
44
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
44
45
 
45
46
  #### Successful Responses
46
47
 
@@ -84,6 +85,7 @@ all.Application, all.Organization, all.User, flowVersions.*, or flowVersions.pos
84
85
  | flowVersion | [Workflow Version Post](_schemas.md#workflow-version-post) | Y | New flow version information | | [Workflow Version Post Example](_schemas.md#workflow-version-post-example) |
85
86
  | 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
87
  | allowReplacement | string | N | Allow replacement of an existing flow version with same version name | false | true |
88
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
87
89
 
88
90
  #### Successful Responses
89
91
 
data/docs/flows.md CHANGED
@@ -7,6 +7,7 @@ parameters and the potential responses.
7
7
  ##### Contents
8
8
 
9
9
  * [Get](#get)
10
+ * [Get by Version](#get-by-version)
10
11
  * [Import](#import)
11
12
  * [Post](#post)
12
13
 
@@ -38,9 +39,10 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
38
39
  | perPage | string | N | How many items to return per page | 1000 | 10 |
39
40
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
40
41
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*flow |
41
- | flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode | | cloud |
42
+ | flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience | cloud | cloud |
42
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) |
43
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
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
44
46
 
45
47
  #### Successful Responses
46
48
 
@@ -57,6 +59,55 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
57
59
 
58
60
  <br/>
59
61
 
62
+ ## Get by Version
63
+
64
+ Returns the flows by version for an application
65
+
66
+ ```ruby
67
+ result = client.flows.get_by_version(
68
+ applicationId: my_application_id,
69
+ version: my_version)
70
+
71
+ puts result
72
+ ```
73
+
74
+ #### Authentication
75
+ The client must be configured with a valid api access token to call this
76
+ action. The token must include at least one of the following scopes:
77
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flows.*, or flows.getByVersion.
78
+
79
+ #### Available Parameters
80
+
81
+ | Name | Type | Required | Description | Default | Example |
82
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
83
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
84
+ | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
85
+ | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
86
+ | page | string | N | Which page of results to return | 0 | 0 |
87
+ | perPage | string | N | How many items to return per page | 1000 | 10 |
88
+ | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
89
+ | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*flow |
90
+ | flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience | cloud | cloud |
91
+ | version | string | Y | Return the workflow versions for the given version. | | myVersion |
92
+ | 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) |
93
+ | 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 |
94
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
95
+
96
+ #### Successful Responses
97
+
98
+ | Code | Type | Description |
99
+ | ---- | ---- | ----------- |
100
+ | 200 | [Workflow Versions](_schemas.md#workflow-versions) | Collection of flow versions |
101
+
102
+ #### Error Responses
103
+
104
+ | Code | Type | Description |
105
+ | ---- | ---- | ----------- |
106
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
107
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
108
+
109
+ <br/>
110
+
60
111
  ## Import
61
112
 
62
113
  Import a set of flows and flow versions
@@ -80,6 +131,7 @@ all.Application, all.Organization, all.User, flows.*, or flows.import.
80
131
  | ---- | ---- | -------- | ----------- | ------- | ------- |
81
132
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
82
133
  | importData | [Workflow Import](_schemas.md#workflow-import) | Y | New flow and flow version information | | [Workflow Import Example](_schemas.md#workflow-import-example) |
134
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
83
135
 
84
136
  #### Successful Responses
85
137
 
@@ -120,6 +172,7 @@ all.Application, all.Organization, all.User, flows.*, or flows.post.
120
172
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
121
173
  | flow | [Workflow Post](_schemas.md#workflow-post) | Y | New flow information | | [Workflow Post Example](_schemas.md#workflow-post-example) |
122
174
  | 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 |
175
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
123
176
 
124
177
  #### Successful Responses
125
178
 
data/docs/integration.md CHANGED
@@ -35,6 +35,7 @@ all.Application, all.Organization, all.User, integration.*, or integration.delet
35
35
  | ---- | ---- | -------- | ----------- | ------- | ------- |
36
36
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
37
37
  | integrationId | string | Y | ID associated with the integration | | 575ed78e7ae143cd83dc4aab |
38
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
38
39
 
39
40
  #### Successful Responses
40
41
 
@@ -74,6 +75,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
74
75
  | ---- | ---- | -------- | ----------- | ------- | ------- |
75
76
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
76
77
  | integrationId | string | Y | ID associated with the integration | | 575ed78e7ae143cd83dc4aab |
78
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
77
79
 
78
80
  #### Successful Responses
79
81
 
@@ -115,6 +117,7 @@ all.Application, all.Organization, all.User, integration.*, or integration.patch
115
117
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
116
118
  | integrationId | string | Y | ID associated with the integration | | 575ed78e7ae143cd83dc4aab |
117
119
  | integration | [Integration Patch](_schemas.md#integration-patch) | Y | Object containing new properties of the integration | | [Integration Patch Example](_schemas.md#integration-patch-example) |
120
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
118
121
 
119
122
  #### Successful Responses
120
123
 
data/docs/integrations.md CHANGED
@@ -37,6 +37,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
37
37
  | perPage | string | N | How many items to return per page | 1000 | 10 |
38
38
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, integrationType | | integrationType |
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*integration |
40
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
40
41
 
41
42
  #### Successful Responses
42
43
 
@@ -76,6 +77,7 @@ all.Application, all.Organization, all.User, integrations.*, or integrations.pos
76
77
  | ---- | ---- | -------- | ----------- | ------- | ------- |
77
78
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
78
79
  | integration | [Integration Post](_schemas.md#integration-post) | Y | New integration information | | [Integration Post Example](_schemas.md#integration-post-example) |
80
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
79
81
 
80
82
  #### Successful Responses
81
83