@emilgroup/notification-sdk 0.8.1-beta.26 → 0.8.1-beta.28

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.
@@ -22,7 +22,8 @@ import { ListEmailMessagesResponseClass } from '../models';
22
22
  */
23
23
  export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configuration) => {
24
24
  /**
25
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
25
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
26
+ * @summary Download the email message attachment
26
27
  * @param {string} code
27
28
  * @param {number} attachmentId
28
29
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -31,7 +32,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
31
32
  */
32
33
  downloadAttachment: (code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
34
  /**
34
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
35
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
36
+ * @summary Retrieve the email message
35
37
  * @param {string} code
36
38
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
37
39
  * @param {*} [options] Override http request option.
@@ -39,7 +41,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
39
41
  */
40
42
  getMessage: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
43
  /**
42
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
44
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
45
+ * @summary List the email message attachments
43
46
  * @param {string} code
44
47
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
45
48
  * @param {*} [options] Override http request option.
@@ -47,7 +50,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
47
50
  */
48
51
  listAttachments: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
49
52
  /**
50
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
53
+ * 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\"
51
54
  * @summary List email messages
52
55
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
53
56
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -68,7 +71,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
68
71
  */
69
72
  export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
70
73
  /**
71
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
74
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
75
+ * @summary Download the email message attachment
72
76
  * @param {string} code
73
77
  * @param {number} attachmentId
74
78
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -77,7 +81,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
77
81
  */
78
82
  downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadAttachmentResponseClass>>;
79
83
  /**
80
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
84
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
85
+ * @summary Retrieve the email message
81
86
  * @param {string} code
82
87
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
83
88
  * @param {*} [options] Override http request option.
@@ -85,7 +90,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
85
90
  */
86
91
  getMessage(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailMessageResponseClass>>;
87
92
  /**
88
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
93
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
94
+ * @summary List the email message attachments
89
95
  * @param {string} code
90
96
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
91
97
  * @param {*} [options] Override http request option.
@@ -93,7 +99,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
93
99
  */
94
100
  listAttachments(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailAttachmentsResponseClass>>;
95
101
  /**
96
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
102
+ * 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\"
97
103
  * @summary List email messages
98
104
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
99
105
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -114,7 +120,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
114
120
  */
115
121
  export declare const EmailMessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
116
122
  /**
117
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
123
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
124
+ * @summary Download the email message attachment
118
125
  * @param {string} code
119
126
  * @param {number} attachmentId
120
127
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -123,7 +130,8 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
123
130
  */
124
131
  downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: any): AxiosPromise<DownloadAttachmentResponseClass>;
125
132
  /**
126
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
133
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
134
+ * @summary Retrieve the email message
127
135
  * @param {string} code
128
136
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
129
137
  * @param {*} [options] Override http request option.
@@ -131,7 +139,8 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
131
139
  */
132
140
  getMessage(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailMessageResponseClass>;
133
141
  /**
134
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
142
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
143
+ * @summary List the email message attachments
135
144
  * @param {string} code
136
145
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
137
146
  * @param {*} [options] Override http request option.
@@ -139,7 +148,7 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
139
148
  */
140
149
  listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass>;
141
150
  /**
142
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
151
+ * 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\"
143
152
  * @summary List email messages
144
153
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
145
154
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -280,7 +289,8 @@ export interface EmailMessagesApiListEmailMessagesRequest {
280
289
  */
281
290
  export declare class EmailMessagesApi extends BaseAPI {
282
291
  /**
283
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
292
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
293
+ * @summary Download the email message attachment
284
294
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
285
295
  * @param {*} [options] Override http request option.
286
296
  * @throws {RequiredError}
@@ -288,7 +298,8 @@ export declare class EmailMessagesApi extends BaseAPI {
288
298
  */
289
299
  downloadAttachment(requestParameters: EmailMessagesApiDownloadAttachmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadAttachmentResponseClass, any, {}>>;
290
300
  /**
291
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
301
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
302
+ * @summary Retrieve the email message
292
303
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
293
304
  * @param {*} [options] Override http request option.
294
305
  * @throws {RequiredError}
@@ -296,7 +307,8 @@ export declare class EmailMessagesApi extends BaseAPI {
296
307
  */
297
308
  getMessage(requestParameters: EmailMessagesApiGetMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailMessageResponseClass, any, {}>>;
298
309
  /**
299
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
310
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
311
+ * @summary List the email message attachments
300
312
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
301
313
  * @param {*} [options] Override http request option.
302
314
  * @throws {RequiredError}
@@ -304,7 +316,7 @@ export declare class EmailMessagesApi extends BaseAPI {
304
316
  */
305
317
  listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailAttachmentsResponseClass, any, {}>>;
306
318
  /**
307
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
319
+ * 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\"
308
320
  * @summary List email messages
309
321
  * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
310
322
  * @param {*} [options] Override http request option.
@@ -93,7 +93,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
96
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
97
+ * @summary Download the email message attachment
97
98
  * @param {string} code
98
99
  * @param {number} attachmentId
99
100
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -144,7 +145,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
144
145
  });
145
146
  },
146
147
  /**
147
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
148
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
149
+ * @summary Retrieve the email message
148
150
  * @param {string} code
149
151
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
150
152
  * @param {*} [options] Override http request option.
@@ -191,7 +193,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
191
193
  });
192
194
  },
193
195
  /**
194
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
196
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
197
+ * @summary List the email message attachments
195
198
  * @param {string} code
196
199
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
197
200
  * @param {*} [options] Override http request option.
@@ -238,7 +241,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
238
241
  });
239
242
  },
240
243
  /**
241
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
244
+ * 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\"
242
245
  * @summary List email messages
243
246
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
244
247
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -320,7 +323,8 @@ var EmailMessagesApiFp = function (configuration) {
320
323
  var localVarAxiosParamCreator = (0, exports.EmailMessagesApiAxiosParamCreator)(configuration);
321
324
  return {
322
325
  /**
323
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
326
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
327
+ * @summary Download the email message attachment
324
328
  * @param {string} code
325
329
  * @param {number} attachmentId
326
330
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -341,7 +345,8 @@ var EmailMessagesApiFp = function (configuration) {
341
345
  });
342
346
  },
343
347
  /**
344
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
348
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
349
+ * @summary Retrieve the email message
345
350
  * @param {string} code
346
351
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
347
352
  * @param {*} [options] Override http request option.
@@ -361,7 +366,8 @@ var EmailMessagesApiFp = function (configuration) {
361
366
  });
362
367
  },
363
368
  /**
364
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
369
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
370
+ * @summary List the email message attachments
365
371
  * @param {string} code
366
372
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
367
373
  * @param {*} [options] Override http request option.
@@ -381,7 +387,7 @@ var EmailMessagesApiFp = function (configuration) {
381
387
  });
382
388
  },
383
389
  /**
384
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
390
+ * 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\"
385
391
  * @summary List email messages
386
392
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
387
393
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -418,7 +424,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
418
424
  var localVarFp = (0, exports.EmailMessagesApiFp)(configuration);
419
425
  return {
420
426
  /**
421
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
427
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
428
+ * @summary Download the email message attachment
422
429
  * @param {string} code
423
430
  * @param {number} attachmentId
424
431
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -429,7 +436,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
429
436
  return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then(function (request) { return request(axios, basePath); });
430
437
  },
431
438
  /**
432
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
439
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
440
+ * @summary Retrieve the email message
433
441
  * @param {string} code
434
442
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
435
443
  * @param {*} [options] Override http request option.
@@ -439,7 +447,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
439
447
  return localVarFp.getMessage(code, authorization, options).then(function (request) { return request(axios, basePath); });
440
448
  },
441
449
  /**
442
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
450
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
451
+ * @summary List the email message attachments
443
452
  * @param {string} code
444
453
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
445
454
  * @param {*} [options] Override http request option.
@@ -449,7 +458,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
449
458
  return localVarFp.listAttachments(code, authorization, options).then(function (request) { return request(axios, basePath); });
450
459
  },
451
460
  /**
452
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
461
+ * 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\"
453
462
  * @summary List email messages
454
463
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
455
464
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -480,7 +489,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
480
489
  return _super !== null && _super.apply(this, arguments) || this;
481
490
  }
482
491
  /**
483
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
492
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
493
+ * @summary Download the email message attachment
484
494
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
485
495
  * @param {*} [options] Override http request option.
486
496
  * @throws {RequiredError}
@@ -491,7 +501,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
491
501
  return (0, exports.EmailMessagesApiFp)(this.configuration).downloadAttachment(requestParameters.code, requestParameters.attachmentId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
492
502
  };
493
503
  /**
494
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
504
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
505
+ * @summary Retrieve the email message
495
506
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
496
507
  * @param {*} [options] Override http request option.
497
508
  * @throws {RequiredError}
@@ -502,7 +513,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
502
513
  return (0, exports.EmailMessagesApiFp)(this.configuration).getMessage(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
503
514
  };
504
515
  /**
505
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
516
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
517
+ * @summary List the email message attachments
506
518
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
507
519
  * @param {*} [options] Override http request option.
508
520
  * @throws {RequiredError}
@@ -513,7 +525,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
513
525
  return (0, exports.EmailMessagesApiFp)(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
514
526
  };
515
527
  /**
516
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
528
+ * 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\"
517
529
  * @summary List email messages
518
530
  * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
519
531
  * @param {*} [options] Override http request option.
@@ -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.