@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
@@ -21,7 +21,8 @@ import { ListEmailThreadsResponseClass } from '../models';
21
21
  */
22
22
  export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configuration) => {
23
23
  /**
24
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
24
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
25
+ * @summary Close the email thread
25
26
  * @param {string} code
26
27
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
27
28
  * @param {*} [options] Override http request option.
@@ -29,7 +30,8 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
29
30
  */
30
31
  closeThread: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
32
  /**
32
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
33
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
34
+ * @summary Retrieve the email thread
33
35
  * @param {string} code
34
36
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
35
37
  * @param {*} [options] Override http request option.
@@ -37,7 +39,7 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
37
39
  */
38
40
  getThread: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39
41
  /**
40
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
42
+ * 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\"
41
43
  * @summary List email messages
42
44
  * @param {string} code
43
45
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -50,7 +52,7 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
50
52
  */
51
53
  listMessages: (code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
54
  /**
53
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
55
+ * 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\"
54
56
  * @summary List email threads
55
57
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
56
58
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -71,7 +73,8 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
71
73
  */
72
74
  export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
73
75
  /**
74
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
76
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
77
+ * @summary Close the email thread
75
78
  * @param {string} code
76
79
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
77
80
  * @param {*} [options] Override http request option.
@@ -79,7 +82,8 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
79
82
  */
80
83
  closeThread(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailThreadResponseClass>>;
81
84
  /**
82
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
85
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
86
+ * @summary Retrieve the email thread
83
87
  * @param {string} code
84
88
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
85
89
  * @param {*} [options] Override http request option.
@@ -87,7 +91,7 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
87
91
  */
88
92
  getThread(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailThreadResponseClass>>;
89
93
  /**
90
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
94
+ * 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\"
91
95
  * @summary List email messages
92
96
  * @param {string} code
93
97
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -100,7 +104,7 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
100
104
  */
101
105
  listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
102
106
  /**
103
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
107
+ * 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\"
104
108
  * @summary List email threads
105
109
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
106
110
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -121,7 +125,8 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
121
125
  */
122
126
  export declare const EmailTrackingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
123
127
  /**
124
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
128
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
129
+ * @summary Close the email thread
125
130
  * @param {string} code
126
131
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
127
132
  * @param {*} [options] Override http request option.
@@ -129,7 +134,8 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
129
134
  */
130
135
  closeThread(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailThreadResponseClass>;
131
136
  /**
132
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
137
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
138
+ * @summary Retrieve the email thread
133
139
  * @param {string} code
134
140
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
135
141
  * @param {*} [options] Override http request option.
@@ -137,7 +143,7 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
137
143
  */
138
144
  getThread(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailThreadResponseClass>;
139
145
  /**
140
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
146
+ * 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\"
141
147
  * @summary List email messages
142
148
  * @param {string} code
143
149
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -150,7 +156,7 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
150
156
  */
151
157
  listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
152
158
  /**
153
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
159
+ * 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\"
154
160
  * @summary List email threads
155
161
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
156
162
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -309,7 +315,8 @@ export interface EmailTrackingApiListThreadsRequest {
309
315
  */
310
316
  export declare class EmailTrackingApi extends BaseAPI {
311
317
  /**
312
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
318
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
319
+ * @summary Close the email thread
313
320
  * @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
314
321
  * @param {*} [options] Override http request option.
315
322
  * @throws {RequiredError}
@@ -317,7 +324,8 @@ export declare class EmailTrackingApi extends BaseAPI {
317
324
  */
318
325
  closeThread(requestParameters: EmailTrackingApiCloseThreadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailThreadResponseClass, any, {}>>;
319
326
  /**
320
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
327
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
328
+ * @summary Retrieve the email thread
321
329
  * @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
322
330
  * @param {*} [options] Override http request option.
323
331
  * @throws {RequiredError}
@@ -325,7 +333,7 @@ export declare class EmailTrackingApi extends BaseAPI {
325
333
  */
326
334
  getThread(requestParameters: EmailTrackingApiGetThreadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailThreadResponseClass, any, {}>>;
327
335
  /**
328
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
336
+ * 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\"
329
337
  * @summary List email messages
330
338
  * @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
331
339
  * @param {*} [options] Override http request option.
@@ -334,7 +342,7 @@ export declare class EmailTrackingApi extends BaseAPI {
334
342
  */
335
343
  listMessages(requestParameters: EmailTrackingApiListMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
336
344
  /**
337
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
345
+ * 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\"
338
346
  * @summary List email threads
339
347
  * @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
340
348
  * @param {*} [options] Override http request option.
@@ -93,7 +93,8 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
96
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
97
+ * @summary Close the email thread
97
98
  * @param {string} code
98
99
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
99
100
  * @param {*} [options] Override http request option.
@@ -140,7 +141,8 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
140
141
  });
141
142
  },
142
143
  /**
143
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
144
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
145
+ * @summary Retrieve the email thread
144
146
  * @param {string} code
145
147
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
146
148
  * @param {*} [options] Override http request option.
@@ -187,7 +189,7 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
187
189
  });
188
190
  },
189
191
  /**
190
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
192
+ * 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\"
191
193
  * @summary List email messages
192
194
  * @param {string} code
193
195
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -251,7 +253,7 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
251
253
  });
252
254
  },
253
255
  /**
254
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
256
+ * 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\"
255
257
  * @summary List email threads
256
258
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
257
259
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -333,7 +335,8 @@ var EmailTrackingApiFp = function (configuration) {
333
335
  var localVarAxiosParamCreator = (0, exports.EmailTrackingApiAxiosParamCreator)(configuration);
334
336
  return {
335
337
  /**
336
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
338
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
339
+ * @summary Close the email thread
337
340
  * @param {string} code
338
341
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
339
342
  * @param {*} [options] Override http request option.
@@ -353,7 +356,8 @@ var EmailTrackingApiFp = function (configuration) {
353
356
  });
354
357
  },
355
358
  /**
356
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
359
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
360
+ * @summary Retrieve the email thread
357
361
  * @param {string} code
358
362
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
359
363
  * @param {*} [options] Override http request option.
@@ -373,7 +377,7 @@ var EmailTrackingApiFp = function (configuration) {
373
377
  });
374
378
  },
375
379
  /**
376
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
380
+ * 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\"
377
381
  * @summary List email messages
378
382
  * @param {string} code
379
383
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -398,7 +402,7 @@ var EmailTrackingApiFp = function (configuration) {
398
402
  });
399
403
  },
400
404
  /**
401
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
405
+ * 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\"
402
406
  * @summary List email threads
403
407
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
404
408
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -435,7 +439,8 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
435
439
  var localVarFp = (0, exports.EmailTrackingApiFp)(configuration);
436
440
  return {
437
441
  /**
438
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
442
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
443
+ * @summary Close the email thread
439
444
  * @param {string} code
440
445
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
441
446
  * @param {*} [options] Override http request option.
@@ -445,7 +450,8 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
445
450
  return localVarFp.closeThread(code, authorization, options).then(function (request) { return request(axios, basePath); });
446
451
  },
447
452
  /**
448
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
453
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
454
+ * @summary Retrieve the email thread
449
455
  * @param {string} code
450
456
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
451
457
  * @param {*} [options] Override http request option.
@@ -455,7 +461,7 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
455
461
  return localVarFp.getThread(code, authorization, options).then(function (request) { return request(axios, basePath); });
456
462
  },
457
463
  /**
458
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
464
+ * 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\"
459
465
  * @summary List email messages
460
466
  * @param {string} code
461
467
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -470,7 +476,7 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
470
476
  return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then(function (request) { return request(axios, basePath); });
471
477
  },
472
478
  /**
473
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
479
+ * 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\"
474
480
  * @summary List email threads
475
481
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
476
482
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -501,7 +507,8 @@ var EmailTrackingApi = /** @class */ (function (_super) {
501
507
  return _super !== null && _super.apply(this, arguments) || this;
502
508
  }
503
509
  /**
504
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
510
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
511
+ * @summary Close the email thread
505
512
  * @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
506
513
  * @param {*} [options] Override http request option.
507
514
  * @throws {RequiredError}
@@ -512,7 +519,8 @@ var EmailTrackingApi = /** @class */ (function (_super) {
512
519
  return (0, exports.EmailTrackingApiFp)(this.configuration).closeThread(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
513
520
  };
514
521
  /**
515
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
522
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
523
+ * @summary Retrieve the email thread
516
524
  * @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
517
525
  * @param {*} [options] Override http request option.
518
526
  * @throws {RequiredError}
@@ -523,7 +531,7 @@ var EmailTrackingApi = /** @class */ (function (_super) {
523
531
  return (0, exports.EmailTrackingApiFp)(this.configuration).getThread(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
524
532
  };
525
533
  /**
526
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
534
+ * 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\"
527
535
  * @summary List email messages
528
536
  * @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
529
537
  * @param {*} [options] Override http request option.
@@ -535,7 +543,7 @@ var EmailTrackingApi = /** @class */ (function (_super) {
535
543
  return (0, exports.EmailTrackingApiFp)(this.configuration).listMessages(requestParameters.code, requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
536
544
  };
537
545
  /**
538
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
546
+ * 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\"
539
547
  * @summary List email threads
540
548
  * @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
541
549
  * @param {*} [options] Override http request option.
@@ -22,7 +22,8 @@ import { InitiateEmailVerificationResponseClass } from '../models';
22
22
  */
23
23
  export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Configuration) => {
24
24
  /**
25
- * undefined **Required Permissions** none
25
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
26
+ * @summary Complete an email verification
26
27
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
27
28
  * @param {string} [authorization] Bearer Token
28
29
  * @param {*} [options] Override http request option.
@@ -30,7 +31,8 @@ export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Co
30
31
  */
31
32
  completeEmailVerification: (completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
33
  /**
33
- * undefined **Required Permissions** none
34
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
35
+ * @summary Initiate an email verification
34
36
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
35
37
  * @param {string} [authorization] Bearer Token
36
38
  * @param {*} [options] Override http request option.
@@ -44,7 +46,8 @@ export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Co
44
46
  */
45
47
  export declare const EmailVerificationsApiFp: (configuration?: Configuration) => {
46
48
  /**
47
- * undefined **Required Permissions** none
49
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
50
+ * @summary Complete an email verification
48
51
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
49
52
  * @param {string} [authorization] Bearer Token
50
53
  * @param {*} [options] Override http request option.
@@ -52,7 +55,8 @@ export declare const EmailVerificationsApiFp: (configuration?: Configuration) =>
52
55
  */
53
56
  completeEmailVerification(completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompleteEmailVerificationResponseClass>>;
54
57
  /**
55
- * undefined **Required Permissions** none
58
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
59
+ * @summary Initiate an email verification
56
60
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
57
61
  * @param {string} [authorization] Bearer Token
58
62
  * @param {*} [options] Override http request option.
@@ -66,7 +70,8 @@ export declare const EmailVerificationsApiFp: (configuration?: Configuration) =>
66
70
  */
67
71
  export declare const EmailVerificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
68
72
  /**
69
- * undefined **Required Permissions** none
73
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
74
+ * @summary Complete an email verification
70
75
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
71
76
  * @param {string} [authorization] Bearer Token
72
77
  * @param {*} [options] Override http request option.
@@ -74,7 +79,8 @@ export declare const EmailVerificationsApiFactory: (configuration?: Configuratio
74
79
  */
75
80
  completeEmailVerification(completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: any): AxiosPromise<CompleteEmailVerificationResponseClass>;
76
81
  /**
77
- * undefined **Required Permissions** none
82
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
83
+ * @summary Initiate an email verification
78
84
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
79
85
  * @param {string} [authorization] Bearer Token
80
86
  * @param {*} [options] Override http request option.
@@ -128,7 +134,8 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
128
134
  */
129
135
  export declare class EmailVerificationsApi extends BaseAPI {
130
136
  /**
131
- * undefined **Required Permissions** none
137
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
138
+ * @summary Complete an email verification
132
139
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
133
140
  * @param {*} [options] Override http request option.
134
141
  * @throws {RequiredError}
@@ -136,7 +143,8 @@ export declare class EmailVerificationsApi extends BaseAPI {
136
143
  */
137
144
  completeEmailVerification(requestParameters: EmailVerificationsApiCompleteEmailVerificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompleteEmailVerificationResponseClass, any, {}>>;
138
145
  /**
139
- * undefined **Required Permissions** none
146
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
147
+ * @summary Initiate an email verification
140
148
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
141
149
  * @param {*} [options] Override http request option.
142
150
  * @throws {RequiredError}
@@ -93,7 +93,8 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** none
96
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
97
+ * @summary Complete an email verification
97
98
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
98
99
  * @param {string} [authorization] Bearer Token
99
100
  * @param {*} [options] Override http request option.
@@ -141,7 +142,8 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
141
142
  });
142
143
  },
143
144
  /**
144
- * undefined **Required Permissions** none
145
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
146
+ * @summary Initiate an email verification
145
147
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
146
148
  * @param {string} [authorization] Bearer Token
147
149
  * @param {*} [options] Override http request option.
@@ -199,7 +201,8 @@ var EmailVerificationsApiFp = function (configuration) {
199
201
  var localVarAxiosParamCreator = (0, exports.EmailVerificationsApiAxiosParamCreator)(configuration);
200
202
  return {
201
203
  /**
202
- * undefined **Required Permissions** none
204
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
205
+ * @summary Complete an email verification
203
206
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
204
207
  * @param {string} [authorization] Bearer Token
205
208
  * @param {*} [options] Override http request option.
@@ -219,7 +222,8 @@ var EmailVerificationsApiFp = function (configuration) {
219
222
  });
220
223
  },
221
224
  /**
222
- * undefined **Required Permissions** none
225
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
226
+ * @summary Initiate an email verification
223
227
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
224
228
  * @param {string} [authorization] Bearer Token
225
229
  * @param {*} [options] Override http request option.
@@ -249,7 +253,8 @@ var EmailVerificationsApiFactory = function (configuration, basePath, axios) {
249
253
  var localVarFp = (0, exports.EmailVerificationsApiFp)(configuration);
250
254
  return {
251
255
  /**
252
- * undefined **Required Permissions** none
256
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
257
+ * @summary Complete an email verification
253
258
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
254
259
  * @param {string} [authorization] Bearer Token
255
260
  * @param {*} [options] Override http request option.
@@ -259,7 +264,8 @@ var EmailVerificationsApiFactory = function (configuration, basePath, axios) {
259
264
  return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then(function (request) { return request(axios, basePath); });
260
265
  },
261
266
  /**
262
- * undefined **Required Permissions** none
267
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
268
+ * @summary Initiate an email verification
263
269
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
264
270
  * @param {string} [authorization] Bearer Token
265
271
  * @param {*} [options] Override http request option.
@@ -283,7 +289,8 @@ var EmailVerificationsApi = /** @class */ (function (_super) {
283
289
  return _super !== null && _super.apply(this, arguments) || this;
284
290
  }
285
291
  /**
286
- * undefined **Required Permissions** none
292
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
293
+ * @summary Complete an email verification
287
294
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
288
295
  * @param {*} [options] Override http request option.
289
296
  * @throws {RequiredError}
@@ -294,7 +301,8 @@ var EmailVerificationsApi = /** @class */ (function (_super) {
294
301
  return (0, exports.EmailVerificationsApiFp)(this.configuration).completeEmailVerification(requestParameters.completeEmailVerificationDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
295
302
  };
296
303
  /**
297
- * undefined **Required Permissions** none
304
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
305
+ * @summary Initiate an email verification
298
306
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
299
307
  * @param {*} [options] Override http request option.
300
308
  * @throws {RequiredError}