losant_rest 1.20.0 → 1.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +139 -13
- data/docs/_schemas.md +7585 -2999
- data/docs/instanceNotificationRule.md +219 -0
- data/docs/instanceNotificationRules.md +91 -0
- data/lib/platform_rest/client.rb +10 -2
- data/lib/platform_rest/instance_notification_rule.rb +275 -0
- data/lib/platform_rest/instance_notification_rules.rb +136 -0
- data/lib/platform_rest/version.rb +1 -1
- data/lib/platform_rest.rb +2 -0
- data/schemas/apiTokenPost.json +9 -0
- data/schemas/applicationDashboardPost.json +94 -8
- data/schemas/applicationSearchResult.json +46 -6
- data/schemas/credentialLinkedResources.json +426 -0
- data/schemas/dashboard.json +94 -8
- data/schemas/dashboardPatch.json +94 -8
- data/schemas/dashboardPost.json +94 -8
- data/schemas/dashboards.json +94 -8
- data/schemas/experienceEndpoint.json +6 -1
- data/schemas/experienceEndpointPatch.json +6 -1
- data/schemas/experienceEndpointPost.json +6 -1
- data/schemas/experienceEndpoints.json +6 -1
- data/schemas/experienceLinkedResources.json +432 -1
- data/schemas/flow.json +142 -0
- data/schemas/flowPatch.json +142 -0
- data/schemas/flowPost.json +142 -0
- data/schemas/flowVersion.json +284 -0
- data/schemas/flowVersionPost.json +142 -0
- data/schemas/flowVersions.json +284 -0
- data/schemas/flows.json +142 -0
- data/schemas/flowsImportPost.json +284 -0
- data/schemas/flowsImportResult.json +426 -0
- data/schemas/githubLogin.json +9 -0
- data/schemas/instance.json +9 -0
- data/schemas/instanceAuditLog.json +2 -1
- data/schemas/instanceAuditLogFilter.json +2 -1
- data/schemas/instanceOrg.json +4 -0
- data/schemas/instanceOrgs.json +4 -0
- data/schemas/instances.json +9 -0
- data/schemas/notificationRule.json +161 -0
- data/schemas/notificationRuleDeliveryLogs.json +123 -0
- data/schemas/notificationRuleEvaluationOptions.json +10 -0
- data/schemas/notificationRulePatch.json +128 -0
- data/schemas/notificationRulePost.json +140 -0
- data/schemas/notificationRules.json +212 -0
- data/schemas/samlResponse.json +9 -0
- data/schemas/userCredentials.json +9 -0
- data/schemas/userPost.json +9 -0
- metadata +12 -2
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"items": {
|
|
6
|
+
"type": "array",
|
|
7
|
+
"items": {
|
|
8
|
+
"title": "Notification Rule",
|
|
9
|
+
"description": "Schema for a single notification rule",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"properties": {
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
15
|
+
},
|
|
16
|
+
"notificationRuleId": {
|
|
17
|
+
"type": "string",
|
|
18
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
19
|
+
},
|
|
20
|
+
"ownerId": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
23
|
+
},
|
|
24
|
+
"ownerType": {
|
|
25
|
+
"type": "string",
|
|
26
|
+
"enum": [
|
|
27
|
+
"instance"
|
|
28
|
+
]
|
|
29
|
+
},
|
|
30
|
+
"creationDate": {
|
|
31
|
+
"type": "string",
|
|
32
|
+
"format": "date-time"
|
|
33
|
+
},
|
|
34
|
+
"lastUpdated": {
|
|
35
|
+
"type": "string",
|
|
36
|
+
"format": "date-time"
|
|
37
|
+
},
|
|
38
|
+
"createdById": {
|
|
39
|
+
"type": "string",
|
|
40
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
41
|
+
},
|
|
42
|
+
"createdByType": {
|
|
43
|
+
"type": "string",
|
|
44
|
+
"enum": [
|
|
45
|
+
"apiToken",
|
|
46
|
+
"user"
|
|
47
|
+
]
|
|
48
|
+
},
|
|
49
|
+
"lastUpdatedById": {
|
|
50
|
+
"type": "string",
|
|
51
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
52
|
+
},
|
|
53
|
+
"lastUpdatedByType": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"enum": [
|
|
56
|
+
"apiToken",
|
|
57
|
+
"user"
|
|
58
|
+
]
|
|
59
|
+
},
|
|
60
|
+
"targetType": {
|
|
61
|
+
"type": "string",
|
|
62
|
+
"enum": [
|
|
63
|
+
"organization"
|
|
64
|
+
]
|
|
65
|
+
},
|
|
66
|
+
"targetQueryJson": {
|
|
67
|
+
"type": "string",
|
|
68
|
+
"maxLength": 8192
|
|
69
|
+
},
|
|
70
|
+
"name": {
|
|
71
|
+
"type": "string",
|
|
72
|
+
"minLength": 1,
|
|
73
|
+
"maxLength": 255
|
|
74
|
+
},
|
|
75
|
+
"description": {
|
|
76
|
+
"type": "string",
|
|
77
|
+
"maxLength": 32767
|
|
78
|
+
},
|
|
79
|
+
"enabled": {
|
|
80
|
+
"type": "boolean"
|
|
81
|
+
},
|
|
82
|
+
"callbackUrl": {
|
|
83
|
+
"type": "string",
|
|
84
|
+
"format": "uri",
|
|
85
|
+
"maxLength": 1024
|
|
86
|
+
},
|
|
87
|
+
"emailConfig": {
|
|
88
|
+
"type": "object",
|
|
89
|
+
"properties": {
|
|
90
|
+
"subjectTemplate": {
|
|
91
|
+
"type": "string",
|
|
92
|
+
"minLength": 1,
|
|
93
|
+
"maxLength": 1024
|
|
94
|
+
},
|
|
95
|
+
"bodyTemplate": {
|
|
96
|
+
"type": "string",
|
|
97
|
+
"maxLength": 32767
|
|
98
|
+
},
|
|
99
|
+
"sendToTarget": {
|
|
100
|
+
"type": "string",
|
|
101
|
+
"enum": [
|
|
102
|
+
"admins",
|
|
103
|
+
"members",
|
|
104
|
+
"none"
|
|
105
|
+
]
|
|
106
|
+
},
|
|
107
|
+
"sendToOwner": {
|
|
108
|
+
"type": "string",
|
|
109
|
+
"enum": [
|
|
110
|
+
"admins",
|
|
111
|
+
"members",
|
|
112
|
+
"none"
|
|
113
|
+
]
|
|
114
|
+
},
|
|
115
|
+
"sendToAddresses": {
|
|
116
|
+
"type": "array",
|
|
117
|
+
"maxItems": 10,
|
|
118
|
+
"items": {
|
|
119
|
+
"type": "string",
|
|
120
|
+
"format": "email",
|
|
121
|
+
"maxLength": 1024
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
},
|
|
125
|
+
"required": [
|
|
126
|
+
"subjectTemplate",
|
|
127
|
+
"bodyTemplate"
|
|
128
|
+
],
|
|
129
|
+
"additionalProperties": false
|
|
130
|
+
},
|
|
131
|
+
"ruleConfig": {
|
|
132
|
+
"type": "object",
|
|
133
|
+
"properties": {
|
|
134
|
+
"ruleType": {
|
|
135
|
+
"type": "string",
|
|
136
|
+
"enum": [
|
|
137
|
+
"payloadUsage",
|
|
138
|
+
"notebookMinuteUsage"
|
|
139
|
+
]
|
|
140
|
+
},
|
|
141
|
+
"thresholdType": {
|
|
142
|
+
"type": "string",
|
|
143
|
+
"enum": [
|
|
144
|
+
"percentOfLimit"
|
|
145
|
+
]
|
|
146
|
+
},
|
|
147
|
+
"threshold": {
|
|
148
|
+
"type": "number",
|
|
149
|
+
"minimum": 0,
|
|
150
|
+
"maximum": 1000
|
|
151
|
+
},
|
|
152
|
+
"maxFrequency": {
|
|
153
|
+
"type": "string",
|
|
154
|
+
"enum": [
|
|
155
|
+
"billingCycle",
|
|
156
|
+
"daily"
|
|
157
|
+
]
|
|
158
|
+
}
|
|
159
|
+
},
|
|
160
|
+
"required": [
|
|
161
|
+
"ruleType",
|
|
162
|
+
"thresholdType",
|
|
163
|
+
"threshold"
|
|
164
|
+
],
|
|
165
|
+
"additionalProperties": false
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
},
|
|
170
|
+
"count": {
|
|
171
|
+
"type": "integer"
|
|
172
|
+
},
|
|
173
|
+
"totalCount": {
|
|
174
|
+
"type": "integer"
|
|
175
|
+
},
|
|
176
|
+
"perPage": {
|
|
177
|
+
"type": "integer"
|
|
178
|
+
},
|
|
179
|
+
"page": {
|
|
180
|
+
"type": "integer"
|
|
181
|
+
},
|
|
182
|
+
"filter": {
|
|
183
|
+
"type": "string"
|
|
184
|
+
},
|
|
185
|
+
"filterField": {
|
|
186
|
+
"type": "string"
|
|
187
|
+
},
|
|
188
|
+
"sortField": {
|
|
189
|
+
"type": "string"
|
|
190
|
+
},
|
|
191
|
+
"sortDirection": {
|
|
192
|
+
"type": "string",
|
|
193
|
+
"enum": [
|
|
194
|
+
"asc",
|
|
195
|
+
"desc",
|
|
196
|
+
"ASC",
|
|
197
|
+
"DESC",
|
|
198
|
+
""
|
|
199
|
+
]
|
|
200
|
+
},
|
|
201
|
+
"ownerId": {
|
|
202
|
+
"type": "string",
|
|
203
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
204
|
+
},
|
|
205
|
+
"ownerType": {
|
|
206
|
+
"type": "string",
|
|
207
|
+
"enum": [
|
|
208
|
+
"instance"
|
|
209
|
+
]
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
}
|
data/schemas/samlResponse.json
CHANGED
|
@@ -427,6 +427,15 @@
|
|
|
427
427
|
"instanceCustomNode.delete",
|
|
428
428
|
"instanceCustomNode.errors",
|
|
429
429
|
"instanceCustomNode.stats",
|
|
430
|
+
"instanceNotificationRules.*",
|
|
431
|
+
"instanceNotificationRules.get",
|
|
432
|
+
"instanceNotificationRules.post",
|
|
433
|
+
"instanceNotificationRule.*",
|
|
434
|
+
"instanceNotificationRule.get",
|
|
435
|
+
"instanceNotificationRule.patch",
|
|
436
|
+
"instanceNotificationRule.delete",
|
|
437
|
+
"instanceNotificationRule.evaluate",
|
|
438
|
+
"instanceNotificationRule.logs",
|
|
430
439
|
"instanceSandbox.*",
|
|
431
440
|
"instanceSandbox.get",
|
|
432
441
|
"instanceSandbox.delete",
|
|
@@ -431,6 +431,15 @@
|
|
|
431
431
|
"instanceCustomNode.delete",
|
|
432
432
|
"instanceCustomNode.errors",
|
|
433
433
|
"instanceCustomNode.stats",
|
|
434
|
+
"instanceNotificationRules.*",
|
|
435
|
+
"instanceNotificationRules.get",
|
|
436
|
+
"instanceNotificationRules.post",
|
|
437
|
+
"instanceNotificationRule.*",
|
|
438
|
+
"instanceNotificationRule.get",
|
|
439
|
+
"instanceNotificationRule.patch",
|
|
440
|
+
"instanceNotificationRule.delete",
|
|
441
|
+
"instanceNotificationRule.evaluate",
|
|
442
|
+
"instanceNotificationRule.logs",
|
|
434
443
|
"instanceSandbox.*",
|
|
435
444
|
"instanceSandbox.get",
|
|
436
445
|
"instanceSandbox.delete",
|
data/schemas/userPost.json
CHANGED
|
@@ -489,6 +489,15 @@
|
|
|
489
489
|
"instanceCustomNode.delete",
|
|
490
490
|
"instanceCustomNode.errors",
|
|
491
491
|
"instanceCustomNode.stats",
|
|
492
|
+
"instanceNotificationRules.*",
|
|
493
|
+
"instanceNotificationRules.get",
|
|
494
|
+
"instanceNotificationRules.post",
|
|
495
|
+
"instanceNotificationRule.*",
|
|
496
|
+
"instanceNotificationRule.get",
|
|
497
|
+
"instanceNotificationRule.patch",
|
|
498
|
+
"instanceNotificationRule.delete",
|
|
499
|
+
"instanceNotificationRule.evaluate",
|
|
500
|
+
"instanceNotificationRule.logs",
|
|
492
501
|
"instanceSandbox.*",
|
|
493
502
|
"instanceSandbox.get",
|
|
494
503
|
"instanceSandbox.delete",
|
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.
|
|
4
|
+
version: 1.21.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Michael Kuehl
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2024-
|
|
11
|
+
date: 2024-11-05 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: httparty
|
|
@@ -148,6 +148,8 @@ files:
|
|
|
148
148
|
- docs/instanceCustomNodes.md
|
|
149
149
|
- docs/instanceMember.md
|
|
150
150
|
- docs/instanceMembers.md
|
|
151
|
+
- docs/instanceNotificationRule.md
|
|
152
|
+
- docs/instanceNotificationRules.md
|
|
151
153
|
- docs/instanceOrg.md
|
|
152
154
|
- docs/instanceOrgInvite.md
|
|
153
155
|
- docs/instanceOrgInvites.md
|
|
@@ -242,6 +244,8 @@ files:
|
|
|
242
244
|
- lib/platform_rest/instance_custom_nodes.rb
|
|
243
245
|
- lib/platform_rest/instance_member.rb
|
|
244
246
|
- lib/platform_rest/instance_members.rb
|
|
247
|
+
- lib/platform_rest/instance_notification_rule.rb
|
|
248
|
+
- lib/platform_rest/instance_notification_rules.rb
|
|
245
249
|
- lib/platform_rest/instance_org.rb
|
|
246
250
|
- lib/platform_rest/instance_org_invite.rb
|
|
247
251
|
- lib/platform_rest/instance_org_invites.rb
|
|
@@ -519,6 +523,12 @@ files:
|
|
|
519
523
|
- schemas/notebookPatch.json
|
|
520
524
|
- schemas/notebookPost.json
|
|
521
525
|
- schemas/notebooks.json
|
|
526
|
+
- schemas/notificationRule.json
|
|
527
|
+
- schemas/notificationRuleDeliveryLogs.json
|
|
528
|
+
- schemas/notificationRuleEvaluationOptions.json
|
|
529
|
+
- schemas/notificationRulePatch.json
|
|
530
|
+
- schemas/notificationRulePost.json
|
|
531
|
+
- schemas/notificationRules.json
|
|
522
532
|
- schemas/org.json
|
|
523
533
|
- schemas/orgInvite.json
|
|
524
534
|
- schemas/orgInviteAction.json
|