losant_rest 1.3.2 → 1.3.3
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 +781 -64
- data/docs/dashboards.md +1 -1
- data/docs/experienceEndpoints.md +1 -1
- data/docs/experienceTemplate.md +130 -0
- data/docs/experienceTemplates.md +92 -0
- data/docs/integration.md +3 -3
- data/docs/integrations.md +2 -2
- data/lib/losant_rest/client.rb +10 -2
- data/lib/losant_rest/dashboards.rb +1 -1
- data/lib/losant_rest/experience_template.rb +174 -0
- data/lib/losant_rest/experience_templates.rb +138 -0
- data/lib/losant_rest/version.rb +1 -1
- data/lib/losant_rest.rb +2 -0
- data/schemas/application.json +3 -0
- data/schemas/applicationApiTokenPost.json +7 -0
- data/schemas/applications.json +3 -0
- data/schemas/auditLog.json +1 -0
- data/schemas/auditLogFilter.json +1 -0
- data/schemas/auditLogs.json +1 -0
- data/schemas/dashboard.json +50 -0
- data/schemas/dashboardPatch.json +50 -0
- data/schemas/dashboardPost.json +50 -0
- data/schemas/dashboards.json +50 -0
- data/schemas/experienceEndpoints.json +73 -1
- data/schemas/experienceTemplate.json +66 -0
- data/schemas/experienceTemplatePatch.json +39 -0
- data/schemas/experienceTemplatePost.json +52 -0
- data/schemas/experienceTemplates.json +116 -0
- data/schemas/integrations.json +2 -2
- data/schemas/me.json +6 -0
- data/schemas/org.json +6 -0
- data/schemas/orgs.json +6 -0
- metadata +10 -2
|
@@ -5,7 +5,79 @@
|
|
|
5
5
|
"items": {
|
|
6
6
|
"type": "array",
|
|
7
7
|
"items": {
|
|
8
|
-
"
|
|
8
|
+
"title": "Experience Endpoint",
|
|
9
|
+
"description": "Schema for a single Experience Endpoint",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"properties": {
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
15
|
+
},
|
|
16
|
+
"experienceEndpointId": {
|
|
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
|
+
"description": {
|
|
33
|
+
"type": "string",
|
|
34
|
+
"maxLength": 32767
|
|
35
|
+
},
|
|
36
|
+
"route": {
|
|
37
|
+
"type": "string",
|
|
38
|
+
"minLength": 1,
|
|
39
|
+
"maxLength": 1024
|
|
40
|
+
},
|
|
41
|
+
"enabled": {
|
|
42
|
+
"type": "boolean"
|
|
43
|
+
},
|
|
44
|
+
"method": {
|
|
45
|
+
"type": "string",
|
|
46
|
+
"enum": [
|
|
47
|
+
"delete",
|
|
48
|
+
"get",
|
|
49
|
+
"options",
|
|
50
|
+
"patch",
|
|
51
|
+
"post",
|
|
52
|
+
"put"
|
|
53
|
+
]
|
|
54
|
+
},
|
|
55
|
+
"access": {
|
|
56
|
+
"type": "string",
|
|
57
|
+
"enum": [
|
|
58
|
+
"public",
|
|
59
|
+
"authenticated",
|
|
60
|
+
"group"
|
|
61
|
+
]
|
|
62
|
+
},
|
|
63
|
+
"experienceGroups": {
|
|
64
|
+
"type": "array",
|
|
65
|
+
"items": {
|
|
66
|
+
"type": "object",
|
|
67
|
+
"properties": {
|
|
68
|
+
"name": {
|
|
69
|
+
"type": "string",
|
|
70
|
+
"minLength": 1,
|
|
71
|
+
"maxLength": 255
|
|
72
|
+
},
|
|
73
|
+
"id": {
|
|
74
|
+
"type": "string",
|
|
75
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
9
81
|
}
|
|
10
82
|
},
|
|
11
83
|
"count": {
|
|
@@ -0,0 +1,66 @@
|
|
|
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
|
+
"experienceTemplateId": {
|
|
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
|
+
"name": {
|
|
26
|
+
"type": "string",
|
|
27
|
+
"minLength": 1,
|
|
28
|
+
"maxLength": 255
|
|
29
|
+
},
|
|
30
|
+
"description": {
|
|
31
|
+
"type": "string",
|
|
32
|
+
"maxLength": 32767
|
|
33
|
+
},
|
|
34
|
+
"templateType": {
|
|
35
|
+
"type": "string",
|
|
36
|
+
"enum": [
|
|
37
|
+
"layout",
|
|
38
|
+
"page",
|
|
39
|
+
"component"
|
|
40
|
+
]
|
|
41
|
+
},
|
|
42
|
+
"layoutId": {
|
|
43
|
+
"type": [
|
|
44
|
+
"string",
|
|
45
|
+
"null"
|
|
46
|
+
],
|
|
47
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
48
|
+
},
|
|
49
|
+
"body": {
|
|
50
|
+
"type": "string",
|
|
51
|
+
"maxLength": 131072,
|
|
52
|
+
"minLength": 1
|
|
53
|
+
},
|
|
54
|
+
"templateTags": {
|
|
55
|
+
"type": "object",
|
|
56
|
+
"patternProperties": {
|
|
57
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
58
|
+
"type": "string",
|
|
59
|
+
"minLength": 1,
|
|
60
|
+
"maxLength": 255
|
|
61
|
+
}
|
|
62
|
+
},
|
|
63
|
+
"additionalProperties": false
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"name": {
|
|
6
|
+
"type": "string",
|
|
7
|
+
"minLength": 1,
|
|
8
|
+
"maxLength": 255
|
|
9
|
+
},
|
|
10
|
+
"description": {
|
|
11
|
+
"type": "string",
|
|
12
|
+
"maxLength": 32767
|
|
13
|
+
},
|
|
14
|
+
"layoutId": {
|
|
15
|
+
"type": [
|
|
16
|
+
"string",
|
|
17
|
+
"null"
|
|
18
|
+
],
|
|
19
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
20
|
+
},
|
|
21
|
+
"body": {
|
|
22
|
+
"type": "string",
|
|
23
|
+
"maxLength": 131072,
|
|
24
|
+
"minLength": 1
|
|
25
|
+
},
|
|
26
|
+
"templateTags": {
|
|
27
|
+
"type": "object",
|
|
28
|
+
"patternProperties": {
|
|
29
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
30
|
+
"type": "string",
|
|
31
|
+
"minLength": 1,
|
|
32
|
+
"maxLength": 255
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
"additionalProperties": false
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"additionalProperties": false
|
|
39
|
+
}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"name": {
|
|
6
|
+
"type": "string",
|
|
7
|
+
"minLength": 1,
|
|
8
|
+
"maxLength": 255
|
|
9
|
+
},
|
|
10
|
+
"description": {
|
|
11
|
+
"type": "string",
|
|
12
|
+
"maxLength": 32767
|
|
13
|
+
},
|
|
14
|
+
"templateType": {
|
|
15
|
+
"type": "string",
|
|
16
|
+
"enum": [
|
|
17
|
+
"layout",
|
|
18
|
+
"page",
|
|
19
|
+
"component"
|
|
20
|
+
]
|
|
21
|
+
},
|
|
22
|
+
"layoutId": {
|
|
23
|
+
"type": [
|
|
24
|
+
"string",
|
|
25
|
+
"null"
|
|
26
|
+
],
|
|
27
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
28
|
+
},
|
|
29
|
+
"body": {
|
|
30
|
+
"type": "string",
|
|
31
|
+
"maxLength": 131072,
|
|
32
|
+
"minLength": 1
|
|
33
|
+
},
|
|
34
|
+
"templateTags": {
|
|
35
|
+
"type": "object",
|
|
36
|
+
"patternProperties": {
|
|
37
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
38
|
+
"type": "string",
|
|
39
|
+
"minLength": 1,
|
|
40
|
+
"maxLength": 255
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
"additionalProperties": false
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
"additionalProperties": false,
|
|
47
|
+
"required": [
|
|
48
|
+
"name",
|
|
49
|
+
"templateType",
|
|
50
|
+
"body"
|
|
51
|
+
]
|
|
52
|
+
}
|
|
@@ -0,0 +1,116 @@
|
|
|
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 Template",
|
|
9
|
+
"description": "Schema for a single Experience Template",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"properties": {
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
15
|
+
},
|
|
16
|
+
"experienceTemplateId": {
|
|
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
|
+
"name": {
|
|
33
|
+
"type": "string",
|
|
34
|
+
"minLength": 1,
|
|
35
|
+
"maxLength": 255
|
|
36
|
+
},
|
|
37
|
+
"description": {
|
|
38
|
+
"type": "string",
|
|
39
|
+
"maxLength": 32767
|
|
40
|
+
},
|
|
41
|
+
"templateType": {
|
|
42
|
+
"type": "string",
|
|
43
|
+
"enum": [
|
|
44
|
+
"layout",
|
|
45
|
+
"page",
|
|
46
|
+
"component"
|
|
47
|
+
]
|
|
48
|
+
},
|
|
49
|
+
"layoutId": {
|
|
50
|
+
"type": [
|
|
51
|
+
"string",
|
|
52
|
+
"null"
|
|
53
|
+
],
|
|
54
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
55
|
+
},
|
|
56
|
+
"body": {
|
|
57
|
+
"type": "string",
|
|
58
|
+
"maxLength": 131072,
|
|
59
|
+
"minLength": 1
|
|
60
|
+
},
|
|
61
|
+
"templateTags": {
|
|
62
|
+
"type": "object",
|
|
63
|
+
"patternProperties": {
|
|
64
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
65
|
+
"type": "string",
|
|
66
|
+
"minLength": 1,
|
|
67
|
+
"maxLength": 255
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
"additionalProperties": false
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
"count": {
|
|
76
|
+
"type": "integer"
|
|
77
|
+
},
|
|
78
|
+
"totalCount": {
|
|
79
|
+
"type": "integer"
|
|
80
|
+
},
|
|
81
|
+
"perPage": {
|
|
82
|
+
"type": "integer"
|
|
83
|
+
},
|
|
84
|
+
"page": {
|
|
85
|
+
"type": "integer"
|
|
86
|
+
},
|
|
87
|
+
"filter": {
|
|
88
|
+
"type": "string"
|
|
89
|
+
},
|
|
90
|
+
"filterField": {
|
|
91
|
+
"type": "string"
|
|
92
|
+
},
|
|
93
|
+
"sortField": {
|
|
94
|
+
"type": "string"
|
|
95
|
+
},
|
|
96
|
+
"sortDirection": {
|
|
97
|
+
"type": "string",
|
|
98
|
+
"enum": [
|
|
99
|
+
"asc",
|
|
100
|
+
"desc"
|
|
101
|
+
]
|
|
102
|
+
},
|
|
103
|
+
"applicationId": {
|
|
104
|
+
"type": "string",
|
|
105
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
106
|
+
},
|
|
107
|
+
"templateType": {
|
|
108
|
+
"type": "string",
|
|
109
|
+
"enum": [
|
|
110
|
+
"layout",
|
|
111
|
+
"page",
|
|
112
|
+
"component"
|
|
113
|
+
]
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
}
|
data/schemas/integrations.json
CHANGED
data/schemas/me.json
CHANGED
|
@@ -104,6 +104,9 @@
|
|
|
104
104
|
"experiencegroup": {
|
|
105
105
|
"type": "number"
|
|
106
106
|
},
|
|
107
|
+
"experiencetemplate": {
|
|
108
|
+
"type": "number"
|
|
109
|
+
},
|
|
107
110
|
"experienceuser": {
|
|
108
111
|
"type": "number"
|
|
109
112
|
},
|
|
@@ -267,6 +270,9 @@
|
|
|
267
270
|
"experienceGroupCount": {
|
|
268
271
|
"type": "number"
|
|
269
272
|
},
|
|
273
|
+
"experienceTemplateCount": {
|
|
274
|
+
"type": "number"
|
|
275
|
+
},
|
|
270
276
|
"experienceUserCount": {
|
|
271
277
|
"type": "number"
|
|
272
278
|
},
|
data/schemas/org.json
CHANGED
|
@@ -97,6 +97,9 @@
|
|
|
97
97
|
"experiencegroup": {
|
|
98
98
|
"type": "number"
|
|
99
99
|
},
|
|
100
|
+
"experiencetemplate": {
|
|
101
|
+
"type": "number"
|
|
102
|
+
},
|
|
100
103
|
"experienceuser": {
|
|
101
104
|
"type": "number"
|
|
102
105
|
},
|
|
@@ -152,6 +155,9 @@
|
|
|
152
155
|
"experienceGroupCount": {
|
|
153
156
|
"type": "number"
|
|
154
157
|
},
|
|
158
|
+
"experienceTemplateCount": {
|
|
159
|
+
"type": "number"
|
|
160
|
+
},
|
|
155
161
|
"experienceUserCount": {
|
|
156
162
|
"type": "number"
|
|
157
163
|
},
|
data/schemas/orgs.json
CHANGED
|
@@ -104,6 +104,9 @@
|
|
|
104
104
|
"experiencegroup": {
|
|
105
105
|
"type": "number"
|
|
106
106
|
},
|
|
107
|
+
"experiencetemplate": {
|
|
108
|
+
"type": "number"
|
|
109
|
+
},
|
|
107
110
|
"experienceuser": {
|
|
108
111
|
"type": "number"
|
|
109
112
|
},
|
|
@@ -159,6 +162,9 @@
|
|
|
159
162
|
"experienceGroupCount": {
|
|
160
163
|
"type": "number"
|
|
161
164
|
},
|
|
165
|
+
"experienceTemplateCount": {
|
|
166
|
+
"type": "number"
|
|
167
|
+
},
|
|
162
168
|
"experienceUserCount": {
|
|
163
169
|
"type": "number"
|
|
164
170
|
},
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: losant_rest
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.3.
|
|
4
|
+
version: 1.3.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Michael Kuehl
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2017-
|
|
11
|
+
date: 2017-10-18 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: httparty
|
|
@@ -107,6 +107,8 @@ files:
|
|
|
107
107
|
- docs/experienceEndpoints.md
|
|
108
108
|
- docs/experienceGroup.md
|
|
109
109
|
- docs/experienceGroups.md
|
|
110
|
+
- docs/experienceTemplate.md
|
|
111
|
+
- docs/experienceTemplates.md
|
|
110
112
|
- docs/experienceUser.md
|
|
111
113
|
- docs/experienceUsers.md
|
|
112
114
|
- docs/flow.md
|
|
@@ -156,6 +158,8 @@ files:
|
|
|
156
158
|
- lib/losant_rest/experience_endpoints.rb
|
|
157
159
|
- lib/losant_rest/experience_group.rb
|
|
158
160
|
- lib/losant_rest/experience_groups.rb
|
|
161
|
+
- lib/losant_rest/experience_template.rb
|
|
162
|
+
- lib/losant_rest/experience_templates.rb
|
|
159
163
|
- lib/losant_rest/experience_user.rb
|
|
160
164
|
- lib/losant_rest/experience_users.rb
|
|
161
165
|
- lib/losant_rest/flow.rb
|
|
@@ -243,6 +247,10 @@ files:
|
|
|
243
247
|
- schemas/experienceGroupPatch.json
|
|
244
248
|
- schemas/experienceGroupPost.json
|
|
245
249
|
- schemas/experienceGroups.json
|
|
250
|
+
- schemas/experienceTemplate.json
|
|
251
|
+
- schemas/experienceTemplatePatch.json
|
|
252
|
+
- schemas/experienceTemplatePost.json
|
|
253
|
+
- schemas/experienceTemplates.json
|
|
246
254
|
- schemas/experienceUser.json
|
|
247
255
|
- schemas/experienceUserPatch.json
|
|
248
256
|
- schemas/experienceUserPost.json
|