@emilgroup/notification-sdk 0.8.1-beta.27 → 0.8.1-beta.29

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.
Files changed (45) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +148 -16
  4. package/api/email-tracking-api.ts +24 -16
  5. package/api/email-verifications-api.ts +16 -8
  6. package/api/layouts-api.ts +56 -36
  7. package/api/notification-templates-api.ts +56 -36
  8. package/api/notifications-api.ts +115 -4
  9. package/dist/api/email-messages-api.d.ts +94 -16
  10. package/dist/api/email-messages-api.js +127 -16
  11. package/dist/api/email-tracking-api.d.ts +24 -16
  12. package/dist/api/email-tracking-api.js +24 -16
  13. package/dist/api/email-verifications-api.d.ts +16 -8
  14. package/dist/api/email-verifications-api.js +16 -8
  15. package/dist/api/layouts-api.d.ts +56 -36
  16. package/dist/api/layouts-api.js +52 -32
  17. package/dist/api/notification-templates-api.d.ts +56 -36
  18. package/dist/api/notification-templates-api.js +52 -32
  19. package/dist/api/notifications-api.d.ts +65 -4
  20. package/dist/api/notifications-api.js +101 -4
  21. package/dist/models/assign-email-message-entity-body-dto.d.ts +43 -0
  22. package/dist/models/assign-email-message-entity-body-dto.js +22 -0
  23. package/dist/models/assign-email-message-entity-response-class.d.ts +25 -0
  24. package/dist/models/assign-email-message-entity-response-class.js +15 -0
  25. package/dist/models/email-message-class.d.ts +2 -1
  26. package/dist/models/email-message-class.js +2 -1
  27. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  28. package/dist/models/grpc-send-email-request-dto.js +22 -0
  29. package/dist/models/index.d.ts +6 -0
  30. package/dist/models/index.js +6 -0
  31. package/dist/models/inline-attachment-dto.d.ts +36 -0
  32. package/dist/models/inline-attachment-dto.js +15 -0
  33. package/dist/models/send-email-request-dto.d.ts +131 -0
  34. package/dist/models/send-email-request-dto.js +22 -0
  35. package/dist/models/send-email-response-class.d.ts +24 -0
  36. package/dist/models/send-email-response-class.js +15 -0
  37. package/models/assign-email-message-entity-body-dto.ts +52 -0
  38. package/models/assign-email-message-entity-response-class.ts +31 -0
  39. package/models/email-message-class.ts +3 -2
  40. package/models/grpc-send-email-request-dto.ts +144 -0
  41. package/models/index.ts +6 -0
  42. package/models/inline-attachment-dto.ts +42 -0
  43. package/models/send-email-request-dto.ts +138 -0
  44. package/models/send-email-response-class.ts +30 -0
  45. package/package.json +1 -1
@@ -16,6 +16,8 @@ common.ts
16
16
  configuration.ts
17
17
  git_push.sh
18
18
  index.ts
19
+ models/assign-email-message-entity-body-dto.ts
20
+ models/assign-email-message-entity-response-class.ts
19
21
  models/complete-email-verification-dto.ts
20
22
  models/complete-email-verification-response-class.ts
21
23
  models/create-layout-request-dto.ts
@@ -34,10 +36,12 @@ models/get-layout-request-dto.ts
34
36
  models/get-layout-response-class.ts
35
37
  models/get-notification-template-request-dto.ts
36
38
  models/get-notification-template-response-class.ts
39
+ models/grpc-send-email-request-dto.ts
37
40
  models/html-template-class.ts
38
41
  models/index.ts
39
42
  models/initiate-email-verification-dto.ts
40
43
  models/initiate-email-verification-response-class.ts
44
+ models/inline-attachment-dto.ts
41
45
  models/inline-response200.ts
42
46
  models/inline-response503.ts
43
47
  models/layout-class.ts
@@ -48,6 +52,8 @@ models/list-layouts-response-class.ts
48
52
  models/list-notification-templates-response-class.ts
49
53
  models/notification-template-class.ts
50
54
  models/s3-document-dto.ts
55
+ models/send-email-request-dto.ts
56
+ models/send-email-response-class.ts
51
57
  models/send-notification-request-dto.ts
