@ogcio/building-blocks-sdk 0.2.0 → 0.2.2
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/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +14 -0
- package/dist/client/clients/journey/index.d.ts.map +1 -1
- package/dist/client/clients/journey/index.js +12 -1
- package/dist/client/clients/journey/index.js.map +1 -1
- package/dist/client/clients/messaging/index.d.ts +47 -65
- package/dist/client/clients/messaging/index.d.ts.map +1 -1
- package/dist/client/clients/messaging/index.js +13 -1
- package/dist/client/clients/messaging/index.js.map +1 -1
- package/dist/client/clients/messaging/schema.d.ts +106 -1916
- package/dist/client/clients/messaging/schema.d.ts.map +1 -1
- package/dist/client/clients/payments/index.d.ts +93 -7
- package/dist/client/clients/payments/index.d.ts.map +1 -1
- package/dist/client/clients/payments/index.js +27 -1
- package/dist/client/clients/payments/index.js.map +1 -1
- package/dist/client/clients/payments/schema.d.ts +113 -7
- package/dist/client/clients/payments/schema.d.ts.map +1 -1
- package/dist/client/clients/profile/index.d.ts +30 -0
- package/dist/client/clients/profile/index.d.ts.map +1 -1
- package/dist/client/clients/profile/index.js +7 -1
- package/dist/client/clients/profile/index.js.map +1 -1
- package/dist/client/clients/profile/schema.d.ts +20 -0
- package/dist/client/clients/profile/schema.d.ts.map +1 -1
- package/dist/client/clients/upload/index.d.ts.map +1 -1
- package/dist/client/clients/upload/index.js +10 -1
- package/dist/client/clients/upload/index.js.map +1 -1
- package/dist/client/utils/client-utils.d.ts +1 -0
- package/dist/client/utils/client-utils.d.ts.map +1 -1
- package/dist/client/utils/client-utils.js +5 -0
- package/dist/client/utils/client-utils.js.map +1 -1
- package/dist/clients-configurations/clients-configuration.json +2 -2
- package/package.json +1 -1
- package/src/client/clients/journey/index.ts +16 -1
- package/src/client/clients/messaging/index.ts +13 -1
- package/src/client/clients/messaging/open-api-definition.json +410 -4561
- package/src/client/clients/messaging/schema.ts +106 -1916
- package/src/client/clients/payments/index.ts +37 -1
- package/src/client/clients/payments/open-api-definition.json +314 -0
- package/src/client/clients/payments/schema.ts +113 -7
- package/src/client/clients/profile/index.ts +13 -1
- package/src/client/clients/profile/open-api-definition.json +100 -20
- package/src/client/clients/profile/schema.ts +20 -0
- package/src/client/clients/upload/index.ts +14 -1
- package/src/client/utils/client-utils.ts +6 -0
- package/src/clients-configurations/clients-configuration.json +2 -2
|
@@ -64,1760 +64,11 @@ export interface paths {
|
|
|
64
64
|
parameters: {
|
|
65
65
|
query: {
|
|
66
66
|
/** @description Provider types that can be manipulated */
|
|
67
|
-
type: "email"
|
|
68
|
-
};
|
|
69
|
-
header?: never;
|
|
70
|
-
path: {
|
|
71
|
-
providerId: string;
|
|
72
|
-
};
|
|
73
|
-
cookie?: never;
|
|
74
|
-
};
|
|
75
|
-
requestBody?: never;
|
|
76
|
-
responses: {
|
|
77
|
-
/** @description Default Response */
|
|
78
|
-
200: {
|
|
79
|
-
headers: {
|
|
80
|
-
[name: string]: unknown;
|
|
81
|
-
};
|
|
82
|
-
content: {
|
|
83
|
-
"application/json": {
|
|
84
|
-
data: {
|
|
85
|
-
/** Format: uuid */
|
|
86
|
-
id: string;
|
|
87
|
-
/** @description Name of the provider */
|
|
88
|
-
providerName: string;
|
|
89
|
-
/** @description If true, the provider is set as primary for the selected type for the current organisation. Please note, each organisation can only have one primary provider for each type */
|
|
90
|
-
isPrimary: boolean;
|
|
91
|
-
/** @enum {string} */
|
|
92
|
-
type: "email";
|
|
93
|
-
/** @description Address of the SMTP host */
|
|
94
|
-
smtpHost: string;
|
|
95
|
-
/** @description Port of the SMTP host */
|
|
96
|
-
smtpPort: number;
|
|
97
|
-
/** @description Username to use to log into the SMTP server */
|
|
98
|
-
username: string;
|
|
99
|
-
/** @description Password to use to log into the SMTP server */
|
|
100
|
-
password: string;
|
|
101
|
-
/** @description Optional field to adjust how long time between each mail, in miliseconds */
|
|
102
|
-
throttle?: number;
|
|
103
|
-
/** @description Email address to use as sender */
|
|
104
|
-
fromAddress: string;
|
|
105
|
-
/** @description Is connection to the SMTP server secure? */
|
|
106
|
-
ssl: boolean;
|
|
107
|
-
} | {
|
|
108
|
-
/** Format: uuid */
|
|
109
|
-
id: string;
|
|
110
|
-
/** @description Name of the provider */
|
|
111
|
-
providerName: string;
|
|
112
|
-
/** @description If true, the provider is set as primary for the selected type for the current organisation. Please note, each organisation can only have one primary provider for each type */
|
|
113
|
-
isPrimary: boolean;
|
|
114
|
-
/** @enum {string} */
|
|
115
|
-
type: "sms";
|
|
116
|
-
config: {
|
|
117
|
-
/** @enum {string} */
|
|
118
|
-
type: "AWS";
|
|
119
|
-
accessKey: string;
|
|
120
|
-
secretAccessKey: string;
|
|
121
|
-
region: string;
|
|
122
|
-
};
|
|
123
|
-
};
|
|
124
|
-
metadata?: {
|
|
125
|
-
/** @description Object containing the links to the related endpoints */
|
|
126
|
-
links?: {
|
|
127
|
-
self: {
|
|
128
|
-
/** @description URL pointing to the request itself */
|
|
129
|
-
href?: string;
|
|
130
|
-
};
|
|
131
|
-
next?: {
|
|
132
|
-
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
133
|
-
href?: string;
|
|
134
|
-
};
|
|
135
|
-
prev?: {
|
|
136
|
-
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
137
|
-
href?: string;
|
|
138
|
-
};
|
|
139
|
-
first: {
|
|
140
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
141
|
-
href?: string;
|
|
142
|
-
};
|
|
143
|
-
last: {
|
|
144
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
145
|
-
href?: string;
|
|
146
|
-
};
|
|
147
|
-
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
148
|
-
pages: {
|
|
149
|
-
[key: string]: {
|
|
150
|
-
href?: string;
|
|
151
|
-
};
|
|
152
|
-
};
|
|
153
|
-
};
|
|
154
|
-
/** @description Number representing the total number of available items */
|
|
155
|
-
totalCount?: number;
|
|
156
|
-
};
|
|
157
|
-
};
|
|
158
|
-
};
|
|
159
|
-
};
|
|
160
|
-
/** @description Default Response */
|
|
161
|
-
"5XX": {
|
|
162
|
-
headers: {
|
|
163
|
-
[name: string]: unknown;
|
|
164
|
-
};
|
|
165
|
-
content: {
|
|
166
|
-
"application/json": {
|
|
167
|
-
/** @description Code used to categorize the error */
|
|
168
|
-
code: string;
|
|
169
|
-
/** @description Description of the error */
|
|
170
|
-
detail: string;
|
|
171
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
172
|
-
requestId: string;
|
|
173
|
-
/** @description Name of the error type */
|
|
174
|
-
name: string;
|
|
175
|
-
/** @description List of the validation errors */
|
|
176
|
-
validation?: {
|
|
177
|
-
fieldName: string;
|
|
178
|
-
message: string;
|
|
179
|
-
}[];
|
|
180
|
-
validationContext?: string;
|
|
181
|
-
};
|
|
182
|
-
};
|
|
183
|
-
};
|
|
184
|
-
/** @description Default Response */
|
|
185
|
-
"4XX": {
|
|
186
|
-
headers: {
|
|
187
|
-
[name: string]: unknown;
|
|
188
|
-
};
|
|
189
|
-
content: {
|
|
190
|
-
"application/json": {
|
|
191
|
-
/** @description Code used to categorize the error */
|
|
192
|
-
code: string;
|
|
193
|
-
/** @description Description of the error */
|
|
194
|
-
detail: string;
|
|
195
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
196
|
-
requestId: string;
|
|
197
|
-
/** @description Name of the error type */
|
|
198
|
-
name: string;
|
|
199
|
-
/** @description List of the validation errors */
|
|
200
|
-
validation?: {
|
|
201
|
-
fieldName: string;
|
|
202
|
-
message: string;
|
|
203
|
-
}[];
|
|
204
|
-
validationContext?: string;
|
|
205
|
-
};
|
|
206
|
-
};
|
|
207
|
-
};
|
|
208
|
-
};
|
|
209
|
-
};
|
|
210
|
-
/** @description Updates the requested provider */
|
|
211
|
-
put: operations["UpdateProvider"];
|
|
212
|
-
post?: never;
|
|
213
|
-
/** @description Deletes the requested provider */
|
|
214
|
-
delete: operations["DeleteProvider"];
|
|
215
|
-
options?: never;
|
|
216
|
-
head?: never;
|
|
217
|
-
patch?: never;
|
|
218
|
-
trace?: never;
|
|
219
|
-
};
|
|
220
|
-
"/api/v1/templates/": {
|
|
221
|
-
parameters: {
|
|
222
|
-
query?: never;
|
|
223
|
-
header?: never;
|
|
224
|
-
path?: never;
|
|
225
|
-
cookie?: never;
|
|
226
|
-
};
|
|
227
|
-
/** @description Returns the providers matching the requested query */
|
|
228
|
-
get: operations["ListTemplates"];
|
|
229
|
-
put?: never;
|
|
230
|
-
/** @description Creates a new template */
|
|
231
|
-
post: operations["CreateTemplate"];
|
|
232
|
-
delete?: never;
|
|
233
|
-
options?: never;
|
|
234
|
-
head?: never;
|
|
235
|
-
patch?: never;
|
|
236
|
-
trace?: never;
|
|
237
|
-
};
|
|
238
|
-
"/api/v1/templates/{templateId}": {
|
|
239
|
-
parameters: {
|
|
240
|
-
query?: never;
|
|
241
|
-
header?: never;
|
|
242
|
-
path?: never;
|
|
243
|
-
cookie?: never;
|
|
244
|
-
};
|
|
245
|
-
/** @description Returns the requested template */
|
|
246
|
-
get: operations["GetTemplate"];
|
|
247
|
-
/** @description Updates the requested template */
|
|
248
|
-
put: operations["UpdateTemplate"];
|
|
249
|
-
post?: never;
|
|
250
|
-
/** @description Deletes the requested template */
|
|
251
|
-
delete: operations["DeleteTemplate"];
|
|
252
|
-
options?: never;
|
|
253
|
-
head?: never;
|
|
254
|
-
patch?: never;
|
|
255
|
-
trace?: never;
|
|
256
|
-
};
|
|
257
|
-
"/api/v1/organisation-settings/": {
|
|
258
|
-
parameters: {
|
|
259
|
-
query?: never;
|
|
260
|
-
header?: never;
|
|
261
|
-
path?: never;
|
|
262
|
-
cookie?: never;
|
|
263
|
-
};
|
|
264
|
-
/** @description Returns the organisation settings for the logged in user */
|
|
265
|
-
get: {
|
|
266
|
-
parameters: {
|
|
267
|
-
query?: {
|
|
268
|
-
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
269
|
-
offset?: string;
|
|
270
|
-
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
271
|
-
limit?: string;
|
|
272
|
-
};
|
|
273
|
-
header?: never;
|
|
274
|
-
path?: never;
|
|
275
|
-
cookie?: never;
|
|
276
|
-
};
|
|
277
|
-
requestBody?: never;
|
|
278
|
-
responses: {
|
|
279
|
-
/** @description Default Response */
|
|
280
|
-
200: {
|
|
281
|
-
headers: {
|
|
282
|
-
[name: string]: unknown;
|
|
283
|
-
};
|
|
284
|
-
content: {
|
|
285
|
-
"application/json": {
|
|
286
|
-
data: {
|
|
287
|
-
/**
|
|
288
|
-
* Format: uuid
|
|
289
|
-
* @description Unique id of the organisation setting
|
|
290
|
-
*/
|
|
291
|
-
id: string;
|
|
292
|
-
/**
|
|
293
|
-
* Format: uuid
|
|
294
|
-
* @description Unique id of the related user
|
|
295
|
-
*/
|
|
296
|
-
userId: string;
|
|
297
|
-
/**
|
|
298
|
-
* @description User profile id, if available
|
|
299
|
-
* @default null
|
|
300
|
-
*/
|
|
301
|
-
userProfileId: null | string;
|
|
302
|
-
/**
|
|
303
|
-
* @description Phone number of the user
|
|
304
|
-
* @default null
|
|
305
|
-
*/
|
|
306
|
-
phoneNumber: null | string;
|
|
307
|
-
/**
|
|
308
|
-
* @description Email address of the user
|
|
309
|
-
* @default null
|
|
310
|
-
*/
|
|
311
|
-
emailAddress: null | string;
|
|
312
|
-
/** @description Unique id of the related organisation */
|
|
313
|
-
organisationId: string;
|
|
314
|
-
/**
|
|
315
|
-
* @description Current status of the invitation to the messaging building block
|
|
316
|
-
* @default pending
|
|
317
|
-
* @enum {string}
|
|
318
|
-
*/
|
|
319
|
-
organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
|
|
320
|
-
/** @description Date and time describing when the organisation invitation has been sent */
|
|
321
|
-
organisationInvitationSentAt?: string;
|
|
322
|
-
/** @description Date and time describing when the user has gave a feedback to the organisation invitation */
|
|
323
|
-
organisationInvitationFeedbackAt?: string;
|
|
324
|
-
/** @description The list of the preferred transports to use. If the selected transports are not available for the recipient, others will be used */
|
|
325
|
-
organisationPreferredTransports: ("email" | "sms")[];
|
|
326
|
-
/**
|
|
327
|
-
* @description If full, it means that the user is already on the Life Events platform, if partial the match has to be reviewed, if not_related the user does not exist
|
|
328
|
-
* @enum {string}
|
|
329
|
-
*/
|
|
330
|
-
correlationQuality: "full" | "partial" | "not_related";
|
|
331
|
-
/**
|
|
332
|
-
* @default pending
|
|
333
|
-
* @enum {string}
|
|
334
|
-
*/
|
|
335
|
-
userStatus: "to_be_invited" | "pending" | "disabled" | "active";
|
|
336
|
-
details?: {
|
|
337
|
-
/**
|
|
338
|
-
* @description PPSN of the imported user
|
|
339
|
-
* @default null
|
|
340
|
-
*/
|
|
341
|
-
publicIdentityId: null | string;
|
|
342
|
-
/**
|
|
343
|
-
* @description First name of the imported user
|
|
344
|
-
* @default null
|
|
345
|
-
*/
|
|
346
|
-
firstName: null | string;
|
|
347
|
-
/**
|
|
348
|
-
* @description Last name of the imported user
|
|
349
|
-
* @default null
|
|
350
|
-
*/
|
|
351
|
-
lastName: null | string;
|
|
352
|
-
/**
|
|
353
|
-
* @description Birth date of the imported user
|
|
354
|
-
* @default null
|
|
355
|
-
*/
|
|
356
|
-
birthDate: null | string;
|
|
357
|
-
/**
|
|
358
|
-
* @description Address of the imported user
|
|
359
|
-
* @default null
|
|
360
|
-
*/
|
|
361
|
-
address: {
|
|
362
|
-
/** @default null */
|
|
363
|
-
city: null | string;
|
|
364
|
-
/** @default null */
|
|
365
|
-
zipCode: null | string;
|
|
366
|
-
/** @default null */
|
|
367
|
-
street: null | string;
|
|
368
|
-
/** @default null */
|
|
369
|
-
country: null | string;
|
|
370
|
-
/** @default null */
|
|
371
|
-
region: null | string;
|
|
372
|
-
} | null;
|
|
373
|
-
/**
|
|
374
|
-
* @description If false, an invitation to the user asking to accept to receive messages from the organisation will be sent. If true, it means that the organisation already asked the permissions to the user
|
|
375
|
-
* @default false
|
|
376
|
-
*/
|
|
377
|
-
collectedConsent: boolean;
|
|
378
|
-
/**
|
|
379
|
-
* @description If true, it means that a message to welcome the user has already been sent
|
|
380
|
-
* @default false
|
|
381
|
-
*/
|
|
382
|
-
welcomed: boolean;
|
|
383
|
-
};
|
|
384
|
-
}[];
|
|
385
|
-
metadata?: {
|
|
386
|
-
/** @description Object containing the links to the related endpoints */
|
|
387
|
-
links?: {
|
|
388
|
-
self: {
|
|
389
|
-
/** @description URL pointing to the request itself */
|
|
390
|
-
href?: string;
|
|
391
|
-
};
|
|
392
|
-
next?: {
|
|
393
|
-
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
394
|
-
href?: string;
|
|
395
|
-
};
|
|
396
|
-
prev?: {
|
|
397
|
-
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
398
|
-
href?: string;
|
|
399
|
-
};
|
|
400
|
-
first: {
|
|
401
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
402
|
-
href?: string;
|
|
403
|
-
};
|
|
404
|
-
last: {
|
|
405
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
406
|
-
href?: string;
|
|
407
|
-
};
|
|
408
|
-
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
409
|
-
pages: {
|
|
410
|
-
[key: string]: {
|
|
411
|
-
href?: string;
|
|
412
|
-
};
|
|
413
|
-
};
|
|
414
|
-
};
|
|
415
|
-
/** @description Number representing the total number of available items */
|
|
416
|
-
totalCount?: number;
|
|
417
|
-
};
|
|
418
|
-
};
|
|
419
|
-
};
|
|
420
|
-
};
|
|
421
|
-
/** @description Default Response */
|
|
422
|
-
400: {
|
|
423
|
-
headers: {
|
|
424
|
-
[name: string]: unknown;
|
|
425
|
-
};
|
|
426
|
-
content: {
|
|
427
|
-
"application/json": {
|
|
428
|
-
/** @description Code used to categorize the error */
|
|
429
|
-
code: string;
|
|
430
|
-
/** @description Description of the error */
|
|
431
|
-
detail: string;
|
|
432
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
433
|
-
requestId: string;
|
|
434
|
-
/** @description Name of the error type */
|
|
435
|
-
name: string;
|
|
436
|
-
/** @description List of the validation errors */
|
|
437
|
-
validation?: {
|
|
438
|
-
fieldName: string;
|
|
439
|
-
message: string;
|
|
440
|
-
}[];
|
|
441
|
-
validationContext?: string;
|
|
442
|
-
};
|
|
443
|
-
};
|
|
444
|
-
};
|
|
445
|
-
/** @description Default Response */
|
|
446
|
-
404: {
|
|
447
|
-
headers: {
|
|
448
|
-
[name: string]: unknown;
|
|
449
|
-
};
|
|
450
|
-
content: {
|
|
451
|
-
"application/json": {
|
|
452
|
-
/** @description Code used to categorize the error */
|
|
453
|
-
code: string;
|
|
454
|
-
/** @description Description of the error */
|
|
455
|
-
detail: string;
|
|
456
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
457
|
-
requestId: string;
|
|
458
|
-
/** @description Name of the error type */
|
|
459
|
-
name: string;
|
|
460
|
-
/** @description List of the validation errors */
|
|
461
|
-
validation?: {
|
|
462
|
-
fieldName: string;
|
|
463
|
-
message: string;
|
|
464
|
-
}[];
|
|
465
|
-
validationContext?: string;
|
|
466
|
-
};
|
|
467
|
-
};
|
|
468
|
-
};
|
|
469
|
-
/** @description Default Response */
|
|
470
|
-
500: {
|
|
471
|
-
headers: {
|
|
472
|
-
[name: string]: unknown;
|
|
473
|
-
};
|
|
474
|
-
content: {
|
|
475
|
-
"application/json": {
|
|
476
|
-
/** @description Code used to categorize the error */
|
|
477
|
-
code: string;
|
|
478
|
-
/** @description Description of the error */
|
|
479
|
-
detail: string;
|
|
480
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
481
|
-
requestId: string;
|
|
482
|
-
/** @description Name of the error type */
|
|
483
|
-
name: string;
|
|
484
|
-
/** @description List of the validation errors */
|
|
485
|
-
validation?: {
|
|
486
|
-
fieldName: string;
|
|
487
|
-
message: string;
|
|
488
|
-
}[];
|
|
489
|
-
validationContext?: string;
|
|
490
|
-
};
|
|
491
|
-
};
|
|
492
|
-
};
|
|
493
|
-
};
|
|
494
|
-
};
|
|
495
|
-
put?: never;
|
|
496
|
-
post?: never;
|
|
497
|
-
delete?: never;
|
|
498
|
-
options?: never;
|
|
499
|
-
head?: never;
|
|
500
|
-
patch?: never;
|
|
501
|
-
trace?: never;
|
|
502
|
-
};
|
|
503
|
-
"/api/v1/organisation-settings/{organisationSettingId}": {
|
|
504
|
-
parameters: {
|
|
505
|
-
query?: never;
|
|
506
|
-
header?: never;
|
|
507
|
-
path?: never;
|
|
508
|
-
cookie?: never;
|
|
509
|
-
};
|
|
510
|
-
/** @description Returns the requested organisation setting */
|
|
511
|
-
get: {
|
|
512
|
-
parameters: {
|
|
513
|
-
query?: never;
|
|
514
|
-
header?: never;
|
|
515
|
-
path: {
|
|
516
|
-
organisationSettingId: string;
|
|
517
|
-
};
|
|
518
|
-
cookie?: never;
|
|
519
|
-
};
|
|
520
|
-
requestBody?: never;
|
|
521
|
-
responses: {
|
|
522
|
-
/** @description Default Response */
|
|
523
|
-
200: {
|
|
524
|
-
headers: {
|
|
525
|
-
[name: string]: unknown;
|
|
526
|
-
};
|
|
527
|
-
content: {
|
|
528
|
-
"application/json": {
|
|
529
|
-
data: {
|
|
530
|
-
/**
|
|
531
|
-
* Format: uuid
|
|
532
|
-
* @description Unique id of the organisation setting
|
|
533
|
-
*/
|
|
534
|
-
id: string;
|
|
535
|
-
/**
|
|
536
|
-
* Format: uuid
|
|
537
|
-
* @description Unique id of the related user
|
|
538
|
-
*/
|
|
539
|
-
userId: string;
|
|
540
|
-
/**
|
|
541
|
-
* @description User profile id, if available
|
|
542
|
-
* @default null
|
|
543
|
-
*/
|
|
544
|
-
userProfileId: null | string;
|
|
545
|
-
/**
|
|
546
|
-
* @description Phone number of the user
|
|
547
|
-
* @default null
|
|
548
|
-
*/
|
|
549
|
-
phoneNumber: null | string;
|
|
550
|
-
/**
|
|
551
|
-
* @description Email address of the user
|
|
552
|
-
* @default null
|
|
553
|
-
*/
|
|
554
|
-
emailAddress: null | string;
|
|
555
|
-
/** @description Unique id of the related organisation */
|
|
556
|
-
organisationId: string;
|
|
557
|
-
/**
|
|
558
|
-
* @description Current status of the invitation to the messaging building block
|
|
559
|
-
* @default pending
|
|
560
|
-
* @enum {string}
|
|
561
|
-
*/
|
|
562
|
-
organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
|
|
563
|
-
/** @description Date and time describing when the organisation invitation has been sent */
|
|
564
|
-
organisationInvitationSentAt?: string;
|
|
565
|
-
/** @description Date and time describing when the user has gave a feedback to the organisation invitation */
|
|
566
|
-
organisationInvitationFeedbackAt?: string;
|
|
567
|
-
/** @description The list of the preferred transports to use. If the selected transports are not available for the recipient, others will be used */
|
|
568
|
-
organisationPreferredTransports: ("email" | "sms")[];
|
|
569
|
-
/**
|
|
570
|
-
* @description If full, it means that the user is already on the Life Events platform, if partial the match has to be reviewed, if not_related the user does not exist
|
|
571
|
-
* @enum {string}
|
|
572
|
-
*/
|
|
573
|
-
correlationQuality: "full" | "partial" | "not_related";
|
|
574
|
-
/**
|
|
575
|
-
* @default pending
|
|
576
|
-
* @enum {string}
|
|
577
|
-
*/
|
|
578
|
-
userStatus: "to_be_invited" | "pending" | "disabled" | "active";
|
|
579
|
-
details?: {
|
|
580
|
-
/**
|
|
581
|
-
* @description PPSN of the imported user
|
|
582
|
-
* @default null
|
|
583
|
-
*/
|
|
584
|
-
publicIdentityId: null | string;
|
|
585
|
-
/**
|
|
586
|
-
* @description First name of the imported user
|
|
587
|
-
* @default null
|
|
588
|
-
*/
|
|
589
|
-
firstName: null | string;
|
|
590
|
-
/**
|
|
591
|
-
* @description Last name of the imported user
|
|
592
|
-
* @default null
|
|
593
|
-
*/
|
|
594
|
-
lastName: null | string;
|
|
595
|
-
/**
|
|
596
|
-
* @description Birth date of the imported user
|
|
597
|
-
* @default null
|
|
598
|
-
*/
|
|
599
|
-
birthDate: null | string;
|
|
600
|
-
/**
|
|
601
|
-
* @description Address of the imported user
|
|
602
|
-
* @default null
|
|
603
|
-
*/
|
|
604
|
-
address: {
|
|
605
|
-
/** @default null */
|
|
606
|
-
city: null | string;
|
|
607
|
-
/** @default null */
|
|
608
|
-
zipCode: null | string;
|
|
609
|
-
/** @default null */
|
|
610
|
-
street: null | string;
|
|
611
|
-
/** @default null */
|
|
612
|
-
country: null | string;
|
|
613
|
-
/** @default null */
|
|
614
|
-
region: null | string;
|
|
615
|
-
} | null;
|
|
616
|
-
/**
|
|
617
|
-
* @description If false, an invitation to the user asking to accept to receive messages from the organisation will be sent. If true, it means that the organisation already asked the permissions to the user
|
|
618
|
-
* @default false
|
|
619
|
-
*/
|
|
620
|
-
collectedConsent: boolean;
|
|
621
|
-
/**
|
|
622
|
-
* @description If true, it means that a message to welcome the user has already been sent
|
|
623
|
-
* @default false
|
|
624
|
-
*/
|
|
625
|
-
welcomed: boolean;
|
|
626
|
-
};
|
|
627
|
-
};
|
|
628
|
-
metadata?: {
|
|
629
|
-
/** @description Object containing the links to the related endpoints */
|
|
630
|
-
links?: {
|
|
631
|
-
self: {
|
|
632
|
-
/** @description URL pointing to the request itself */
|
|
633
|
-
href?: string;
|
|
634
|
-
};
|
|
635
|
-
next?: {
|
|
636
|
-
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
637
|
-
href?: string;
|
|
638
|
-
};
|
|
639
|
-
prev?: {
|
|
640
|
-
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
641
|
-
href?: string;
|
|
642
|
-
};
|
|
643
|
-
first: {
|
|
644
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
645
|
-
href?: string;
|
|
646
|
-
};
|
|
647
|
-
last: {
|
|
648
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
649
|
-
href?: string;
|
|
650
|
-
};
|
|
651
|
-
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
652
|
-
pages: {
|
|
653
|
-
[key: string]: {
|
|
654
|
-
href?: string;
|
|
655
|
-
};
|
|
656
|
-
};
|
|
657
|
-
};
|
|
658
|
-
/** @description Number representing the total number of available items */
|
|
659
|
-
totalCount?: number;
|
|
660
|
-
};
|
|
661
|
-
};
|
|
662
|
-
};
|
|
663
|
-
};
|
|
664
|
-
/** @description Default Response */
|
|
665
|
-
400: {
|
|
666
|
-
headers: {
|
|
667
|
-
[name: string]: unknown;
|
|
668
|
-
};
|
|
669
|
-
content: {
|
|
670
|
-
"application/json": {
|
|
671
|
-
/** @description Code used to categorize the error */
|
|
672
|
-
code: string;
|
|
673
|
-
/** @description Description of the error */
|
|
674
|
-
detail: string;
|
|
675
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
676
|
-
requestId: string;
|
|
677
|
-
/** @description Name of the error type */
|
|
678
|
-
name: string;
|
|
679
|
-
/** @description List of the validation errors */
|
|
680
|
-
validation?: {
|
|
681
|
-
fieldName: string;
|
|
682
|
-
message: string;
|
|
683
|
-
}[];
|
|
684
|
-
validationContext?: string;
|
|
685
|
-
};
|
|
686
|
-
};
|
|
687
|
-
};
|
|
688
|
-
/** @description Default Response */
|
|
689
|
-
404: {
|
|
690
|
-
headers: {
|
|
691
|
-
[name: string]: unknown;
|
|
692
|
-
};
|
|
693
|
-
content: {
|
|
694
|
-
"application/json": {
|
|
695
|
-
/** @description Code used to categorize the error */
|
|
696
|
-
code: string;
|
|
697
|
-
/** @description Description of the error */
|
|
698
|
-
detail: string;
|
|
699
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
700
|
-
requestId: string;
|
|
701
|
-
/** @description Name of the error type */
|
|
702
|
-
name: string;
|
|
703
|
-
/** @description List of the validation errors */
|
|
704
|
-
validation?: {
|
|
705
|
-
fieldName: string;
|
|
706
|
-
message: string;
|
|
707
|
-
}[];
|
|
708
|
-
validationContext?: string;
|
|
709
|
-
};
|
|
710
|
-
};
|
|
711
|
-
};
|
|
712
|
-
/** @description Default Response */
|
|
713
|
-
500: {
|
|
714
|
-
headers: {
|
|
715
|
-
[name: string]: unknown;
|
|
716
|
-
};
|
|
717
|
-
content: {
|
|
718
|
-
"application/json": {
|
|
719
|
-
/** @description Code used to categorize the error */
|
|
720
|
-
code: string;
|
|
721
|
-
/** @description Description of the error */
|
|
722
|
-
detail: string;
|
|
723
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
724
|
-
requestId: string;
|
|
725
|
-
/** @description Name of the error type */
|
|
726
|
-
name: string;
|
|
727
|
-
/** @description List of the validation errors */
|
|
728
|
-
validation?: {
|
|
729
|
-
fieldName: string;
|
|
730
|
-
message: string;
|
|
731
|
-
}[];
|
|
732
|
-
validationContext?: string;
|
|
733
|
-
};
|
|
734
|
-
};
|
|
735
|
-
};
|
|
736
|
-
};
|
|
737
|
-
};
|
|
738
|
-
put?: never;
|
|
739
|
-
post?: never;
|
|
740
|
-
delete?: never;
|
|
741
|
-
options?: never;
|
|
742
|
-
head?: never;
|
|
743
|
-
/** @description Updates the requested organisation settings */
|
|
744
|
-
patch: {
|
|
745
|
-
parameters: {
|
|
746
|
-
query?: never;
|
|
747
|
-
header?: never;
|
|
748
|
-
path: {
|
|
749
|
-
organisationSettingId: string;
|
|
750
|
-
};
|
|
751
|
-
cookie?: never;
|
|
752
|
-
};
|
|
753
|
-
requestBody: {
|
|
754
|
-
content: {
|
|
755
|
-
"application/json": {
|
|
756
|
-
/**
|
|
757
|
-
* @description Current status of the invitation to receive messages from the organisation
|
|
758
|
-
* @default accepted
|
|
759
|
-
* @enum {string}
|
|
760
|
-
*/
|
|
761
|
-
invitationStatusFeedback: "accepted" | "declined";
|
|
762
|
-
/** @description The list of the preferred transports to use. If the selected transports are not available for the recipient, others will be used */
|
|
763
|
-
preferredTransports: ("email" | "sms")[];
|
|
764
|
-
};
|
|
765
|
-
};
|
|
766
|
-
};
|
|
767
|
-
responses: {
|
|
768
|
-
/** @description Default Response */
|
|
769
|
-
202: {
|
|
770
|
-
headers: {
|
|
771
|
-
[name: string]: unknown;
|
|
772
|
-
};
|
|
773
|
-
content: {
|
|
774
|
-
"application/json": {
|
|
775
|
-
data: {
|
|
776
|
-
/**
|
|
777
|
-
* Format: uuid
|
|
778
|
-
* @description Unique id of the organisation setting
|
|
779
|
-
*/
|
|
780
|
-
id: string;
|
|
781
|
-
/**
|
|
782
|
-
* Format: uuid
|
|
783
|
-
* @description Unique id of the related user
|
|
784
|
-
*/
|
|
785
|
-
userId: string;
|
|
786
|
-
/**
|
|
787
|
-
* @description User profile id, if available
|
|
788
|
-
* @default null
|
|
789
|
-
*/
|
|
790
|
-
userProfileId: null | string;
|
|
791
|
-
/**
|
|
792
|
-
* @description Phone number of the user
|
|
793
|
-
* @default null
|
|
794
|
-
*/
|
|
795
|
-
phoneNumber: null | string;
|
|
796
|
-
/**
|
|
797
|
-
* @description Email address of the user
|
|
798
|
-
* @default null
|
|
799
|
-
*/
|
|
800
|
-
emailAddress: null | string;
|
|
801
|
-
/** @description Unique id of the related organisation */
|
|
802
|
-
organisationId: string;
|
|
803
|
-
/**
|
|
804
|
-
* @description Current status of the invitation to the messaging building block
|
|
805
|
-
* @default pending
|
|
806
|
-
* @enum {string}
|
|
807
|
-
*/
|
|
808
|
-
organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
|
|
809
|
-
/** @description Date and time describing when the organisation invitation has been sent */
|
|
810
|
-
organisationInvitationSentAt?: string;
|
|
811
|
-
/** @description Date and time describing when the user has gave a feedback to the organisation invitation */
|
|
812
|
-
organisationInvitationFeedbackAt?: string;
|
|
813
|
-
/** @description The list of the preferred transports to use. If the selected transports are not available for the recipient, others will be used */
|
|
814
|
-
organisationPreferredTransports: ("email" | "sms")[];
|
|
815
|
-
/**
|
|
816
|
-
* @description If full, it means that the user is already on the Life Events platform, if partial the match has to be reviewed, if not_related the user does not exist
|
|
817
|
-
* @enum {string}
|
|
818
|
-
*/
|
|
819
|
-
correlationQuality: "full" | "partial" | "not_related";
|
|
820
|
-
/**
|
|
821
|
-
* @default pending
|
|
822
|
-
* @enum {string}
|
|
823
|
-
*/
|
|
824
|
-
userStatus: "to_be_invited" | "pending" | "disabled" | "active";
|
|
825
|
-
details?: {
|
|
826
|
-
/**
|
|
827
|
-
* @description PPSN of the imported user
|
|
828
|
-
* @default null
|
|
829
|
-
*/
|
|
830
|
-
publicIdentityId: null | string;
|
|
831
|
-
/**
|
|
832
|
-
* @description First name of the imported user
|
|
833
|
-
* @default null
|
|
834
|
-
*/
|
|
835
|
-
firstName: null | string;
|
|
836
|
-
/**
|
|
837
|
-
* @description Last name of the imported user
|
|
838
|
-
* @default null
|
|
839
|
-
*/
|
|
840
|
-
lastName: null | string;
|
|
841
|
-
/**
|
|
842
|
-
* @description Birth date of the imported user
|
|
843
|
-
* @default null
|
|
844
|
-
*/
|
|
845
|
-
birthDate: null | string;
|
|
846
|
-
/**
|
|
847
|
-
* @description Address of the imported user
|
|
848
|
-
* @default null
|
|
849
|
-
*/
|
|
850
|
-
address: {
|
|
851
|
-
/** @default null */
|
|
852
|
-
city: null | string;
|
|
853
|
-
/** @default null */
|
|
854
|
-
zipCode: null | string;
|
|
855
|
-
/** @default null */
|
|
856
|
-
street: null | string;
|
|
857
|
-
/** @default null */
|
|
858
|
-
country: null | string;
|
|
859
|
-
/** @default null */
|
|
860
|
-
region: null | string;
|
|
861
|
-
} | null;
|
|
862
|
-
/**
|
|
863
|
-
* @description If false, an invitation to the user asking to accept to receive messages from the organisation will be sent. If true, it means that the organisation already asked the permissions to the user
|
|
864
|
-
* @default false
|
|
865
|
-
*/
|
|
866
|
-
collectedConsent: boolean;
|
|
867
|
-
/**
|
|
868
|
-
* @description If true, it means that a message to welcome the user has already been sent
|
|
869
|
-
* @default false
|
|
870
|
-
*/
|
|
871
|
-
welcomed: boolean;
|
|
872
|
-
};
|
|
873
|
-
};
|
|
874
|
-
metadata?: {
|
|
875
|
-
/** @description Object containing the links to the related endpoints */
|
|
876
|
-
links?: {
|
|
877
|
-
self: {
|
|
878
|
-
/** @description URL pointing to the request itself */
|
|
879
|
-
href?: string;
|
|
880
|
-
};
|
|
881
|
-
next?: {
|
|
882
|
-
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
883
|
-
href?: string;
|
|
884
|
-
};
|
|
885
|
-
prev?: {
|
|
886
|
-
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
887
|
-
href?: string;
|
|
888
|
-
};
|
|
889
|
-
first: {
|
|
890
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
891
|
-
href?: string;
|
|
892
|
-
};
|
|
893
|
-
last: {
|
|
894
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
895
|
-
href?: string;
|
|
896
|
-
};
|
|
897
|
-
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
898
|
-
pages: {
|
|
899
|
-
[key: string]: {
|
|
900
|
-
href?: string;
|
|
901
|
-
};
|
|
902
|
-
};
|
|
903
|
-
};
|
|
904
|
-
/** @description Number representing the total number of available items */
|
|
905
|
-
totalCount?: number;
|
|
906
|
-
};
|
|
907
|
-
};
|
|
908
|
-
};
|
|
909
|
-
};
|
|
910
|
-
/** @description Default Response */
|
|
911
|
-
400: {
|
|
912
|
-
headers: {
|
|
913
|
-
[name: string]: unknown;
|
|
914
|
-
};
|
|
915
|
-
content: {
|
|
916
|
-
"application/json": {
|
|
917
|
-
/** @description Code used to categorize the error */
|
|
918
|
-
code: string;
|
|
919
|
-
/** @description Description of the error */
|
|
920
|
-
detail: string;
|
|
921
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
922
|
-
requestId: string;
|
|
923
|
-
/** @description Name of the error type */
|
|
924
|
-
name: string;
|
|
925
|
-
/** @description List of the validation errors */
|
|
926
|
-
validation?: {
|
|
927
|
-
fieldName: string;
|
|
928
|
-
message: string;
|
|
929
|
-
}[];
|
|
930
|
-
validationContext?: string;
|
|
931
|
-
};
|
|
932
|
-
};
|
|
933
|
-
};
|
|
934
|
-
/** @description Default Response */
|
|
935
|
-
404: {
|
|
936
|
-
headers: {
|
|
937
|
-
[name: string]: unknown;
|
|
938
|
-
};
|
|
939
|
-
content: {
|
|
940
|
-
"application/json": {
|
|
941
|
-
/** @description Code used to categorize the error */
|
|
942
|
-
code: string;
|
|
943
|
-
/** @description Description of the error */
|
|
944
|
-
detail: string;
|
|
945
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
946
|
-
requestId: string;
|
|
947
|
-
/** @description Name of the error type */
|
|
948
|
-
name: string;
|
|
949
|
-
/** @description List of the validation errors */
|
|
950
|
-
validation?: {
|
|
951
|
-
fieldName: string;
|
|
952
|
-
message: string;
|
|
953
|
-
}[];
|
|
954
|
-
validationContext?: string;
|
|
955
|
-
};
|
|
956
|
-
};
|
|
957
|
-
};
|
|
958
|
-
/** @description Default Response */
|
|
959
|
-
500: {
|
|
960
|
-
headers: {
|
|
961
|
-
[name: string]: unknown;
|
|
962
|
-
};
|
|
963
|
-
content: {
|
|
964
|
-
"application/json": {
|
|
965
|
-
/** @description Code used to categorize the error */
|
|
966
|
-
code: string;
|
|
967
|
-
/** @description Description of the error */
|
|
968
|
-
detail: string;
|
|
969
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
970
|
-
requestId: string;
|
|
971
|
-
/** @description Name of the error type */
|
|
972
|
-
name: string;
|
|
973
|
-
/** @description List of the validation errors */
|
|
974
|
-
validation?: {
|
|
975
|
-
fieldName: string;
|
|
976
|
-
message: string;
|
|
977
|
-
}[];
|
|
978
|
-
validationContext?: string;
|
|
979
|
-
};
|
|
980
|
-
};
|
|
981
|
-
};
|
|
982
|
-
};
|
|
983
|
-
};
|
|
984
|
-
trace?: never;
|
|
985
|
-
};
|
|
986
|
-
"/api/v1/user-imports/": {
|
|
987
|
-
parameters: {
|
|
988
|
-
query?: never;
|
|
989
|
-
header?: never;
|
|
990
|
-
path?: never;
|
|
991
|
-
cookie?: never;
|
|
992
|
-
};
|
|
993
|
-
/** @description Retrieves the user import batches related to the current organisation */
|
|
994
|
-
get: {
|
|
995
|
-
parameters: {
|
|
996
|
-
query?: {
|
|
997
|
-
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
998
|
-
offset?: string;
|
|
999
|
-
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
1000
|
-
limit?: string;
|
|
1001
|
-
};
|
|
1002
|
-
header?: never;
|
|
1003
|
-
path?: never;
|
|
1004
|
-
cookie?: never;
|
|
1005
|
-
};
|
|
1006
|
-
requestBody?: never;
|
|
1007
|
-
responses: {
|
|
1008
|
-
/** @description Default Response */
|
|
1009
|
-
200: {
|
|
1010
|
-
headers: {
|
|
1011
|
-
[name: string]: unknown;
|
|
1012
|
-
};
|
|
1013
|
-
content: {
|
|
1014
|
-
"application/json": {
|
|
1015
|
-
data: {
|
|
1016
|
-
organisationId: string;
|
|
1017
|
-
/** Format: date-time */
|
|
1018
|
-
importedAt: string;
|
|
1019
|
-
/**
|
|
1020
|
-
* @description Channel through which the users have been imported
|
|
1021
|
-
* @default api
|
|
1022
|
-
* @enum {string}
|
|
1023
|
-
*/
|
|
1024
|
-
importChannel: "api" | "csv";
|
|
1025
|
-
/** @default 0 */
|
|
1026
|
-
retryCount: number;
|
|
1027
|
-
/** @default null */
|
|
1028
|
-
lastRetryAt: string | null;
|
|
1029
|
-
/** Format: uuid */
|
|
1030
|
-
id: string;
|
|
1031
|
-
}[];
|
|
1032
|
-
metadata?: {
|
|
1033
|
-
/** @description Object containing the links to the related endpoints */
|
|
1034
|
-
links?: {
|
|
1035
|
-
self: {
|
|
1036
|
-
/** @description URL pointing to the request itself */
|
|
1037
|
-
href?: string;
|
|
1038
|
-
};
|
|
1039
|
-
next?: {
|
|
1040
|
-
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1041
|
-
href?: string;
|
|
1042
|
-
};
|
|
1043
|
-
prev?: {
|
|
1044
|
-
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1045
|
-
href?: string;
|
|
1046
|
-
};
|
|
1047
|
-
first: {
|
|
1048
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
1049
|
-
href?: string;
|
|
1050
|
-
};
|
|
1051
|
-
last: {
|
|
1052
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
1053
|
-
href?: string;
|
|
1054
|
-
};
|
|
1055
|
-
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
1056
|
-
pages: {
|
|
1057
|
-
[key: string]: {
|
|
1058
|
-
href?: string;
|
|
1059
|
-
};
|
|
1060
|
-
};
|
|
1061
|
-
};
|
|
1062
|
-
/** @description Number representing the total number of available items */
|
|
1063
|
-
totalCount?: number;
|
|
1064
|
-
};
|
|
1065
|
-
};
|
|
1066
|
-
};
|
|
1067
|
-
};
|
|
1068
|
-
};
|
|
1069
|
-
};
|
|
1070
|
-
put?: never;
|
|
1071
|
-
/** @description Imports a new batch of users. If 'Content-Type' header contains 'multipart/form-data' it accepts a CSV file, otherwise an array of users to import */
|
|
1072
|
-
post: {
|
|
1073
|
-
parameters: {
|
|
1074
|
-
query?: never;
|
|
1075
|
-
header?: never;
|
|
1076
|
-
path?: never;
|
|
1077
|
-
cookie?: never;
|
|
1078
|
-
};
|
|
1079
|
-
requestBody?: {
|
|
1080
|
-
content: {
|
|
1081
|
-
"multipart/form-data": {
|
|
1082
|
-
/** @description Numeric index of the user to import. It must increments by one across users so to be able to notify which users' import failed */
|
|
1083
|
-
importIndex: number;
|
|
1084
|
-
/**
|
|
1085
|
-
* @description PPSN of the user to be imported
|
|
1086
|
-
* @default null
|
|
1087
|
-
*/
|
|
1088
|
-
publicIdentityId?: null | string;
|
|
1089
|
-
/**
|
|
1090
|
-
* @description First name of the user to be imported
|
|
1091
|
-
* @default null
|
|
1092
|
-
*/
|
|
1093
|
-
firstName?: null | string;
|
|
1094
|
-
/**
|
|
1095
|
-
* @description Last name of the user to be imported
|
|
1096
|
-
* @default null
|
|
1097
|
-
*/
|
|
1098
|
-
lastName?: null | string;
|
|
1099
|
-
/**
|
|
1100
|
-
* @description Phone number of the user to be imported
|
|
1101
|
-
* @default null
|
|
1102
|
-
*/
|
|
1103
|
-
phoneNumber?: null | string;
|
|
1104
|
-
/**
|
|
1105
|
-
* @description Birth date of the user to be imported
|
|
1106
|
-
* @default null
|
|
1107
|
-
*/
|
|
1108
|
-
birthDate?: null | string;
|
|
1109
|
-
/**
|
|
1110
|
-
* @description Email address of the user to be imported
|
|
1111
|
-
* @default null
|
|
1112
|
-
*/
|
|
1113
|
-
emailAddress?: null | string;
|
|
1114
|
-
/**
|
|
1115
|
-
* @description City of the user to be imported
|
|
1116
|
-
* @default null
|
|
1117
|
-
*/
|
|
1118
|
-
addressCity?: null | string;
|
|
1119
|
-
/**
|
|
1120
|
-
* @description Zip Code of the user to be imported
|
|
1121
|
-
* @default null
|
|
1122
|
-
*/
|
|
1123
|
-
addressZipCode?: null | string;
|
|
1124
|
-
/**
|
|
1125
|
-
* @description Street of the user to be imported
|
|
1126
|
-
* @default null
|
|
1127
|
-
*/
|
|
1128
|
-
addressStreet?: null | string;
|
|
1129
|
-
/**
|
|
1130
|
-
* @description Country of the user to be imported
|
|
1131
|
-
* @default null
|
|
1132
|
-
*/
|
|
1133
|
-
addressCountry?: null | string;
|
|
1134
|
-
/**
|
|
1135
|
-
* @description Region of the user to be imported
|
|
1136
|
-
* @default null
|
|
1137
|
-
*/
|
|
1138
|
-
addressRegion?: null | string;
|
|
1139
|
-
/**
|
|
1140
|
-
* @description Tags of the user to be imported. The tags can made by multiple levels, splitting each level by a '.' and listing multiple tags using a ';'
|
|
1141
|
-
* @default null
|
|
1142
|
-
*/
|
|
1143
|
-
tags?: null | string;
|
|
1144
|
-
/**
|
|
1145
|
-
* @description If false, an invitation to the user asking to accept to receive messages from the organisation will be sent. If true, it means that the organisation already asked the permissions to the user
|
|
1146
|
-
* @default false
|
|
1147
|
-
*/
|
|
1148
|
-
collectedConsent?: null | string;
|
|
1149
|
-
}[] | unknown;
|
|
1150
|
-
"application/json": {
|
|
1151
|
-
/** @description Numeric index of the user to import. It must increments by one across users so to be able to notify which users' import failed */
|
|
1152
|
-
importIndex: number;
|
|
1153
|
-
/**
|
|
1154
|
-
* @description PPSN of the user to be imported
|
|
1155
|
-
* @default null
|
|
1156
|
-
*/
|
|
1157
|
-
publicIdentityId?: null | string;
|
|
1158
|
-
/**
|
|
1159
|
-
* @description First name of the user to be imported
|
|
1160
|
-
* @default null
|
|
1161
|
-
*/
|
|
1162
|
-
firstName?: null | string;
|
|
1163
|
-
/**
|
|
1164
|
-
* @description Last name of the user to be imported
|
|
1165
|
-
* @default null
|
|
1166
|
-
*/
|
|
1167
|
-
lastName?: null | string;
|
|
1168
|
-
/**
|
|
1169
|
-
* @description Phone number of the user to be imported
|
|
1170
|
-
* @default null
|
|
1171
|
-
*/
|
|
1172
|
-
phoneNumber?: null | string;
|
|
1173
|
-
/**
|
|
1174
|
-
* @description Birth date of the user to be imported
|
|
1175
|
-
* @default null
|
|
1176
|
-
*/
|
|
1177
|
-
birthDate?: null | string;
|
|
1178
|
-
/**
|
|
1179
|
-
* @description Email address of the user to be imported
|
|
1180
|
-
* @default null
|
|
1181
|
-
*/
|
|
1182
|
-
emailAddress?: null | string;
|
|
1183
|
-
/**
|
|
1184
|
-
* @description City of the user to be imported
|
|
1185
|
-
* @default null
|
|
1186
|
-
*/
|
|
1187
|
-
addressCity?: null | string;
|
|
1188
|
-
/**
|
|
1189
|
-
* @description Zip Code of the user to be imported
|
|
1190
|
-
* @default null
|
|
1191
|
-
*/
|
|
1192
|
-
addressZipCode?: null | string;
|
|
1193
|
-
/**
|
|
1194
|
-
* @description Street of the user to be imported
|
|
1195
|
-
* @default null
|
|
1196
|
-
*/
|
|
1197
|
-
addressStreet?: null | string;
|
|
1198
|
-
/**
|
|
1199
|
-
* @description Country of the user to be imported
|
|
1200
|
-
* @default null
|
|
1201
|
-
*/
|
|
1202
|
-
addressCountry?: null | string;
|
|
1203
|
-
/**
|
|
1204
|
-
* @description Region of the user to be imported
|
|
1205
|
-
* @default null
|
|
1206
|
-
*/
|
|
1207
|
-
addressRegion?: null | string;
|
|
1208
|
-
/**
|
|
1209
|
-
* @description Tags of the user to be imported. The tags can made by multiple levels, splitting each level by a '.' and listing multiple tags using a ';'
|
|
1210
|
-
* @default null
|
|
1211
|
-
*/
|
|
1212
|
-
tags?: null | string;
|
|
1213
|
-
/**
|
|
1214
|
-
* @description If false, an invitation to the user asking to accept to receive messages from the organisation will be sent. If true, it means that the organisation already asked the permissions to the user
|
|
1215
|
-
* @default false
|
|
1216
|
-
*/
|
|
1217
|
-
collectedConsent?: null | string;
|
|
1218
|
-
}[] | unknown;
|
|
1219
|
-
};
|
|
1220
|
-
};
|
|
1221
|
-
responses: {
|
|
1222
|
-
/** @description Default Response */
|
|
1223
|
-
200: {
|
|
1224
|
-
headers: {
|
|
1225
|
-
[name: string]: unknown;
|
|
1226
|
-
};
|
|
1227
|
-
content: {
|
|
1228
|
-
"application/json": {
|
|
1229
|
-
data: {
|
|
1230
|
-
/** Format: uuid */
|
|
1231
|
-
id: string;
|
|
1232
|
-
};
|
|
1233
|
-
};
|
|
1234
|
-
};
|
|
1235
|
-
};
|
|
1236
|
-
/** @description Default Response */
|
|
1237
|
-
"5XX": {
|
|
1238
|
-
headers: {
|
|
1239
|
-
[name: string]: unknown;
|
|
1240
|
-
};
|
|
1241
|
-
content: {
|
|
1242
|
-
"application/json": {
|
|
1243
|
-
/** @description Code used to categorize the error */
|
|
1244
|
-
code: string;
|
|
1245
|
-
/** @description Description of the error */
|
|
1246
|
-
detail: string;
|
|
1247
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1248
|
-
requestId: string;
|
|
1249
|
-
/** @description Name of the error type */
|
|
1250
|
-
name: string;
|
|
1251
|
-
/** @description List of the validation errors */
|
|
1252
|
-
validation?: {
|
|
1253
|
-
fieldName: string;
|
|
1254
|
-
message: string;
|
|
1255
|
-
}[];
|
|
1256
|
-
validationContext?: string;
|
|
1257
|
-
};
|
|
1258
|
-
};
|
|
1259
|
-
};
|
|
1260
|
-
/** @description Default Response */
|
|
1261
|
-
"4XX": {
|
|
1262
|
-
headers: {
|
|
1263
|
-
[name: string]: unknown;
|
|
1264
|
-
};
|
|
1265
|
-
content: {
|
|
1266
|
-
"application/json": {
|
|
1267
|
-
/** @description Code used to categorize the error */
|
|
1268
|
-
code: string;
|
|
1269
|
-
/** @description Description of the error */
|
|
1270
|
-
detail: string;
|
|
1271
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1272
|
-
requestId: string;
|
|
1273
|
-
/** @description Name of the error type */
|
|
1274
|
-
name: string;
|
|
1275
|
-
/** @description List of the validation errors */
|
|
1276
|
-
validation?: {
|
|
1277
|
-
fieldName: string;
|
|
1278
|
-
message: string;
|
|
1279
|
-
}[];
|
|
1280
|
-
validationContext?: string;
|
|
1281
|
-
};
|
|
1282
|
-
};
|
|
1283
|
-
};
|
|
1284
|
-
};
|
|
1285
|
-
};
|
|
1286
|
-
delete?: never;
|
|
1287
|
-
options?: never;
|
|
1288
|
-
head?: never;
|
|
1289
|
-
patch?: never;
|
|
1290
|
-
trace?: never;
|
|
1291
|
-
};
|
|
1292
|
-
"/api/v1/user-imports/{importId}": {
|
|
1293
|
-
parameters: {
|
|
1294
|
-
query?: never;
|
|
1295
|
-
header?: never;
|
|
1296
|
-
path?: never;
|
|
1297
|
-
cookie?: never;
|
|
1298
|
-
};
|
|
1299
|
-
/** @description Retrieves the requested user import batch */
|
|
1300
|
-
get: {
|
|
1301
|
-
parameters: {
|
|
1302
|
-
query?: {
|
|
1303
|
-
/** @description If true, it returns the data of the user sent in the import batch */
|
|
1304
|
-
includeImportedData?: "true" | "false" | "0" | "1";
|
|
1305
|
-
};
|
|
1306
|
-
header?: never;
|
|
1307
|
-
path: {
|
|
1308
|
-
importId: string;
|
|
1309
|
-
};
|
|
1310
|
-
cookie?: never;
|
|
1311
|
-
};
|
|
1312
|
-
requestBody?: never;
|
|
1313
|
-
responses: {
|
|
1314
|
-
/** @description Default Response */
|
|
1315
|
-
200: {
|
|
1316
|
-
headers: {
|
|
1317
|
-
[name: string]: unknown;
|
|
1318
|
-
};
|
|
1319
|
-
content: {
|
|
1320
|
-
"application/json": {
|
|
1321
|
-
data: {
|
|
1322
|
-
organisationId: string;
|
|
1323
|
-
/** Format: date-time */
|
|
1324
|
-
importedAt: string;
|
|
1325
|
-
usersData: {
|
|
1326
|
-
importIndex: number;
|
|
1327
|
-
/**
|
|
1328
|
-
* @description Phone number of the user
|
|
1329
|
-
* @default null
|
|
1330
|
-
*/
|
|
1331
|
-
phoneNumber: null | string;
|
|
1332
|
-
/**
|
|
1333
|
-
* @description Email address of the user
|
|
1334
|
-
* @default null
|
|
1335
|
-
*/
|
|
1336
|
-
emailAddress: null | string;
|
|
1337
|
-
/**
|
|
1338
|
-
* @description Result of the import for the user
|
|
1339
|
-
* @default pending
|
|
1340
|
-
* @enum {string}
|
|
1341
|
-
*/
|
|
1342
|
-
importStatus: "pending" | "imported" | "not_found" | "error" | "missing_contacts";
|
|
1343
|
-
/**
|
|
1344
|
-
* @description The error raised during the import, if set
|
|
1345
|
-
* @default null
|
|
1346
|
-
*/
|
|
1347
|
-
importError: null | string;
|
|
1348
|
-
/**
|
|
1349
|
-
* @description Related user profile id from the Life Events building block, if available
|
|
1350
|
-
* @default null
|
|
1351
|
-
*/
|
|
1352
|
-
relatedUserProfileId: null | string;
|
|
1353
|
-
/**
|
|
1354
|
-
* @description Related user id from the Messaging building block, if available
|
|
1355
|
-
* @default null
|
|
1356
|
-
*/
|
|
1357
|
-
relatedUserId: null | string;
|
|
1358
|
-
/** @description Tags related to the user */
|
|
1359
|
-
tags?: string[];
|
|
1360
|
-
/**
|
|
1361
|
-
* @description PPSN of the imported user
|
|
1362
|
-
* @default null
|
|
1363
|
-
*/
|
|
1364
|
-
publicIdentityId: null | string;
|
|
1365
|
-
/**
|
|
1366
|
-
* @description First name of the imported user
|
|
1367
|
-
* @default null
|
|
1368
|
-
*/
|
|
1369
|
-
firstName: null | string;
|
|
1370
|
-
/**
|
|
1371
|
-
* @description Last name of the imported user
|
|
1372
|
-
* @default null
|
|
1373
|
-
*/
|
|
1374
|
-
lastName: null | string;
|
|
1375
|
-
/**
|
|
1376
|
-
* @description Birth date of the imported user
|
|
1377
|
-
* @default null
|
|
1378
|
-
*/
|
|
1379
|
-
birthDate: null | string;
|
|
1380
|
-
/**
|
|
1381
|
-
* @description Address of the imported user
|
|
1382
|
-
* @default null
|
|
1383
|
-
*/
|
|
1384
|
-
address: {
|
|
1385
|
-
/** @default null */
|
|
1386
|
-
city: null | string;
|
|
1387
|
-
/** @default null */
|
|
1388
|
-
zipCode: null | string;
|
|
1389
|
-
/** @default null */
|
|
1390
|
-
street: null | string;
|
|
1391
|
-
/** @default null */
|
|
1392
|
-
country: null | string;
|
|
1393
|
-
/** @default null */
|
|
1394
|
-
region: null | string;
|
|
1395
|
-
} | null;
|
|
1396
|
-
/**
|
|
1397
|
-
* @description If false, an invitation to the user asking to accept to receive messages from the organisation will be sent. If true, it means that the organisation already asked the permissions to the user
|
|
1398
|
-
* @default false
|
|
1399
|
-
*/
|
|
1400
|
-
collectedConsent: boolean;
|
|
1401
|
-
/**
|
|
1402
|
-
* @description If true, it means that a message to welcome the user has already been sent
|
|
1403
|
-
* @default false
|
|
1404
|
-
*/
|
|
1405
|
-
welcomed: boolean;
|
|
1406
|
-
}[];
|
|
1407
|
-
/**
|
|
1408
|
-
* @description Channel through which the users have been imported
|
|
1409
|
-
* @default api
|
|
1410
|
-
* @enum {string}
|
|
1411
|
-
*/
|
|
1412
|
-
importChannel: "api" | "csv";
|
|
1413
|
-
/** @default 0 */
|
|
1414
|
-
retryCount: number;
|
|
1415
|
-
/** @default null */
|
|
1416
|
-
lastRetryAt: string | null;
|
|
1417
|
-
/** Format: uuid */
|
|
1418
|
-
id: string;
|
|
1419
|
-
};
|
|
1420
|
-
metadata?: {
|
|
1421
|
-
/** @description Object containing the links to the related endpoints */
|
|
1422
|
-
links?: {
|
|
1423
|
-
self: {
|
|
1424
|
-
/** @description URL pointing to the request itself */
|
|
1425
|
-
href?: string;
|
|
1426
|
-
};
|
|
1427
|
-
next?: {
|
|
1428
|
-
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1429
|
-
href?: string;
|
|
1430
|
-
};
|
|
1431
|
-
prev?: {
|
|
1432
|
-
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1433
|
-
href?: string;
|
|
1434
|
-
};
|
|
1435
|
-
first: {
|
|
1436
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
1437
|
-
href?: string;
|
|
1438
|
-
};
|
|
1439
|
-
last: {
|
|
1440
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
1441
|
-
href?: string;
|
|
1442
|
-
};
|
|
1443
|
-
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
1444
|
-
pages: {
|
|
1445
|
-
[key: string]: {
|
|
1446
|
-
href?: string;
|
|
1447
|
-
};
|
|
1448
|
-
};
|
|
1449
|
-
};
|
|
1450
|
-
/** @description Number representing the total number of available items */
|
|
1451
|
-
totalCount?: number;
|
|
1452
|
-
};
|
|
1453
|
-
};
|
|
1454
|
-
};
|
|
1455
|
-
};
|
|
1456
|
-
/** @description Default Response */
|
|
1457
|
-
"5XX": {
|
|
1458
|
-
headers: {
|
|
1459
|
-
[name: string]: unknown;
|
|
1460
|
-
};
|
|
1461
|
-
content: {
|
|
1462
|
-
"application/json": {
|
|
1463
|
-
/** @description Code used to categorize the error */
|
|
1464
|
-
code: string;
|
|
1465
|
-
/** @description Description of the error */
|
|
1466
|
-
detail: string;
|
|
1467
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1468
|
-
requestId: string;
|
|
1469
|
-
/** @description Name of the error type */
|
|
1470
|
-
name: string;
|
|
1471
|
-
/** @description List of the validation errors */
|
|
1472
|
-
validation?: {
|
|
1473
|
-
fieldName: string;
|
|
1474
|
-
message: string;
|
|
1475
|
-
}[];
|
|
1476
|
-
validationContext?: string;
|
|
1477
|
-
};
|
|
1478
|
-
};
|
|
1479
|
-
};
|
|
1480
|
-
/** @description Default Response */
|
|
1481
|
-
"4XX": {
|
|
1482
|
-
headers: {
|
|
1483
|
-
[name: string]: unknown;
|
|
1484
|
-
};
|
|
1485
|
-
content: {
|
|
1486
|
-
"application/json": {
|
|
1487
|
-
/** @description Code used to categorize the error */
|
|
1488
|
-
code: string;
|
|
1489
|
-
/** @description Description of the error */
|
|
1490
|
-
detail: string;
|
|
1491
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1492
|
-
requestId: string;
|
|
1493
|
-
/** @description Name of the error type */
|
|
1494
|
-
name: string;
|
|
1495
|
-
/** @description List of the validation errors */
|
|
1496
|
-
validation?: {
|
|
1497
|
-
fieldName: string;
|
|
1498
|
-
message: string;
|
|
1499
|
-
}[];
|
|
1500
|
-
validationContext?: string;
|
|
1501
|
-
};
|
|
1502
|
-
};
|
|
1503
|
-
};
|
|
1504
|
-
};
|
|
1505
|
-
};
|
|
1506
|
-
put?: never;
|
|
1507
|
-
post?: never;
|
|
1508
|
-
delete?: never;
|
|
1509
|
-
options?: never;
|
|
1510
|
-
head?: never;
|
|
1511
|
-
patch?: never;
|
|
1512
|
-
trace?: never;
|
|
1513
|
-
};
|
|
1514
|
-
"/api/v1/user-imports/template-download": {
|
|
1515
|
-
parameters: {
|
|
1516
|
-
query?: never;
|
|
1517
|
-
header?: never;
|
|
1518
|
-
path?: never;
|
|
1519
|
-
cookie?: never;
|
|
1520
|
-
};
|
|
1521
|
-
/** @description Returns a string containing the template with the csv that will be used to import users */
|
|
1522
|
-
get: {
|
|
1523
|
-
parameters: {
|
|
1524
|
-
query?: never;
|
|
1525
|
-
header?: never;
|
|
1526
|
-
path?: never;
|
|
1527
|
-
cookie?: never;
|
|
1528
|
-
};
|
|
1529
|
-
requestBody?: never;
|
|
1530
|
-
responses: {
|
|
1531
|
-
/** @description The header and one example line for the CSV template that must be used to import users */
|
|
1532
|
-
200: {
|
|
1533
|
-
headers: {
|
|
1534
|
-
[name: string]: unknown;
|
|
1535
|
-
};
|
|
1536
|
-
content: {
|
|
1537
|
-
"text/csv": string;
|
|
1538
|
-
};
|
|
1539
|
-
};
|
|
1540
|
-
};
|
|
1541
|
-
};
|
|
1542
|
-
put?: never;
|
|
1543
|
-
post?: never;
|
|
1544
|
-
delete?: never;
|
|
1545
|
-
options?: never;
|
|
1546
|
-
head?: never;
|
|
1547
|
-
patch?: never;
|
|
1548
|
-
trace?: never;
|
|
1549
|
-
};
|
|
1550
|
-
"/api/v1/users/": {
|
|
1551
|
-
parameters: {
|
|
1552
|
-
query?: never;
|
|
1553
|
-
header?: never;
|
|
1554
|
-
path?: never;
|
|
1555
|
-
cookie?: never;
|
|
1556
|
-
};
|
|
1557
|
-
get: {
|
|
1558
|
-
parameters: {
|
|
1559
|
-
query?: {
|
|
1560
|
-
/** @description If set, the endpoint searches for users whom contain this value in either the name, the surname, or the email address */
|
|
1561
|
-
search?: string;
|
|
1562
|
-
/** @description If set, it must contain a list of transports divided by ',' and the endpoint searches for users whom have selected at least one of them as preferred for the organisation */
|
|
1563
|
-
transports?: string;
|
|
1564
|
-
/** @description If set, the endpoint returns the users whom have imported by that specific batch */
|
|
1565
|
-
importId?: string;
|
|
1566
|
-
/** @description If true, the endpoint returns active only users */
|
|
1567
|
-
activeOnly?: string;
|
|
1568
|
-
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
1569
|
-
offset?: string;
|
|
1570
|
-
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
1571
|
-
limit?: string;
|
|
1572
|
-
};
|
|
1573
|
-
header?: never;
|
|
1574
|
-
path?: never;
|
|
1575
|
-
cookie?: never;
|
|
1576
|
-
};
|
|
1577
|
-
requestBody?: never;
|
|
1578
|
-
responses: {
|
|
1579
|
-
/** @description Default Response */
|
|
1580
|
-
200: {
|
|
1581
|
-
headers: {
|
|
1582
|
-
[name: string]: unknown;
|
|
1583
|
-
};
|
|
1584
|
-
content: {
|
|
1585
|
-
"application/json": {
|
|
1586
|
-
data: {
|
|
1587
|
-
/**
|
|
1588
|
-
* Format: uuid
|
|
1589
|
-
* @description Unique id of the organisation setting
|
|
1590
|
-
*/
|
|
1591
|
-
organisationSettingId: string;
|
|
1592
|
-
/**
|
|
1593
|
-
* @description First name of the user
|
|
1594
|
-
* @default null
|
|
1595
|
-
*/
|
|
1596
|
-
firstName: null | string;
|
|
1597
|
-
/**
|
|
1598
|
-
* @description Last name of the user
|
|
1599
|
-
* @default null
|
|
1600
|
-
*/
|
|
1601
|
-
lastName: null | string;
|
|
1602
|
-
/**
|
|
1603
|
-
* @description Birth date of the user
|
|
1604
|
-
* @default null
|
|
1605
|
-
*/
|
|
1606
|
-
birthDate: null | string;
|
|
1607
|
-
/**
|
|
1608
|
-
* @description Preferred language of the user
|
|
1609
|
-
* @default null
|
|
1610
|
-
*/
|
|
1611
|
-
lang: null | string;
|
|
1612
|
-
/**
|
|
1613
|
-
* @description PPSN of the user
|
|
1614
|
-
* @default null
|
|
1615
|
-
*/
|
|
1616
|
-
ppsn: null | string;
|
|
1617
|
-
/**
|
|
1618
|
-
* Format: uuid
|
|
1619
|
-
* @description Unique id of the related user
|
|
1620
|
-
*/
|
|
1621
|
-
id: string;
|
|
1622
|
-
/**
|
|
1623
|
-
* @description User profile id, if available
|
|
1624
|
-
* @default null
|
|
1625
|
-
*/
|
|
1626
|
-
userProfileId: null | string;
|
|
1627
|
-
/**
|
|
1628
|
-
* @description Phone number of the user
|
|
1629
|
-
* @default null
|
|
1630
|
-
*/
|
|
1631
|
-
phoneNumber: null | string;
|
|
1632
|
-
/**
|
|
1633
|
-
* @description Email address of the user
|
|
1634
|
-
* @default null
|
|
1635
|
-
*/
|
|
1636
|
-
emailAddress: null | string;
|
|
1637
|
-
/** @description Unique id of the related organisation */
|
|
1638
|
-
organisationId: string;
|
|
1639
|
-
/**
|
|
1640
|
-
* @description Current status of the invitation to the messaging building block
|
|
1641
|
-
* @default pending
|
|
1642
|
-
* @enum {string}
|
|
1643
|
-
*/
|
|
1644
|
-
organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
|
|
1645
|
-
/** @description Date and time describing when the organisation invitation has been sent */
|
|
1646
|
-
organisationInvitationSentAt?: string;
|
|
1647
|
-
/** @description Date and time describing when the user has gave a feedback to the organisation invitation */
|
|
1648
|
-
organisationInvitationFeedbackAt?: string;
|
|
1649
|
-
/** @description The list of the preferred transports to use. If the selected transports are not available for the recipient, others will be used */
|
|
1650
|
-
organisationPreferredTransports: ("email" | "sms")[];
|
|
1651
|
-
/**
|
|
1652
|
-
* @description If full, it means that the user is already on the Life Events platform, if partial the match has to be reviewed, if not_related the user does not exist
|
|
1653
|
-
* @enum {string}
|
|
1654
|
-
*/
|
|
1655
|
-
correlationQuality: "full" | "partial" | "not_related";
|
|
1656
|
-
/**
|
|
1657
|
-
* @default pending
|
|
1658
|
-
* @enum {string}
|
|
1659
|
-
*/
|
|
1660
|
-
userStatus: "to_be_invited" | "pending" | "disabled" | "active";
|
|
1661
|
-
details?: {
|
|
1662
|
-
/**
|
|
1663
|
-
* @description PPSN of the imported user
|
|
1664
|
-
* @default null
|
|
1665
|
-
*/
|
|
1666
|
-
publicIdentityId: null | string;
|
|
1667
|
-
/**
|
|
1668
|
-
* @description First name of the imported user
|
|
1669
|
-
* @default null
|
|
1670
|
-
*/
|
|
1671
|
-
firstName: null | string;
|
|
1672
|
-
/**
|
|
1673
|
-
* @description Last name of the imported user
|
|
1674
|
-
* @default null
|
|
1675
|
-
*/
|
|
1676
|
-
lastName: null | string;
|
|
1677
|
-
/**
|
|
1678
|
-
* @description Birth date of the imported user
|
|
1679
|
-
* @default null
|
|
1680
|
-
*/
|
|
1681
|
-
birthDate: null | string;
|
|
1682
|
-
/**
|
|
1683
|
-
* @description Address of the imported user
|
|
1684
|
-
* @default null
|
|
1685
|
-
*/
|
|
1686
|
-
address: {
|
|
1687
|
-
/** @default null */
|
|
1688
|
-
city: null | string;
|
|
1689
|
-
/** @default null */
|
|
1690
|
-
zipCode: null | string;
|
|
1691
|
-
/** @default null */
|
|
1692
|
-
street: null | string;
|
|
1693
|
-
/** @default null */
|
|
1694
|
-
country: null | string;
|
|
1695
|
-
/** @default null */
|
|
1696
|
-
region: null | string;
|
|
1697
|
-
} | null;
|
|
1698
|
-
/**
|
|
1699
|
-
* @description If false, an invitation to the user asking to accept to receive messages from the organisation will be sent. If true, it means that the organisation already asked the permissions to the user
|
|
1700
|
-
* @default false
|
|
1701
|
-
*/
|
|
1702
|
-
collectedConsent: boolean;
|
|
1703
|
-
/**
|
|
1704
|
-
* @description If true, it means that a message to welcome the user has already been sent
|
|
1705
|
-
* @default false
|
|
1706
|
-
*/
|
|
1707
|
-
welcomed: boolean;
|
|
1708
|
-
};
|
|
1709
|
-
}[];
|
|
1710
|
-
metadata?: {
|
|
1711
|
-
/** @description Object containing the links to the related endpoints */
|
|
1712
|
-
links?: {
|
|
1713
|
-
self: {
|
|
1714
|
-
/** @description URL pointing to the request itself */
|
|
1715
|
-
href?: string;
|
|
1716
|
-
};
|
|
1717
|
-
next?: {
|
|
1718
|
-
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1719
|
-
href?: string;
|
|
1720
|
-
};
|
|
1721
|
-
prev?: {
|
|
1722
|
-
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1723
|
-
href?: string;
|
|
1724
|
-
};
|
|
1725
|
-
first: {
|
|
1726
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
1727
|
-
href?: string;
|
|
1728
|
-
};
|
|
1729
|
-
last: {
|
|
1730
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
1731
|
-
href?: string;
|
|
1732
|
-
};
|
|
1733
|
-
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
1734
|
-
pages: {
|
|
1735
|
-
[key: string]: {
|
|
1736
|
-
href?: string;
|
|
1737
|
-
};
|
|
1738
|
-
};
|
|
1739
|
-
};
|
|
1740
|
-
/** @description Number representing the total number of available items */
|
|
1741
|
-
totalCount?: number;
|
|
1742
|
-
};
|
|
1743
|
-
};
|
|
1744
|
-
};
|
|
1745
|
-
};
|
|
1746
|
-
/** @description Default Response */
|
|
1747
|
-
"5XX": {
|
|
1748
|
-
headers: {
|
|
1749
|
-
[name: string]: unknown;
|
|
1750
|
-
};
|
|
1751
|
-
content: {
|
|
1752
|
-
"application/json": {
|
|
1753
|
-
/** @description Code used to categorize the error */
|
|
1754
|
-
code: string;
|
|
1755
|
-
/** @description Description of the error */
|
|
1756
|
-
detail: string;
|
|
1757
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1758
|
-
requestId: string;
|
|
1759
|
-
/** @description Name of the error type */
|
|
1760
|
-
name: string;
|
|
1761
|
-
/** @description List of the validation errors */
|
|
1762
|
-
validation?: {
|
|
1763
|
-
fieldName: string;
|
|
1764
|
-
message: string;
|
|
1765
|
-
}[];
|
|
1766
|
-
validationContext?: string;
|
|
1767
|
-
};
|
|
1768
|
-
};
|
|
1769
|
-
};
|
|
1770
|
-
/** @description Default Response */
|
|
1771
|
-
"4XX": {
|
|
1772
|
-
headers: {
|
|
1773
|
-
[name: string]: unknown;
|
|
1774
|
-
};
|
|
1775
|
-
content: {
|
|
1776
|
-
"application/json": {
|
|
1777
|
-
/** @description Code used to categorize the error */
|
|
1778
|
-
code: string;
|
|
1779
|
-
/** @description Description of the error */
|
|
1780
|
-
detail: string;
|
|
1781
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1782
|
-
requestId: string;
|
|
1783
|
-
/** @description Name of the error type */
|
|
1784
|
-
name: string;
|
|
1785
|
-
/** @description List of the validation errors */
|
|
1786
|
-
validation?: {
|
|
1787
|
-
fieldName: string;
|
|
1788
|
-
message: string;
|
|
1789
|
-
}[];
|
|
1790
|
-
validationContext?: string;
|
|
1791
|
-
};
|
|
1792
|
-
};
|
|
1793
|
-
};
|
|
1794
|
-
};
|
|
1795
|
-
};
|
|
1796
|
-
put?: never;
|
|
1797
|
-
post?: never;
|
|
1798
|
-
delete?: never;
|
|
1799
|
-
options?: never;
|
|
1800
|
-
head?: never;
|
|
1801
|
-
patch?: never;
|
|
1802
|
-
trace?: never;
|
|
1803
|
-
};
|
|
1804
|
-
"/api/v1/users/{userId}": {
|
|
1805
|
-
parameters: {
|
|
1806
|
-
query?: never;
|
|
1807
|
-
header?: never;
|
|
1808
|
-
path?: never;
|
|
1809
|
-
cookie?: never;
|
|
1810
|
-
};
|
|
1811
|
-
/** @description Returns the requested user */
|
|
1812
|
-
get: {
|
|
1813
|
-
parameters: {
|
|
1814
|
-
query?: {
|
|
1815
|
-
/** @description If true, the endpoint returns active only users */
|
|
1816
|
-
activeOnly?: string;
|
|
67
|
+
type: "email";
|
|
1817
68
|
};
|
|
1818
69
|
header?: never;
|
|
1819
70
|
path: {
|
|
1820
|
-
|
|
71
|
+
providerId: string;
|
|
1821
72
|
};
|
|
1822
73
|
cookie?: never;
|
|
1823
74
|
};
|
|
@@ -1831,128 +82,28 @@ export interface paths {
|
|
|
1831
82
|
content: {
|
|
1832
83
|
"application/json": {
|
|
1833
84
|
data: {
|
|
1834
|
-
/**
|
|
1835
|
-
* Format: uuid
|
|
1836
|
-
* @description Unique id of the organisation setting
|
|
1837
|
-
*/
|
|
1838
|
-
organisationSettingId: string;
|
|
1839
|
-
/**
|
|
1840
|
-
* @description First name of the user
|
|
1841
|
-
* @default null
|
|
1842
|
-
*/
|
|
1843
|
-
firstName: null | string;
|
|
1844
|
-
/**
|
|
1845
|
-
* @description Last name of the user
|
|
1846
|
-
* @default null
|
|
1847
|
-
*/
|
|
1848
|
-
lastName: null | string;
|
|
1849
|
-
/**
|
|
1850
|
-
* @description Birth date of the user
|
|
1851
|
-
* @default null
|
|
1852
|
-
*/
|
|
1853
|
-
birthDate: null | string;
|
|
1854
|
-
/**
|
|
1855
|
-
* @description Preferred language of the user
|
|
1856
|
-
* @default null
|
|
1857
|
-
*/
|
|
1858
|
-
lang: null | string;
|
|
1859
|
-
/**
|
|
1860
|
-
* @description PPSN of the user
|
|
1861
|
-
* @default null
|
|
1862
|
-
*/
|
|
1863
|
-
ppsn: null | string;
|
|
1864
|
-
/**
|
|
1865
|
-
* Format: uuid
|
|
1866
|
-
* @description Unique id of the related user
|
|
1867
|
-
*/
|
|
85
|
+
/** Format: uuid */
|
|
1868
86
|
id: string;
|
|
1869
|
-
/**
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
/**
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
* @enum {string}
|
|
1890
|
-
*/
|
|
1891
|
-
organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
|
|
1892
|
-
/** @description Date and time describing when the organisation invitation has been sent */
|
|
1893
|
-
organisationInvitationSentAt?: string;
|
|
1894
|
-
/** @description Date and time describing when the user has gave a feedback to the organisation invitation */
|
|
1895
|
-
organisationInvitationFeedbackAt?: string;
|
|
1896
|
-
/** @description The list of the preferred transports to use. If the selected transports are not available for the recipient, others will be used */
|
|
1897
|
-
organisationPreferredTransports: ("email" | "sms")[];
|
|
1898
|
-
/**
|
|
1899
|
-
* @description If full, it means that the user is already on the Life Events platform, if partial the match has to be reviewed, if not_related the user does not exist
|
|
1900
|
-
* @enum {string}
|
|
1901
|
-
*/
|
|
1902
|
-
correlationQuality: "full" | "partial" | "not_related";
|
|
1903
|
-
/**
|
|
1904
|
-
* @default pending
|
|
1905
|
-
* @enum {string}
|
|
1906
|
-
*/
|
|
1907
|
-
userStatus: "to_be_invited" | "pending" | "disabled" | "active";
|
|
1908
|
-
details?: {
|
|
1909
|
-
/**
|
|
1910
|
-
* @description PPSN of the imported user
|
|
1911
|
-
* @default null
|
|
1912
|
-
*/
|
|
1913
|
-
publicIdentityId: null | string;
|
|
1914
|
-
/**
|
|
1915
|
-
* @description First name of the imported user
|
|
1916
|
-
* @default null
|
|
1917
|
-
*/
|
|
1918
|
-
firstName: null | string;
|
|
1919
|
-
/**
|
|
1920
|
-
* @description Last name of the imported user
|
|
1921
|
-
* @default null
|
|
1922
|
-
*/
|
|
1923
|
-
lastName: null | string;
|
|
1924
|
-
/**
|
|
1925
|
-
* @description Birth date of the imported user
|
|
1926
|
-
* @default null
|
|
1927
|
-
*/
|
|
1928
|
-
birthDate: null | string;
|
|
1929
|
-
/**
|
|
1930
|
-
* @description Address of the imported user
|
|
1931
|
-
* @default null
|
|
1932
|
-
*/
|
|
1933
|
-
address: {
|
|
1934
|
-
/** @default null */
|
|
1935
|
-
city: null | string;
|
|
1936
|
-
/** @default null */
|
|
1937
|
-
zipCode: null | string;
|
|
1938
|
-
/** @default null */
|
|
1939
|
-
street: null | string;
|
|
1940
|
-
/** @default null */
|
|
1941
|
-
country: null | string;
|
|
1942
|
-
/** @default null */
|
|
1943
|
-
region: null | string;
|
|
1944
|
-
} | null;
|
|
1945
|
-
/**
|
|
1946
|
-
* @description If false, an invitation to the user asking to accept to receive messages from the organisation will be sent. If true, it means that the organisation already asked the permissions to the user
|
|
1947
|
-
* @default false
|
|
1948
|
-
*/
|
|
1949
|
-
collectedConsent: boolean;
|
|
1950
|
-
/**
|
|
1951
|
-
* @description If true, it means that a message to welcome the user has already been sent
|
|
1952
|
-
* @default false
|
|
1953
|
-
*/
|
|
1954
|
-
welcomed: boolean;
|
|
1955
|
-
};
|
|
87
|
+
/** @description Name of the provider */
|
|
88
|
+
providerName: string;
|
|
89
|
+
/** @description If true, the provider is set as primary for the selected type for the current organisation. Please note, each organisation can only have one primary provider for each type */
|
|
90
|
+
isPrimary: boolean;
|
|
91
|
+
/** @enum {string} */
|
|
92
|
+
type: "email";
|
|
93
|
+
/** @description Address of the SMTP host */
|
|
94
|
+
smtpHost: string;
|
|
95
|
+
/** @description Port of the SMTP host */
|
|
96
|
+
smtpPort: number;
|
|
97
|
+
/** @description Username to use to log into the SMTP server */
|
|
98
|
+
username: string;
|
|
99
|
+
/** @description Password to use to log into the SMTP server */
|
|
100
|
+
password: string;
|
|
101
|
+
/** @description Optional field to adjust how long time between each mail, in miliseconds */
|
|
102
|
+
throttle?: number;
|
|
103
|
+
/** @description Email address to use as sender */
|
|
104
|
+
fromAddress: string;
|
|
105
|
+
/** @description Is connection to the SMTP server secure? */
|
|
106
|
+
ssl: boolean;
|
|
1956
107
|
};
|
|
1957
108
|
metadata?: {
|
|
1958
109
|
/** @description Object containing the links to the related endpoints */
|
|
@@ -2011,6 +162,7 @@ export interface paths {
|
|
|
2011
162
|
message: string;
|
|
2012
163
|
}[];
|
|
2013
164
|
validationContext?: string;
|
|
165
|
+
statusCode: number;
|
|
2014
166
|
};
|
|
2015
167
|
};
|
|
2016
168
|
};
|
|
@@ -2035,19 +187,59 @@ export interface paths {
|
|
|
2035
187
|
message: string;
|
|
2036
188
|
}[];
|
|
2037
189
|
validationContext?: string;
|
|
190
|
+
statusCode: number;
|
|
2038
191
|
};
|
|
2039
192
|
};
|
|
2040
193
|
};
|
|
2041
194
|
};
|
|
2042
195
|
};
|
|
2043
|
-
|
|
196
|
+
/** @description Updates the requested provider */
|
|
197
|
+
put: operations["UpdateProvider"];
|
|
2044
198
|
post?: never;
|
|
199
|
+
/** @description Deletes the requested provider */
|
|
200
|
+
delete: operations["DeleteProvider"];
|
|
201
|
+
options?: never;
|
|
202
|
+
head?: never;
|
|
203
|
+
patch?: never;
|
|
204
|
+
trace?: never;
|
|
205
|
+
};
|
|
206
|
+
"/api/v1/templates/": {
|
|
207
|
+
parameters: {
|
|
208
|
+
query?: never;
|
|
209
|
+
header?: never;
|
|
210
|
+
path?: never;
|
|
211
|
+
cookie?: never;
|
|
212
|
+
};
|
|
213
|
+
/** @description Returns the providers matching the requested query */
|
|
214
|
+
get: operations["ListTemplates"];
|
|
215
|
+
put?: never;
|
|
216
|
+
/** @description Creates a new template */
|
|
217
|
+
post: operations["CreateTemplate"];
|
|
2045
218
|
delete?: never;
|
|
2046
219
|
options?: never;
|
|
2047
220
|
head?: never;
|
|
2048
221
|
patch?: never;
|
|
2049
222
|
trace?: never;
|
|
2050
223
|
};
|
|
224
|
+
"/api/v1/templates/{templateId}": {
|
|
225
|
+
parameters: {
|
|
226
|
+
query?: never;
|
|
227
|
+
header?: never;
|
|
228
|
+
path?: never;
|
|
229
|
+
cookie?: never;
|
|
230
|
+
};
|
|
231
|
+
/** @description Returns the requested template */
|
|
232
|
+
get: operations["GetTemplate"];
|
|
233
|
+
/** @description Updates the requested template */
|
|
234
|
+
put: operations["UpdateTemplate"];
|
|
235
|
+
post?: never;
|
|
236
|
+
/** @description Deletes the requested template */
|
|
237
|
+
delete: operations["DeleteTemplate"];
|
|
238
|
+
options?: never;
|
|
239
|
+
head?: never;
|
|
240
|
+
patch?: never;
|
|
241
|
+
trace?: never;
|
|
242
|
+
};
|
|
2051
243
|
"/api/v1/message-events/": {
|
|
2052
244
|
parameters: {
|
|
2053
245
|
query?: never;
|
|
@@ -2158,6 +350,7 @@ export interface paths {
|
|
|
2158
350
|
message: string;
|
|
2159
351
|
}[];
|
|
2160
352
|
validationContext?: string;
|
|
353
|
+
statusCode: number;
|
|
2161
354
|
};
|
|
2162
355
|
};
|
|
2163
356
|
};
|
|
@@ -2182,6 +375,7 @@ export interface paths {
|
|
|
2182
375
|
message: string;
|
|
2183
376
|
}[];
|
|
2184
377
|
validationContext?: string;
|
|
378
|
+
statusCode: number;
|
|
2185
379
|
};
|
|
2186
380
|
};
|
|
2187
381
|
};
|
|
@@ -2269,8 +463,6 @@ export interface paths {
|
|
|
2269
463
|
* @enum {string}
|
|
2270
464
|
*/
|
|
2271
465
|
security: "confidential" | "public";
|
|
2272
|
-
/** @description If true, the message will be sent even if the recipient didn't accept the organisation's invitation */
|
|
2273
|
-
bypassConsent: boolean;
|
|
2274
466
|
} | {
|
|
2275
467
|
/** @description Unique id of the related message */
|
|
2276
468
|
messageId: string;
|
|
@@ -2310,6 +502,7 @@ export interface paths {
|
|
|
2310
502
|
message: string;
|
|
2311
503
|
}[];
|
|
2312
504
|
validationContext?: string;
|
|
505
|
+
statusCode: number;
|
|
2313
506
|
};
|
|
2314
507
|
};
|
|
2315
508
|
};
|
|
@@ -2334,6 +527,7 @@ export interface paths {
|
|
|
2334
527
|
message: string;
|
|
2335
528
|
}[];
|
|
2336
529
|
validationContext?: string;
|
|
530
|
+
statusCode: number;
|
|
2337
531
|
};
|
|
2338
532
|
};
|
|
2339
533
|
};
|
|
@@ -2403,6 +597,7 @@ export interface paths {
|
|
|
2403
597
|
message: string;
|
|
2404
598
|
}[];
|
|
2405
599
|
validationContext?: string;
|
|
600
|
+
statusCode: number;
|
|
2406
601
|
};
|
|
2407
602
|
};
|
|
2408
603
|
};
|
|
@@ -2427,6 +622,7 @@ export interface paths {
|
|
|
2427
622
|
message: string;
|
|
2428
623
|
}[];
|
|
2429
624
|
validationContext?: string;
|
|
625
|
+
statusCode: number;
|
|
2430
626
|
};
|
|
2431
627
|
};
|
|
2432
628
|
};
|
|
@@ -2493,6 +689,7 @@ export interface paths {
|
|
|
2493
689
|
message: string;
|
|
2494
690
|
}[];
|
|
2495
691
|
validationContext?: string;
|
|
692
|
+
statusCode: number;
|
|
2496
693
|
};
|
|
2497
694
|
};
|
|
2498
695
|
};
|
|
@@ -2517,6 +714,7 @@ export interface paths {
|
|
|
2517
714
|
message: string;
|
|
2518
715
|
}[];
|
|
2519
716
|
validationContext?: string;
|
|
717
|
+
statusCode: number;
|
|
2520
718
|
};
|
|
2521
719
|
};
|
|
2522
720
|
};
|
|
@@ -2642,6 +840,7 @@ export interface operations {
|
|
|
2642
840
|
message: string;
|
|
2643
841
|
}[];
|
|
2644
842
|
validationContext?: string;
|
|
843
|
+
statusCode: number;
|
|
2645
844
|
};
|
|
2646
845
|
};
|
|
2647
846
|
};
|
|
@@ -2666,6 +865,7 @@ export interface operations {
|
|
|
2666
865
|
message: string;
|
|
2667
866
|
}[];
|
|
2668
867
|
validationContext?: string;
|
|
868
|
+
statusCode: number;
|
|
2669
869
|
};
|
|
2670
870
|
};
|
|
2671
871
|
};
|
|
@@ -2682,7 +882,7 @@ export interface operations {
|
|
|
2682
882
|
content: {
|
|
2683
883
|
"application/json": {
|
|
2684
884
|
/** @description The list of the preferred transports to use. If the selected transports are not available for the recipient, others will be used */
|
|
2685
|
-
preferredTransports: ("
|
|
885
|
+
preferredTransports: ("email" | "lifeEvent")[];
|
|
2686
886
|
/** @description Unique user id of the recipient */
|
|
2687
887
|
recipientUserId: string;
|
|
2688
888
|
/**
|
|
@@ -2690,11 +890,6 @@ export interface operations {
|
|
|
2690
890
|
* @enum {string}
|
|
2691
891
|
*/
|
|
2692
892
|
security: "confidential" | "public";
|
|
2693
|
-
/**
|
|
2694
|
-
* @description If true, the message will be sent even if the recipient didn't accept the organisation's invitation
|
|
2695
|
-
* @default false
|
|
2696
|
-
*/
|
|
2697
|
-
bypassConsent: boolean;
|
|
2698
893
|
/**
|
|
2699
894
|
* Format: date-time
|
|
2700
895
|
* @description Date and time of when schedule the message
|
|
@@ -2793,6 +988,7 @@ export interface operations {
|
|
|
2793
988
|
message: string;
|
|
2794
989
|
}[];
|
|
2795
990
|
validationContext?: string;
|
|
991
|
+
statusCode: number;
|
|
2796
992
|
};
|
|
2797
993
|
};
|
|
2798
994
|
};
|
|
@@ -2817,6 +1013,7 @@ export interface operations {
|
|
|
2817
1013
|
message: string;
|
|
2818
1014
|
}[];
|
|
2819
1015
|
validationContext?: string;
|
|
1016
|
+
statusCode: number;
|
|
2820
1017
|
};
|
|
2821
1018
|
};
|
|
2822
1019
|
};
|
|
@@ -2925,6 +1122,7 @@ export interface operations {
|
|
|
2925
1122
|
message: string;
|
|
2926
1123
|
}[];
|
|
2927
1124
|
validationContext?: string;
|
|
1125
|
+
statusCode: number;
|
|
2928
1126
|
};
|
|
2929
1127
|
};
|
|
2930
1128
|
};
|
|
@@ -2949,6 +1147,7 @@ export interface operations {
|
|
|
2949
1147
|
message: string;
|
|
2950
1148
|
}[];
|
|
2951
1149
|
validationContext?: string;
|
|
1150
|
+
statusCode: number;
|
|
2952
1151
|
};
|
|
2953
1152
|
};
|
|
2954
1153
|
};
|
|
@@ -2960,7 +1159,7 @@ export interface operations {
|
|
|
2960
1159
|
/** @description If set, returns only the primary providers if true, otherwise the non-primary ones */
|
|
2961
1160
|
primary?: "true" | "false" | "0" | "1";
|
|
2962
1161
|
/** @description Provider types that can be manipulated */
|
|
2963
|
-
type: "email"
|
|
1162
|
+
type: "email";
|
|
2964
1163
|
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
2965
1164
|
offset?: string;
|
|
2966
1165
|
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
@@ -2993,7 +1192,7 @@ export interface operations {
|
|
|
2993
1192
|
* @description Provider types that can be manipulated
|
|
2994
1193
|
* @enum {string}
|
|
2995
1194
|
*/
|
|
2996
|
-
type: "email"
|
|
1195
|
+
type: "email";
|
|
2997
1196
|
}[];
|
|
2998
1197
|
metadata?: {
|
|
2999
1198
|
/** @description Object containing the links to the related endpoints */
|
|
@@ -3052,6 +1251,7 @@ export interface operations {
|
|
|
3052
1251
|
message: string;
|
|
3053
1252
|
}[];
|
|
3054
1253
|
validationContext?: string;
|
|
1254
|
+
statusCode: number;
|
|
3055
1255
|
};
|
|
3056
1256
|
};
|
|
3057
1257
|
};
|
|
@@ -3076,6 +1276,7 @@ export interface operations {
|
|
|
3076
1276
|
message: string;
|
|
3077
1277
|
}[];
|
|
3078
1278
|
validationContext?: string;
|
|
1279
|
+
statusCode: number;
|
|
3079
1280
|
};
|
|
3080
1281
|
};
|
|
3081
1282
|
};
|
|
@@ -3088,7 +1289,7 @@ export interface operations {
|
|
|
3088
1289
|
path?: never;
|
|
3089
1290
|
cookie?: never;
|
|
3090
1291
|
};
|
|
3091
|
-
requestBody
|
|
1292
|
+
requestBody: {
|
|
3092
1293
|
content: {
|
|
3093
1294
|
"application/json": {
|
|
3094
1295
|
/** @description Name of the provider */
|
|
@@ -3111,20 +1312,6 @@ export interface operations {
|
|
|
3111
1312
|
fromAddress: string;
|
|
3112
1313
|
/** @description Is connection to the SMTP server secure? */
|
|
3113
1314
|
ssl: boolean;
|
|
3114
|
-
} | {
|
|
3115
|
-
/** @description Name of the provider */
|
|
3116
|
-
providerName: string;
|
|
3117
|
-
/** @description If true, the provider is set as primary for the selected type for the current organisation. Please note, each organisation can only have one primary provider for each type */
|
|
3118
|
-
isPrimary: boolean;
|
|
3119
|
-
/** @enum {string} */
|
|
3120
|
-
type: "sms";
|
|
3121
|
-
config: {
|
|
3122
|
-
/** @enum {string} */
|
|
3123
|
-
type: "AWS";
|
|
3124
|
-
accessKey: string;
|
|
3125
|
-
secretAccessKey: string;
|
|
3126
|
-
region: string;
|
|
3127
|
-
};
|
|
3128
1315
|
};
|
|
3129
1316
|
};
|
|
3130
1317
|
};
|
|
@@ -3197,6 +1384,7 @@ export interface operations {
|
|
|
3197
1384
|
message: string;
|
|
3198
1385
|
}[];
|
|
3199
1386
|
validationContext?: string;
|
|
1387
|
+
statusCode: number;
|
|
3200
1388
|
};
|
|
3201
1389
|
};
|
|
3202
1390
|
};
|
|
@@ -3221,6 +1409,7 @@ export interface operations {
|
|
|
3221
1409
|
message: string;
|
|
3222
1410
|
}[];
|
|
3223
1411
|
validationContext?: string;
|
|
1412
|
+
statusCode: number;
|
|
3224
1413
|
};
|
|
3225
1414
|
};
|
|
3226
1415
|
};
|
|
@@ -3235,7 +1424,7 @@ export interface operations {
|
|
|
3235
1424
|
};
|
|
3236
1425
|
cookie?: never;
|
|
3237
1426
|
};
|
|
3238
|
-
requestBody
|
|
1427
|
+
requestBody: {
|
|
3239
1428
|
content: {
|
|
3240
1429
|
"application/json": {
|
|
3241
1430
|
/** Format: uuid */
|
|
@@ -3260,22 +1449,6 @@ export interface operations {
|
|
|
3260
1449
|
fromAddress: string;
|
|
3261
1450
|
/** @description Is connection to the SMTP server secure? */
|
|
3262
1451
|
ssl: boolean;
|
|
3263
|
-
} | {
|
|
3264
|
-
/** Format: uuid */
|
|
3265
|
-
id: string;
|
|
3266
|
-
/** @description Name of the provider */
|
|
3267
|
-
providerName: string;
|
|
3268
|
-
/** @description If true, the provider is set as primary for the selected type for the current organisation. Please note, each organisation can only have one primary provider for each type */
|
|
3269
|
-
isPrimary: boolean;
|
|
3270
|
-
/** @enum {string} */
|
|
3271
|
-
type: "sms";
|
|
3272
|
-
config: {
|
|
3273
|
-
/** @enum {string} */
|
|
3274
|
-
type: "AWS";
|
|
3275
|
-
accessKey: string;
|
|
3276
|
-
secretAccessKey: string;
|
|
3277
|
-
region: string;
|
|
3278
|
-
};
|
|
3279
1452
|
};
|
|
3280
1453
|
};
|
|
3281
1454
|
};
|
|
@@ -3348,6 +1521,7 @@ export interface operations {
|
|
|
3348
1521
|
message: string;
|
|
3349
1522
|
}[];
|
|
3350
1523
|
validationContext?: string;
|
|
1524
|
+
statusCode: number;
|
|
3351
1525
|
};
|
|
3352
1526
|
};
|
|
3353
1527
|
};
|
|
@@ -3372,6 +1546,7 @@ export interface operations {
|
|
|
3372
1546
|
message: string;
|
|
3373
1547
|
}[];
|
|
3374
1548
|
validationContext?: string;
|
|
1549
|
+
statusCode: number;
|
|
3375
1550
|
};
|
|
3376
1551
|
};
|
|
3377
1552
|
};
|
|
@@ -3379,7 +1554,10 @@ export interface operations {
|
|
|
3379
1554
|
};
|
|
3380
1555
|
DeleteProvider: {
|
|
3381
1556
|
parameters: {
|
|
3382
|
-
query
|
|
1557
|
+
query: {
|
|
1558
|
+
/** @description Provider types that can be manipulated */
|
|
1559
|
+
type: "email";
|
|
1560
|
+
};
|
|
3383
1561
|
header?: never;
|
|
3384
1562
|
path: {
|
|
3385
1563
|
providerId: string;
|
|
@@ -3456,6 +1634,7 @@ export interface operations {
|
|
|
3456
1634
|
message: string;
|
|
3457
1635
|
}[];
|
|
3458
1636
|
validationContext?: string;
|
|
1637
|
+
statusCode: number;
|
|
3459
1638
|
};
|
|
3460
1639
|
};
|
|
3461
1640
|
};
|
|
@@ -3480,6 +1659,7 @@ export interface operations {
|
|
|
3480
1659
|
message: string;
|
|
3481
1660
|
}[];
|
|
3482
1661
|
validationContext?: string;
|
|
1662
|
+
statusCode: number;
|
|
3483
1663
|
};
|
|
3484
1664
|
};
|
|
3485
1665
|
};
|
|
@@ -3579,6 +1759,7 @@ export interface operations {
|
|
|
3579
1759
|
message: string;
|
|
3580
1760
|
}[];
|
|
3581
1761
|
validationContext?: string;
|
|
1762
|
+
statusCode: number;
|
|
3582
1763
|
};
|
|
3583
1764
|
};
|
|
3584
1765
|
};
|
|
@@ -3603,6 +1784,7 @@ export interface operations {
|
|
|
3603
1784
|
message: string;
|
|
3604
1785
|
}[];
|
|
3605
1786
|
validationContext?: string;
|
|
1787
|
+
statusCode: number;
|
|
3606
1788
|
};
|
|
3607
1789
|
};
|
|
3608
1790
|
};
|
|
@@ -3711,6 +1893,7 @@ export interface operations {
|
|
|
3711
1893
|
message: string;
|
|
3712
1894
|
}[];
|
|
3713
1895
|
validationContext?: string;
|
|
1896
|
+
statusCode: number;
|
|
3714
1897
|
};
|
|
3715
1898
|
};
|
|
3716
1899
|
};
|
|
@@ -3735,6 +1918,7 @@ export interface operations {
|
|
|
3735
1918
|
message: string;
|
|
3736
1919
|
}[];
|
|
3737
1920
|
validationContext?: string;
|
|
1921
|
+
statusCode: number;
|
|
3738
1922
|
};
|
|
3739
1923
|
};
|
|
3740
1924
|
};
|
|
@@ -3837,6 +2021,7 @@ export interface operations {
|
|
|
3837
2021
|
message: string;
|
|
3838
2022
|
}[];
|
|
3839
2023
|
validationContext?: string;
|
|
2024
|
+
statusCode: number;
|
|
3840
2025
|
};
|
|
3841
2026
|
};
|
|
3842
2027
|
};
|
|
@@ -3861,6 +2046,7 @@ export interface operations {
|
|
|
3861
2046
|
message: string;
|
|
3862
2047
|
}[];
|
|
3863
2048
|
validationContext?: string;
|
|
2049
|
+
statusCode: number;
|
|
3864
2050
|
};
|
|
3865
2051
|
};
|
|
3866
2052
|
};
|
|
@@ -3973,6 +2159,7 @@ export interface operations {
|
|
|
3973
2159
|
message: string;
|
|
3974
2160
|
}[];
|
|
3975
2161
|
validationContext?: string;
|
|
2162
|
+
statusCode: number;
|
|
3976
2163
|
};
|
|
3977
2164
|
};
|
|
3978
2165
|
};
|
|
@@ -3997,6 +2184,7 @@ export interface operations {
|
|
|
3997
2184
|
message: string;
|
|
3998
2185
|
}[];
|
|
3999
2186
|
validationContext?: string;
|
|
2187
|
+
statusCode: number;
|
|
4000
2188
|
};
|
|
4001
2189
|
};
|
|
4002
2190
|
};
|
|
@@ -4081,6 +2269,7 @@ export interface operations {
|
|
|
4081
2269
|
message: string;
|
|
4082
2270
|
}[];
|
|
4083
2271
|
validationContext?: string;
|
|
2272
|
+
statusCode: number;
|
|
4084
2273
|
};
|
|
4085
2274
|
};
|
|
4086
2275
|
};
|
|
@@ -4105,6 +2294,7 @@ export interface operations {
|
|
|
4105
2294
|
message: string;
|
|
4106
2295
|
}[];
|
|
4107
2296
|
validationContext?: string;
|
|
2297
|
+
statusCode: number;
|
|
4108
2298
|
};
|
|
4109
2299
|
};
|
|
4110
2300
|
};
|