losant_rest 1.20.1 → 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 +1413 -17
- 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/applicationSearchResult.json +46 -6
- data/schemas/credentialLinkedResources.json +12 -0
- 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 +18 -1
- data/schemas/flow.json +4 -0
- data/schemas/flowPatch.json +4 -0
- data/schemas/flowPost.json +4 -0
- data/schemas/flowVersion.json +8 -0
- data/schemas/flowVersionPost.json +4 -0
- data/schemas/flowVersions.json +8 -0
- data/schemas/flows.json +4 -0
- data/schemas/flowsImportPost.json +8 -0
- data/schemas/flowsImportResult.json +12 -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,161 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"id": {
|
|
6
|
+
"type": "string",
|
|
7
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
8
|
+
},
|
|
9
|
+
"notificationRuleId": {
|
|
10
|
+
"type": "string",
|
|
11
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
12
|
+
},
|
|
13
|
+
"ownerId": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
16
|
+
},
|
|
17
|
+
"ownerType": {
|
|
18
|
+
"type": "string",
|
|
19
|
+
"enum": [
|
|
20
|
+
"instance"
|
|
21
|
+
]
|
|
22
|
+
},
|
|
23
|
+
"creationDate": {
|
|
24
|
+
"type": "string",
|
|
25
|
+
"format": "date-time"
|
|
26
|
+
},
|
|
27
|
+
"lastUpdated": {
|
|
28
|
+
"type": "string",
|
|
29
|
+
"format": "date-time"
|
|
30
|
+
},
|
|
31
|
+
"createdById": {
|
|
32
|
+
"type": "string",
|
|
33
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
34
|
+
},
|
|
35
|
+
"createdByType": {
|
|
36
|
+
"type": "string",
|
|
37
|
+
"enum": [
|
|
38
|
+
"apiToken",
|
|
39
|
+
"user"
|
|
40
|
+
]
|
|
41
|
+
},
|
|
42
|
+
"lastUpdatedById": {
|
|
43
|
+
"type": "string",
|
|
44
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
45
|
+
},
|
|
46
|
+
"lastUpdatedByType": {
|
|
47
|
+
"type": "string",
|
|
48
|
+
"enum": [
|
|
49
|
+
"apiToken",
|
|
50
|
+
"user"
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
"targetType": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"enum": [
|
|
56
|
+
"organization"
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
"targetQueryJson": {
|
|
60
|
+
"type": "string",
|
|
61
|
+
"maxLength": 8192
|
|
62
|
+
},
|
|
63
|
+
"name": {
|
|
64
|
+
"type": "string",
|
|
65
|
+
"minLength": 1,
|
|
66
|
+
"maxLength": 255
|
|
67
|
+
},
|
|
68
|
+
"description": {
|
|
69
|
+
"type": "string",
|
|
70
|
+
"maxLength": 32767
|
|
71
|
+
},
|
|
72
|
+
"enabled": {
|
|
73
|
+
"type": "boolean"
|
|
74
|
+
},
|
|
75
|
+
"callbackUrl": {
|
|
76
|
+
"type": "string",
|
|
77
|
+
"format": "uri",
|
|
78
|
+
"maxLength": 1024
|
|
79
|
+
},
|
|
80
|
+
"emailConfig": {
|
|
81
|
+
"type": "object",
|
|
82
|
+
"properties": {
|
|
83
|
+
"subjectTemplate": {
|
|
84
|
+
"type": "string",
|
|
85
|
+
"minLength": 1,
|
|
86
|
+
"maxLength": 1024
|
|
87
|
+
},
|
|
88
|
+
"bodyTemplate": {
|
|
89
|
+
"type": "string",
|
|
90
|
+
"maxLength": 32767
|
|
91
|
+
},
|
|
92
|
+
"sendToTarget": {
|
|
93
|
+
"type": "string",
|
|
94
|
+
"enum": [
|
|
95
|
+
"admins",
|
|
96
|
+
"members",
|
|
97
|
+
"none"
|
|
98
|
+
]
|
|
99
|
+
},
|
|
100
|
+
"sendToOwner": {
|
|
101
|
+
"type": "string",
|
|
102
|
+
"enum": [
|
|
103
|
+
"admins",
|
|
104
|
+
"members",
|
|
105
|
+
"none"
|
|
106
|
+
]
|
|
107
|
+
},
|
|
108
|
+
"sendToAddresses": {
|
|
109
|
+
"type": "array",
|
|
110
|
+
"maxItems": 10,
|
|
111
|
+
"items": {
|
|
112
|
+
"type": "string",
|
|
113
|
+
"format": "email",
|
|
114
|
+
"maxLength": 1024
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
},
|
|
118
|
+
"required": [
|
|
119
|
+
"subjectTemplate",
|
|
120
|
+
"bodyTemplate"
|
|
121
|
+
],
|
|
122
|
+
"additionalProperties": false
|
|
123
|
+
},
|
|
124
|
+
"ruleConfig": {
|
|
125
|
+
"type": "object",
|
|
126
|
+
"properties": {
|
|
127
|
+
"ruleType": {
|
|
128
|
+
"type": "string",
|
|
129
|
+
"enum": [
|
|
130
|
+
"payloadUsage",
|
|
131
|
+
"notebookMinuteUsage"
|
|
132
|
+
]
|
|
133
|
+
},
|
|
134
|
+
"thresholdType": {
|
|
135
|
+
"type": "string",
|
|
136
|
+
"enum": [
|
|
137
|
+
"percentOfLimit"
|
|
138
|
+
]
|
|
139
|
+
},
|
|
140
|
+
"threshold": {
|
|
141
|
+
"type": "number",
|
|
142
|
+
"minimum": 0,
|
|
143
|
+
"maximum": 1000
|
|
144
|
+
},
|
|
145
|
+
"maxFrequency": {
|
|
146
|
+
"type": "string",
|
|
147
|
+
"enum": [
|
|
148
|
+
"billingCycle",
|
|
149
|
+
"daily"
|
|
150
|
+
]
|
|
151
|
+
}
|
|
152
|
+
},
|
|
153
|
+
"required": [
|
|
154
|
+
"ruleType",
|
|
155
|
+
"thresholdType",
|
|
156
|
+
"threshold"
|
|
157
|
+
],
|
|
158
|
+
"additionalProperties": false
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
}
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"type": "array",
|
|
4
|
+
"items": {
|
|
5
|
+
"type": "object",
|
|
6
|
+
"properties": {
|
|
7
|
+
"id": {
|
|
8
|
+
"type": "string",
|
|
9
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
10
|
+
},
|
|
11
|
+
"notificationRuleDeliveryId": {
|
|
12
|
+
"type": "string",
|
|
13
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
14
|
+
},
|
|
15
|
+
"notificationRuleId": {
|
|
16
|
+
"type": "string",
|
|
17
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
18
|
+
},
|
|
19
|
+
"ownerId": {
|
|
20
|
+
"type": "string",
|
|
21
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
22
|
+
},
|
|
23
|
+
"ownerType": {
|
|
24
|
+
"type": "string",
|
|
25
|
+
"enum": [
|
|
26
|
+
"instance"
|
|
27
|
+
]
|
|
28
|
+
},
|
|
29
|
+
"requestedById": {
|
|
30
|
+
"type": "string",
|
|
31
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
32
|
+
},
|
|
33
|
+
"requestedByType": {
|
|
34
|
+
"type": "string",
|
|
35
|
+
"enum": [
|
|
36
|
+
"user",
|
|
37
|
+
"apiToken",
|
|
38
|
+
"system"
|
|
39
|
+
]
|
|
40
|
+
},
|
|
41
|
+
"sentAt": {
|
|
42
|
+
"type": "string",
|
|
43
|
+
"format": "date-time"
|
|
44
|
+
},
|
|
45
|
+
"targetType": {
|
|
46
|
+
"type": "string",
|
|
47
|
+
"enum": [
|
|
48
|
+
"organization"
|
|
49
|
+
]
|
|
50
|
+
},
|
|
51
|
+
"targetId": {
|
|
52
|
+
"type": "string",
|
|
53
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
54
|
+
},
|
|
55
|
+
"targetName": {
|
|
56
|
+
"type": "string",
|
|
57
|
+
"minLength": 1,
|
|
58
|
+
"maxLength": 255
|
|
59
|
+
},
|
|
60
|
+
"callbackUrl": {
|
|
61
|
+
"type": "string",
|
|
62
|
+
"format": "uri",
|
|
63
|
+
"maxLength": 1024
|
|
64
|
+
},
|
|
65
|
+
"email": {
|
|
66
|
+
"type": "object",
|
|
67
|
+
"properties": {
|
|
68
|
+
"subject": {
|
|
69
|
+
"type": "string"
|
|
70
|
+
},
|
|
71
|
+
"body": {
|
|
72
|
+
"type": "string"
|
|
73
|
+
},
|
|
74
|
+
"addresses": {
|
|
75
|
+
"type": "array",
|
|
76
|
+
"items": {
|
|
77
|
+
"type": "string",
|
|
78
|
+
"format": "email",
|
|
79
|
+
"maxLength": 1024
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
},
|
|
84
|
+
"evaluation": {
|
|
85
|
+
"type": "object",
|
|
86
|
+
"properties": {
|
|
87
|
+
"value": {
|
|
88
|
+
"type": "number"
|
|
89
|
+
},
|
|
90
|
+
"limit": {
|
|
91
|
+
"type": "number"
|
|
92
|
+
},
|
|
93
|
+
"ruleType": {
|
|
94
|
+
"type": "string",
|
|
95
|
+
"enum": [
|
|
96
|
+
"payloadUsage",
|
|
97
|
+
"notebookMinuteUsage"
|
|
98
|
+
]
|
|
99
|
+
},
|
|
100
|
+
"thresholdType": {
|
|
101
|
+
"type": "string",
|
|
102
|
+
"enum": [
|
|
103
|
+
"percentOfLimit"
|
|
104
|
+
]
|
|
105
|
+
},
|
|
106
|
+
"threshold": {
|
|
107
|
+
"type": "number",
|
|
108
|
+
"minimum": 0,
|
|
109
|
+
"maximum": 1000
|
|
110
|
+
},
|
|
111
|
+
"maxFrequency": {
|
|
112
|
+
"type": "string",
|
|
113
|
+
"enum": [
|
|
114
|
+
"billingCycle",
|
|
115
|
+
"daily",
|
|
116
|
+
"unlimited"
|
|
117
|
+
]
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"targetQueryJson": {
|
|
6
|
+
"type": "string",
|
|
7
|
+
"maxLength": 8192
|
|
8
|
+
},
|
|
9
|
+
"name": {
|
|
10
|
+
"type": "string",
|
|
11
|
+
"minLength": 1,
|
|
12
|
+
"maxLength": 255
|
|
13
|
+
},
|
|
14
|
+
"description": {
|
|
15
|
+
"type": "string",
|
|
16
|
+
"maxLength": 32767
|
|
17
|
+
},
|
|
18
|
+
"enabled": {
|
|
19
|
+
"type": "boolean"
|
|
20
|
+
},
|
|
21
|
+
"callbackUrl": {
|
|
22
|
+
"oneOf": [
|
|
23
|
+
{
|
|
24
|
+
"type": "string",
|
|
25
|
+
"format": "uri",
|
|
26
|
+
"maxLength": 1024
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"type": "null"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"type": "string",
|
|
33
|
+
"enum": [
|
|
34
|
+
""
|
|
35
|
+
]
|
|
36
|
+
}
|
|
37
|
+
]
|
|
38
|
+
},
|
|
39
|
+
"emailConfig": {
|
|
40
|
+
"oneOf": [
|
|
41
|
+
{
|
|
42
|
+
"type": "object",
|
|
43
|
+
"properties": {
|
|
44
|
+
"subjectTemplate": {
|
|
45
|
+
"type": "string",
|
|
46
|
+
"minLength": 1,
|
|
47
|
+
"maxLength": 1024
|
|
48
|
+
},
|
|
49
|
+
"bodyTemplate": {
|
|
50
|
+
"type": "string",
|
|
51
|
+
"maxLength": 32767
|
|
52
|
+
},
|
|
53
|
+
"sendToTarget": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"enum": [
|
|
56
|
+
"admins",
|
|
57
|
+
"members",
|
|
58
|
+
"none"
|
|
59
|
+
]
|
|
60
|
+
},
|
|
61
|
+
"sendToOwner": {
|
|
62
|
+
"type": "string",
|
|
63
|
+
"enum": [
|
|
64
|
+
"admins",
|
|
65
|
+
"members",
|
|
66
|
+
"none"
|
|
67
|
+
]
|
|
68
|
+
},
|
|
69
|
+
"sendToAddresses": {
|
|
70
|
+
"type": "array",
|
|
71
|
+
"maxItems": 10,
|
|
72
|
+
"items": {
|
|
73
|
+
"type": "string",
|
|
74
|
+
"format": "email",
|
|
75
|
+
"maxLength": 1024
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
},
|
|
79
|
+
"required": [
|
|
80
|
+
"subjectTemplate",
|
|
81
|
+
"bodyTemplate"
|
|
82
|
+
],
|
|
83
|
+
"additionalProperties": false
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"type": "null"
|
|
87
|
+
}
|
|
88
|
+
]
|
|
89
|
+
},
|
|
90
|
+
"ruleConfig": {
|
|
91
|
+
"type": "object",
|
|
92
|
+
"properties": {
|
|
93
|
+
"ruleType": {
|
|
94
|
+
"type": "string",
|
|
95
|
+
"enum": [
|
|
96
|
+
"payloadUsage",
|
|
97
|
+
"notebookMinuteUsage"
|
|
98
|
+
]
|
|
99
|
+
},
|
|
100
|
+
"thresholdType": {
|
|
101
|
+
"type": "string",
|
|
102
|
+
"enum": [
|
|
103
|
+
"percentOfLimit"
|
|
104
|
+
]
|
|
105
|
+
},
|
|
106
|
+
"threshold": {
|
|
107
|
+
"type": "number",
|
|
108
|
+
"minimum": 0,
|
|
109
|
+
"maximum": 1000
|
|
110
|
+
},
|
|
111
|
+
"maxFrequency": {
|
|
112
|
+
"type": "string",
|
|
113
|
+
"enum": [
|
|
114
|
+
"billingCycle",
|
|
115
|
+
"daily"
|
|
116
|
+
]
|
|
117
|
+
}
|
|
118
|
+
},
|
|
119
|
+
"required": [
|
|
120
|
+
"ruleType",
|
|
121
|
+
"thresholdType",
|
|
122
|
+
"threshold"
|
|
123
|
+
],
|
|
124
|
+
"additionalProperties": false
|
|
125
|
+
}
|
|
126
|
+
},
|
|
127
|
+
"additionalProperties": false
|
|
128
|
+
}
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"targetType": {
|
|
6
|
+
"type": "string",
|
|
7
|
+
"enum": [
|
|
8
|
+
"organization"
|
|
9
|
+
]
|
|
10
|
+
},
|
|
11
|
+
"targetQueryJson": {
|
|
12
|
+
"type": "string",
|
|
13
|
+
"maxLength": 8192
|
|
14
|
+
},
|
|
15
|
+
"name": {
|
|
16
|
+
"type": "string",
|
|
17
|
+
"minLength": 1,
|
|
18
|
+
"maxLength": 255
|
|
19
|
+
},
|
|
20
|
+
"description": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"maxLength": 32767
|
|
23
|
+
},
|
|
24
|
+
"enabled": {
|
|
25
|
+
"type": "boolean"
|
|
26
|
+
},
|
|
27
|
+
"callbackUrl": {
|
|
28
|
+
"oneOf": [
|
|
29
|
+
{
|
|
30
|
+
"type": "string",
|
|
31
|
+
"format": "uri",
|
|
32
|
+
"maxLength": 1024
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"type": "null"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"type": "string",
|
|
39
|
+
"enum": [
|
|
40
|
+
""
|
|
41
|
+
]
|
|
42
|
+
}
|
|
43
|
+
]
|
|
44
|
+
},
|
|
45
|
+
"emailConfig": {
|
|
46
|
+
"oneOf": [
|
|
47
|
+
{
|
|
48
|
+
"type": "object",
|
|
49
|
+
"properties": {
|
|
50
|
+
"subjectTemplate": {
|
|
51
|
+
"type": "string",
|
|
52
|
+
"minLength": 1,
|
|
53
|
+
"maxLength": 1024
|
|
54
|
+
},
|
|
55
|
+
"bodyTemplate": {
|
|
56
|
+
"type": "string",
|
|
57
|
+
"maxLength": 32767
|
|
58
|
+
},
|
|
59
|
+
"sendToTarget": {
|
|
60
|
+
"type": "string",
|
|
61
|
+
"enum": [
|
|
62
|
+
"admins",
|
|
63
|
+
"members",
|
|
64
|
+
"none"
|
|
65
|
+
]
|
|
66
|
+
},
|
|
67
|
+
"sendToOwner": {
|
|
68
|
+
"type": "string",
|
|
69
|
+
"enum": [
|
|
70
|
+
"admins",
|
|
71
|
+
"members",
|
|
72
|
+
"none"
|
|
73
|
+
]
|
|
74
|
+
},
|
|
75
|
+
"sendToAddresses": {
|
|
76
|
+
"type": "array",
|
|
77
|
+
"maxItems": 10,
|
|
78
|
+
"items": {
|
|
79
|
+
"type": "string",
|
|
80
|
+
"format": "email",
|
|
81
|
+
"maxLength": 1024
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
},
|
|
85
|
+
"required": [
|
|
86
|
+
"subjectTemplate",
|
|
87
|
+
"bodyTemplate"
|
|
88
|
+
],
|
|
89
|
+
"additionalProperties": false
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"type": "null"
|
|
93
|
+
}
|
|
94
|
+
]
|
|
95
|
+
},
|
|
96
|
+
"ruleConfig": {
|
|
97
|
+
"type": "object",
|
|
98
|
+
"properties": {
|
|
99
|
+
"ruleType": {
|
|
100
|
+
"type": "string",
|
|
101
|
+
"enum": [
|
|
102
|
+
"payloadUsage",
|
|
103
|
+
"notebookMinuteUsage"
|
|
104
|
+
]
|
|
105
|
+
},
|
|
106
|
+
"thresholdType": {
|
|
107
|
+
"type": "string",
|
|
108
|
+
"enum": [
|
|
109
|
+
"percentOfLimit"
|
|
110
|
+
]
|
|
111
|
+
},
|
|
112
|
+
"threshold": {
|
|
113
|
+
"type": "number",
|
|
114
|
+
"minimum": 0,
|
|
115
|
+
"maximum": 1000
|
|
116
|
+
},
|
|
117
|
+
"maxFrequency": {
|
|
118
|
+
"type": "string",
|
|
119
|
+
"enum": [
|
|
120
|
+
"billingCycle",
|
|
121
|
+
"daily"
|
|
122
|
+
]
|
|
123
|
+
}
|
|
124
|
+
},
|
|
125
|
+
"required": [
|
|
126
|
+
"ruleType",
|
|
127
|
+
"thresholdType",
|
|
128
|
+
"threshold"
|
|
129
|
+
],
|
|
130
|
+
"additionalProperties": false
|
|
131
|
+
}
|
|
132
|
+
},
|
|
133
|
+
"additionalProperties": false,
|
|
134
|
+
"required": [
|
|
135
|
+
"targetType",
|
|
136
|
+
"targetQueryJson",
|
|
137
|
+
"name",
|
|
138
|
+
"ruleConfig"
|
|
139
|
+
]
|
|
140
|
+
}
|