52
58
  models/send-notification-response-class.ts
53
59
  models/update-html-template-request-dto.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/notification-sdk@0.8.1-beta.27 --save
20
+ npm install @emilgroup/notification-sdk@0.8.1-beta.29 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/notification-sdk@0.8.1-beta.27
24
+ yarn add @emilgroup/notification-sdk@0.8.1-beta.29
25
25
  ```
26
26
 
27
27
  And then you can import ``.
@@ -21,6 +21,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
+ import { AssignEmailMessageEntityBodyDto } from '../models';
25
+ // @ts-ignore
26
+ import { AssignEmailMessageEntityResponseClass } from '../models';
27
+ // @ts-ignore
24
28
  import { DownloadAttachmentResponseClass } from '../models';
25
29
  // @ts-ignore
26
30
  import { GetEmailMessageResponseClass } from '../models';
@@ -35,7 +39,59 @@ import { ListEmailMessagesResponseClass } from '../models';
35
39
  export const EmailMessagesApiAxiosParamCreator = function (configuration?: Configuration) {
36
40
  return {
37
41
  /**
38
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
42
+ * Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
43
+ * @summary Assign an email message to an entity
44
+ * @param {string} code
45
+ * @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
46
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ assignEntity: async (code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
51
+ // verify required parameter 'code' is not null or undefined
52
+ assertParamExists('assignEntity', 'code', code)
53
+ // verify required parameter 'assignEmailMessageEntityBodyDto' is not null or undefined
54
+ assertParamExists('assignEntity', 'assignEmailMessageEntityBodyDto', assignEmailMessageEntityBodyDto)
55
+ const localVarPath = `/notificationservice/v1/email-messages/{code}/entity`
56
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
57
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
58
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
59
+ let baseOptions;
60
+ let baseAccessToken;
61
+ if (configuration) {
62
+ baseOptions = configuration.baseOptions;
63
+ baseAccessToken = configuration.accessToken;
64
+ }
65
+
66
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
67
+ const localVarHeaderParameter = {} as any;
68
+ const localVarQueryParameter = {} as any;
69
+
70
+ // authentication bearer required
71
+ // http bearer authentication required
72
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
73
+
74
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
75
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
76
+ }
77
+
78
+
79
+
80
+ localVarHeaderParameter['Content-Type'] = 'application/json';
81
+
82
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
83
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
84
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
85
+ localVarRequestOptions.data = serializeDataIfNeeded(assignEmailMessageEntityBodyDto, localVarRequestOptions, configuration)
86
+
87
+ return {
88
+ url: toPathString(localVarUrlObj),
89
+ options: localVarRequestOptions,
90
+ };
91
+ },
92
+ /**
93
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
94
+ * @summary Download the email message attachment
39
95
  * @param {string} code
40
96
  * @param {number} attachmentId
41
97
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -83,7 +139,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
83
139
  };
84
140
  },
85
141
  /**
86
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
142
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
143
+ * @summary Retrieve the email message
87
144
  * @param {string} code
88
145
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
146
  * @param {*} [options] Override http request option.
@@ -127,7 +184,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
127
184
  };
128
185
  },
129
186
  /**
130
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
187
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
188
+ * @summary List the email message attachments
131
189
  * @param {string} code
132
190
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
133
191
  * @param {*} [options] Override http request option.
@@ -171,7 +229,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
171
229
  };
172
230
  },
173
231
  /**
174
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
232
+ * Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
175
233
  * @summary List email messages
176
234
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
177
235
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -257,7 +315,21 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
257
315
  const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
258
316
  return {
259
317
  /**
260
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
318
+ * Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
319
+ * @summary Assign an email message to an entity
320
+ * @param {string} code
321
+ * @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
322
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
323
+ * @param {*} [options] Override http request option.
324
+ * @throws {RequiredError}
325
+ */
326
+ async assignEntity(code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssignEmailMessageEntityResponseClass>> {
327
+ const localVarAxiosArgs = await localVarAxiosParamCreator.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options);
328
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
329
+ },
330
+ /**
331
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
332
+ * @summary Download the email message attachment
261
333
  * @param {string} code
262
334
  * @param {number} attachmentId
263
335
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -269,7 +341,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
269
341
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
270
342
  },
271
343
  /**
272
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
344
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
345
+ * @summary Retrieve the email message
273
346
  * @param {string} code
274
347
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
275
348
  * @param {*} [options] Override http request option.
@@ -280,7 +353,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
280
353
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
281
354
  },
282
355
  /**
283
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
356
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
357
+ * @summary List the email message attachments
284
358
  * @param {string} code
285
359
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
286
360
  * @param {*} [options] Override http request option.
@@ -291,7 +365,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
291
365
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
292
366
  },
293
367
  /**
294
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
368
+ * Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
295
369
  * @summary List email messages
296
370
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
297
371
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -319,7 +393,20 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
319
393
  const localVarFp = EmailMessagesApiFp(configuration)
320
394
  return {
321
395
  /**
322
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
396
+ * Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
397
+ * @summary Assign an email message to an entity
398
+ * @param {string} code
399
+ * @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
400
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
401
+ * @param {*} [options] Override http request option.
402
+ * @throws {RequiredError}
403
+ */
404
+ assignEntity(code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: any): AxiosPromise<AssignEmailMessageEntityResponseClass> {
405
+ return localVarFp.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options).then((request) => request(axios, basePath));
406
+ },
407
+ /**
408
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
409
+ * @summary Download the email message attachment
323
410
  * @param {string} code
324
411
  * @param {number} attachmentId
325
412
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -330,7 +417,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
330
417
  return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
331
418
  },
332
419
  /**
333
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
420
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
421
+ * @summary Retrieve the email message
334
422
  * @param {string} code
335
423
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
336
424
  * @param {*} [options] Override http request option.
@@ -340,7 +428,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
340
428
  return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
341
429
  },
342
430
  /**
343
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
431
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
432
+ * @summary List the email message attachments
344
433
  * @param {string} code
345
434
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
346
435
  * @param {*} [options] Override http request option.
@@ -350,7 +439,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
350
439
  return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
351
440
  },
352
441
  /**
353
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
442
+ * Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
354
443
  * @summary List email messages
355
444
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
356
445
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -369,6 +458,34 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
369
458
  };
370
459
  };
371
460
 
461
+ /**
462
+ * Request parameters for assignEntity operation in EmailMessagesApi.
463
+ * @export
464
+ * @interface EmailMessagesApiAssignEntityRequest
465
+ */
466
+ export interface EmailMessagesApiAssignEntityRequest {
467
+ /**
468
+ *
469
+ * @type {string}
470
+ * @memberof EmailMessagesApiAssignEntity
471
+ */
472
+ readonly code: string
473
+
474
+ /**
475
+ *
476
+ * @type {AssignEmailMessageEntityBodyDto}
477
+ * @memberof EmailMessagesApiAssignEntity
478
+ */
479
+ readonly assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto
480
+
481
+ /**
482
+ * Bearer Token: provided by the login endpoint under the name accessToken.
483
+ * @type {string}
484
+ * @memberof EmailMessagesApiAssignEntity
485
+ */
486
+ readonly authorization?: string
487
+ }
488
+
372
489
  /**
373
490
  * Request parameters for downloadAttachment operation in EmailMessagesApi.
374
491
  * @export
@@ -510,7 +627,20 @@ export interface EmailMessagesApiListEmailMessagesRequest {
510
627
  */
511
628
  export class EmailMessagesApi extends BaseAPI {
512
629
  /**
513
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
630
+ * Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
631
+ * @summary Assign an email message to an entity
632
+ * @param {EmailMessagesApiAssignEntityRequest} requestParameters Request parameters.
633
+ * @param {*} [options] Override http request option.
634
+ * @throws {RequiredError}
635
+ * @memberof EmailMessagesApi
636
+ */
637
+ public assignEntity(requestParameters: EmailMessagesApiAssignEntityRequest, options?: AxiosRequestConfig) {
638
+ return EmailMessagesApiFp(this.configuration).assignEntity(requestParameters.code, requestParameters.assignEmailMessageEntityBodyDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
639
+ }
640
+
641
+ /**
642
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
643
+ * @summary Download the email message attachment
514
644
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
515
645
  * @param {*} [options] Override http request option.
516
646
  * @throws {RequiredError}
@@ -521,7 +651,8 @@ export class EmailMessagesApi extends BaseAPI {
521
651
  }
522
652
 
523
653
  /**
524
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
654
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
655
+ * @summary Retrieve the email message
525
656
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
526
657
  * @param {*} [options] Override http request option.
527
658
  * @throws {RequiredError}
@@ -532,7 +663,8 @@ export class EmailMessagesApi extends BaseAPI {
532
663
  }
533
664
 
534
665
  /**
535
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
666
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
667
+ * @summary List the email message attachments
536
668
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
537
669
  * @param {*} [options] Override http request option.
538
670
  * @throws {RequiredError}
@@ -543,7 +675,7 @@ export class EmailMessagesApi extends BaseAPI {
543
675
  }
544
676
 
545
677
  /**
546
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
678
+ * Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
547
679
  * @summary List email messages
548
680
  * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
549
681
  * @param {*} [options] Override http request option.
@@ -33,7 +33,8 @@ import { ListEmailThreadsResponseClass } from '../models';
33
33
  export const EmailTrackingApiAxiosParamCreator = function (configuration?: Configuration) {
34
34
  return {
35
35
  /**
36
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
36
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
37
+ * @summary Close the email thread
37
38
  * @param {string} code
38
39
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
39
40
  * @param {*} [options] Override http request option.
@@ -77,7 +78,8 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
77
78
  };
78
79
  },
79
80
  /**
80
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
81
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
82
+ * @summary Retrieve the email thread
81
83
  * @param {string} code
82
84
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
83
85
  * @param {*} [options] Override http request option.
@@ -121,7 +123,7 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
121
123
  };
122
124
  },
123
125
  /**
124
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
126
+ * Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
125
127
  * @summary List email messages
126
128
  * @param {string} code
127
129
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -186,7 +188,7 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
186
188
  };
187
189
  },
188
190
  /**
189
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
191
+ * Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
190
192
  * @summary List email threads
191
193
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
192
194
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -272,7 +274,8 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
272
274
  const localVarAxiosParamCreator = EmailTrackingApiAxiosParamCreator(configuration)
273
275
  return {
274
276
  /**
275
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
277
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
278
+ * @summary Close the email thread
276
279
  * @param {string} code
277
280
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
278
281
  * @param {*} [options] Override http request option.
@@ -283,7 +286,8 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
283
286
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
284
287
  },
285
288
  /**
286
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
289
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
290
+ * @summary Retrieve the email thread
287
291
  * @param {string} code
288
292
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
289
293
  * @param {*} [options] Override http request option.
@@ -294,7 +298,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
294
298
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
295
299
  },
296
300
  /**
297
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
301
+ * Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
298
302
  * @summary List email messages
299
303
  * @param {string} code
300
304
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -310,7 +314,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
310
314
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
311
315
  },
312
316
  /**
313
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
317
+ * Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
314
318
  * @summary List email threads
315
319
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
316
320
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -338,7 +342,8 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
338
342
  const localVarFp = EmailTrackingApiFp(configuration)
339
343
  return {
340
344
  /**
341
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
345
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
346
+ * @summary Close the email thread
342
347
  * @param {string} code
343
348
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
344
349
  * @param {*} [options] Override http request option.
@@ -348,7 +353,8 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
348
353
  return localVarFp.closeThread(code, authorization, options).then((request) => request(axios, basePath));
349
354
  },
350
355
  /**
351
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
356
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
357
+ * @summary Retrieve the email thread
352
358
  * @param {string} code
353
359
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
354
360
  * @param {*} [options] Override http request option.
@@ -358,7 +364,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
358
364
  return localVarFp.getThread(code, authorization, options).then((request) => request(axios, basePath));
359
365
  },
360
366
  /**
361
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
367
+ * Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
362
368
  * @summary List email messages
363
369
  * @param {string} code
364
370
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -373,7 +379,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
373
379
  return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
374
380
  },
375
381
  /**
376
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
382
+ * Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
377
383
  * @summary List email threads
378
384
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
379
385
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -554,7 +560,8 @@ export interface EmailTrackingApiListThreadsRequest {
554
560
  */
555
561
  export class EmailTrackingApi extends BaseAPI {
556
562
  /**
557
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
563
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
564
+ * @summary Close the email thread
558
565
  * @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
559
566
  * @param {*} [options] Override http request option.
560
567
  * @throws {RequiredError}
@@ -565,7 +572,8 @@ export class EmailTrackingApi extends BaseAPI {
565
572
  }
566
573
 
567
574
  /**
568
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
575
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
576
+ * @summary Retrieve the email thread
569
577
  * @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
570
578
  * @param {*} [options] Override http request option.
571
579
  * @throws {RequiredError}
@@ -576,7 +584,7 @@ export class EmailTrackingApi extends BaseAPI {
576
584
  }
577
585
 
578
586
  /**
579
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
587
+ * Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
580
588
  * @summary List email messages
581
589
  * @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
582
590
  * @param {*} [options] Override http request option.
@@ -588,7 +596,7 @@ export class EmailTrackingApi extends BaseAPI {
588
596
  }
589
597
 
590
598
  /**
591
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
599
+ * Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
592
600
  * @summary List email threads
593
601
  * @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
594
602
  * @param {*} [options] Override http request option.
@@ -35,7 +35,8 @@ import { InitiateEmailVerificationResponseClass } from '../models';
35
35
  export const EmailVerificationsApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- * undefined **Required Permissions** none
38
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
39
+ * @summary Complete an email verification
39
40
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
40
41
  * @param {string} [authorization] Bearer Token
41
42
  * @param {*} [options] Override http request option.
@@ -81,7 +82,8 @@ export const EmailVerificationsApiAxiosParamCreator = function (configuration?:
81
82
  };
82
83
  },
83
84
  /**
84
- * undefined **Required Permissions** none
85
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
86
+ * @summary Initiate an email verification
85
87
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
86
88
  * @param {string} [authorization] Bearer Token
87
89
  * @param {*} [options] Override http request option.
@@ -137,7 +139,8 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
137
139
  const localVarAxiosParamCreator = EmailVerificationsApiAxiosParamCreator(configuration)
138
140
  return {
139
141
  /**
140
- * undefined **Required Permissions** none
142
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
143
+ * @summary Complete an email verification
141
144
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
142
145
  * @param {string} [authorization] Bearer Token
143
146
  * @param {*} [options] Override http request option.
@@ -148,7 +151,8 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
148
151
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
149
152
  },
150
153
  /**
151
- * undefined **Required Permissions** none
154
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
155
+ * @summary Initiate an email verification
152
156
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
153
157
  * @param {string} [authorization] Bearer Token
154
158
  * @param {*} [options] Override http request option.
@@ -169,7 +173,8 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
169
173
  const localVarFp = EmailVerificationsApiFp(configuration)
170
174
  return {
171
175
  /**
172
- * undefined **Required Permissions** none
176
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
177
+ * @summary Complete an email verification
173
178
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
174
179
  * @param {string} [authorization] Bearer Token
175
180
  * @param {*} [options] Override http request option.
@@ -179,7 +184,8 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
179
184
  return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then((request) => request(axios, basePath));
180
185
  },
181
186
  /**
182
- * undefined **Required Permissions** none
187
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
188
+ * @summary Initiate an email verification
183
189
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
184
190
  * @param {string} [authorization] Bearer Token
185
191
  * @param {*} [options] Override http request option.
@@ -241,7 +247,8 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
241
247
  */
242
248
  export class EmailVerificationsApi extends BaseAPI {
243
249
  /**
244
- * undefined **Required Permissions** none
250
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
251
+ * @summary Complete an email verification
245
252
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
246
253
  * @param {*} [options] Override http request option.
247
254
  * @throws {RequiredError}
@@ -252,7 +259,8 @@ export class EmailVerificationsApi extends BaseAPI {
252
259
  }
253
260
 
254
261
  /**
255
- * undefined **Required Permissions** none
262
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
263
+ * @summary Initiate an email verification
256
264
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
257
265
  * @param {*} [options] Override http request option.
258
266
  * @throws {RequiredError}