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.
- checksums.yaml +4 -4
- data/docs/_schemas.md +7347 -4603
- data/docs/application.md +47 -0
- data/docs/applicationApiToken.md +3 -0
- data/docs/applicationApiTokens.md +2 -0
- data/docs/applicationKey.md +3 -0
- data/docs/applicationKeys.md +2 -0
- data/docs/applications.md +2 -0
- data/docs/auditLog.md +1 -0
- data/docs/auditLogs.md +1 -0
- data/docs/auth.md +4 -0
- data/docs/dashboard.md +4 -0
- data/docs/dashboards.md +2 -0
- data/docs/data.md +2 -0
- data/docs/dataTable.md +5 -0
- data/docs/dataTableRow.md +3 -0
- data/docs/dataTableRows.md +9 -3
- data/docs/dataTables.md +2 -0
- data/docs/device.md +12 -0
- data/docs/deviceRecipe.md +4 -0
- data/docs/deviceRecipes.md +2 -0
- data/docs/devices.md +4 -0
- data/docs/edgeDeployments.md +4 -0
- data/docs/event.md +3 -0
- data/docs/events.md +4 -0
- data/docs/experience.md +52 -8
- data/docs/experienceDomain.md +3 -0
- data/docs/experienceDomains.md +2 -0
- data/docs/experienceEndpoint.md +4 -0
- data/docs/experienceEndpoints.md +9 -1
- data/docs/experienceGroup.md +3 -0
- data/docs/experienceGroups.md +2 -0
- data/docs/experienceSlug.md +133 -0
- data/docs/experienceSlugs.md +87 -0
- data/docs/experienceUser.md +3 -0
- data/docs/experienceUsers.md +2 -0
- data/docs/experienceVersion.md +133 -0
- data/docs/experienceVersions.md +93 -0
- data/docs/experienceView.md +4 -0
- data/docs/experienceViews.md +3 -0
- data/docs/file.md +4 -0
- data/docs/files.md +2 -0
- data/docs/flow.md +8 -0
- data/docs/flowVersion.md +4 -0
- data/docs/flowVersions.md +2 -0
- data/docs/flows.md +54 -1
- data/docs/integration.md +3 -0
- data/docs/integrations.md +2 -0
- data/docs/me.md +19 -3
- data/docs/org.md +10 -0
- data/docs/orgInvites.md +2 -0
- data/docs/orgs.md +2 -0
- data/docs/solution.md +3 -0
- data/docs/solutionUser.md +3 -0
- data/docs/solutionUsers.md +2 -0
- data/docs/solutions.md +2 -0
- data/docs/webhook.md +3 -0
- data/docs/webhooks.md +2 -0
- data/lib/losant_rest/application.rb +47 -0
- data/lib/losant_rest/client.rb +18 -2
- data/lib/losant_rest/data_table_rows.rb +3 -3
- data/lib/losant_rest/experience.rb +62 -11
- data/lib/losant_rest/experience_endpoint.rb +2 -0
- data/lib/losant_rest/experience_endpoints.rb +11 -1
- data/lib/losant_rest/experience_slug.rb +174 -0
- data/lib/losant_rest/experience_slugs.rb +124 -0
- data/lib/losant_rest/experience_version.rb +174 -0
- data/lib/losant_rest/experience_versions.rb +136 -0
- data/lib/losant_rest/experience_view.rb +2 -0
- data/lib/losant_rest/experience_views.rb +2 -0
- data/lib/losant_rest/flows.rb +66 -1
- data/lib/losant_rest/version.rb +1 -1
- data/lib/losant_rest.rb +4 -0
- data/schemas/apiTokens.json +128 -0
- data/schemas/application.json +6 -0
- data/schemas/applicationApiTokenPost.json +18 -0
- data/schemas/applications.json +6 -0
- data/schemas/dataTableRowInMultiple.json +20 -0
- data/schemas/dataTableRowInsert.json +42 -0
- data/schemas/dataTableRowInsertResult.json +54 -0
- data/schemas/edgeDeployment.json +119 -0
- data/schemas/emailVerificationVerify.json +20 -0
- data/schemas/experienceBootstrapOptions.json +25 -0
- data/schemas/experienceBootstrapResult.json +16 -0
- data/schemas/experienceDomain.json +5 -0
- data/schemas/experienceDomainPatch.json +12 -0
- data/schemas/experienceDomainPost.json +12 -0
- data/schemas/experienceDomains.json +5 -0
- data/schemas/experienceSlug.json +37 -0
- data/schemas/experienceSlugPatch.json +25 -0
- data/schemas/experienceSlugPost.json +28 -0
- data/schemas/experienceSlugs.json +57 -0
- data/schemas/experienceVersion.json +82 -0
- data/schemas/experienceVersionPatch.json +19 -0
- data/schemas/experienceVersionPost.json +35 -0
- data/schemas/experienceVersions.json +102 -0
- data/schemas/file.json +3 -0
- data/schemas/files.json +3 -0
- data/schemas/flow.json +5 -0
- data/schemas/flowPatch.json +1 -0
- data/schemas/flowPost.json +2 -0
- data/schemas/flowVersion.json +622 -433
- data/schemas/flowVersionPost.json +1 -0
- data/schemas/flowVersions.json +622 -433
- data/schemas/flows.json +6 -0
- data/schemas/flowsImportPost.json +3 -0
- data/schemas/flowsImportResult.json +628 -434
- data/schemas/githubLogin.json +18 -0
- data/schemas/me.json +12 -0
- data/schemas/mqttPublishBody.json +20 -0
- data/schemas/org.json +12 -0
- data/schemas/orgs.json +12 -0
- data/schemas/passwordResetFinish.json +31 -0
- data/schemas/passwordResetInput.json +19 -0
- data/schemas/passwordResetResponse.json +18 -0
- data/schemas/solutionMe.json +150 -0
- data/schemas/userCredentials.json +18 -0
- data/schemas/userPost.json +388 -0
- metadata +32 -2
data/docs/edgeDeployments.md
CHANGED
@@ -41,6 +41,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
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 |
|
43
43
|
| flowId | string | N | Filter deployments to the given Workflow ID | | 575ed18f7ae143cd83dc4aa6 |
|
44
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
44
45
|
|
45
46
|
#### Successful Responses
|
46
47
|
|
@@ -80,6 +81,7 @@ all.Application, all.Organization, all.User, edgeDeployments.*, or edgeDeploymen
|
|
80
81
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
81
82
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
82
83
|
| deployment | [Edge Deployment Release](_schemas.md#edge-deployment-release) | Y | Deployment release information | | [Edge Deployment Release Example](_schemas.md#edge-deployment-release-example) |
|
84
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
83
85
|
|
84
86
|
#### Successful Responses
|
85
87
|
|
@@ -119,6 +121,7 @@ all.Application, all.Organization, all.User, edgeDeployments.*, or edgeDeploymen
|
|
119
121
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
120
122
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
121
123
|
| deployment | [Edge Deployment Remove](_schemas.md#edge-deployment-remove) | Y | Deployment removal information | | [Edge Deployment Remove Example](_schemas.md#edge-deployment-remove-example) |
|
124
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
122
125
|
|
123
126
|
#### Successful Responses
|
124
127
|
|
@@ -158,6 +161,7 @@ all.Application, all.Organization, all.User, edgeDeployments.*, or edgeDeploymen
|
|
158
161
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
159
162
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
160
163
|
| deployment | [Edge Deployment Replace](_schemas.md#edge-deployment-replace) | Y | Deployment replacement information | | [Edge Deployment Replace Example](_schemas.md#edge-deployment-replace-example) |
|
164
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
161
165
|
|
162
166
|
#### Successful Responses
|
163
167
|
|
data/docs/event.md
CHANGED
@@ -35,6 +35,7 @@ all.Application, all.Organization, all.User, event.*, or event.delete.
|
|
35
35
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
36
36
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
37
37
|
| eventId | string | Y | ID associated with the event | | 575ed0de7ae143cd83dc4aa5 |
|
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
|
| eventId | string | Y | ID associated with the event | | 575ed0de7ae143cd83dc4aa5 |
|
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, event.*, or event.patch.
|
|
115
117
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
116
118
|
| eventId | string | Y | ID associated with the event | | 575ed0de7ae143cd83dc4aa5 |
|
117
119
|
| event | [Event Patch](_schemas.md#event-patch) | Y | Object containing new properties of the event | | [Event Patch Example](_schemas.md#event-patch-example) |
|
120
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
118
121
|
|
119
122
|
#### Successful Responses
|
120
123
|
|
data/docs/events.md
CHANGED
@@ -40,6 +40,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
40
40
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: subject | | subject |
|
41
41
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | abnormal power to * |
|
42
42
|
| state | string | N | If provided, return events only in the given state. Accepted values are: new, acknowledged, resolved | | new |
|
43
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
43
44
|
|
44
45
|
#### Successful Responses
|
45
46
|
|
@@ -77,6 +78,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
77
78
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
78
79
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
79
80
|
| filter | string | N | Filter to apply against event subjects. Supports globbing. Blank or not provided means no filtering. | | abnormal power to * |
|
81
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
80
82
|
|
81
83
|
#### Successful Responses
|
82
84
|
|
@@ -118,6 +120,7 @@ all.Application, all.Organization, all.User, events.*, or events.patch.
|
|
118
120
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | abnormal power to * |
|
119
121
|
| state | string | N | If provided, act on events only in the given state. Accepted values are: new, acknowledged, resolved | | new |
|
120
122
|
| updates | [Event Patch](_schemas.md#event-patch) | Y | Object containing updated information for the events | | [Event Patch Example](_schemas.md#event-patch-example) |
|
123
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
121
124
|
|
122
125
|
#### Successful Responses
|
123
126
|
|
@@ -157,6 +160,7 @@ all.Application, all.Organization, all.User, events.*, or events.post.
|
|
157
160
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
158
161
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
159
162
|
| event | [Event Post](_schemas.md#event-post) | Y | New event information | | [Event Post Example](_schemas.md#event-post-example) |
|
163
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
160
164
|
|
161
165
|
#### Successful Responses
|
162
166
|
|
data/docs/experience.md
CHANGED
@@ -6,13 +6,54 @@ parameters and the potential responses.
|
|
6
6
|
|
7
7
|
##### Contents
|
8
8
|
|
9
|
+
* [Bootstrap](#bootstrap)
|
9
10
|
* [Delete](#delete)
|
10
11
|
|
11
12
|
<br/>
|
12
13
|
|
14
|
+
## Bootstrap
|
15
|
+
|
16
|
+
Bootstraps the experience for this application with standard endpoints and views
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
result = client.experience.bootstrap(
|
20
|
+
applicationId: my_application_id,
|
21
|
+
options: my_options)
|
22
|
+
|
23
|
+
puts result
|
24
|
+
```
|
25
|
+
|
26
|
+
#### Authentication
|
27
|
+
The client must be configured with a valid api access token to call this
|
28
|
+
action. The token must include at least one of the following scopes:
|
29
|
+
all.Application, all.Organization, all.User, experience.*, or experience.bootstrap.
|
30
|
+
|
31
|
+
#### Available Parameters
|
32
|
+
|
33
|
+
| Name | Type | Required | Description | Default | Example |
|
34
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
35
|
+
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
36
|
+
| options | [Experience Bootstrap Options](_schemas.md#experience-bootstrap-options) | Y | Bootstrap options | | [Experience Bootstrap Options Example](_schemas.md#experience-bootstrap-options-example) |
|
37
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
38
|
+
|
39
|
+
#### Successful Responses
|
40
|
+
|
41
|
+
| Code | Type | Description |
|
42
|
+
| ---- | ---- | ----------- |
|
43
|
+
| 200 | [Experience Bootstrap Result](_schemas.md#experience-bootstrap-result) | If bootstrap was successful |
|
44
|
+
|
45
|
+
#### Error Responses
|
46
|
+
|
47
|
+
| Code | Type | Description |
|
48
|
+
| ---- | ---- | ----------- |
|
49
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
50
|
+
| 404 | [Error](_schemas.md#error) | Error if application was not found |
|
51
|
+
|
52
|
+
<br/>
|
53
|
+
|
13
54
|
## Delete
|
14
55
|
|
15
|
-
Deletes multiple parts of an experience including users, domains,
|
56
|
+
Deletes multiple parts of an experience including users, groups, slugs, domains, versions, endpoints, views, and workflows
|
16
57
|
|
17
58
|
```ruby
|
18
59
|
result = client.experience.delete(applicationId: my_application_id)
|
@@ -30,18 +71,21 @@ all.Application, all.Organization, all.User, experience.*, or experience.delete.
|
|
30
71
|
| Name | Type | Required | Description | Default | Example |
|
31
72
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
32
73
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
74
|
+
| keepUsers | string | N | If this is set, Experience Users will not be removed. | | true |
|
75
|
+
| keepGroups | string | N | If this is set, Experience Groups will not be removed. | | true |
|
76
|
+
| keepSlugs | string | N | If this is set, Experience Slugs will not be removed. | | true |
|
77
|
+
| keepDomains | string | N | If this is set, Experience Domains will not be removed. | | true |
|
78
|
+
| removeVersions | string | N | If this is set, all Experience Versions and their contents will be removed (except for develop). | | true |
|
79
|
+
| keepViews | string | N | If this is set, Experience Views (in the develop version) will not be removed. | | true |
|
80
|
+
| keepEndpoints | string | N | If this is set, Experience Endpoints (in the develop version) will not be removed. | | true |
|
81
|
+
| removeWorkflows | string | N | If this is set, all Experience Workflows (in the develop version) will ve removed. | | true |
|
82
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
39
83
|
|
40
84
|
#### Successful Responses
|
41
85
|
|
42
86
|
| Code | Type | Description |
|
43
87
|
| ---- | ---- | ----------- |
|
44
|
-
| 200 | [Success](_schemas.md#success) | If
|
88
|
+
| 200 | [Success](_schemas.md#success) | If deletion was successful |
|
45
89
|
|
46
90
|
#### Error Responses
|
47
91
|
|
data/docs/experienceDomain.md
CHANGED
@@ -35,6 +35,7 @@ all.Application, all.Organization, all.User, experienceDomain.*, or experienceDo
|
|
35
35
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
36
36
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
37
37
|
| experienceDomainId | string | Y | ID associated with the experience domain | | 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
|
| experienceDomainId | string | Y | ID associated with the experience domain | | 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, experienceDomain.*, or experienceDo
|
|
115
117
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
116
118
|
| experienceDomainId | string | Y | ID associated with the experience domain | | 575ed78e7ae143cd83dc4aab |
|
117
119
|
| experienceDomain | [Experience Domain Patch](_schemas.md#experience-domain-patch) | Y | Object containing new properties of the experience domain | | [Experience Domain Patch Example](_schemas.md#experience-domain-patch-example) |
|
120
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
118
121
|
|
119
122
|
#### Successful Responses
|
120
123
|
|
data/docs/experienceDomains.md
CHANGED
@@ -31,6 +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
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
34
35
|
|
35
36
|
#### Successful Responses
|
36
37
|
|
@@ -70,6 +71,7 @@ all.Application, all.Organization, all.User, experienceDomains.*, or experienceD
|
|
70
71
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
71
72
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
72
73
|
| experienceDomain | [Experience Domain Post](_schemas.md#experience-domain-post) | Y | New experience domain information | | [Experience Domain Post Example](_schemas.md#experience-domain-post-example) |
|
74
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
73
75
|
|
74
76
|
#### Successful Responses
|
75
77
|
|
data/docs/experienceEndpoint.md
CHANGED
@@ -35,6 +35,7 @@ all.Application, all.Organization, all.User, experienceEndpoint.*, or experience
|
|
35
35
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
36
36
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
37
37
|
| experienceEndpointId | string | Y | ID associated with the experience endpoint | | 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
|
| experienceEndpointId | string | Y | ID associated with the experience endpoint | | 575ed78e7ae143cd83dc4aab |
|
78
|
+
| version | string | N | Version of this experience endpoint 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, experienceEndpoint.*, or experience
|
|
115
118
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
116
119
|
| experienceEndpointId | string | Y | ID associated with the experience endpoint | | 575ed78e7ae143cd83dc4aab |
|
117
120
|
| experienceEndpoint | [Experience Endpoint Patch](_schemas.md#experience-endpoint-patch) | Y | Object containing new properties of the experience endpoint | | [Experience Endpoint Patch Example](_schemas.md#experience-endpoint-patch-example) |
|
121
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
118
122
|
|
119
123
|
#### Successful Responses
|
120
124
|
|
data/docs/experienceEndpoints.md
CHANGED
@@ -38,6 +38,8 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
38
38
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*route |
|
39
39
|
| experienceGroupId | string | N | Filter endpoints to those only in the specified group | | 575ec8687ae143cd83dc4a97 |
|
40
40
|
| requestCountDuration | string | N | If set, a count of recent requests is included on each endpoint for the duration requested (milliseconds) | | 86400000 |
|
41
|
+
| version | string | N | Return the experience endpoints 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, experienceEndpoints.*, or experienc
|
|
77
79
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
78
80
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
79
81
|
| experienceEndpoint | [Experience Endpoint Post](_schemas.md#experience-endpoint-post) | Y | New experience endpoint information | | [Experience Endpoint Post Example](_schemas.md#experience-endpoint-post-example) |
|
82
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
80
83
|
|
81
84
|
#### Successful Responses
|
82
85
|
|
@@ -113,9 +116,14 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
113
116
|
| Name | Type | Required | Description | Default | Example |
|
114
117
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
115
118
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
116
|
-
| statGrouping | string | N | Field to group the statistics by. Accepted values are: statusCode, endpointId | statusCode | statusCode |
|
119
|
+
| statGrouping | string | N | Field to group the statistics by. Accepted values are: statusCode, endpointId, version, domain | statusCode | statusCode |
|
117
120
|
| duration | string | N | Duration in milliseconds | 86400000 | 86400000 |
|
118
121
|
| resolution | string | N | Resolution in milliseconds | 3600000 | 3600000 |
|
122
|
+
| versionFilter | string | N | Filters the stats to a particular experience version | | myVersion |
|
123
|
+
| domainFilter | string | N | Filters the stats to a particular experience domain or slug | | mycustomdomain.com |
|
124
|
+
| statusCodeFilter | string | N | Filters the stats to a particular status code | | 200 |
|
125
|
+
| endpointIdFilter | string | N | Filters the stats to a particular endpoint | | 575ec8687ae143cd83dc4a98 |
|
126
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
119
127
|
|
120
128
|
#### Successful Responses
|
121
129
|
|
data/docs/experienceGroup.md
CHANGED
@@ -35,6 +35,7 @@ all.Application, all.Organization, all.User, experienceGroup.*, or experienceGro
|
|
35
35
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
36
36
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
37
37
|
| experienceGroupId | string | Y | ID associated with the experience group | | 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
|
| experienceGroupId | string | Y | ID associated with the experience group | | 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, experienceGroup.*, or experienceGro
|
|
115
117
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
116
118
|
| experienceGroupId | string | Y | ID associated with the experience group | | 575ed78e7ae143cd83dc4aab |
|
117
119
|
| experienceGroup | [Experience Group Patch](_schemas.md#experience-group-patch) | Y | Object containing new properties of the experience group | | [Experience Group Patch Example](_schemas.md#experience-group-patch-example) |
|
120
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
118
121
|
|
119
122
|
#### Successful Responses
|
120
123
|
|
data/docs/experienceGroups.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 | | 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
|
+
| 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, experienceGroups.*, or experienceGr
|
|
76
77
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
77
78
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
78
79
|
| experienceGroup | [Experience Group Post](_schemas.md#experience-group-post) | Y | New experience group information | | [Experience Group Post Example](_schemas.md#experience-group-post-example) |
|
80
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
79
81
|
|
80
82
|
#### Successful Responses
|
81
83
|
|
@@ -0,0 +1,133 @@
|
|
1
|
+
# Experience Slug Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
Experience Slug 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 slug
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
result = client.experience_slug.delete(
|
21
|
+
applicationId: my_application_id,
|
22
|
+
experienceSlugId: my_experience_slug_id)
|
23
|
+
|
24
|
+
puts result
|
25
|
+
```
|
26
|
+
|
27
|
+
#### Authentication
|
28
|
+
The client must be configured with a valid api access token to call this
|
29
|
+
action. The token must include at least one of the following scopes:
|
30
|
+
all.Application, all.Organization, all.User, experienceSlug.*, or experienceSlug.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
|
+
| experienceSlugId | string | Y | ID associated with the experience slug | | 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 slug 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 slug was not found |
|
52
|
+
|
53
|
+
<br/>
|
54
|
+
|
55
|
+
## Get
|
56
|
+
|
57
|
+
Retrieves information on an experience slug
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
result = client.experience_slug.get(
|
61
|
+
applicationId: my_application_id,
|
62
|
+
experienceSlugId: my_experience_slug_id)
|
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, experienceSlug.*, or experienceSlug.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
|
+
| experienceSlugId | string | Y | ID associated with the experience slug | | 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 Slug](_schemas.md#experience-slug) | Experience slug 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 slug was not found |
|
92
|
+
|
93
|
+
<br/>
|
94
|
+
|
95
|
+
## Patch
|
96
|
+
|
97
|
+
Updates information about an experience slug
|
98
|
+
|
99
|
+
```ruby
|
100
|
+
result = client.experience_slug.patch(
|
101
|
+
applicationId: my_application_id,
|
102
|
+
experienceSlugId: my_experience_slug_id,
|
103
|
+
experienceSlug: my_experience_slug)
|
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, experienceSlug.*, or experienceSlug.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
|
+
| experienceSlugId | string | Y | ID associated with the experience slug | | 575ed78e7ae143cd83dc4aab |
|
119
|
+
| experienceSlug | [Experience Slug Patch](_schemas.md#experience-slug-patch) | Y | Object containing new properties of the experience slug | | [Experience Slug Patch Example](_schemas.md#experience-slug-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 Slug](_schemas.md#experience-slug) | Updated experience slug 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 slug was not found |
|
@@ -0,0 +1,87 @@
|
|
1
|
+
# Experience Slugs Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
Experience Slugs 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 slugs for an application
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
result = client.experience_slugs.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, experienceSlugs.*, or experienceSlugs.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
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
35
|
+
|
36
|
+
#### Successful Responses
|
37
|
+
|
38
|
+
| Code | Type | Description |
|
39
|
+
| ---- | ---- | ----------- |
|
40
|
+
| 200 | [Experience Slugs](_schemas.md#experience-slugs) | Collection of experience slugs |
|
41
|
+
|
42
|
+
#### Error Responses
|
43
|
+
|
44
|
+
| Code | Type | Description |
|
45
|
+
| ---- | ---- | ----------- |
|
46
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
47
|
+
| 404 | [Error](_schemas.md#error) | Error if application was not found |
|
48
|
+
|
49
|
+
<br/>
|
50
|
+
|
51
|
+
## Post
|
52
|
+
|
53
|
+
Create a new experience slug for an application
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
result = client.experience_slugs.post(
|
57
|
+
applicationId: my_application_id,
|
58
|
+
experienceSlug: my_experience_slug)
|
59
|
+
|
60
|
+
puts result
|
61
|
+
```
|
62
|
+
|
63
|
+
#### Authentication
|
64
|
+
The client must be configured with a valid api access token to call this
|
65
|
+
action. The token must include at least one of the following scopes:
|
66
|
+
all.Application, all.Organization, all.User, experienceSlugs.*, or experienceSlugs.post.
|
67
|
+
|
68
|
+
#### Available Parameters
|
69
|
+
|
70
|
+
| Name | Type | Required | Description | Default | Example |
|
71
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
72
|
+
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
73
|
+
| experienceSlug | [Experience Slug Post](_schemas.md#experience-slug-post) | Y | New experience slug information | | [Experience Slug Post Example](_schemas.md#experience-slug-post-example) |
|
74
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
75
|
+
|
76
|
+
#### Successful Responses
|
77
|
+
|
78
|
+
| Code | Type | Description |
|
79
|
+
| ---- | ---- | ----------- |
|
80
|
+
| 201 | [Experience Slug](_schemas.md#experience-slug) | Successfully created experience slug |
|
81
|
+
|
82
|
+
#### Error Responses
|
83
|
+
|
84
|
+
| Code | Type | Description |
|
85
|
+
| ---- | ---- | ----------- |
|
86
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
87
|
+
| 404 | [Error](_schemas.md#error) | Error if application was not found |
|
data/docs/experienceUser.md
CHANGED
@@ -35,6 +35,7 @@ all.Application, all.Organization, all.User, experienceUser.*, or experienceUser
|
|
35
35
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
36
36
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
37
37
|
| experienceUserId | string | Y | ID associated with the experience user | | 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
|
| experienceUserId | string | Y | ID associated with the experience user | | 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, experienceUser.*, or experienceUser
|
|
115
117
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
116
118
|
| experienceUserId | string | Y | ID associated with the experience user | | 575ed78e7ae143cd83dc4aab |
|
117
119
|
| experienceUser | [Experience User Patch](_schemas.md#experience-user-patch) | Y | Object containing new properties of the experience user | | [Experience User Patch Example](_schemas.md#experience-user-patch-example) |
|
120
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
118
121
|
|
119
122
|
#### Successful Responses
|
120
123
|
|
data/docs/experienceUsers.md
CHANGED
@@ -38,6 +38,7 @@ 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: 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 | | 575ec8687ae143cd83dc4a97 |
|
41
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
41
42
|
|
42
43
|
#### Successful Responses
|
43
44
|
|
@@ -77,6 +78,7 @@ all.Application, all.Organization, all.User, experienceUsers.*, or experienceUse
|
|
77
78
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
78
79
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
79
80
|
| experienceUser | [Experience User Post](_schemas.md#experience-user-post) | Y | New experience user information | | [Experience User Post Example](_schemas.md#experience-user-post-example) |
|
81
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
80
82
|
|
81
83
|
#### Successful Responses
|
82
84
|
|