@timebyping/configuration-service-sdk 7.68.0 → 7.69.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +4648 -1015
- package/dist/index.js +131 -30
- package/dist/index.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/openapi.json +1548 -626
- package/package.json +1 -1
- package/src/index.ts +267 -35
package/openapi.json
CHANGED
|
@@ -1,326 +1,208 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.0",
|
|
3
3
|
"paths": {
|
|
4
|
-
"/api/v1/
|
|
4
|
+
"/api/v1/global": {
|
|
5
5
|
"post": {
|
|
6
|
-
"operationId": "
|
|
7
|
-
"parameters": [
|
|
8
|
-
{
|
|
9
|
-
"name": "customerId",
|
|
10
|
-
"required": true,
|
|
11
|
-
"in": "path",
|
|
12
|
-
"schema": {
|
|
13
|
-
"type": "string"
|
|
14
|
-
}
|
|
15
|
-
},
|
|
16
|
-
{
|
|
17
|
-
"name": "userId",
|
|
18
|
-
"required": true,
|
|
19
|
-
"in": "path",
|
|
20
|
-
"schema": {
|
|
21
|
-
"type": "string"
|
|
22
|
-
}
|
|
23
|
-
}
|
|
24
|
-
],
|
|
6
|
+
"operationId": "GlobalConfigController_createGlobalConfig_v1",
|
|
7
|
+
"parameters": [],
|
|
25
8
|
"requestBody": {
|
|
26
9
|
"required": true,
|
|
27
10
|
"content": {
|
|
28
11
|
"application/json": {
|
|
29
12
|
"schema": {
|
|
30
|
-
"$ref": "#/components/schemas/
|
|
13
|
+
"$ref": "#/components/schemas/GlobalConfigCreateDto"
|
|
31
14
|
}
|
|
32
15
|
}
|
|
33
16
|
}
|
|
34
17
|
},
|
|
35
18
|
"responses": {
|
|
36
19
|
"201": {
|
|
37
|
-
"description": "Returns the created
|
|
20
|
+
"description": "Returns the created global configuration",
|
|
38
21
|
"content": {
|
|
39
22
|
"application/json": {
|
|
40
23
|
"schema": {
|
|
41
|
-
"$ref": "#/components/schemas/
|
|
24
|
+
"$ref": "#/components/schemas/GlobalConfig"
|
|
42
25
|
}
|
|
43
26
|
}
|
|
44
27
|
}
|
|
45
28
|
},
|
|
46
29
|
"403": {
|
|
47
|
-
"description": "Not authorized to create
|
|
30
|
+
"description": "Not authorized to create global configuration"
|
|
48
31
|
},
|
|
49
32
|
"409": {
|
|
50
|
-
"description": "
|
|
33
|
+
"description": "Global configuration already exists"
|
|
51
34
|
}
|
|
52
35
|
},
|
|
53
|
-
"summary": "Create
|
|
36
|
+
"summary": "Create global configuration for current environment",
|
|
54
37
|
"tags": [
|
|
55
|
-
"
|
|
38
|
+
"Global Configuration"
|
|
56
39
|
]
|
|
57
40
|
},
|
|
58
41
|
"get": {
|
|
59
|
-
"operationId": "
|
|
60
|
-
"parameters": [
|
|
61
|
-
{
|
|
62
|
-
"name": "customerId",
|
|
63
|
-
"required": true,
|
|
64
|
-
"in": "path",
|
|
65
|
-
"schema": {
|
|
66
|
-
"format": "objectid",
|
|
67
|
-
"type": "string"
|
|
68
|
-
}
|
|
69
|
-
},
|
|
70
|
-
{
|
|
71
|
-
"name": "userId",
|
|
72
|
-
"required": true,
|
|
73
|
-
"in": "path",
|
|
74
|
-
"schema": {
|
|
75
|
-
"format": "objectid",
|
|
76
|
-
"type": "string"
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
],
|
|
42
|
+
"operationId": "GlobalConfigController_getGlobalConfig_v1",
|
|
43
|
+
"parameters": [],
|
|
80
44
|
"responses": {
|
|
81
45
|
"200": {
|
|
82
|
-
"description": "",
|
|
46
|
+
"description": "Returns the global configuration",
|
|
83
47
|
"content": {
|
|
84
48
|
"application/json": {
|
|
85
49
|
"schema": {
|
|
86
|
-
"$ref": "#/components/schemas/
|
|
50
|
+
"$ref": "#/components/schemas/GlobalConfig"
|
|
87
51
|
}
|
|
88
52
|
}
|
|
89
53
|
}
|
|
54
|
+
},
|
|
55
|
+
"404": {
|
|
56
|
+
"description": "Global configuration not found"
|
|
90
57
|
}
|
|
91
58
|
},
|
|
59
|
+
"summary": "Get global configuration for current environment",
|
|
92
60
|
"tags": [
|
|
93
|
-
"
|
|
61
|
+
"Global Configuration"
|
|
94
62
|
]
|
|
95
63
|
},
|
|
96
64
|
"patch": {
|
|
97
|
-
"operationId": "
|
|
98
|
-
"parameters": [
|
|
99
|
-
{
|
|
100
|
-
"name": "customerId",
|
|
101
|
-
"required": true,
|
|
102
|
-
"in": "path",
|
|
103
|
-
"schema": {
|
|
104
|
-
"format": "objectid",
|
|
105
|
-
"type": "string"
|
|
106
|
-
}
|
|
107
|
-
},
|
|
108
|
-
{
|
|
109
|
-
"name": "userId",
|
|
110
|
-
"required": true,
|
|
111
|
-
"in": "path",
|
|
112
|
-
"schema": {
|
|
113
|
-
"format": "objectid",
|
|
114
|
-
"type": "string"
|
|
115
|
-
}
|
|
116
|
-
}
|
|
117
|
-
],
|
|
65
|
+
"operationId": "GlobalConfigController_updateGlobalConfig_v1",
|
|
66
|
+
"parameters": [],
|
|
118
67
|
"requestBody": {
|
|
119
68
|
"required": true,
|
|
120
69
|
"content": {
|
|
121
70
|
"application/json": {
|
|
122
71
|
"schema": {
|
|
123
|
-
"$ref": "#/components/schemas/
|
|
72
|
+
"$ref": "#/components/schemas/GlobalConfigUpdateDto"
|
|
124
73
|
}
|
|
125
74
|
}
|
|
126
75
|
}
|
|
127
76
|
},
|
|
128
77
|
"responses": {
|
|
129
78
|
"200": {
|
|
130
|
-
"description": "Returns the updated
|
|
79
|
+
"description": "Returns the updated global configuration",
|
|
131
80
|
"content": {
|
|
132
81
|
"application/json": {
|
|
133
82
|
"schema": {
|
|
134
|
-
"$ref": "#/components/schemas/
|
|
83
|
+
"$ref": "#/components/schemas/GlobalConfig"
|
|
135
84
|
}
|
|
136
85
|
}
|
|
137
86
|
}
|
|
138
87
|
},
|
|
139
88
|
"403": {
|
|
140
|
-
"description": "Not authorized to
|
|
89
|
+
"description": "Not authorized to update global configuration"
|
|
141
90
|
},
|
|
142
91
|
"404": {
|
|
143
|
-
"description": "
|
|
144
|
-
}
|
|
145
|
-
},
|
|
146
|
-
"summary": "Update user configuration by customerId and userId",
|
|
147
|
-
"tags": [
|
|
148
|
-
"Users Configuration"
|
|
149
|
-
]
|
|
150
|
-
}
|
|
151
|
-
},
|
|
152
|
-
"/api/v1/customers/{customerId}/users/{userId}/timezone": {
|
|
153
|
-
"get": {
|
|
154
|
-
"operationId": "UserConfigController_getUserTimeZone_v1",
|
|
155
|
-
"parameters": [
|
|
156
|
-
{
|
|
157
|
-
"name": "customerId",
|
|
158
|
-
"required": true,
|
|
159
|
-
"in": "path",
|
|
160
|
-
"schema": {
|
|
161
|
-
"format": "objectid",
|
|
162
|
-
"type": "string"
|
|
163
|
-
}
|
|
164
|
-
},
|
|
165
|
-
{
|
|
166
|
-
"name": "userId",
|
|
167
|
-
"required": true,
|
|
168
|
-
"in": "path",
|
|
169
|
-
"schema": {
|
|
170
|
-
"format": "objectid",
|
|
171
|
-
"type": "string"
|
|
172
|
-
}
|
|
173
|
-
}
|
|
174
|
-
],
|
|
175
|
-
"responses": {
|
|
176
|
-
"200": {
|
|
177
|
-
"description": "",
|
|
178
|
-
"content": {
|
|
179
|
-
"application/json": {
|
|
180
|
-
"schema": {
|
|
181
|
-
"$ref": "#/components/schemas/TimeZoneEntity"
|
|
182
|
-
}
|
|
183
|
-
}
|
|
184
|
-
}
|
|
92
|
+
"description": "Global configuration not found"
|
|
185
93
|
}
|
|
186
94
|
},
|
|
95
|
+
"summary": "Update global configuration for current environment",
|
|
187
96
|
"tags": [
|
|
188
|
-
"
|
|
97
|
+
"Global Configuration"
|
|
189
98
|
]
|
|
190
99
|
}
|
|
191
100
|
},
|
|
192
|
-
"/api/v1/
|
|
193
|
-
"
|
|
194
|
-
"operationId": "
|
|
195
|
-
"parameters": [],
|
|
196
|
-
"responses": {
|
|
197
|
-
"200": {
|
|
198
|
-
"description": "Returns the custom filters",
|
|
199
|
-
"content": {
|
|
200
|
-
"application/json": {
|
|
201
|
-
"schema": {
|
|
202
|
-
"type": "array",
|
|
203
|
-
"items": {
|
|
204
|
-
"$ref": "#/components/schemas/WebappWorkActivityCustomFilter"
|
|
205
|
-
}
|
|
206
|
-
}
|
|
207
|
-
}
|
|
208
|
-
}
|
|
209
|
-
},
|
|
210
|
-
"403": {
|
|
211
|
-
"description": "Not authorized"
|
|
212
|
-
},
|
|
213
|
-
"404": {
|
|
214
|
-
"description": "User configuration not found"
|
|
215
|
-
}
|
|
216
|
-
},
|
|
217
|
-
"summary": "Get custom activity filters for the current user",
|
|
218
|
-
"tags": [
|
|
219
|
-
"User Self Configuration"
|
|
220
|
-
]
|
|
221
|
-
},
|
|
222
|
-
"patch": {
|
|
223
|
-
"operationId": "UserSelfConfigController_updateCustomFilters_v1",
|
|
101
|
+
"/api/v1/tenants": {
|
|
102
|
+
"post": {
|
|
103
|
+
"operationId": "TenantConfigController_create_v1",
|
|
224
104
|
"parameters": [],
|
|
225
105
|
"requestBody": {
|
|
226
106
|
"required": true,
|
|
227
107
|
"content": {
|
|
228
108
|
"application/json": {
|
|
229
109
|
"schema": {
|
|
230
|
-
"$ref": "#/components/schemas/
|
|
110
|
+
"$ref": "#/components/schemas/TenantConfigCreateDto"
|
|
231
111
|
}
|
|
232
112
|
}
|
|
233
113
|
}
|
|
234
114
|
},
|
|
235
115
|
"responses": {
|
|
236
|
-
"
|
|
237
|
-
"description": "Returns the
|
|
116
|
+
"201": {
|
|
117
|
+
"description": "Returns the created tenant configuration",
|
|
238
118
|
"content": {
|
|
239
119
|
"application/json": {
|
|
240
120
|
"schema": {
|
|
241
|
-
"
|
|
242
|
-
"items": {
|
|
243
|
-
"$ref": "#/components/schemas/WebappWorkActivityCustomFilter"
|
|
244
|
-
}
|
|
121
|
+
"$ref": "#/components/schemas/TenantConfig"
|
|
245
122
|
}
|
|
246
123
|
}
|
|
247
124
|
}
|
|
248
125
|
},
|
|
249
126
|
"403": {
|
|
250
|
-
"description": "Not authorized"
|
|
127
|
+
"description": "Not authorized to create tenant configuration"
|
|
251
128
|
},
|
|
252
|
-
"
|
|
253
|
-
"description": "
|
|
129
|
+
"409": {
|
|
130
|
+
"description": "Tenant configuration already exists"
|
|
254
131
|
}
|
|
255
132
|
},
|
|
256
|
-
"summary": "
|
|
133
|
+
"summary": "Create tenant configuration",
|
|
257
134
|
"tags": [
|
|
258
|
-
"
|
|
135
|
+
"Tenant Configuration"
|
|
259
136
|
]
|
|
260
|
-
}
|
|
261
|
-
},
|
|
262
|
-
"/api/v1/users/me": {
|
|
137
|
+
},
|
|
263
138
|
"get": {
|
|
264
|
-
"operationId": "
|
|
139
|
+
"operationId": "TenantConfigController_getTenantConfigs_v1",
|
|
265
140
|
"parameters": [],
|
|
266
141
|
"responses": {
|
|
267
142
|
"200": {
|
|
268
|
-
"description": "Returns
|
|
143
|
+
"description": "Returns all tenant configurations",
|
|
269
144
|
"content": {
|
|
270
145
|
"application/json": {
|
|
271
146
|
"schema": {
|
|
272
|
-
"
|
|
147
|
+
"type": "array",
|
|
148
|
+
"items": {
|
|
149
|
+
"$ref": "#/components/schemas/TenantConfig"
|
|
150
|
+
}
|
|
273
151
|
}
|
|
274
152
|
}
|
|
275
153
|
}
|
|
276
154
|
},
|
|
277
155
|
"403": {
|
|
278
|
-
"description": "Not authorized"
|
|
279
|
-
},
|
|
280
|
-
"404": {
|
|
281
|
-
"description": "User configuration not found"
|
|
156
|
+
"description": "Not authorized to access tenant configurations"
|
|
282
157
|
}
|
|
283
158
|
},
|
|
284
|
-
"summary": "Get
|
|
159
|
+
"summary": "Get all tenant configurations",
|
|
285
160
|
"tags": [
|
|
286
|
-
"
|
|
161
|
+
"Tenant Configuration"
|
|
287
162
|
]
|
|
288
163
|
}
|
|
289
164
|
},
|
|
290
|
-
"/api/v1/
|
|
165
|
+
"/api/v1/tenants/{tenantId}": {
|
|
291
166
|
"get": {
|
|
292
|
-
"operationId": "
|
|
293
|
-
"parameters": [
|
|
167
|
+
"operationId": "TenantConfigController_getTenantConfigById_v1",
|
|
168
|
+
"parameters": [
|
|
169
|
+
{
|
|
170
|
+
"name": "tenantId",
|
|
171
|
+
"required": true,
|
|
172
|
+
"in": "path",
|
|
173
|
+
"schema": {
|
|
174
|
+
"type": "string"
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
],
|
|
294
178
|
"responses": {
|
|
295
179
|
"200": {
|
|
296
|
-
"description": "Returns the
|
|
180
|
+
"description": "Returns the tenant configuration",
|
|
297
181
|
"content": {
|
|
298
182
|
"application/json": {
|
|
299
183
|
"schema": {
|
|
300
|
-
"$ref": "#/components/schemas/
|
|
184
|
+
"$ref": "#/components/schemas/TenantConfig"
|
|
301
185
|
}
|
|
302
186
|
}
|
|
303
187
|
}
|
|
304
188
|
},
|
|
305
189
|
"403": {
|
|
306
|
-
"description": "Not authorized"
|
|
190
|
+
"description": "Not authorized to access tenant configuration"
|
|
307
191
|
},
|
|
308
192
|
"404": {
|
|
309
|
-
"description": "
|
|
193
|
+
"description": "Tenant configuration not found"
|
|
310
194
|
}
|
|
311
195
|
},
|
|
312
|
-
"summary": "Get
|
|
196
|
+
"summary": "Get tenant configuration by tenantId",
|
|
313
197
|
"tags": [
|
|
314
|
-
"
|
|
198
|
+
"Tenant Configuration"
|
|
315
199
|
]
|
|
316
|
-
}
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
"post": {
|
|
320
|
-
"operationId": "CustomerConfigController_create_v1",
|
|
200
|
+
},
|
|
201
|
+
"patch": {
|
|
202
|
+
"operationId": "TenantConfigController_update_v1",
|
|
321
203
|
"parameters": [
|
|
322
204
|
{
|
|
323
|
-
"name": "
|
|
205
|
+
"name": "tenantId",
|
|
324
206
|
"required": true,
|
|
325
207
|
"in": "path",
|
|
326
208
|
"schema": {
|
|
@@ -333,39 +215,39 @@
|
|
|
333
215
|
"content": {
|
|
334
216
|
"application/json": {
|
|
335
217
|
"schema": {
|
|
336
|
-
"$ref": "#/components/schemas/
|
|
218
|
+
"$ref": "#/components/schemas/TenantConfigUpdateDto"
|
|
337
219
|
}
|
|
338
220
|
}
|
|
339
221
|
}
|
|
340
222
|
},
|
|
341
223
|
"responses": {
|
|
342
|
-
"
|
|
343
|
-
"description": "Returns the
|
|
224
|
+
"200": {
|
|
225
|
+
"description": "Returns the updated tenant configuration",
|
|
344
226
|
"content": {
|
|
345
227
|
"application/json": {
|
|
346
228
|
"schema": {
|
|
347
|
-
"$ref": "#/components/schemas/
|
|
229
|
+
"$ref": "#/components/schemas/TenantConfig"
|
|
348
230
|
}
|
|
349
231
|
}
|
|
350
232
|
}
|
|
351
233
|
},
|
|
352
234
|
"403": {
|
|
353
|
-
"description": "Not authorized to
|
|
235
|
+
"description": "Not authorized to update tenant configuration"
|
|
354
236
|
},
|
|
355
|
-
"
|
|
356
|
-
"description": "
|
|
237
|
+
"404": {
|
|
238
|
+
"description": "Tenant configuration not found"
|
|
357
239
|
}
|
|
358
240
|
},
|
|
359
|
-
"summary": "
|
|
241
|
+
"summary": "Update tenant configuration by tenantId",
|
|
360
242
|
"tags": [
|
|
361
|
-
"
|
|
243
|
+
"Tenant Configuration"
|
|
362
244
|
]
|
|
363
245
|
},
|
|
364
|
-
"
|
|
365
|
-
"operationId": "
|
|
246
|
+
"delete": {
|
|
247
|
+
"operationId": "TenantConfigController_delete_v1",
|
|
366
248
|
"parameters": [
|
|
367
249
|
{
|
|
368
|
-
"name": "
|
|
250
|
+
"name": "tenantId",
|
|
369
251
|
"required": true,
|
|
370
252
|
"in": "path",
|
|
371
253
|
"schema": {
|
|
@@ -375,162 +257,125 @@
|
|
|
375
257
|
],
|
|
376
258
|
"responses": {
|
|
377
259
|
"200": {
|
|
378
|
-
"description": "Returns the
|
|
260
|
+
"description": "Returns the deleted tenant configuration",
|
|
379
261
|
"content": {
|
|
380
262
|
"application/json": {
|
|
381
263
|
"schema": {
|
|
382
|
-
"$ref": "#/components/schemas/
|
|
264
|
+
"$ref": "#/components/schemas/TenantConfig"
|
|
383
265
|
}
|
|
384
266
|
}
|
|
385
267
|
}
|
|
386
268
|
},
|
|
269
|
+
"403": {
|
|
270
|
+
"description": "Not authorized to delete tenant configuration"
|
|
271
|
+
},
|
|
387
272
|
"404": {
|
|
388
|
-
"description": "
|
|
273
|
+
"description": "Tenant configuration not found"
|
|
389
274
|
}
|
|
390
275
|
},
|
|
391
|
-
"summary": "
|
|
276
|
+
"summary": "Delete tenant configuration by tenantId",
|
|
392
277
|
"tags": [
|
|
393
|
-
"
|
|
278
|
+
"Tenant Configuration"
|
|
394
279
|
]
|
|
395
|
-
}
|
|
396
|
-
|
|
397
|
-
|
|
280
|
+
}
|
|
281
|
+
},
|
|
282
|
+
"/api/v1/customers/{customerId}/users": {
|
|
283
|
+
"get": {
|
|
284
|
+
"operationId": "UserConfigController_list_v1",
|
|
398
285
|
"parameters": [
|
|
399
286
|
{
|
|
400
287
|
"name": "customerId",
|
|
401
288
|
"required": true,
|
|
402
289
|
"in": "path",
|
|
403
290
|
"schema": {
|
|
291
|
+
"format": "objectid",
|
|
404
292
|
"type": "string"
|
|
405
293
|
}
|
|
406
294
|
}
|
|
407
295
|
],
|
|
408
|
-
"requestBody": {
|
|
409
|
-
"required": true,
|
|
410
|
-
"content": {
|
|
411
|
-
"application/json": {
|
|
412
|
-
"schema": {
|
|
413
|
-
"$ref": "#/components/schemas/CustomerConfigUpdateDto"
|
|
414
|
-
}
|
|
415
|
-
}
|
|
416
|
-
}
|
|
417
|
-
},
|
|
418
296
|
"responses": {
|
|
419
297
|
"200": {
|
|
420
|
-
"description": "Returns
|
|
298
|
+
"description": "Returns user configurations",
|
|
421
299
|
"content": {
|
|
422
300
|
"application/json": {
|
|
423
301
|
"schema": {
|
|
424
|
-
"
|
|
302
|
+
"type": "array",
|
|
303
|
+
"items": {
|
|
304
|
+
"$ref": "#/components/schemas/UserConfig"
|
|
305
|
+
}
|
|
425
306
|
}
|
|
426
307
|
}
|
|
427
308
|
}
|
|
428
309
|
},
|
|
429
310
|
"403": {
|
|
430
|
-
"description": "Not authorized to
|
|
431
|
-
},
|
|
432
|
-
"404": {
|
|
433
|
-
"description": "Customer configuration not found"
|
|
311
|
+
"description": "Not authorized to list user configurations"
|
|
434
312
|
}
|
|
435
313
|
},
|
|
436
|
-
"summary": "
|
|
314
|
+
"summary": "List user configurations by customerId",
|
|
437
315
|
"tags": [
|
|
438
|
-
"
|
|
316
|
+
"Users Configuration"
|
|
439
317
|
]
|
|
440
318
|
}
|
|
441
319
|
},
|
|
442
|
-
"/api/v1/customers": {
|
|
443
|
-
"
|
|
444
|
-
"operationId": "
|
|
320
|
+
"/api/v1/customers/{customerId}/users/{userId}": {
|
|
321
|
+
"delete": {
|
|
322
|
+
"operationId": "UserConfigController_delete_v1",
|
|
445
323
|
"parameters": [
|
|
446
324
|
{
|
|
447
|
-
"name": "
|
|
325
|
+
"name": "customerId",
|
|
448
326
|
"required": true,
|
|
449
|
-
"in": "
|
|
327
|
+
"in": "path",
|
|
450
328
|
"schema": {
|
|
329
|
+
"format": "objectid",
|
|
451
330
|
"type": "string"
|
|
452
331
|
}
|
|
453
332
|
},
|
|
454
333
|
{
|
|
455
|
-
"name": "
|
|
334
|
+
"name": "userId",
|
|
456
335
|
"required": true,
|
|
457
|
-
"in": "
|
|
336
|
+
"in": "path",
|
|
458
337
|
"schema": {
|
|
338
|
+
"format": "objectid",
|
|
459
339
|
"type": "string"
|
|
460
340
|
}
|
|
461
341
|
}
|
|
462
342
|
],
|
|
463
343
|
"responses": {
|
|
464
344
|
"200": {
|
|
465
|
-
"description": "Returns the
|
|
345
|
+
"description": "Returns the deleted user configuration",
|
|
466
346
|
"content": {
|
|
467
347
|
"application/json": {
|
|
468
348
|
"schema": {
|
|
469
|
-
"
|
|
349
|
+
"$ref": "#/components/schemas/UserConfig"
|
|
470
350
|
}
|
|
471
351
|
}
|
|
472
352
|
}
|
|
473
353
|
},
|
|
474
354
|
"403": {
|
|
475
|
-
"description": "Not authorized to
|
|
355
|
+
"description": "Not authorized to delete user configuration"
|
|
476
356
|
},
|
|
477
357
|
"404": {
|
|
478
|
-
"description": "
|
|
358
|
+
"description": "User configuration not found"
|
|
479
359
|
}
|
|
480
360
|
},
|
|
481
|
-
"summary": "
|
|
361
|
+
"summary": "Delete user configuration by customerId and userId",
|
|
482
362
|
"tags": [
|
|
483
|
-
"
|
|
363
|
+
"Users Configuration"
|
|
484
364
|
]
|
|
485
|
-
}
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
"get": {
|
|
489
|
-
"operationId": "CustomerConfigController_getUsersTimeZones_v1",
|
|
365
|
+
},
|
|
366
|
+
"post": {
|
|
367
|
+
"operationId": "UserConfigController_create_v1",
|
|
490
368
|
"parameters": [
|
|
491
369
|
{
|
|
492
370
|
"name": "customerId",
|
|
493
371
|
"required": true,
|
|
494
372
|
"in": "path",
|
|
495
373
|
"schema": {
|
|
496
|
-
"format": "objectid",
|
|
497
374
|
"type": "string"
|
|
498
375
|
}
|
|
499
|
-
}
|
|
500
|
-
],
|
|
501
|
-
"responses": {
|
|
502
|
-
"200": {
|
|
503
|
-
"description": "Returns the users time zones",
|
|
504
|
-
"content": {
|
|
505
|
-
"application/json": {
|
|
506
|
-
"schema": {
|
|
507
|
-
"additionalProperties": {
|
|
508
|
-
"items": {
|
|
509
|
-
"type": "string"
|
|
510
|
-
},
|
|
511
|
-
"type": "array"
|
|
512
|
-
},
|
|
513
|
-
"type": "object"
|
|
514
|
-
}
|
|
515
|
-
}
|
|
516
|
-
}
|
|
517
376
|
},
|
|
518
|
-
"403": {
|
|
519
|
-
"description": "Not authorized to access this customer configuration"
|
|
520
|
-
}
|
|
521
|
-
},
|
|
522
|
-
"summary": "Get users time zones by customerId",
|
|
523
|
-
"tags": [
|
|
524
|
-
"Customer Configuration"
|
|
525
|
-
]
|
|
526
|
-
}
|
|
527
|
-
},
|
|
528
|
-
"/api/v1/customers/{customerId}/websites/bulk": {
|
|
529
|
-
"patch": {
|
|
530
|
-
"operationId": "CustomerConfigController_bulkUpdateWebsites_v1",
|
|
531
|
-
"parameters": [
|
|
532
377
|
{
|
|
533
|
-
"name": "
|
|
378
|
+
"name": "userId",
|
|
534
379
|
"required": true,
|
|
535
380
|
"in": "path",
|
|
536
381
|
"schema": {
|
|
@@ -543,131 +388,90 @@
|
|
|
543
388
|
"content": {
|
|
544
389
|
"application/json": {
|
|
545
390
|
"schema": {
|
|
546
|
-
"$ref": "#/components/schemas/
|
|
391
|
+
"$ref": "#/components/schemas/UserConfigCreateDto"
|
|
547
392
|
}
|
|
548
393
|
}
|
|
549
394
|
}
|
|
550
395
|
},
|
|
551
396
|
"responses": {
|
|
552
|
-
"
|
|
553
|
-
"description": "Returns
|
|
397
|
+
"201": {
|
|
398
|
+
"description": "Returns the created user configuration",
|
|
554
399
|
"content": {
|
|
555
400
|
"application/json": {
|
|
556
401
|
"schema": {
|
|
557
|
-
"$ref": "#/components/schemas/
|
|
402
|
+
"$ref": "#/components/schemas/UserConfig"
|
|
558
403
|
}
|
|
559
404
|
}
|
|
560
405
|
}
|
|
561
406
|
},
|
|
562
407
|
"403": {
|
|
563
|
-
"description": "Not authorized to
|
|
408
|
+
"description": "Not authorized to create user configuration"
|
|
564
409
|
},
|
|
565
|
-
"
|
|
566
|
-
"description": "
|
|
410
|
+
"409": {
|
|
411
|
+
"description": "User configuration already exists"
|
|
567
412
|
}
|
|
568
413
|
},
|
|
569
|
-
"summary": "
|
|
414
|
+
"summary": "Create user configuration by customerId and userId",
|
|
570
415
|
"tags": [
|
|
571
|
-
"
|
|
416
|
+
"Users Configuration"
|
|
572
417
|
]
|
|
573
|
-
}
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
"post": {
|
|
577
|
-
"operationId": "PrivacyDocumentController_create_v1",
|
|
418
|
+
},
|
|
419
|
+
"get": {
|
|
420
|
+
"operationId": "UserConfigController_get_v1",
|
|
578
421
|
"parameters": [
|
|
579
422
|
{
|
|
580
423
|
"name": "customerId",
|
|
581
424
|
"required": true,
|
|
582
425
|
"in": "path",
|
|
583
426
|
"schema": {
|
|
427
|
+
"format": "objectid",
|
|
584
428
|
"type": "string"
|
|
585
429
|
}
|
|
586
|
-
}
|
|
587
|
-
],
|
|
588
|
-
"requestBody": {
|
|
589
|
-
"required": true,
|
|
590
|
-
"content": {
|
|
591
|
-
"application/json": {
|
|
592
|
-
"schema": {
|
|
593
|
-
"$ref": "#/components/schemas/PrivacyDocumentCreateDto"
|
|
594
|
-
}
|
|
595
|
-
}
|
|
596
|
-
}
|
|
597
|
-
},
|
|
598
|
-
"responses": {
|
|
599
|
-
"201": {
|
|
600
|
-
"description": "Returns the created privacy document",
|
|
601
|
-
"content": {
|
|
602
|
-
"application/json": {
|
|
603
|
-
"schema": {
|
|
604
|
-
"$ref": "#/components/schemas/PrivacyDocument"
|
|
605
|
-
}
|
|
606
|
-
}
|
|
607
|
-
}
|
|
608
430
|
},
|
|
609
|
-
"403": {
|
|
610
|
-
"description": "Not authorized to create privacy documents"
|
|
611
|
-
}
|
|
612
|
-
},
|
|
613
|
-
"summary": "Create a new privacy document",
|
|
614
|
-
"tags": [
|
|
615
|
-
"Privacy Documents"
|
|
616
|
-
]
|
|
617
|
-
},
|
|
618
|
-
"get": {
|
|
619
|
-
"operationId": "PrivacyDocumentController_getAll_v1",
|
|
620
|
-
"parameters": [
|
|
621
431
|
{
|
|
622
|
-
"name": "
|
|
432
|
+
"name": "userId",
|
|
623
433
|
"required": true,
|
|
624
434
|
"in": "path",
|
|
625
435
|
"schema": {
|
|
436
|
+
"format": "objectid",
|
|
626
437
|
"type": "string"
|
|
627
438
|
}
|
|
628
439
|
}
|
|
629
440
|
],
|
|
630
441
|
"responses": {
|
|
631
442
|
"200": {
|
|
632
|
-
"description": "
|
|
443
|
+
"description": "",
|
|
633
444
|
"content": {
|
|
634
445
|
"application/json": {
|
|
635
446
|
"schema": {
|
|
636
|
-
"
|
|
637
|
-
"items": {
|
|
638
|
-
"$ref": "#/components/schemas/PrivacyDocument"
|
|
639
|
-
}
|
|
447
|
+
"$ref": "#/components/schemas/UserConfig"
|
|
640
448
|
}
|
|
641
449
|
}
|
|
642
450
|
}
|
|
643
|
-
},
|
|
644
|
-
"403": {
|
|
645
|
-
"description": "Not authorized to read privacy documents"
|
|
646
451
|
}
|
|
647
452
|
},
|
|
648
|
-
"summary": "Get all privacy documents for customer",
|
|
649
453
|
"tags": [
|
|
650
|
-
"
|
|
454
|
+
"Users Configuration"
|
|
651
455
|
]
|
|
652
|
-
}
|
|
653
|
-
},
|
|
654
|
-
"/api/v1/customers/{customerId}/privacy-documents/{id}": {
|
|
456
|
+
},
|
|
655
457
|
"patch": {
|
|
656
|
-
"operationId": "
|
|
458
|
+
"operationId": "UserConfigController_update_v1",
|
|
657
459
|
"parameters": [
|
|
658
460
|
{
|
|
659
461
|
"name": "customerId",
|
|
660
462
|
"required": true,
|
|
661
463
|
"in": "path",
|
|
662
464
|
"schema": {
|
|
465
|
+
"format": "objectid",
|
|
663
466
|
"type": "string"
|
|
664
467
|
}
|
|
665
468
|
},
|
|
666
469
|
{
|
|
667
|
-
"name": "
|
|
470
|
+
"name": "userId",
|
|
668
471
|
"required": true,
|
|
669
472
|
"in": "path",
|
|
670
473
|
"schema": {
|
|
474
|
+
"format": "objectid",
|
|
671
475
|
"type": "string"
|
|
672
476
|
}
|
|
673
477
|
}
|
|
@@ -677,176 +481,204 @@
|
|
|
677
481
|
"content": {
|
|
678
482
|
"application/json": {
|
|
679
483
|
"schema": {
|
|
680
|
-
"$ref": "#/components/schemas/
|
|
484
|
+
"$ref": "#/components/schemas/UserConfigUpdateDto"
|
|
681
485
|
}
|
|
682
486
|
}
|
|
683
487
|
}
|
|
684
488
|
},
|
|
685
489
|
"responses": {
|
|
686
490
|
"200": {
|
|
687
|
-
"description": "Returns the updated
|
|
491
|
+
"description": "Returns the updated user configuration",
|
|
688
492
|
"content": {
|
|
689
493
|
"application/json": {
|
|
690
494
|
"schema": {
|
|
691
|
-
"$ref": "#/components/schemas/
|
|
495
|
+
"$ref": "#/components/schemas/UserConfig"
|
|
692
496
|
}
|
|
693
497
|
}
|
|
694
498
|
}
|
|
695
499
|
},
|
|
696
500
|
"403": {
|
|
697
|
-
"description": "Not authorized to
|
|
501
|
+
"description": "Not authorized to access this user configuration"
|
|
698
502
|
},
|
|
699
503
|
"404": {
|
|
700
|
-
"description": "
|
|
504
|
+
"description": "User configuration not found"
|
|
701
505
|
}
|
|
702
506
|
},
|
|
703
|
-
"summary": "Update
|
|
507
|
+
"summary": "Update user configuration by customerId and userId",
|
|
704
508
|
"tags": [
|
|
705
|
-
"
|
|
509
|
+
"Users Configuration"
|
|
706
510
|
]
|
|
707
|
-
}
|
|
511
|
+
}
|
|
512
|
+
},
|
|
513
|
+
"/api/v1/customers/{customerId}/users/{userId}/timezone": {
|
|
708
514
|
"get": {
|
|
709
|
-
"operationId": "
|
|
515
|
+
"operationId": "UserConfigController_getUserTimeZone_v1",
|
|
710
516
|
"parameters": [
|
|
711
517
|
{
|
|
712
518
|
"name": "customerId",
|
|
713
519
|
"required": true,
|
|
714
520
|
"in": "path",
|
|
715
521
|
"schema": {
|
|
522
|
+
"format": "objectid",
|
|
716
523
|
"type": "string"
|
|
717
524
|
}
|
|
718
525
|
},
|
|
719
526
|
{
|
|
720
|
-
"name": "
|
|
527
|
+
"name": "userId",
|
|
721
528
|
"required": true,
|
|
722
529
|
"in": "path",
|
|
723
530
|
"schema": {
|
|
531
|
+
"format": "objectid",
|
|
724
532
|
"type": "string"
|
|
725
533
|
}
|
|
726
534
|
}
|
|
727
535
|
],
|
|
728
536
|
"responses": {
|
|
729
537
|
"200": {
|
|
730
|
-
"description": "
|
|
538
|
+
"description": "",
|
|
731
539
|
"content": {
|
|
732
540
|
"application/json": {
|
|
733
541
|
"schema": {
|
|
734
|
-
"$ref": "#/components/schemas/
|
|
542
|
+
"$ref": "#/components/schemas/TimeZoneEntity"
|
|
735
543
|
}
|
|
736
544
|
}
|
|
737
545
|
}
|
|
738
|
-
},
|
|
739
|
-
"403": {
|
|
740
|
-
"description": "Not authorized to read privacy documents"
|
|
741
|
-
},
|
|
742
|
-
"404": {
|
|
743
|
-
"description": "Privacy document not found"
|
|
744
546
|
}
|
|
745
547
|
},
|
|
746
|
-
"summary": "Get privacy document by ID",
|
|
747
548
|
"tags": [
|
|
748
|
-
"
|
|
549
|
+
"Users Configuration"
|
|
749
550
|
]
|
|
750
551
|
}
|
|
751
552
|
},
|
|
752
|
-
"/api/v1/
|
|
553
|
+
"/api/v1/users/me/custom-filters": {
|
|
753
554
|
"get": {
|
|
754
|
-
"operationId": "
|
|
755
|
-
"parameters": [
|
|
756
|
-
{
|
|
757
|
-
"name": "customerId",
|
|
758
|
-
"required": true,
|
|
759
|
-
"in": "path",
|
|
760
|
-
"schema": {
|
|
761
|
-
"type": "string"
|
|
762
|
-
}
|
|
763
|
-
},
|
|
764
|
-
{
|
|
765
|
-
"name": "language",
|
|
766
|
-
"required": true,
|
|
767
|
-
"in": "query",
|
|
768
|
-
"description": "Language code (e.g., \"en\", \"fr\", \"es\")",
|
|
769
|
-
"schema": {
|
|
770
|
-
"example": "en",
|
|
771
|
-
"type": "string"
|
|
772
|
-
}
|
|
773
|
-
}
|
|
774
|
-
],
|
|
555
|
+
"operationId": "UserSelfConfigController_getCustomFilters_v1",
|
|
556
|
+
"parameters": [],
|
|
775
557
|
"responses": {
|
|
776
558
|
"200": {
|
|
777
|
-
"description": "Returns the
|
|
559
|
+
"description": "Returns the custom filters",
|
|
778
560
|
"content": {
|
|
779
561
|
"application/json": {
|
|
780
562
|
"schema": {
|
|
781
|
-
"
|
|
563
|
+
"type": "array",
|
|
564
|
+
"items": {
|
|
565
|
+
"$ref": "#/components/schemas/WebappWorkActivityCustomFilter"
|
|
566
|
+
}
|
|
782
567
|
}
|
|
783
568
|
}
|
|
784
569
|
}
|
|
785
570
|
},
|
|
786
571
|
"403": {
|
|
787
|
-
"description": "Not authorized
|
|
572
|
+
"description": "Not authorized"
|
|
788
573
|
},
|
|
789
574
|
"404": {
|
|
790
|
-
"description": "
|
|
575
|
+
"description": "User configuration not found"
|
|
791
576
|
}
|
|
792
577
|
},
|
|
793
|
-
"summary": "Get
|
|
578
|
+
"summary": "Get custom activity filters for the current user",
|
|
794
579
|
"tags": [
|
|
795
|
-
"
|
|
580
|
+
"User Self Configuration"
|
|
796
581
|
]
|
|
797
|
-
}
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
"
|
|
802
|
-
|
|
803
|
-
{
|
|
804
|
-
"
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
"type": "string"
|
|
582
|
+
},
|
|
583
|
+
"patch": {
|
|
584
|
+
"operationId": "UserSelfConfigController_updateCustomFilters_v1",
|
|
585
|
+
"parameters": [],
|
|
586
|
+
"requestBody": {
|
|
587
|
+
"required": true,
|
|
588
|
+
"content": {
|
|
589
|
+
"application/json": {
|
|
590
|
+
"schema": {
|
|
591
|
+
"$ref": "#/components/schemas/UserSelfCustomFiltersUpdateDto"
|
|
592
|
+
}
|
|
809
593
|
}
|
|
810
594
|
}
|
|
811
|
-
|
|
595
|
+
},
|
|
812
596
|
"responses": {
|
|
813
597
|
"200": {
|
|
814
|
-
"description": "Returns
|
|
598
|
+
"description": "Returns the updated custom filters",
|
|
815
599
|
"content": {
|
|
816
600
|
"application/json": {
|
|
817
601
|
"schema": {
|
|
818
|
-
"
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
},
|
|
823
|
-
"url": {
|
|
824
|
-
"description": "Signed S3 URL for the logo",
|
|
825
|
-
"type": "string"
|
|
826
|
-
}
|
|
827
|
-
},
|
|
828
|
-
"type": "object"
|
|
602
|
+
"type": "array",
|
|
603
|
+
"items": {
|
|
604
|
+
"$ref": "#/components/schemas/WebappWorkActivityCustomFilter"
|
|
605
|
+
}
|
|
829
606
|
}
|
|
830
607
|
}
|
|
831
608
|
}
|
|
832
609
|
},
|
|
833
|
-
"
|
|
834
|
-
"description": "
|
|
610
|
+
"403": {
|
|
611
|
+
"description": "Not authorized"
|
|
612
|
+
},
|
|
613
|
+
"404": {
|
|
614
|
+
"description": "User configuration not found"
|
|
615
|
+
}
|
|
616
|
+
},
|
|
617
|
+
"summary": "Update custom activity filters for the current user",
|
|
618
|
+
"tags": [
|
|
619
|
+
"User Self Configuration"
|
|
620
|
+
]
|
|
621
|
+
}
|
|
622
|
+
},
|
|
623
|
+
"/api/v1/users/me": {
|
|
624
|
+
"get": {
|
|
625
|
+
"operationId": "UserSelfConfigController_getSelfConfig_v1",
|
|
626
|
+
"parameters": [],
|
|
627
|
+
"responses": {
|
|
628
|
+
"200": {
|
|
629
|
+
"description": "Returns the user configuration",
|
|
630
|
+
"content": {
|
|
631
|
+
"application/json": {
|
|
632
|
+
"schema": {
|
|
633
|
+
"$ref": "#/components/schemas/UserConfig"
|
|
634
|
+
}
|
|
635
|
+
}
|
|
636
|
+
}
|
|
835
637
|
},
|
|
836
638
|
"403": {
|
|
837
|
-
"description": "Not authorized
|
|
639
|
+
"description": "Not authorized"
|
|
640
|
+
},
|
|
641
|
+
"404": {
|
|
642
|
+
"description": "User configuration not found"
|
|
643
|
+
}
|
|
644
|
+
},
|
|
645
|
+
"summary": "Get the current user configuration",
|
|
646
|
+
"tags": [
|
|
647
|
+
"User Self Configuration"
|
|
648
|
+
]
|
|
649
|
+
}
|
|
650
|
+
},
|
|
651
|
+
"/api/v1/customers/me": {
|
|
652
|
+
"get": {
|
|
653
|
+
"operationId": "CustomerSelfConfigController_getSelfConfig_v1",
|
|
654
|
+
"parameters": [],
|
|
655
|
+
"responses": {
|
|
656
|
+
"200": {
|
|
657
|
+
"description": "Returns the customer configuration",
|
|
658
|
+
"content": {
|
|
659
|
+
"application/json": {
|
|
660
|
+
"schema": {
|
|
661
|
+
"$ref": "#/components/schemas/CustomerConfig"
|
|
662
|
+
}
|
|
663
|
+
}
|
|
664
|
+
}
|
|
665
|
+
},
|
|
666
|
+
"403": {
|
|
667
|
+
"description": "Not authorized"
|
|
838
668
|
},
|
|
839
669
|
"404": {
|
|
840
670
|
"description": "Customer configuration not found"
|
|
841
671
|
}
|
|
842
672
|
},
|
|
843
|
-
"summary": "Get
|
|
673
|
+
"summary": "Get customer configuration for the authenticated customer",
|
|
844
674
|
"tags": [
|
|
845
|
-
"
|
|
675
|
+
"Customer Self Configuration"
|
|
846
676
|
]
|
|
847
|
-
}
|
|
848
|
-
|
|
849
|
-
|
|
677
|
+
}
|
|
678
|
+
},
|
|
679
|
+
"/api/v1/customers/{customerId}": {
|
|
680
|
+
"post": {
|
|
681
|
+
"operationId": "CustomerConfigController_create_v1",
|
|
850
682
|
"parameters": [
|
|
851
683
|
{
|
|
852
684
|
"name": "customerId",
|
|
@@ -857,9 +689,19 @@
|
|
|
857
689
|
}
|
|
858
690
|
}
|
|
859
691
|
],
|
|
692
|
+
"requestBody": {
|
|
693
|
+
"required": true,
|
|
694
|
+
"content": {
|
|
695
|
+
"application/json": {
|
|
696
|
+
"schema": {
|
|
697
|
+
"$ref": "#/components/schemas/CustomerConfigCreateDto"
|
|
698
|
+
}
|
|
699
|
+
}
|
|
700
|
+
}
|
|
701
|
+
},
|
|
860
702
|
"responses": {
|
|
861
|
-
"
|
|
862
|
-
"description": "",
|
|
703
|
+
"201": {
|
|
704
|
+
"description": "Returns the created customer configuration",
|
|
863
705
|
"content": {
|
|
864
706
|
"application/json": {
|
|
865
707
|
"schema": {
|
|
@@ -868,43 +710,37 @@
|
|
|
868
710
|
}
|
|
869
711
|
}
|
|
870
712
|
},
|
|
871
|
-
"400": {
|
|
872
|
-
"description": "Invalid request"
|
|
873
|
-
},
|
|
874
713
|
"403": {
|
|
875
|
-
"description": "Not authorized to
|
|
714
|
+
"description": "Not authorized to create customer configuration"
|
|
876
715
|
},
|
|
877
|
-
"
|
|
878
|
-
"description": "Customer configuration
|
|
716
|
+
"409": {
|
|
717
|
+
"description": "Customer configuration already exists"
|
|
879
718
|
}
|
|
880
719
|
},
|
|
881
|
-
"summary": "
|
|
720
|
+
"summary": "Create customer configuration for a customerId",
|
|
882
721
|
"tags": [
|
|
883
|
-
"
|
|
722
|
+
"Customer Configuration"
|
|
884
723
|
]
|
|
885
|
-
}
|
|
886
|
-
},
|
|
887
|
-
"/api/v1/customers/{customerId}/signal": {
|
|
724
|
+
},
|
|
888
725
|
"get": {
|
|
889
|
-
"operationId": "
|
|
726
|
+
"operationId": "CustomerConfigController_getCustomerConfigById_v1",
|
|
890
727
|
"parameters": [
|
|
891
728
|
{
|
|
892
729
|
"name": "customerId",
|
|
893
730
|
"required": true,
|
|
894
731
|
"in": "path",
|
|
895
732
|
"schema": {
|
|
896
|
-
"format": "objectid",
|
|
897
733
|
"type": "string"
|
|
898
734
|
}
|
|
899
735
|
}
|
|
900
736
|
],
|
|
901
737
|
"responses": {
|
|
902
738
|
"200": {
|
|
903
|
-
"description": "Returns the
|
|
739
|
+
"description": "Returns the customer configuration",
|
|
904
740
|
"content": {
|
|
905
741
|
"application/json": {
|
|
906
742
|
"schema": {
|
|
907
|
-
"$ref": "#/components/schemas/
|
|
743
|
+
"$ref": "#/components/schemas/CustomerConfig"
|
|
908
744
|
}
|
|
909
745
|
}
|
|
910
746
|
}
|
|
@@ -913,20 +749,19 @@
|
|
|
913
749
|
"description": "Customer configuration not found"
|
|
914
750
|
}
|
|
915
751
|
},
|
|
916
|
-
"summary": "Get
|
|
752
|
+
"summary": "Get customer configuration by customerId",
|
|
917
753
|
"tags": [
|
|
918
|
-
"Customer
|
|
754
|
+
"Customer Configuration"
|
|
919
755
|
]
|
|
920
756
|
},
|
|
921
757
|
"patch": {
|
|
922
|
-
"operationId": "
|
|
758
|
+
"operationId": "CustomerConfigController_update_v1",
|
|
923
759
|
"parameters": [
|
|
924
760
|
{
|
|
925
761
|
"name": "customerId",
|
|
926
762
|
"required": true,
|
|
927
763
|
"in": "path",
|
|
928
764
|
"schema": {
|
|
929
|
-
"format": "objectid",
|
|
930
765
|
"type": "string"
|
|
931
766
|
}
|
|
932
767
|
}
|
|
@@ -936,113 +771,122 @@
|
|
|
936
771
|
"content": {
|
|
937
772
|
"application/json": {
|
|
938
773
|
"schema": {
|
|
939
|
-
"$ref": "#/components/schemas/
|
|
774
|
+
"$ref": "#/components/schemas/CustomerConfigUpdateDto"
|
|
940
775
|
}
|
|
941
776
|
}
|
|
942
777
|
}
|
|
943
778
|
},
|
|
944
779
|
"responses": {
|
|
945
780
|
"200": {
|
|
946
|
-
"description": "Returns the updated
|
|
781
|
+
"description": "Returns the updated customer configuration",
|
|
947
782
|
"content": {
|
|
948
783
|
"application/json": {
|
|
949
784
|
"schema": {
|
|
950
|
-
"$ref": "#/components/schemas/
|
|
785
|
+
"$ref": "#/components/schemas/CustomerConfig"
|
|
951
786
|
}
|
|
952
787
|
}
|
|
953
788
|
}
|
|
954
789
|
},
|
|
790
|
+
"403": {
|
|
791
|
+
"description": "Not authorized to access this customer configuration"
|
|
792
|
+
},
|
|
955
793
|
"404": {
|
|
956
794
|
"description": "Customer configuration not found"
|
|
957
795
|
}
|
|
958
796
|
},
|
|
959
|
-
"summary": "
|
|
797
|
+
"summary": "Update customer configuration by customerId",
|
|
960
798
|
"tags": [
|
|
961
|
-
"Customer
|
|
799
|
+
"Customer Configuration"
|
|
962
800
|
]
|
|
963
|
-
}
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
"get": {
|
|
967
|
-
"operationId": "CustomerSignalConfigController_getInsights_v1",
|
|
801
|
+
},
|
|
802
|
+
"delete": {
|
|
803
|
+
"operationId": "CustomerConfigController_deleteCustomerConfigById_v1",
|
|
968
804
|
"parameters": [
|
|
969
805
|
{
|
|
970
806
|
"name": "customerId",
|
|
971
807
|
"required": true,
|
|
972
808
|
"in": "path",
|
|
973
809
|
"schema": {
|
|
974
|
-
"format": "objectid",
|
|
975
810
|
"type": "string"
|
|
976
811
|
}
|
|
977
812
|
}
|
|
978
813
|
],
|
|
979
814
|
"responses": {
|
|
980
815
|
"200": {
|
|
981
|
-
"description": "Returns the
|
|
816
|
+
"description": "Returns the deleted customer configuration",
|
|
982
817
|
"content": {
|
|
983
818
|
"application/json": {
|
|
984
819
|
"schema": {
|
|
985
|
-
"$ref": "#/components/schemas/
|
|
820
|
+
"$ref": "#/components/schemas/CustomerConfig"
|
|
986
821
|
}
|
|
987
822
|
}
|
|
988
823
|
}
|
|
989
824
|
},
|
|
825
|
+
"403": {
|
|
826
|
+
"description": "Not authorized to delete this customer configuration"
|
|
827
|
+
},
|
|
990
828
|
"404": {
|
|
991
829
|
"description": "Customer configuration not found"
|
|
992
830
|
}
|
|
993
831
|
},
|
|
994
|
-
"summary": "
|
|
832
|
+
"summary": "Delete customer configuration by customerId",
|
|
995
833
|
"tags": [
|
|
996
|
-
"Customer
|
|
834
|
+
"Customer Configuration"
|
|
997
835
|
]
|
|
998
|
-
}
|
|
999
|
-
|
|
1000
|
-
|
|
836
|
+
}
|
|
837
|
+
},
|
|
838
|
+
"/api/v1/customers": {
|
|
839
|
+
"get": {
|
|
840
|
+
"operationId": "CustomerConfigController_getCustomerConfigs_v1",
|
|
1001
841
|
"parameters": [
|
|
1002
842
|
{
|
|
1003
|
-
"name": "
|
|
1004
|
-
"required":
|
|
1005
|
-
"in": "
|
|
843
|
+
"name": "identityType",
|
|
844
|
+
"required": false,
|
|
845
|
+
"in": "query",
|
|
846
|
+
"description": "Identity type for customer lookup (e.g. webexOrgId)",
|
|
1006
847
|
"schema": {
|
|
1007
|
-
"format": "objectid",
|
|
1008
848
|
"type": "string"
|
|
1009
849
|
}
|
|
1010
|
-
}
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
"
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
850
|
+
},
|
|
851
|
+
{
|
|
852
|
+
"name": "identityId",
|
|
853
|
+
"required": false,
|
|
854
|
+
"in": "query",
|
|
855
|
+
"description": "Identity ID for customer lookup",
|
|
856
|
+
"schema": {
|
|
857
|
+
"type": "string"
|
|
858
|
+
}
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
"name": "name",
|
|
862
|
+
"required": false,
|
|
863
|
+
"in": "query",
|
|
864
|
+
"description": "Filter customer configurations by name",
|
|
865
|
+
"schema": {
|
|
866
|
+
"type": "string"
|
|
1019
867
|
}
|
|
1020
868
|
}
|
|
1021
|
-
|
|
869
|
+
],
|
|
1022
870
|
"responses": {
|
|
1023
871
|
"200": {
|
|
1024
|
-
"description": "Returns
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
"$ref": "#/components/schemas/InsightsConfig"
|
|
1029
|
-
}
|
|
1030
|
-
}
|
|
1031
|
-
}
|
|
872
|
+
"description": "Returns customer configurations or a customerId"
|
|
873
|
+
},
|
|
874
|
+
"403": {
|
|
875
|
+
"description": "Not authorized"
|
|
1032
876
|
},
|
|
1033
877
|
"404": {
|
|
1034
878
|
"description": "Customer configuration not found"
|
|
1035
879
|
}
|
|
1036
880
|
},
|
|
1037
|
-
"summary": "
|
|
881
|
+
"summary": "List all customer configurations, search by name, or get customerId by identity type",
|
|
1038
882
|
"tags": [
|
|
1039
|
-
"Customer
|
|
883
|
+
"Customer Configuration"
|
|
1040
884
|
]
|
|
1041
885
|
}
|
|
1042
886
|
},
|
|
1043
|
-
"/api/v1/customers/{customerId}/
|
|
887
|
+
"/api/v1/customers/{customerId}/timezones": {
|
|
1044
888
|
"get": {
|
|
1045
|
-
"operationId": "
|
|
889
|
+
"operationId": "CustomerConfigController_getUsersTimeZones_v1",
|
|
1046
890
|
"parameters": [
|
|
1047
891
|
{
|
|
1048
892
|
"name": "customerId",
|
|
@@ -1056,33 +900,40 @@
|
|
|
1056
900
|
],
|
|
1057
901
|
"responses": {
|
|
1058
902
|
"200": {
|
|
1059
|
-
"description": "Returns the
|
|
903
|
+
"description": "Returns the users time zones",
|
|
1060
904
|
"content": {
|
|
1061
905
|
"application/json": {
|
|
1062
906
|
"schema": {
|
|
1063
|
-
"
|
|
907
|
+
"additionalProperties": {
|
|
908
|
+
"items": {
|
|
909
|
+
"type": "string"
|
|
910
|
+
},
|
|
911
|
+
"type": "array"
|
|
912
|
+
},
|
|
913
|
+
"type": "object"
|
|
1064
914
|
}
|
|
1065
915
|
}
|
|
1066
916
|
}
|
|
1067
917
|
},
|
|
1068
|
-
"
|
|
1069
|
-
"description": "
|
|
918
|
+
"403": {
|
|
919
|
+
"description": "Not authorized to access this customer configuration"
|
|
1070
920
|
}
|
|
1071
921
|
},
|
|
1072
|
-
"summary": "Get
|
|
922
|
+
"summary": "Get users time zones by customerId",
|
|
1073
923
|
"tags": [
|
|
1074
|
-
"Customer
|
|
924
|
+
"Customer Configuration"
|
|
1075
925
|
]
|
|
1076
|
-
}
|
|
926
|
+
}
|
|
927
|
+
},
|
|
928
|
+
"/api/v1/customers/{customerId}/websites/bulk": {
|
|
1077
929
|
"patch": {
|
|
1078
|
-
"operationId": "
|
|
930
|
+
"operationId": "CustomerConfigController_bulkUpdateWebsites_v1",
|
|
1079
931
|
"parameters": [
|
|
1080
932
|
{
|
|
1081
933
|
"name": "customerId",
|
|
1082
934
|
"required": true,
|
|
1083
935
|
"in": "path",
|
|
1084
936
|
"schema": {
|
|
1085
|
-
"format": "objectid",
|
|
1086
937
|
"type": "string"
|
|
1087
938
|
}
|
|
1088
939
|
}
|
|
@@ -1092,129 +943,1188 @@
|
|
|
1092
943
|
"content": {
|
|
1093
944
|
"application/json": {
|
|
1094
945
|
"schema": {
|
|
1095
|
-
"$ref": "#/components/schemas/
|
|
946
|
+
"$ref": "#/components/schemas/BulkUpdateWebsitesDto"
|
|
1096
947
|
}
|
|
1097
948
|
}
|
|
1098
949
|
}
|
|
1099
950
|
},
|
|
1100
951
|
"responses": {
|
|
1101
952
|
"200": {
|
|
1102
|
-
"description": "Returns
|
|
953
|
+
"description": "Returns bulk operation results",
|
|
1103
954
|
"content": {
|
|
1104
955
|
"application/json": {
|
|
1105
956
|
"schema": {
|
|
1106
|
-
"$ref": "#/components/schemas/
|
|
957
|
+
"$ref": "#/components/schemas/BulkUpdateWebsitesResponseDto"
|
|
1107
958
|
}
|
|
1108
959
|
}
|
|
1109
960
|
}
|
|
1110
961
|
},
|
|
1111
|
-
"
|
|
1112
|
-
"description": "
|
|
1113
|
-
}
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
"
|
|
1130
|
-
|
|
962
|
+
"403": {
|
|
963
|
+
"description": "Not authorized to access this customer configuration"
|
|
964
|
+
},
|
|
965
|
+
"404": {
|
|
966
|
+
"description": "Customer configuration not found"
|
|
967
|
+
}
|
|
968
|
+
},
|
|
969
|
+
"summary": "Bulk update website entries for customer configuration",
|
|
970
|
+
"tags": [
|
|
971
|
+
"Customer Configuration"
|
|
972
|
+
]
|
|
973
|
+
}
|
|
974
|
+
},
|
|
975
|
+
"/api/v1/customers/{customerId}/privacy-documents": {
|
|
976
|
+
"post": {
|
|
977
|
+
"operationId": "PrivacyDocumentController_create_v1",
|
|
978
|
+
"parameters": [
|
|
979
|
+
{
|
|
980
|
+
"name": "customerId",
|
|
981
|
+
"required": true,
|
|
982
|
+
"in": "path",
|
|
983
|
+
"schema": {
|
|
984
|
+
"type": "string"
|
|
985
|
+
}
|
|
986
|
+
}
|
|
987
|
+
],
|
|
988
|
+
"requestBody": {
|
|
989
|
+
"required": true,
|
|
990
|
+
"content": {
|
|
991
|
+
"application/json": {
|
|
992
|
+
"schema": {
|
|
993
|
+
"$ref": "#/components/schemas/PrivacyDocumentCreateDto"
|
|
994
|
+
}
|
|
995
|
+
}
|
|
996
|
+
}
|
|
997
|
+
},
|
|
998
|
+
"responses": {
|
|
999
|
+
"201": {
|
|
1000
|
+
"description": "Returns the created privacy document",
|
|
1001
|
+
"content": {
|
|
1002
|
+
"application/json": {
|
|
1003
|
+
"schema": {
|
|
1004
|
+
"$ref": "#/components/schemas/PrivacyDocument"
|
|
1005
|
+
}
|
|
1006
|
+
}
|
|
1007
|
+
}
|
|
1008
|
+
},
|
|
1009
|
+
"403": {
|
|
1010
|
+
"description": "Not authorized to create privacy documents"
|
|
1011
|
+
}
|
|
1012
|
+
},
|
|
1013
|
+
"summary": "Create a new privacy document",
|
|
1014
|
+
"tags": [
|
|
1015
|
+
"Privacy Documents"
|
|
1016
|
+
]
|
|
1017
|
+
},
|
|
1018
|
+
"get": {
|
|
1019
|
+
"operationId": "PrivacyDocumentController_getAll_v1",
|
|
1020
|
+
"parameters": [
|
|
1021
|
+
{
|
|
1022
|
+
"name": "customerId",
|
|
1023
|
+
"required": true,
|
|
1024
|
+
"in": "path",
|
|
1025
|
+
"schema": {
|
|
1026
|
+
"type": "string"
|
|
1027
|
+
}
|
|
1028
|
+
}
|
|
1029
|
+
],
|
|
1030
|
+
"responses": {
|
|
1031
|
+
"200": {
|
|
1032
|
+
"description": "Returns all privacy documents for the customer",
|
|
1033
|
+
"content": {
|
|
1034
|
+
"application/json": {
|
|
1035
|
+
"schema": {
|
|
1036
|
+
"type": "array",
|
|
1037
|
+
"items": {
|
|
1038
|
+
"$ref": "#/components/schemas/PrivacyDocument"
|
|
1039
|
+
}
|
|
1040
|
+
}
|
|
1041
|
+
}
|
|
1042
|
+
}
|
|
1043
|
+
},
|
|
1044
|
+
"403": {
|
|
1045
|
+
"description": "Not authorized to read privacy documents"
|
|
1046
|
+
}
|
|
1047
|
+
},
|
|
1048
|
+
"summary": "Get all privacy documents for customer",
|
|
1049
|
+
"tags": [
|
|
1050
|
+
"Privacy Documents"
|
|
1051
|
+
]
|
|
1052
|
+
}
|
|
1053
|
+
},
|
|
1054
|
+
"/api/v1/customers/{customerId}/privacy-documents/{id}": {
|
|
1055
|
+
"patch": {
|
|
1056
|
+
"operationId": "PrivacyDocumentController_update_v1",
|
|
1057
|
+
"parameters": [
|
|
1058
|
+
{
|
|
1059
|
+
"name": "customerId",
|
|
1060
|
+
"required": true,
|
|
1061
|
+
"in": "path",
|
|
1062
|
+
"schema": {
|
|
1063
|
+
"type": "string"
|
|
1064
|
+
}
|
|
1065
|
+
},
|
|
1066
|
+
{
|
|
1067
|
+
"name": "id",
|
|
1068
|
+
"required": true,
|
|
1069
|
+
"in": "path",
|
|
1070
|
+
"schema": {
|
|
1071
|
+
"type": "string"
|
|
1072
|
+
}
|
|
1073
|
+
}
|
|
1074
|
+
],
|
|
1075
|
+
"requestBody": {
|
|
1076
|
+
"required": true,
|
|
1077
|
+
"content": {
|
|
1078
|
+
"application/json": {
|
|
1079
|
+
"schema": {
|
|
1080
|
+
"$ref": "#/components/schemas/PrivacyDocumentUpdateDto"
|
|
1081
|
+
}
|
|
1082
|
+
}
|
|
1083
|
+
}
|
|
1084
|
+
},
|
|
1085
|
+
"responses": {
|
|
1086
|
+
"200": {
|
|
1087
|
+
"description": "Returns the updated privacy document",
|
|
1088
|
+
"content": {
|
|
1089
|
+
"application/json": {
|
|
1090
|
+
"schema": {
|
|
1091
|
+
"$ref": "#/components/schemas/PrivacyDocument"
|
|
1092
|
+
}
|
|
1093
|
+
}
|
|
1094
|
+
}
|
|
1095
|
+
},
|
|
1096
|
+
"403": {
|
|
1097
|
+
"description": "Not authorized to update privacy documents"
|
|
1098
|
+
},
|
|
1099
|
+
"404": {
|
|
1100
|
+
"description": "Privacy document not found"
|
|
1101
|
+
}
|
|
1102
|
+
},
|
|
1103
|
+
"summary": "Update privacy document by ID",
|
|
1104
|
+
"tags": [
|
|
1105
|
+
"Privacy Documents"
|
|
1106
|
+
]
|
|
1107
|
+
},
|
|
1108
|
+
"get": {
|
|
1109
|
+
"operationId": "PrivacyDocumentController_getById_v1",
|
|
1110
|
+
"parameters": [
|
|
1111
|
+
{
|
|
1112
|
+
"name": "customerId",
|
|
1113
|
+
"required": true,
|
|
1114
|
+
"in": "path",
|
|
1115
|
+
"schema": {
|
|
1116
|
+
"type": "string"
|
|
1117
|
+
}
|
|
1118
|
+
},
|
|
1119
|
+
{
|
|
1120
|
+
"name": "id",
|
|
1121
|
+
"required": true,
|
|
1122
|
+
"in": "path",
|
|
1123
|
+
"schema": {
|
|
1124
|
+
"type": "string"
|
|
1125
|
+
}
|
|
1126
|
+
}
|
|
1127
|
+
],
|
|
1128
|
+
"responses": {
|
|
1129
|
+
"200": {
|
|
1130
|
+
"description": "Returns the privacy document",
|
|
1131
|
+
"content": {
|
|
1132
|
+
"application/json": {
|
|
1133
|
+
"schema": {
|
|
1134
|
+
"$ref": "#/components/schemas/PrivacyDocument"
|
|
1135
|
+
}
|
|
1136
|
+
}
|
|
1137
|
+
}
|
|
1138
|
+
},
|
|
1139
|
+
"403": {
|
|
1140
|
+
"description": "Not authorized to read privacy documents"
|
|
1141
|
+
},
|
|
1142
|
+
"404": {
|
|
1143
|
+
"description": "Privacy document not found"
|
|
1144
|
+
}
|
|
1145
|
+
},
|
|
1146
|
+
"summary": "Get privacy document by ID",
|
|
1147
|
+
"tags": [
|
|
1148
|
+
"Privacy Documents"
|
|
1149
|
+
]
|
|
1150
|
+
}
|
|
1151
|
+
},
|
|
1152
|
+
"/api/v1/customers/{customerId}/privacy-documents/published": {
|
|
1153
|
+
"get": {
|
|
1154
|
+
"operationId": "PrivacyDocumentController_getPublished_v1",
|
|
1155
|
+
"parameters": [
|
|
1156
|
+
{
|
|
1157
|
+
"name": "customerId",
|
|
1158
|
+
"required": true,
|
|
1159
|
+
"in": "path",
|
|
1160
|
+
"schema": {
|
|
1161
|
+
"type": "string"
|
|
1162
|
+
}
|
|
1163
|
+
},
|
|
1164
|
+
{
|
|
1165
|
+
"name": "language",
|
|
1166
|
+
"required": true,
|
|
1167
|
+
"in": "query",
|
|
1168
|
+
"description": "Language code (e.g., \"en\", \"fr\", \"es\")",
|
|
1169
|
+
"schema": {
|
|
1170
|
+
"example": "en",
|
|
1171
|
+
"type": "string"
|
|
1172
|
+
}
|
|
1173
|
+
}
|
|
1174
|
+
],
|
|
1175
|
+
"responses": {
|
|
1176
|
+
"200": {
|
|
1177
|
+
"description": "Returns the published privacy document",
|
|
1178
|
+
"content": {
|
|
1179
|
+
"application/json": {
|
|
1180
|
+
"schema": {
|
|
1181
|
+
"$ref": "#/components/schemas/PrivacyDocument"
|
|
1182
|
+
}
|
|
1183
|
+
}
|
|
1184
|
+
}
|
|
1185
|
+
},
|
|
1186
|
+
"403": {
|
|
1187
|
+
"description": "Not authorized to read privacy documents"
|
|
1188
|
+
},
|
|
1189
|
+
"404": {
|
|
1190
|
+
"description": "Privacy document not found"
|
|
1191
|
+
}
|
|
1192
|
+
},
|
|
1193
|
+
"summary": "Get published privacy document by language",
|
|
1194
|
+
"tags": [
|
|
1195
|
+
"Privacy Documents"
|
|
1196
|
+
]
|
|
1197
|
+
}
|
|
1198
|
+
},
|
|
1199
|
+
"/api/v1/onboarding/{customerId}/logo": {
|
|
1200
|
+
"get": {
|
|
1201
|
+
"operationId": "OnboardingController_getLogoUrl_v1",
|
|
1202
|
+
"parameters": [
|
|
1203
|
+
{
|
|
1204
|
+
"name": "customerId",
|
|
1205
|
+
"required": true,
|
|
1206
|
+
"in": "path",
|
|
1207
|
+
"schema": {
|
|
1208
|
+
"type": "string"
|
|
1209
|
+
}
|
|
1210
|
+
}
|
|
1211
|
+
],
|
|
1212
|
+
"responses": {
|
|
1213
|
+
"200": {
|
|
1214
|
+
"description": "Returns signed URL for the logo, or null if no logo exists",
|
|
1215
|
+
"content": {
|
|
1216
|
+
"application/json": {
|
|
1217
|
+
"schema": {
|
|
1218
|
+
"properties": {
|
|
1219
|
+
"expiresIn": {
|
|
1220
|
+
"description": "URL expiration time in seconds",
|
|
1221
|
+
"type": "number"
|
|
1222
|
+
},
|
|
1223
|
+
"url": {
|
|
1224
|
+
"description": "Signed S3 URL for the logo",
|
|
1225
|
+
"type": "string"
|
|
1226
|
+
}
|
|
1227
|
+
},
|
|
1228
|
+
"type": "object"
|
|
1229
|
+
}
|
|
1230
|
+
}
|
|
1231
|
+
}
|
|
1232
|
+
},
|
|
1233
|
+
"400": {
|
|
1234
|
+
"description": "Invalid customerId"
|
|
1235
|
+
},
|
|
1236
|
+
"403": {
|
|
1237
|
+
"description": "Not authorized to access this customer configuration"
|
|
1238
|
+
},
|
|
1239
|
+
"404": {
|
|
1240
|
+
"description": "Customer configuration not found"
|
|
1241
|
+
}
|
|
1242
|
+
},
|
|
1243
|
+
"summary": "Get signed URL for onboarding logo",
|
|
1244
|
+
"tags": [
|
|
1245
|
+
"Onboarding"
|
|
1246
|
+
]
|
|
1247
|
+
},
|
|
1248
|
+
"patch": {
|
|
1249
|
+
"operationId": "OnboardingController_uploadLogo_v1",
|
|
1250
|
+
"parameters": [
|
|
1251
|
+
{
|
|
1252
|
+
"name": "customerId",
|
|
1253
|
+
"required": true,
|
|
1254
|
+
"in": "path",
|
|
1255
|
+
"schema": {
|
|
1256
|
+
"type": "string"
|
|
1257
|
+
}
|
|
1258
|
+
}
|
|
1259
|
+
],
|
|
1260
|
+
"responses": {
|
|
1261
|
+
"200": {
|
|
1262
|
+
"description": "",
|
|
1263
|
+
"content": {
|
|
1264
|
+
"application/json": {
|
|
1265
|
+
"schema": {
|
|
1266
|
+
"$ref": "#/components/schemas/CustomerConfig"
|
|
1267
|
+
}
|
|
1268
|
+
}
|
|
1269
|
+
}
|
|
1270
|
+
},
|
|
1271
|
+
"400": {
|
|
1272
|
+
"description": "Invalid request"
|
|
1273
|
+
},
|
|
1274
|
+
"403": {
|
|
1275
|
+
"description": "Not authorized to access this customer configuration"
|
|
1276
|
+
},
|
|
1277
|
+
"404": {
|
|
1278
|
+
"description": "Customer configuration not found"
|
|
1279
|
+
}
|
|
1280
|
+
},
|
|
1281
|
+
"summary": "Upload a logo for onboarding welcome quote",
|
|
1282
|
+
"tags": [
|
|
1283
|
+
"Onboarding"
|
|
1284
|
+
]
|
|
1285
|
+
}
|
|
1286
|
+
},
|
|
1287
|
+
"/api/v1/customers/{customerId}/signal": {
|
|
1288
|
+
"get": {
|
|
1289
|
+
"operationId": "CustomerSignalConfigController_getSignal_v1",
|
|
1290
|
+
"parameters": [
|
|
1291
|
+
{
|
|
1292
|
+
"name": "customerId",
|
|
1293
|
+
"required": true,
|
|
1294
|
+
"in": "path",
|
|
1295
|
+
"schema": {
|
|
1296
|
+
"format": "objectid",
|
|
1297
|
+
"type": "string"
|
|
1298
|
+
}
|
|
1299
|
+
}
|
|
1300
|
+
],
|
|
1301
|
+
"responses": {
|
|
1302
|
+
"200": {
|
|
1303
|
+
"description": "Returns the signal configuration",
|
|
1304
|
+
"content": {
|
|
1305
|
+
"application/json": {
|
|
1306
|
+
"schema": {
|
|
1307
|
+
"$ref": "#/components/schemas/SignalCustomerConfig"
|
|
1308
|
+
}
|
|
1309
|
+
}
|
|
1310
|
+
}
|
|
1311
|
+
},
|
|
1312
|
+
"404": {
|
|
1313
|
+
"description": "Customer configuration not found"
|
|
1314
|
+
}
|
|
1315
|
+
},
|
|
1316
|
+
"summary": "Get signal configuration for a customer",
|
|
1317
|
+
"tags": [
|
|
1318
|
+
"Customer Signal Configuration"
|
|
1319
|
+
]
|
|
1320
|
+
},
|
|
1321
|
+
"patch": {
|
|
1322
|
+
"operationId": "CustomerSignalConfigController_patchSignal_v1",
|
|
1323
|
+
"parameters": [
|
|
1324
|
+
{
|
|
1325
|
+
"name": "customerId",
|
|
1326
|
+
"required": true,
|
|
1327
|
+
"in": "path",
|
|
1328
|
+
"schema": {
|
|
1329
|
+
"format": "objectid",
|
|
1330
|
+
"type": "string"
|
|
1331
|
+
}
|
|
1332
|
+
}
|
|
1333
|
+
],
|
|
1334
|
+
"requestBody": {
|
|
1335
|
+
"required": true,
|
|
1336
|
+
"content": {
|
|
1337
|
+
"application/json": {
|
|
1338
|
+
"schema": {
|
|
1339
|
+
"$ref": "#/components/schemas/SignalCustomerConfig"
|
|
1340
|
+
}
|
|
1341
|
+
}
|
|
1342
|
+
}
|
|
1343
|
+
},
|
|
1344
|
+
"responses": {
|
|
1345
|
+
"200": {
|
|
1346
|
+
"description": "Returns the updated signal configuration",
|
|
1347
|
+
"content": {
|
|
1348
|
+
"application/json": {
|
|
1349
|
+
"schema": {
|
|
1350
|
+
"$ref": "#/components/schemas/SignalCustomerConfig"
|
|
1351
|
+
}
|
|
1352
|
+
}
|
|
1353
|
+
}
|
|
1354
|
+
},
|
|
1355
|
+
"404": {
|
|
1356
|
+
"description": "Customer configuration not found"
|
|
1357
|
+
}
|
|
1358
|
+
},
|
|
1359
|
+
"summary": "Patch signal configuration for a customer",
|
|
1360
|
+
"tags": [
|
|
1361
|
+
"Customer Signal Configuration"
|
|
1362
|
+
]
|
|
1363
|
+
}
|
|
1364
|
+
},
|
|
1365
|
+
"/api/v1/customers/{customerId}/signal/insights": {
|
|
1366
|
+
"get": {
|
|
1367
|
+
"operationId": "CustomerSignalConfigController_getInsights_v1",
|
|
1368
|
+
"parameters": [
|
|
1369
|
+
{
|
|
1370
|
+
"name": "customerId",
|
|
1371
|
+
"required": true,
|
|
1372
|
+
"in": "path",
|
|
1373
|
+
"schema": {
|
|
1374
|
+
"format": "objectid",
|
|
1375
|
+
"type": "string"
|
|
1376
|
+
}
|
|
1377
|
+
}
|
|
1378
|
+
],
|
|
1379
|
+
"responses": {
|
|
1380
|
+
"200": {
|
|
1381
|
+
"description": "Returns the insights configuration",
|
|
1382
|
+
"content": {
|
|
1383
|
+
"application/json": {
|
|
1384
|
+
"schema": {
|
|
1385
|
+
"$ref": "#/components/schemas/InsightsConfig"
|
|
1386
|
+
}
|
|
1387
|
+
}
|
|
1388
|
+
}
|
|
1389
|
+
},
|
|
1390
|
+
"404": {
|
|
1391
|
+
"description": "Customer configuration not found"
|
|
1392
|
+
}
|
|
1393
|
+
},
|
|
1394
|
+
"summary": "Get signal insights configuration for a customer",
|
|
1395
|
+
"tags": [
|
|
1396
|
+
"Customer Signal Configuration"
|
|
1397
|
+
]
|
|
1398
|
+
},
|
|
1399
|
+
"patch": {
|
|
1400
|
+
"operationId": "CustomerSignalConfigController_patchInsights_v1",
|
|
1401
|
+
"parameters": [
|
|
1402
|
+
{
|
|
1403
|
+
"name": "customerId",
|
|
1404
|
+
"required": true,
|
|
1405
|
+
"in": "path",
|
|
1406
|
+
"schema": {
|
|
1407
|
+
"format": "objectid",
|
|
1408
|
+
"type": "string"
|
|
1409
|
+
}
|
|
1410
|
+
}
|
|
1411
|
+
],
|
|
1412
|
+
"requestBody": {
|
|
1413
|
+
"required": true,
|
|
1414
|
+
"content": {
|
|
1415
|
+
"application/json": {
|
|
1416
|
+
"schema": {
|
|
1417
|
+
"$ref": "#/components/schemas/InsightsConfig"
|
|
1418
|
+
}
|
|
1419
|
+
}
|
|
1420
|
+
}
|
|
1421
|
+
},
|
|
1422
|
+
"responses": {
|
|
1423
|
+
"200": {
|
|
1424
|
+
"description": "Returns the updated insights configuration",
|
|
1425
|
+
"content": {
|
|
1426
|
+
"application/json": {
|
|
1427
|
+
"schema": {
|
|
1428
|
+
"$ref": "#/components/schemas/InsightsConfig"
|
|
1429
|
+
}
|
|
1430
|
+
}
|
|
1431
|
+
}
|
|
1432
|
+
},
|
|
1433
|
+
"404": {
|
|
1434
|
+
"description": "Customer configuration not found"
|
|
1435
|
+
}
|
|
1436
|
+
},
|
|
1437
|
+
"summary": "Patch signal insights configuration for a customer",
|
|
1438
|
+
"tags": [
|
|
1439
|
+
"Customer Signal Configuration"
|
|
1440
|
+
]
|
|
1441
|
+
}
|
|
1442
|
+
},
|
|
1443
|
+
"/api/v1/customers/{customerId}/signal/insights/org": {
|
|
1444
|
+
"get": {
|
|
1445
|
+
"operationId": "CustomerSignalConfigController_getOrg_v1",
|
|
1446
|
+
"parameters": [
|
|
1447
|
+
{
|
|
1448
|
+
"name": "customerId",
|
|
1449
|
+
"required": true,
|
|
1450
|
+
"in": "path",
|
|
1451
|
+
"schema": {
|
|
1452
|
+
"format": "objectid",
|
|
1453
|
+
"type": "string"
|
|
1454
|
+
}
|
|
1455
|
+
}
|
|
1456
|
+
],
|
|
1457
|
+
"responses": {
|
|
1458
|
+
"200": {
|
|
1459
|
+
"description": "Returns the org insights configuration",
|
|
1460
|
+
"content": {
|
|
1461
|
+
"application/json": {
|
|
1462
|
+
"schema": {
|
|
1463
|
+
"$ref": "#/components/schemas/OrgInsightsConfig"
|
|
1464
|
+
}
|
|
1465
|
+
}
|
|
1466
|
+
}
|
|
1467
|
+
},
|
|
1468
|
+
"404": {
|
|
1469
|
+
"description": "Customer configuration not found"
|
|
1470
|
+
}
|
|
1471
|
+
},
|
|
1472
|
+
"summary": "Get signal org insights configuration for a customer",
|
|
1473
|
+
"tags": [
|
|
1474
|
+
"Customer Signal Configuration"
|
|
1475
|
+
]
|
|
1476
|
+
},
|
|
1477
|
+
"patch": {
|
|
1478
|
+
"operationId": "CustomerSignalConfigController_patchOrg_v1",
|
|
1479
|
+
"parameters": [
|
|
1480
|
+
{
|
|
1481
|
+
"name": "customerId",
|
|
1482
|
+
"required": true,
|
|
1483
|
+
"in": "path",
|
|
1484
|
+
"schema": {
|
|
1485
|
+
"format": "objectid",
|
|
1486
|
+
"type": "string"
|
|
1487
|
+
}
|
|
1488
|
+
}
|
|
1489
|
+
],
|
|
1490
|
+
"requestBody": {
|
|
1491
|
+
"required": true,
|
|
1492
|
+
"content": {
|
|
1493
|
+
"application/json": {
|
|
1494
|
+
"schema": {
|
|
1495
|
+
"$ref": "#/components/schemas/OrgInsightsConfig"
|
|
1496
|
+
}
|
|
1497
|
+
}
|
|
1498
|
+
}
|
|
1499
|
+
},
|
|
1500
|
+
"responses": {
|
|
1501
|
+
"200": {
|
|
1502
|
+
"description": "Returns the updated org insights configuration",
|
|
1503
|
+
"content": {
|
|
1504
|
+
"application/json": {
|
|
1505
|
+
"schema": {
|
|
1506
|
+
"$ref": "#/components/schemas/OrgInsightsConfig"
|
|
1507
|
+
}
|
|
1508
|
+
}
|
|
1509
|
+
}
|
|
1510
|
+
},
|
|
1511
|
+
"404": {
|
|
1512
|
+
"description": "Customer configuration not found"
|
|
1513
|
+
}
|
|
1514
|
+
},
|
|
1515
|
+
"summary": "Patch signal org insights configuration for a customer",
|
|
1516
|
+
"tags": [
|
|
1517
|
+
"Customer Signal Configuration"
|
|
1518
|
+
]
|
|
1519
|
+
}
|
|
1520
|
+
},
|
|
1521
|
+
"/api/v1/customers/{customerId}/signal/insights/org/timeVelocity": {
|
|
1522
|
+
"get": {
|
|
1523
|
+
"operationId": "CustomerSignalConfigController_getTimeVelocity_v1",
|
|
1524
|
+
"parameters": [
|
|
1525
|
+
{
|
|
1526
|
+
"name": "customerId",
|
|
1527
|
+
"required": true,
|
|
1528
|
+
"in": "path",
|
|
1529
|
+
"schema": {
|
|
1530
|
+
"format": "objectid",
|
|
1531
|
+
"type": "string"
|
|
1532
|
+
}
|
|
1533
|
+
}
|
|
1534
|
+
],
|
|
1535
|
+
"responses": {
|
|
1536
|
+
"200": {
|
|
1537
|
+
"description": "Returns the time velocity configuration",
|
|
1538
|
+
"content": {
|
|
1539
|
+
"application/json": {
|
|
1540
|
+
"schema": {
|
|
1541
|
+
"$ref": "#/components/schemas/TimeVelocityConfig"
|
|
1542
|
+
}
|
|
1543
|
+
}
|
|
1544
|
+
}
|
|
1545
|
+
},
|
|
1546
|
+
"404": {
|
|
1547
|
+
"description": "Customer configuration not found"
|
|
1548
|
+
}
|
|
1549
|
+
},
|
|
1550
|
+
"summary": "Get signal time velocity configuration for a customer",
|
|
1551
|
+
"tags": [
|
|
1552
|
+
"Customer Signal Configuration"
|
|
1553
|
+
]
|
|
1554
|
+
},
|
|
1555
|
+
"patch": {
|
|
1556
|
+
"operationId": "CustomerSignalConfigController_patchTimeVelocity_v1",
|
|
1557
|
+
"parameters": [
|
|
1558
|
+
{
|
|
1559
|
+
"name": "customerId",
|
|
1560
|
+
"required": true,
|
|
1561
|
+
"in": "path",
|
|
1562
|
+
"schema": {
|
|
1563
|
+
"format": "objectid",
|
|
1564
|
+
"type": "string"
|
|
1565
|
+
}
|
|
1566
|
+
}
|
|
1567
|
+
],
|
|
1568
|
+
"requestBody": {
|
|
1569
|
+
"required": true,
|
|
1570
|
+
"content": {
|
|
1571
|
+
"application/json": {
|
|
1572
|
+
"schema": {
|
|
1573
|
+
"$ref": "#/components/schemas/TimeVelocityConfig"
|
|
1574
|
+
}
|
|
1575
|
+
}
|
|
1576
|
+
}
|
|
1577
|
+
},
|
|
1578
|
+
"responses": {
|
|
1579
|
+
"200": {
|
|
1580
|
+
"description": "Returns the updated time velocity configuration",
|
|
1581
|
+
"content": {
|
|
1582
|
+
"application/json": {
|
|
1583
|
+
"schema": {
|
|
1584
|
+
"$ref": "#/components/schemas/TimeVelocityConfig"
|
|
1585
|
+
}
|
|
1586
|
+
}
|
|
1587
|
+
}
|
|
1588
|
+
},
|
|
1589
|
+
"404": {
|
|
1590
|
+
"description": "Customer configuration not found"
|
|
1591
|
+
}
|
|
1592
|
+
},
|
|
1593
|
+
"summary": "Patch signal time velocity configuration for a customer",
|
|
1594
|
+
"tags": [
|
|
1595
|
+
"Customer Signal Configuration"
|
|
1596
|
+
]
|
|
1597
|
+
}
|
|
1598
|
+
}
|
|
1599
|
+
},
|
|
1600
|
+
"info": {
|
|
1601
|
+
"title": "Settings Service API",
|
|
1602
|
+
"description": "",
|
|
1603
|
+
"version": "1",
|
|
1604
|
+
"contact": {}
|
|
1605
|
+
},
|
|
1606
|
+
"tags": [],
|
|
1607
|
+
"servers": [],
|
|
1608
|
+
"components": {
|
|
1609
|
+
"securitySchemes": {
|
|
1610
|
+
"ApiBearerAuth": {
|
|
1611
|
+
"scheme": "bearer",
|
|
1612
|
+
"bearerFormat": "JWT",
|
|
1613
|
+
"description": "Enter access token",
|
|
1614
|
+
"type": "http"
|
|
1615
|
+
}
|
|
1616
|
+
},
|
|
1617
|
+
"schemas": {
|
|
1618
|
+
"GlobalConfigCreateDto": {
|
|
1619
|
+
"type": "object",
|
|
1620
|
+
"properties": {
|
|
1621
|
+
"agentConfigurationRefreshInterval": {
|
|
1622
|
+
"type": "number",
|
|
1623
|
+
"format": "double",
|
|
1624
|
+
"nullable": true
|
|
1625
|
+
},
|
|
1626
|
+
"feedbackUrl": {
|
|
1627
|
+
"type": "string",
|
|
1628
|
+
"nullable": true
|
|
1629
|
+
},
|
|
1630
|
+
"identityServiceManagementUrl": {
|
|
1631
|
+
"type": "string",
|
|
1632
|
+
"nullable": true
|
|
1633
|
+
},
|
|
1634
|
+
"logLevel": {
|
|
1635
|
+
"type": "string",
|
|
1636
|
+
"enum": [
|
|
1637
|
+
"DEBUG",
|
|
1638
|
+
"INFO",
|
|
1639
|
+
"ERROR",
|
|
1640
|
+
"WARN"
|
|
1641
|
+
],
|
|
1642
|
+
"nullable": true
|
|
1643
|
+
},
|
|
1644
|
+
"supportUrl": {
|
|
1645
|
+
"type": "string",
|
|
1646
|
+
"nullable": true
|
|
1647
|
+
},
|
|
1648
|
+
"laurelUrl": {
|
|
1649
|
+
"type": "string",
|
|
1650
|
+
"nullable": true
|
|
1651
|
+
},
|
|
1652
|
+
"agentMinimumWindowsClientVersionSupported": {
|
|
1653
|
+
"type": "string",
|
|
1654
|
+
"nullable": true
|
|
1655
|
+
},
|
|
1656
|
+
"agentMinimumWindowsClientVersionSupportedMessage": {
|
|
1657
|
+
"type": "string",
|
|
1658
|
+
"nullable": true
|
|
1659
|
+
},
|
|
1660
|
+
"agentMinimumMacClientVersionSupported": {
|
|
1661
|
+
"type": "string",
|
|
1662
|
+
"nullable": true
|
|
1663
|
+
},
|
|
1664
|
+
"agentMinimumMacClientVersionSupportedMessage": {
|
|
1665
|
+
"type": "string",
|
|
1666
|
+
"nullable": true
|
|
1667
|
+
},
|
|
1668
|
+
"agentLoggingEndpoint": {
|
|
1669
|
+
"type": "string",
|
|
1670
|
+
"nullable": true
|
|
1671
|
+
},
|
|
1672
|
+
"agentLoggingSecureEndpoint": {
|
|
1673
|
+
"type": "string",
|
|
1674
|
+
"nullable": true
|
|
1675
|
+
},
|
|
1676
|
+
"agentLoggingToken": {
|
|
1677
|
+
"type": "string",
|
|
1678
|
+
"nullable": true
|
|
1679
|
+
}
|
|
1680
|
+
}
|
|
1681
|
+
},
|
|
1682
|
+
"GlobalConfig": {
|
|
1683
|
+
"type": "object",
|
|
1684
|
+
"properties": {
|
|
1685
|
+
"_id": {
|
|
1686
|
+
"type": "string",
|
|
1687
|
+
"format": "objectid"
|
|
1688
|
+
},
|
|
1689
|
+
"agentConfigurationRefreshInterval": {
|
|
1690
|
+
"type": "number",
|
|
1691
|
+
"format": "double",
|
|
1692
|
+
"nullable": true
|
|
1693
|
+
},
|
|
1694
|
+
"deletedAt": {
|
|
1695
|
+
"type": "string",
|
|
1696
|
+
"example": "2022-08-12T20:44:48Z",
|
|
1697
|
+
"format": "iso-date-time"
|
|
1698
|
+
},
|
|
1699
|
+
"feedbackUrl": {
|
|
1700
|
+
"type": "string",
|
|
1701
|
+
"nullable": true
|
|
1702
|
+
},
|
|
1703
|
+
"identityServiceManagementUrl": {
|
|
1704
|
+
"type": "string",
|
|
1705
|
+
"nullable": true
|
|
1706
|
+
},
|
|
1707
|
+
"logLevel": {
|
|
1708
|
+
"type": "string",
|
|
1709
|
+
"enum": [
|
|
1710
|
+
"DEBUG",
|
|
1711
|
+
"INFO",
|
|
1712
|
+
"ERROR",
|
|
1713
|
+
"WARN"
|
|
1714
|
+
],
|
|
1715
|
+
"nullable": true
|
|
1716
|
+
},
|
|
1717
|
+
"name": {
|
|
1718
|
+
"type": "string"
|
|
1719
|
+
},
|
|
1720
|
+
"supportUrl": {
|
|
1721
|
+
"type": "string",
|
|
1722
|
+
"nullable": true
|
|
1723
|
+
},
|
|
1724
|
+
"laurelUrl": {
|
|
1725
|
+
"type": "string",
|
|
1726
|
+
"nullable": true
|
|
1727
|
+
},
|
|
1728
|
+
"agentMinimumWindowsClientVersionSupported": {
|
|
1729
|
+
"type": "string",
|
|
1730
|
+
"nullable": true
|
|
1731
|
+
},
|
|
1732
|
+
"agentMinimumWindowsClientVersionSupportedMessage": {
|
|
1733
|
+
"type": "string",
|
|
1734
|
+
"nullable": true
|
|
1735
|
+
},
|
|
1736
|
+
"agentMinimumMacClientVersionSupported": {
|
|
1737
|
+
"type": "string",
|
|
1738
|
+
"nullable": true
|
|
1739
|
+
},
|
|
1740
|
+
"agentMinimumMacClientVersionSupportedMessage": {
|
|
1741
|
+
"type": "string",
|
|
1742
|
+
"nullable": true
|
|
1743
|
+
},
|
|
1744
|
+
"agentLoggingEndpoint": {
|
|
1745
|
+
"type": "string",
|
|
1746
|
+
"nullable": true
|
|
1747
|
+
},
|
|
1748
|
+
"agentLoggingSecureEndpoint": {
|
|
1749
|
+
"type": "string",
|
|
1750
|
+
"nullable": true
|
|
1751
|
+
},
|
|
1752
|
+
"agentLoggingToken": {
|
|
1753
|
+
"type": "string",
|
|
1754
|
+
"nullable": true
|
|
1755
|
+
},
|
|
1756
|
+
"version": {
|
|
1757
|
+
"type": "string",
|
|
1758
|
+
"example": "2022-08-12T20:44:48Z",
|
|
1759
|
+
"format": "iso-date-time"
|
|
1760
|
+
},
|
|
1761
|
+
"versionUserId": {
|
|
1762
|
+
"type": "string",
|
|
1763
|
+
"format": "objectid",
|
|
1764
|
+
"nullable": true
|
|
1765
|
+
},
|
|
1766
|
+
"schemaVersion": {
|
|
1767
|
+
"type": "string"
|
|
1768
|
+
}
|
|
1769
|
+
},
|
|
1770
|
+
"required": [
|
|
1771
|
+
"_id",
|
|
1772
|
+
"name",
|
|
1773
|
+
"version"
|
|
1774
|
+
]
|
|
1775
|
+
},
|
|
1776
|
+
"GlobalConfigUpdateDto": {
|
|
1777
|
+
"type": "object",
|
|
1778
|
+
"properties": {
|
|
1779
|
+
"agentConfigurationRefreshInterval": {
|
|
1780
|
+
"type": "number",
|
|
1781
|
+
"format": "double",
|
|
1782
|
+
"nullable": true
|
|
1783
|
+
},
|
|
1784
|
+
"feedbackUrl": {
|
|
1785
|
+
"type": "string",
|
|
1786
|
+
"nullable": true
|
|
1787
|
+
},
|
|
1788
|
+
"identityServiceManagementUrl": {
|
|
1789
|
+
"type": "string",
|
|
1790
|
+
"nullable": true
|
|
1791
|
+
},
|
|
1792
|
+
"logLevel": {
|
|
1793
|
+
"type": "string",
|
|
1794
|
+
"enum": [
|
|
1795
|
+
"DEBUG",
|
|
1796
|
+
"INFO",
|
|
1797
|
+
"ERROR",
|
|
1798
|
+
"WARN"
|
|
1799
|
+
],
|
|
1800
|
+
"nullable": true
|
|
1801
|
+
},
|
|
1802
|
+
"supportUrl": {
|
|
1803
|
+
"type": "string",
|
|
1804
|
+
"nullable": true
|
|
1805
|
+
},
|
|
1806
|
+
"laurelUrl": {
|
|
1807
|
+
"type": "string",
|
|
1808
|
+
"nullable": true
|
|
1809
|
+
},
|
|
1810
|
+
"agentMinimumWindowsClientVersionSupported": {
|
|
1811
|
+
"type": "string",
|
|
1812
|
+
"nullable": true
|
|
1813
|
+
},
|
|
1814
|
+
"agentMinimumWindowsClientVersionSupportedMessage": {
|
|
1815
|
+
"type": "string",
|
|
1816
|
+
"nullable": true
|
|
1817
|
+
},
|
|
1818
|
+
"agentMinimumMacClientVersionSupported": {
|
|
1819
|
+
"type": "string",
|
|
1820
|
+
"nullable": true
|
|
1821
|
+
},
|
|
1822
|
+
"agentMinimumMacClientVersionSupportedMessage": {
|
|
1823
|
+
"type": "string",
|
|
1824
|
+
"nullable": true
|
|
1825
|
+
},
|
|
1826
|
+
"agentLoggingEndpoint": {
|
|
1827
|
+
"type": "string",
|
|
1828
|
+
"nullable": true
|
|
1829
|
+
},
|
|
1830
|
+
"agentLoggingSecureEndpoint": {
|
|
1831
|
+
"type": "string",
|
|
1832
|
+
"nullable": true
|
|
1833
|
+
},
|
|
1834
|
+
"agentLoggingToken": {
|
|
1835
|
+
"type": "string",
|
|
1836
|
+
"nullable": true
|
|
1837
|
+
}
|
|
1838
|
+
}
|
|
1839
|
+
},
|
|
1840
|
+
"TenantConfigCreateDto": {
|
|
1841
|
+
"type": "object",
|
|
1842
|
+
"properties": {
|
|
1843
|
+
"tenantId": {
|
|
1844
|
+
"type": "string",
|
|
1845
|
+
"format": "objectid"
|
|
1846
|
+
},
|
|
1847
|
+
"atlasMajorVersion": {
|
|
1848
|
+
"type": "number",
|
|
1849
|
+
"format": "double",
|
|
1850
|
+
"nullable": true
|
|
1851
|
+
},
|
|
1852
|
+
"atlasMinorVersion": {
|
|
1853
|
+
"type": "number",
|
|
1854
|
+
"format": "double",
|
|
1855
|
+
"nullable": true
|
|
1856
|
+
},
|
|
1857
|
+
"enableAlerts": {
|
|
1858
|
+
"type": "boolean",
|
|
1859
|
+
"nullable": true
|
|
1860
|
+
},
|
|
1861
|
+
"enableAtlas": {
|
|
1862
|
+
"type": "boolean",
|
|
1863
|
+
"nullable": true
|
|
1864
|
+
},
|
|
1865
|
+
"enableFeatureFlags": {
|
|
1866
|
+
"type": "boolean",
|
|
1867
|
+
"nullable": true
|
|
1868
|
+
},
|
|
1869
|
+
"enableTracking": {
|
|
1870
|
+
"type": "boolean",
|
|
1871
|
+
"nullable": true
|
|
1872
|
+
},
|
|
1873
|
+
"enableTrackingMicrosoftTeams": {
|
|
1874
|
+
"type": "boolean",
|
|
1875
|
+
"nullable": true
|
|
1876
|
+
},
|
|
1877
|
+
"enableTrackingGoogle": {
|
|
1878
|
+
"type": "boolean",
|
|
1879
|
+
"nullable": true
|
|
1880
|
+
},
|
|
1881
|
+
"enableTrackingZoom": {
|
|
1882
|
+
"type": "boolean",
|
|
1883
|
+
"nullable": true
|
|
1884
|
+
},
|
|
1885
|
+
"trackingWebexCDREnabled": {
|
|
1886
|
+
"type": "boolean",
|
|
1887
|
+
"nullable": true
|
|
1888
|
+
},
|
|
1889
|
+
"trackingWebexCallsEnabled": {
|
|
1890
|
+
"type": "boolean",
|
|
1891
|
+
"nullable": true
|
|
1892
|
+
},
|
|
1893
|
+
"trackingWebexMeetingsEnabled": {
|
|
1894
|
+
"type": "boolean",
|
|
1895
|
+
"nullable": true
|
|
1896
|
+
},
|
|
1897
|
+
"environmentName": {
|
|
1898
|
+
"type": "string",
|
|
1899
|
+
"nullable": true
|
|
1900
|
+
},
|
|
1901
|
+
"logLevel": {
|
|
1902
|
+
"type": "string",
|
|
1903
|
+
"enum": [
|
|
1904
|
+
"DEBUG",
|
|
1905
|
+
"INFO",
|
|
1906
|
+
"ERROR",
|
|
1907
|
+
"WARN"
|
|
1908
|
+
],
|
|
1909
|
+
"nullable": true
|
|
1910
|
+
},
|
|
1911
|
+
"outboundIps": {
|
|
1912
|
+
"type": "array",
|
|
1913
|
+
"items": {
|
|
1914
|
+
"type": "string"
|
|
1915
|
+
}
|
|
1916
|
+
},
|
|
1917
|
+
"timeServiceUrl": {
|
|
1918
|
+
"type": "string",
|
|
1919
|
+
"nullable": true
|
|
1920
|
+
},
|
|
1921
|
+
"trackingMongoUri": {
|
|
1922
|
+
"type": "string",
|
|
1923
|
+
"nullable": true
|
|
1924
|
+
}
|
|
1925
|
+
},
|
|
1926
|
+
"required": [
|
|
1927
|
+
"tenantId"
|
|
1928
|
+
]
|
|
1929
|
+
},
|
|
1930
|
+
"TenantConfig": {
|
|
1931
|
+
"type": "object",
|
|
1932
|
+
"properties": {
|
|
1933
|
+
"_id": {
|
|
1934
|
+
"type": "string",
|
|
1935
|
+
"format": "objectid"
|
|
1936
|
+
},
|
|
1937
|
+
"atlasMajorVersion": {
|
|
1938
|
+
"type": "number",
|
|
1939
|
+
"format": "double",
|
|
1940
|
+
"nullable": true
|
|
1941
|
+
},
|
|
1942
|
+
"atlasMinorVersion": {
|
|
1943
|
+
"type": "number",
|
|
1944
|
+
"format": "double",
|
|
1945
|
+
"nullable": true
|
|
1946
|
+
},
|
|
1947
|
+
"deletedAt": {
|
|
1948
|
+
"type": "string",
|
|
1949
|
+
"example": "2022-08-12T20:44:48Z",
|
|
1950
|
+
"format": "iso-date-time"
|
|
1951
|
+
},
|
|
1952
|
+
"enableAlerts": {
|
|
1953
|
+
"type": "boolean",
|
|
1954
|
+
"nullable": true
|
|
1955
|
+
},
|
|
1956
|
+
"enableAtlas": {
|
|
1957
|
+
"type": "boolean",
|
|
1958
|
+
"nullable": true
|
|
1959
|
+
},
|
|
1960
|
+
"enableFeatureFlags": {
|
|
1961
|
+
"type": "boolean",
|
|
1962
|
+
"nullable": true
|
|
1963
|
+
},
|
|
1964
|
+
"enableTracking": {
|
|
1965
|
+
"type": "boolean",
|
|
1966
|
+
"nullable": true
|
|
1967
|
+
},
|
|
1968
|
+
"enableTrackingMicrosoftTeams": {
|
|
1969
|
+
"type": "boolean",
|
|
1970
|
+
"nullable": true
|
|
1971
|
+
},
|
|
1972
|
+
"enableTrackingGoogle": {
|
|
1973
|
+
"type": "boolean",
|
|
1974
|
+
"nullable": true
|
|
1975
|
+
},
|
|
1976
|
+
"enableTrackingZoom": {
|
|
1977
|
+
"type": "boolean",
|
|
1978
|
+
"nullable": true
|
|
1979
|
+
},
|
|
1980
|
+
"trackingWebexCDREnabled": {
|
|
1981
|
+
"type": "boolean",
|
|
1982
|
+
"nullable": true
|
|
1983
|
+
},
|
|
1984
|
+
"trackingWebexCallsEnabled": {
|
|
1985
|
+
"type": "boolean",
|
|
1986
|
+
"nullable": true
|
|
1987
|
+
},
|
|
1988
|
+
"trackingWebexMeetingsEnabled": {
|
|
1989
|
+
"type": "boolean",
|
|
1990
|
+
"nullable": true
|
|
1991
|
+
},
|
|
1992
|
+
"environmentName": {
|
|
1993
|
+
"type": "string",
|
|
1994
|
+
"nullable": true
|
|
1995
|
+
},
|
|
1996
|
+
"logLevel": {
|
|
1997
|
+
"type": "string",
|
|
1998
|
+
"enum": [
|
|
1999
|
+
"DEBUG",
|
|
2000
|
+
"INFO",
|
|
2001
|
+
"ERROR",
|
|
2002
|
+
"WARN"
|
|
2003
|
+
],
|
|
2004
|
+
"nullable": true
|
|
2005
|
+
},
|
|
2006
|
+
"outboundIps": {
|
|
2007
|
+
"type": "array",
|
|
2008
|
+
"items": {
|
|
1131
2009
|
"type": "string"
|
|
1132
2010
|
}
|
|
1133
|
-
}
|
|
1134
|
-
],
|
|
1135
|
-
"responses": {
|
|
1136
|
-
"200": {
|
|
1137
|
-
"description": "Returns the time velocity configuration",
|
|
1138
|
-
"content": {
|
|
1139
|
-
"application/json": {
|
|
1140
|
-
"schema": {
|
|
1141
|
-
"$ref": "#/components/schemas/TimeVelocityConfig"
|
|
1142
|
-
}
|
|
1143
|
-
}
|
|
1144
|
-
}
|
|
1145
2011
|
},
|
|
1146
|
-
"
|
|
1147
|
-
"
|
|
2012
|
+
"tenantId": {
|
|
2013
|
+
"type": "string",
|
|
2014
|
+
"format": "objectid"
|
|
2015
|
+
},
|
|
2016
|
+
"timeServiceUrl": {
|
|
2017
|
+
"type": "string",
|
|
2018
|
+
"nullable": true
|
|
2019
|
+
},
|
|
2020
|
+
"trackingMongoUri": {
|
|
2021
|
+
"type": "string",
|
|
2022
|
+
"nullable": true
|
|
2023
|
+
},
|
|
2024
|
+
"version": {
|
|
2025
|
+
"type": "string",
|
|
2026
|
+
"example": "2022-08-12T20:44:48Z",
|
|
2027
|
+
"format": "iso-date-time"
|
|
2028
|
+
},
|
|
2029
|
+
"versionUserId": {
|
|
2030
|
+
"type": "string",
|
|
2031
|
+
"format": "objectid",
|
|
2032
|
+
"nullable": true
|
|
2033
|
+
},
|
|
2034
|
+
"schemaVersion": {
|
|
2035
|
+
"type": "string"
|
|
1148
2036
|
}
|
|
1149
2037
|
},
|
|
1150
|
-
"
|
|
1151
|
-
|
|
1152
|
-
"
|
|
2038
|
+
"required": [
|
|
2039
|
+
"_id",
|
|
2040
|
+
"outboundIps",
|
|
2041
|
+
"tenantId",
|
|
2042
|
+
"version"
|
|
1153
2043
|
]
|
|
1154
2044
|
},
|
|
1155
|
-
"
|
|
1156
|
-
"
|
|
1157
|
-
"
|
|
1158
|
-
{
|
|
1159
|
-
"
|
|
1160
|
-
"
|
|
1161
|
-
"
|
|
1162
|
-
|
|
1163
|
-
|
|
2045
|
+
"TenantConfigUpdateDto": {
|
|
2046
|
+
"type": "object",
|
|
2047
|
+
"properties": {
|
|
2048
|
+
"atlasMajorVersion": {
|
|
2049
|
+
"type": "number",
|
|
2050
|
+
"format": "double",
|
|
2051
|
+
"nullable": true
|
|
2052
|
+
},
|
|
2053
|
+
"atlasMinorVersion": {
|
|
2054
|
+
"type": "number",
|
|
2055
|
+
"format": "double",
|
|
2056
|
+
"nullable": true
|
|
2057
|
+
},
|
|
2058
|
+
"enableAlerts": {
|
|
2059
|
+
"type": "boolean",
|
|
2060
|
+
"nullable": true
|
|
2061
|
+
},
|
|
2062
|
+
"enableAtlas": {
|
|
2063
|
+
"type": "boolean",
|
|
2064
|
+
"nullable": true
|
|
2065
|
+
},
|
|
2066
|
+
"enableFeatureFlags": {
|
|
2067
|
+
"type": "boolean",
|
|
2068
|
+
"nullable": true
|
|
2069
|
+
},
|
|
2070
|
+
"enableTracking": {
|
|
2071
|
+
"type": "boolean",
|
|
2072
|
+
"nullable": true
|
|
2073
|
+
},
|
|
2074
|
+
"enableTrackingMicrosoftTeams": {
|
|
2075
|
+
"type": "boolean",
|
|
2076
|
+
"nullable": true
|
|
2077
|
+
},
|
|
2078
|
+
"enableTrackingGoogle": {
|
|
2079
|
+
"type": "boolean",
|
|
2080
|
+
"nullable": true
|
|
2081
|
+
},
|
|
2082
|
+
"enableTrackingZoom": {
|
|
2083
|
+
"type": "boolean",
|
|
2084
|
+
"nullable": true
|
|
2085
|
+
},
|
|
2086
|
+
"trackingWebexCDREnabled": {
|
|
2087
|
+
"type": "boolean",
|
|
2088
|
+
"nullable": true
|
|
2089
|
+
},
|
|
2090
|
+
"trackingWebexCallsEnabled": {
|
|
2091
|
+
"type": "boolean",
|
|
2092
|
+
"nullable": true
|
|
2093
|
+
},
|
|
2094
|
+
"trackingWebexMeetingsEnabled": {
|
|
2095
|
+
"type": "boolean",
|
|
2096
|
+
"nullable": true
|
|
2097
|
+
},
|
|
2098
|
+
"environmentName": {
|
|
2099
|
+
"type": "string",
|
|
2100
|
+
"nullable": true
|
|
2101
|
+
},
|
|
2102
|
+
"logLevel": {
|
|
2103
|
+
"type": "string",
|
|
2104
|
+
"enum": [
|
|
2105
|
+
"DEBUG",
|
|
2106
|
+
"INFO",
|
|
2107
|
+
"ERROR",
|
|
2108
|
+
"WARN"
|
|
2109
|
+
],
|
|
2110
|
+
"nullable": true
|
|
2111
|
+
},
|
|
2112
|
+
"outboundIps": {
|
|
2113
|
+
"type": "array",
|
|
2114
|
+
"items": {
|
|
1164
2115
|
"type": "string"
|
|
1165
2116
|
}
|
|
1166
|
-
}
|
|
1167
|
-
],
|
|
1168
|
-
"requestBody": {
|
|
1169
|
-
"required": true,
|
|
1170
|
-
"content": {
|
|
1171
|
-
"application/json": {
|
|
1172
|
-
"schema": {
|
|
1173
|
-
"$ref": "#/components/schemas/TimeVelocityConfig"
|
|
1174
|
-
}
|
|
1175
|
-
}
|
|
1176
|
-
}
|
|
1177
|
-
},
|
|
1178
|
-
"responses": {
|
|
1179
|
-
"200": {
|
|
1180
|
-
"description": "Returns the updated time velocity configuration",
|
|
1181
|
-
"content": {
|
|
1182
|
-
"application/json": {
|
|
1183
|
-
"schema": {
|
|
1184
|
-
"$ref": "#/components/schemas/TimeVelocityConfig"
|
|
1185
|
-
}
|
|
1186
|
-
}
|
|
1187
|
-
}
|
|
1188
2117
|
},
|
|
1189
|
-
"
|
|
1190
|
-
"
|
|
2118
|
+
"timeServiceUrl": {
|
|
2119
|
+
"type": "string",
|
|
2120
|
+
"nullable": true
|
|
2121
|
+
},
|
|
2122
|
+
"trackingMongoUri": {
|
|
2123
|
+
"type": "string",
|
|
2124
|
+
"nullable": true
|
|
1191
2125
|
}
|
|
1192
|
-
}
|
|
1193
|
-
|
|
1194
|
-
"tags": [
|
|
1195
|
-
"Customer Signal Configuration"
|
|
1196
|
-
]
|
|
1197
|
-
}
|
|
1198
|
-
}
|
|
1199
|
-
},
|
|
1200
|
-
"info": {
|
|
1201
|
-
"title": "Settings Service API",
|
|
1202
|
-
"description": "",
|
|
1203
|
-
"version": "1",
|
|
1204
|
-
"contact": {}
|
|
1205
|
-
},
|
|
1206
|
-
"tags": [],
|
|
1207
|
-
"servers": [],
|
|
1208
|
-
"components": {
|
|
1209
|
-
"securitySchemes": {
|
|
1210
|
-
"ApiBearerAuth": {
|
|
1211
|
-
"scheme": "bearer",
|
|
1212
|
-
"bearerFormat": "JWT",
|
|
1213
|
-
"description": "Enter access token",
|
|
1214
|
-
"type": "http"
|
|
1215
|
-
}
|
|
1216
|
-
},
|
|
1217
|
-
"schemas": {
|
|
2126
|
+
}
|
|
2127
|
+
},
|
|
1218
2128
|
"AccessibilitySignatureMetadataEntry": {
|
|
1219
2129
|
"type": "object",
|
|
1220
2130
|
"properties": {
|
|
@@ -1581,9 +2491,13 @@
|
|
|
1581
2491
|
"searchText"
|
|
1582
2492
|
]
|
|
1583
2493
|
},
|
|
1584
|
-
"
|
|
2494
|
+
"UserConfig": {
|
|
1585
2495
|
"type": "object",
|
|
1586
2496
|
"properties": {
|
|
2497
|
+
"_id": {
|
|
2498
|
+
"type": "string",
|
|
2499
|
+
"format": "objectid"
|
|
2500
|
+
},
|
|
1587
2501
|
"agentAccessibilityCheckDurationInMinutes": {
|
|
1588
2502
|
"type": "number",
|
|
1589
2503
|
"format": "double",
|
|
@@ -1659,6 +2573,10 @@
|
|
|
1659
2573
|
"type": "boolean",
|
|
1660
2574
|
"nullable": true
|
|
1661
2575
|
},
|
|
2576
|
+
"customerId": {
|
|
2577
|
+
"type": "string",
|
|
2578
|
+
"format": "objectid"
|
|
2579
|
+
},
|
|
1662
2580
|
"deletedAt": {
|
|
1663
2581
|
"type": "string",
|
|
1664
2582
|
"example": "2022-08-12T20:44:48Z",
|
|
@@ -2104,6 +3022,15 @@
|
|
|
2104
3022
|
"type": "string",
|
|
2105
3023
|
"nullable": true
|
|
2106
3024
|
},
|
|
3025
|
+
"userId": {
|
|
3026
|
+
"type": "string",
|
|
3027
|
+
"format": "objectid"
|
|
3028
|
+
},
|
|
3029
|
+
"version": {
|
|
3030
|
+
"type": "string",
|
|
3031
|
+
"example": "2022-08-12T20:44:48Z",
|
|
3032
|
+
"format": "iso-date-time"
|
|
3033
|
+
},
|
|
2107
3034
|
"versionUserId": {
|
|
2108
3035
|
"type": "string",
|
|
2109
3036
|
"format": "objectid",
|
|
@@ -2164,15 +3091,18 @@
|
|
|
2164
3091
|
"$ref": "#/components/schemas/WebappWorkActivityCustomFilter"
|
|
2165
3092
|
}
|
|
2166
3093
|
}
|
|
2167
|
-
}
|
|
3094
|
+
},
|
|
3095
|
+
"required": [
|
|
3096
|
+
"_id",
|
|
3097
|
+
"customerId",
|
|
3098
|
+
"userId",
|
|
3099
|
+
"version",
|
|
3100
|
+
"timerCarryover"
|
|
3101
|
+
]
|
|
2168
3102
|
},
|
|
2169
|
-
"
|
|
3103
|
+
"UserConfigCreateDto": {
|
|
2170
3104
|
"type": "object",
|
|
2171
3105
|
"properties": {
|
|
2172
|
-
"_id": {
|
|
2173
|
-
"type": "string",
|
|
2174
|
-
"format": "objectid"
|
|
2175
|
-
},
|
|
2176
3106
|
"agentAccessibilityCheckDurationInMinutes": {
|
|
2177
3107
|
"type": "number",
|
|
2178
3108
|
"format": "double",
|
|
@@ -2248,10 +3178,6 @@
|
|
|
2248
3178
|
"type": "boolean",
|
|
2249
3179
|
"nullable": true
|
|
2250
3180
|
},
|
|
2251
|
-
"customerId": {
|
|
2252
|
-
"type": "string",
|
|
2253
|
-
"format": "objectid"
|
|
2254
|
-
},
|
|
2255
3181
|
"deletedAt": {
|
|
2256
3182
|
"type": "string",
|
|
2257
3183
|
"example": "2022-08-12T20:44:48Z",
|
|
@@ -2697,15 +3623,6 @@
|
|
|
2697
3623
|
"type": "string",
|
|
2698
3624
|
"nullable": true
|
|
2699
3625
|
},
|
|
2700
|
-
"userId": {
|
|
2701
|
-
"type": "string",
|
|
2702
|
-
"format": "objectid"
|
|
2703
|
-
},
|
|
2704
|
-
"version": {
|
|
2705
|
-
"type": "string",
|
|
2706
|
-
"example": "2022-08-12T20:44:48Z",
|
|
2707
|
-
"format": "iso-date-time"
|
|
2708
|
-
},
|
|
2709
3626
|
"versionUserId": {
|
|
2710
3627
|
"type": "string",
|
|
2711
3628
|
"format": "objectid",
|
|
@@ -2766,14 +3683,7 @@
|
|
|
2766
3683
|
"$ref": "#/components/schemas/WebappWorkActivityCustomFilter"
|
|
2767
3684
|
}
|
|
2768
3685
|
}
|
|
2769
|
-
}
|
|
2770
|
-
"required": [
|
|
2771
|
-
"_id",
|
|
2772
|
-
"customerId",
|
|
2773
|
-
"userId",
|
|
2774
|
-
"version",
|
|
2775
|
-
"timerCarryover"
|
|
2776
|
-
]
|
|
3686
|
+
}
|
|
2777
3687
|
},
|
|
2778
3688
|
"TimeZoneEntity": {
|
|
2779
3689
|
"type": "object",
|
|
@@ -4255,6 +5165,10 @@
|
|
|
4255
5165
|
"type": "boolean",
|
|
4256
5166
|
"nullable": true
|
|
4257
5167
|
},
|
|
5168
|
+
"allowUserVersionOverride": {
|
|
5169
|
+
"type": "boolean",
|
|
5170
|
+
"nullable": true
|
|
5171
|
+
},
|
|
4258
5172
|
"autoAddUsers": {
|
|
4259
5173
|
"type": "boolean",
|
|
4260
5174
|
"nullable": true
|
|
@@ -4858,6 +5772,10 @@
|
|
|
4858
5772
|
"type": "boolean",
|
|
4859
5773
|
"nullable": true
|
|
4860
5774
|
},
|
|
5775
|
+
"allowUserVersionOverride": {
|
|
5776
|
+
"type": "boolean",
|
|
5777
|
+
"nullable": true
|
|
5778
|
+
},
|
|
4861
5779
|
"autoAddUsers": {
|
|
4862
5780
|
"type": "boolean",
|
|
4863
5781
|
"nullable": true
|
|
@@ -5540,6 +6458,10 @@
|
|
|
5540
6458
|
"type": "boolean",
|
|
5541
6459
|
"nullable": true
|
|
5542
6460
|
},
|
|
6461
|
+
"allowUserVersionOverride": {
|
|
6462
|
+
"type": "boolean",
|
|
6463
|
+
"nullable": true
|
|
6464
|
+
},
|
|
5543
6465
|
"autoAddUsers": {
|
|
5544
6466
|
"type": "boolean",
|
|
5545
6467
|
"nullable": true
|