losant_rest 1.3.3 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.markdownlint.json +11 -0
- data/README.md +139 -231
- data/docs/_schemas.md +1036 -393
- data/docs/dataTableRows.md +41 -0
- data/docs/deviceRecipe.md +1 -0
- data/docs/{experienceTemplate.md → experienceDomain.md} +25 -25
- data/docs/experienceDomains.md +85 -0
- data/docs/experienceView.md +130 -0
- data/docs/{experienceTemplates.md → experienceViews.md} +15 -15
- data/docs/me.md +36 -0
- data/lib/losant_rest.rb +4 -2
- data/lib/losant_rest/client.rb +18 -10
- data/lib/losant_rest/data_table_rows.rb +48 -0
- data/lib/losant_rest/device_recipe.rb +1 -0
- data/lib/losant_rest/{experience_template.rb → experience_domain.rb} +26 -26
- data/lib/losant_rest/experience_domains.rb +124 -0
- data/lib/losant_rest/experience_view.rb +174 -0
- data/lib/losant_rest/{experience_templates.rb → experience_views.rb} +16 -16
- data/lib/losant_rest/me.rb +44 -0
- data/lib/losant_rest/version.rb +1 -1
- data/schemas/application.json +34 -2
- data/schemas/applicationApiTokenPost.json +14 -7
- data/schemas/applicationPatch.json +29 -0
- data/schemas/applications.json +34 -2
- data/schemas/auditLog.json +2 -1
- data/schemas/auditLogFilter.json +2 -1
- data/schemas/auditLogs.json +2 -1
- data/schemas/changePassword.json +28 -0
- data/schemas/dataTableRowsExport.json +36 -0
- data/schemas/deviceRecipeBulkCreateEnqueued.json +9 -0
- data/schemas/deviceRecipeBulkCreatePost.json +5 -0
- data/schemas/experienceDomain.json +41 -0
- data/schemas/experienceDomainPatch.json +27 -0
- data/schemas/experienceDomainPost.json +30 -0
- data/schemas/experienceDomains.json +61 -0
- data/schemas/experienceEndpoint.json +11 -0
- data/schemas/experienceEndpointPatch.json +11 -0
- data/schemas/experienceEndpointPost.json +11 -0
- data/schemas/experienceEndpoints.json +11 -0
- data/schemas/experienceGroup.json +11 -0
- data/schemas/experienceGroupPatch.json +11 -0
- data/schemas/experienceGroupPost.json +11 -0
- data/schemas/experienceGroups.json +11 -0
- data/schemas/{experienceTemplate.json → experienceView.json} +8 -3
- data/schemas/{experienceTemplatePatch.json → experienceViewPatch.json} +1 -1
- data/schemas/{experienceTemplatePost.json → experienceViewPost.json} +3 -3
- data/schemas/{experienceTemplates.json → experienceViews.json} +11 -6
- data/schemas/me.json +10 -4
- data/schemas/org.json +10 -4
- data/schemas/orgs.json +10 -4
- data/schemas/solutionUser.json +4 -0
- data/schemas/solutionUserPatch.json +4 -0
- data/schemas/solutionUserPost.json +4 -0
- data/schemas/solutionUsers.json +4 -0
- metadata +22 -10
|
@@ -46,6 +46,35 @@
|
|
|
46
46
|
"json"
|
|
47
47
|
]
|
|
48
48
|
}
|
|
49
|
+
},
|
|
50
|
+
"ftueTracking": {
|
|
51
|
+
"type": "array",
|
|
52
|
+
"items": {
|
|
53
|
+
"type": "object",
|
|
54
|
+
"properties": {
|
|
55
|
+
"name": {
|
|
56
|
+
"type": "string",
|
|
57
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
58
|
+
},
|
|
59
|
+
"version": {
|
|
60
|
+
"type": "number"
|
|
61
|
+
},
|
|
62
|
+
"status": {
|
|
63
|
+
"type": "string",
|
|
64
|
+
"enum": [
|
|
65
|
+
"skipped",
|
|
66
|
+
"completed"
|
|
67
|
+
]
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
"required": [
|
|
71
|
+
"name",
|
|
72
|
+
"version",
|
|
73
|
+
"status"
|
|
74
|
+
],
|
|
75
|
+
"additionalProperties": false
|
|
76
|
+
},
|
|
77
|
+
"maxItems": 100
|
|
49
78
|
}
|
|
50
79
|
},
|
|
51
80
|
"additionalProperties": false
|
data/schemas/applications.json
CHANGED
|
@@ -102,16 +102,19 @@
|
|
|
102
102
|
"eventCount": {
|
|
103
103
|
"type": "number"
|
|
104
104
|
},
|
|
105
|
+
"experienceDomainCount": {
|
|
106
|
+
"type": "number"
|
|
107
|
+
},
|
|
105
108
|
"experienceEndpointCount": {
|
|
106
109
|
"type": "number"
|
|
107
110
|
},
|
|
108
111
|
"experienceGroupCount": {
|
|
109
112
|
"type": "number"
|
|
110
113
|
},
|
|
111
|
-
"
|
|
114
|
+
"experienceUserCount": {
|
|
112
115
|
"type": "number"
|
|
113
116
|
},
|
|
114
|
-
"
|
|
117
|
+
"experienceViewCount": {
|
|
115
118
|
"type": "number"
|
|
116
119
|
},
|
|
117
120
|
"flowCount": {
|
|
@@ -124,6 +127,35 @@
|
|
|
124
127
|
"type": "number"
|
|
125
128
|
}
|
|
126
129
|
}
|
|
130
|
+
},
|
|
131
|
+
"ftueTracking": {
|
|
132
|
+
"type": "array",
|
|
133
|
+
"items": {
|
|
134
|
+
"type": "object",
|
|
135
|
+
"properties": {
|
|
136
|
+
"name": {
|
|
137
|
+
"type": "string",
|
|
138
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
139
|
+
},
|
|
140
|
+
"version": {
|
|
141
|
+
"type": "number"
|
|
142
|
+
},
|
|
143
|
+
"status": {
|
|
144
|
+
"type": "string",
|
|
145
|
+
"enum": [
|
|
146
|
+
"skipped",
|
|
147
|
+
"completed"
|
|
148
|
+
]
|
|
149
|
+
}
|
|
150
|
+
},
|
|
151
|
+
"required": [
|
|
152
|
+
"name",
|
|
153
|
+
"version",
|
|
154
|
+
"status"
|
|
155
|
+
],
|
|
156
|
+
"additionalProperties": false
|
|
157
|
+
},
|
|
158
|
+
"maxItems": 100
|
|
127
159
|
}
|
|
128
160
|
}
|
|
129
161
|
}
|
data/schemas/auditLog.json
CHANGED
data/schemas/auditLogFilter.json
CHANGED
data/schemas/auditLogs.json
CHANGED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"twoFactorCode": {
|
|
6
|
+
"type": "string",
|
|
7
|
+
"maxLength": 2048
|
|
8
|
+
},
|
|
9
|
+
"password": {
|
|
10
|
+
"type": "string",
|
|
11
|
+
"minLength": 8,
|
|
12
|
+
"maxLength": 2048
|
|
13
|
+
},
|
|
14
|
+
"newPassword": {
|
|
15
|
+
"type": "string",
|
|
16
|
+
"minLength": 8,
|
|
17
|
+
"maxLength": 2048
|
|
18
|
+
},
|
|
19
|
+
"invalidateExistingTokens": {
|
|
20
|
+
"type": "boolean"
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
"required": [
|
|
24
|
+
"password",
|
|
25
|
+
"newPassword"
|
|
26
|
+
],
|
|
27
|
+
"additionalProperties": false
|
|
28
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"email": {
|
|
6
|
+
"type": "string",
|
|
7
|
+
"format": "email",
|
|
8
|
+
"maxLength": 1024
|
|
9
|
+
},
|
|
10
|
+
"query": {
|
|
11
|
+
"$ref": "#/definitions/dataTableQuery"
|
|
12
|
+
},
|
|
13
|
+
"queryOptions": {
|
|
14
|
+
"type": "object",
|
|
15
|
+
"properties": {
|
|
16
|
+
"sortDirection": {
|
|
17
|
+
"type": "string",
|
|
18
|
+
"enum": [
|
|
19
|
+
"desc",
|
|
20
|
+
"asc"
|
|
21
|
+
]
|
|
22
|
+
},
|
|
23
|
+
"limit": {
|
|
24
|
+
"type": "number"
|
|
25
|
+
},
|
|
26
|
+
"sortColumn": {
|
|
27
|
+
"type": "string"
|
|
28
|
+
},
|
|
29
|
+
"offset": {
|
|
30
|
+
"type": "number"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
"additionalProperties": false
|
|
36
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"id": {
|
|
6
|
+
"type": "string",
|
|
7
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
8
|
+
},
|
|
9
|
+
"experienceDomainId": {
|
|
10
|
+
"type": "string",
|
|
11
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
12
|
+
},
|
|
13
|
+
"applicationId": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
16
|
+
},
|
|
17
|
+
"creationDate": {
|
|
18
|
+
"type": "string",
|
|
19
|
+
"format": "date-time"
|
|
20
|
+
},
|
|
21
|
+
"lastUpdated": {
|
|
22
|
+
"type": "string",
|
|
23
|
+
"format": "date-time"
|
|
24
|
+
},
|
|
25
|
+
"sslCert": {
|
|
26
|
+
"type": "string",
|
|
27
|
+
"maxLength": 32767,
|
|
28
|
+
"minLength": 50
|
|
29
|
+
},
|
|
30
|
+
"sslBundle": {
|
|
31
|
+
"type": "string",
|
|
32
|
+
"maxLength": 32767,
|
|
33
|
+
"minLength": 50
|
|
34
|
+
},
|
|
35
|
+
"domainName": {
|
|
36
|
+
"type": "string",
|
|
37
|
+
"maxLength": 1024,
|
|
38
|
+
"minLength": 3
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"sslKey": {
|
|
6
|
+
"type": "string",
|
|
7
|
+
"maxLength": 32767,
|
|
8
|
+
"minLength": 50
|
|
9
|
+
},
|
|
10
|
+
"sslCert": {
|
|
11
|
+
"type": "string",
|
|
12
|
+
"maxLength": 32767,
|
|
13
|
+
"minLength": 50
|
|
14
|
+
},
|
|
15
|
+
"sslBundle": {
|
|
16
|
+
"type": "string",
|
|
17
|
+
"maxLength": 32767,
|
|
18
|
+
"minLength": 50
|
|
19
|
+
},
|
|
20
|
+
"domainName": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"maxLength": 1024,
|
|
23
|
+
"minLength": 3
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"additionalProperties": false
|
|
27
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"sslKey": {
|
|
6
|
+
"type": "string",
|
|
7
|
+
"maxLength": 32767,
|
|
8
|
+
"minLength": 50
|
|
9
|
+
},
|
|
10
|
+
"sslCert": {
|
|
11
|
+
"type": "string",
|
|
12
|
+
"maxLength": 32767,
|
|
13
|
+
"minLength": 50
|
|
14
|
+
},
|
|
15
|
+
"sslBundle": {
|
|
16
|
+
"type": "string",
|
|
17
|
+
"maxLength": 32767,
|
|
18
|
+
"minLength": 50
|
|
19
|
+
},
|
|
20
|
+
"domainName": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"maxLength": 1024,
|
|
23
|
+
"minLength": 3
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"additionalProperties": false,
|
|
27
|
+
"required": [
|
|
28
|
+
"domainName"
|
|
29
|
+
]
|
|
30
|
+
}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"items": {
|
|
6
|
+
"type": "array",
|
|
7
|
+
"items": {
|
|
8
|
+
"title": "Experience Domain",
|
|
9
|
+
"description": "Schema for a single Experience Domain",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"properties": {
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
15
|
+
},
|
|
16
|
+
"experienceDomainId": {
|
|
17
|
+
"type": "string",
|
|
18
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
19
|
+
},
|
|
20
|
+
"applicationId": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
23
|
+
},
|
|
24
|
+
"creationDate": {
|
|
25
|
+
"type": "string",
|
|
26
|
+
"format": "date-time"
|
|
27
|
+
},
|
|
28
|
+
"lastUpdated": {
|
|
29
|
+
"type": "string",
|
|
30
|
+
"format": "date-time"
|
|
31
|
+
},
|
|
32
|
+
"sslCert": {
|
|
33
|
+
"type": "string",
|
|
34
|
+
"maxLength": 32767,
|
|
35
|
+
"minLength": 50
|
|
36
|
+
},
|
|
37
|
+
"sslBundle": {
|
|
38
|
+
"type": "string",
|
|
39
|
+
"maxLength": 32767,
|
|
40
|
+
"minLength": 50
|
|
41
|
+
},
|
|
42
|
+
"domainName": {
|
|
43
|
+
"type": "string",
|
|
44
|
+
"maxLength": 1024,
|
|
45
|
+
"minLength": 3
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
"count": {
|
|
51
|
+
"type": "integer"
|
|
52
|
+
},
|
|
53
|
+
"totalCount": {
|
|
54
|
+
"type": "integer"
|
|
55
|
+
},
|
|
56
|
+
"applicationId": {
|
|
57
|
+
"type": "string",
|
|
58
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
@@ -53,6 +53,17 @@
|
|
|
53
53
|
"group"
|
|
54
54
|
]
|
|
55
55
|
},
|
|
56
|
+
"endpointTags": {
|
|
57
|
+
"type": "object",
|
|
58
|
+
"patternProperties": {
|
|
59
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
60
|
+
"type": "string",
|
|
61
|
+
"minLength": 1,
|
|
62
|
+
"maxLength": 255
|
|
63
|
+
}
|
|
64
|
+
},
|
|
65
|
+
"additionalProperties": false
|
|
66
|
+
},
|
|
56
67
|
"experienceGroups": {
|
|
57
68
|
"type": "array",
|
|
58
69
|
"items": {
|
|
@@ -33,6 +33,17 @@
|
|
|
33
33
|
"group"
|
|
34
34
|
]
|
|
35
35
|
},
|
|
36
|
+
"endpointTags": {
|
|
37
|
+
"type": "object",
|
|
38
|
+
"patternProperties": {
|
|
39
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
40
|
+
"type": "string",
|
|
41
|
+
"minLength": 1,
|
|
42
|
+
"maxLength": 255
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
"additionalProperties": false
|
|
46
|
+
},
|
|
36
47
|
"experienceGroupIds": {
|
|
37
48
|
"type": "array",
|
|
38
49
|
"items": {
|
|
@@ -33,6 +33,17 @@
|
|
|
33
33
|
"group"
|
|
34
34
|
]
|
|
35
35
|
},
|
|
36
|
+
"endpointTags": {
|
|
37
|
+
"type": "object",
|
|
38
|
+
"patternProperties": {
|
|
39
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
40
|
+
"type": "string",
|
|
41
|
+
"minLength": 1,
|
|
42
|
+
"maxLength": 255
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
"additionalProperties": false
|
|
46
|
+
},
|
|
36
47
|
"experienceGroupIds": {
|
|
37
48
|
"type": "array",
|
|
38
49
|
"items": {
|