@emilgroup/notification-sdk 0.1.1-beta.17 → 0.1.1-beta.7

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.
@@ -93,7 +93,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
96
+ * undefined **Required Permissions** none
97
97
  * @param {string} code
98
98
  * @param {number} attachmentId
99
99
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -144,7 +144,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
144
144
  });
145
145
  },
146
146
  /**
147
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
147
+ * undefined **Required Permissions** none
148
148
  * @param {string} code
149
149
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
150
150
  * @param {*} [options] Override http request option.
@@ -191,7 +191,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
191
191
  });
192
192
  },
193
193
  /**
194
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
194
+ * undefined **Required Permissions** none
195
195
  * @param {string} code
196
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
197
197
  * @param {*} [options] Override http request option.
@@ -237,78 +237,6 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
237
237
  });
238
238
  });
239
239
  },
240
- /**
241
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
242
- * @summary List email messages
243
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
244
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
245
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
246
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
247
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
248
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
249
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
250
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
251
- * @param {*} [options] Override http request option.
252
- * @throws {RequiredError}
253
- */
254
- listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
255
- if (options === void 0) { options = {}; }
256
- return __awaiter(_this, void 0, void 0, function () {
257
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
258
- return __generator(this, function (_a) {
259
- switch (_a.label) {
260
- case 0:
261
- localVarPath = "/notificationservice/v1/email-messages";
262
- localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
263
- if (configuration) {
264
- baseOptions = configuration.baseOptions;
265
- baseAccessToken = configuration.accessToken;
266
- }
267
- localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
268
- localVarHeaderParameter = {};
269
- localVarQueryParameter = {};
270
- // authentication bearer required
271
- // http bearer authentication required
272
- return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
273
- case 1:
274
- // authentication bearer required
275
- // http bearer authentication required
276
- _a.sent();
277
- if (pageSize !== undefined) {
278
- localVarQueryParameter['pageSize'] = pageSize;
279
- }
280
- if (pageToken !== undefined) {
281
- localVarQueryParameter['pageToken'] = pageToken;
282
- }
283
- if (filter !== undefined) {
284
- localVarQueryParameter['filter'] = filter;
285
- }
286
- if (search !== undefined) {
287
- localVarQueryParameter['search'] = search;
288
- }
289
- if (order !== undefined) {
290
- localVarQueryParameter['order'] = order;
291
- }
292
- if (expand !== undefined) {
293
- localVarQueryParameter['expand'] = expand;
294
- }
295
- if (filters !== undefined) {
296
- localVarQueryParameter['filters'] = filters;
297
- }
298
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
299
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
300
- }
301
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
302
- headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
303
- localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
304
- return [2 /*return*/, {
305
- url: (0, common_1.toPathString)(localVarUrlObj),
306
- options: localVarRequestOptions,
307
- }];
308
- }
309
- });
310
- });
311
- },
312
240
  };
313
241
  };
314
242
  exports.EmailMessagesApiAxiosParamCreator = EmailMessagesApiAxiosParamCreator;
@@ -320,7 +248,7 @@ var EmailMessagesApiFp = function (configuration) {
320
248
  var localVarAxiosParamCreator = (0, exports.EmailMessagesApiAxiosParamCreator)(configuration);
321
249
  return {
322
250
  /**
323
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
251
+ * undefined **Required Permissions** none
324
252
  * @param {string} code
325
253
  * @param {number} attachmentId
326
254
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -341,7 +269,7 @@ var EmailMessagesApiFp = function (configuration) {
341
269
  });
342
270
  },
343
271
  /**
344
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
272
+ * undefined **Required Permissions** none
345
273
  * @param {string} code
346
274
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
347
275
  * @param {*} [options] Override http request option.
@@ -361,7 +289,7 @@ var EmailMessagesApiFp = function (configuration) {
361
289
  });
362
290
  },
363
291
  /**
364
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
292
+ * undefined **Required Permissions** none
365
293
  * @param {string} code
366
294
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
367
295
  * @param {*} [options] Override http request option.
@@ -380,33 +308,6 @@ var EmailMessagesApiFp = function (configuration) {
380
308
  });
381
309
  });
382
310
  },
383
- /**
384
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
385
- * @summary List email messages
386
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
387
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
388
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
389
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
390
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
391
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
392
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
393
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
394
- * @param {*} [options] Override http request option.
395
- * @throws {RequiredError}
396
- */
397
- listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
398
- return __awaiter(this, void 0, void 0, function () {
399
- var localVarAxiosArgs;
400
- return __generator(this, function (_a) {
401
- switch (_a.label) {
402
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
403
- case 1:
404
- localVarAxiosArgs = _a.sent();
405
- return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
406
- }
407
- });
408
- });
409
- },
410
311
  };
411
312
  };
412
313
  exports.EmailMessagesApiFp = EmailMessagesApiFp;
@@ -418,7 +319,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
418
319
  var localVarFp = (0, exports.EmailMessagesApiFp)(configuration);
419
320
  return {
420
321
  /**
421
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
322
+ * undefined **Required Permissions** none
422
323
  * @param {string} code
423
324
  * @param {number} attachmentId
424
325
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -429,7 +330,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
429
330
  return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then(function (request) { return request(axios, basePath); });
430
331
  },
431
332
  /**
432
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
333
+ * undefined **Required Permissions** none
433
334
  * @param {string} code
434
335
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
435
336
  * @param {*} [options] Override http request option.
@@ -439,7 +340,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
439
340
  return localVarFp.getMessage(code, authorization, options).then(function (request) { return request(axios, basePath); });
440
341
  },
441
342
  /**
442
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
343
+ * undefined **Required Permissions** none
443
344
  * @param {string} code
444
345
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
445
346
  * @param {*} [options] Override http request option.
@@ -448,23 +349,6 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
448
349
  listAttachments: function (code, authorization, options) {
449
350
  return localVarFp.listAttachments(code, authorization, options).then(function (request) { return request(axios, basePath); });
450
351
  },
451
- /**
452
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
453
- * @summary List email messages
454
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
455
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
456
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
457
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
458
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
459
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
460
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
461
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
462
- * @param {*} [options] Override http request option.
463
- * @throws {RequiredError}
464
- */
465
- listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
466
- return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
467
- },
468
352
  };
469
353
  };
470
354
  exports.EmailMessagesApiFactory = EmailMessagesApiFactory;
@@ -480,7 +364,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
480
364
  return _super !== null && _super.apply(this, arguments) || this;
481
365
  }
482
366
  /**
483
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
367
+ * undefined **Required Permissions** none
484
368
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
485
369
  * @param {*} [options] Override http request option.
486
370
  * @throws {RequiredError}
@@ -491,7 +375,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
491
375
  return (0, exports.EmailMessagesApiFp)(this.configuration).downloadAttachment(requestParameters.code, requestParameters.attachmentId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
492
376
  };
493
377
  /**
494
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
378
+ * undefined **Required Permissions** none
495
379
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
496
380
  * @param {*} [options] Override http request option.
497
381
  * @throws {RequiredError}
@@ -502,7 +386,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
502
386
  return (0, exports.EmailMessagesApiFp)(this.configuration).getMessage(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
503
387
  };
504
388
  /**
505
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
389
+ * undefined **Required Permissions** none
506
390
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
507
391
  * @param {*} [options] Override http request option.
508
392
  * @throws {RequiredError}
@@ -512,19 +396,6 @@ var EmailMessagesApi = /** @class */ (function (_super) {
512
396
  var _this = this;
513
397
  return (0, exports.EmailMessagesApiFp)(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
514
398
  };
515
- /**
516
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
517
- * @summary List email messages
518
- * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
519
- * @param {*} [options] Override http request option.
520
- * @throws {RequiredError}
521
- * @memberof EmailMessagesApi
522
- */
523
- EmailMessagesApi.prototype.listEmailMessages = function (requestParameters, options) {
524
- var _this = this;
525
- if (requestParameters === void 0) { requestParameters = {}; }
526
- return (0, exports.EmailMessagesApiFp)(this.configuration).listEmailMessages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
527
- };
528
399
  return EmailMessagesApi;
529
400
  }(base_1.BaseAPI));
530
401
  exports.EmailMessagesApi = EmailMessagesApi;
@@ -21,7 +21,7 @@ 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
+ * undefined **Required Permissions** none
25
25
  * @param {string} code
26
26
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
27
27
  * @param {*} [options] Override http request option.
@@ -29,7 +29,7 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
29
29
  */
30
30
  closeThread: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
31
  /**
32
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
32
+ * undefined **Required Permissions** none
33
33
  * @param {string} code
34
34
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
35
35
  * @param {*} [options] Override http request option.
@@ -37,29 +37,23 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
37
37
  */
38
38
  getThread: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39
39
  /**
40
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
41
- * @summary List email messages
40
+ * undefined **Required Permissions** none
42
41
  * @param {string} code
43
42
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
44
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
45
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
46
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
47
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
48
43
  * @param {*} [options] Override http request option.
49
44
  * @throws {RequiredError}
50
45
  */
51
- listMessages: (code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
+ listMessages: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
47
  /**
53
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
54
- * @summary List email threads
48
+ * undefined **Required Permissions** none
55
49
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
56
50
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
57
51
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
58
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
52
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
59
53
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
60
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt&lt;/i&gt;
61
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: messages&lt;i&gt;
62
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
54
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
55
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
56
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
63
57
  * @param {*} [options] Override http request option.
64
58
  * @throws {RequiredError}
65
59
  */
@@ -71,7 +65,7 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
71
65
  */
72
66
  export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
73
67
  /**
74
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
68
+ * undefined **Required Permissions** none
75
69
  * @param {string} code
76
70
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
77
71
  * @param {*} [options] Override http request option.
@@ -79,7 +73,7 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
79
73
  */
80
74
  closeThread(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailThreadResponseClass>>;
81
75
  /**
82
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
76
+ * undefined **Required Permissions** none
83
77
  * @param {string} code
84
78
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
85
79
  * @param {*} [options] Override http request option.
@@ -87,29 +81,23 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
87
81
  */
88
82
  getThread(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailThreadResponseClass>>;
89
83
  /**
90
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
91
- * @summary List email messages
84
+ * undefined **Required Permissions** none
92
85
  * @param {string} code
93
86
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
94
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
95
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
96
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
97
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
98
87
  * @param {*} [options] Override http request option.
99
88
  * @throws {RequiredError}
100
89
  */
101
- listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
90
+ listMessages(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
102
91
  /**
103
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
104
- * @summary List email threads
92
+ * undefined **Required Permissions** none
105
93
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
106
94
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
107
95
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
108
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
96
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
109
97
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
110
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt&lt;/i&gt;
111
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: messages&lt;i&gt;
112
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
98
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
99
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
100
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
113
101
  * @param {*} [options] Override http request option.
114
102
  * @throws {RequiredError}
115
103
  */
@@ -121,7 +109,7 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
121
109
  */
122
110
  export declare const EmailTrackingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
123
111
  /**
124
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
112
+ * undefined **Required Permissions** none
125
113
  * @param {string} code
126
114
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
127
115
  * @param {*} [options] Override http request option.
@@ -129,7 +117,7 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
129
117
  */
130
118
  closeThread(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailThreadResponseClass>;
131
119
  /**
132
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
120
+ * undefined **Required Permissions** none
133
121
  * @param {string} code
134
122
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
135
123
  * @param {*} [options] Override http request option.
@@ -137,29 +125,23 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
137
125
  */
138
126
  getThread(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailThreadResponseClass>;
139
127
  /**
140
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
141
- * @summary List email messages
128
+ * undefined **Required Permissions** none
142
129
  * @param {string} code
143
130
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
144
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
145
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
146
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
147
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
148
131
  * @param {*} [options] Override http request option.
149
132
  * @throws {RequiredError}
150
133
  */
151
- listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
134
+ listMessages(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
152
135
  /**
153
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
154
- * @summary List email threads
136
+ * undefined **Required Permissions** none
155
137
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
156
138
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
157
139
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
158
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
140
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
159
141
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
160
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt&lt;/i&gt;
161
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: messages&lt;i&gt;
162
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
142
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
143
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
144
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
163
145
  * @param {*} [options] Override http request option.
164
146
  * @throws {RequiredError}
165
147
  */
@@ -221,30 +203,6 @@ export interface EmailTrackingApiListMessagesRequest {
221
203
  * @memberof EmailTrackingApiListMessages
222
204
  */
223
205
  readonly authorization?: string;
224
- /**
225
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
226
- * @type {string}
227
- * @memberof EmailTrackingApiListMessages
228
- */
229
- readonly filter?: string;
230
- /**
231
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
232
- * @type {string}
233
- * @memberof EmailTrackingApiListMessages
234
- */
235
- readonly filters?: string;
236
- /**
237
- * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
238
- * @type {string}
239
- * @memberof EmailTrackingApiListMessages
240
- */
241
- readonly order?: string;
242
- /**
243
- * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
244
- * @type {string}
245
- * @memberof EmailTrackingApiListMessages
246
- */
247
- readonly expand?: string;
248
206
  }
249
207
  /**
250
208
  * Request parameters for listThreads operation in EmailTrackingApi.
@@ -271,7 +229,7 @@ export interface EmailTrackingApiListThreadsRequest {
271
229
  */
272
230
  readonly pageToken?: string;
273
231
  /**
274
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
232
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
275
233
  * @type {string}
276
234
  * @memberof EmailTrackingApiListThreads
277
235
  */
@@ -283,19 +241,19 @@ export interface EmailTrackingApiListThreadsRequest {
283
241
  */
284
242
  readonly search?: string;
285
243
  /**
286
- * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt&lt;/i&gt;
244
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
287
245
  * @type {string}
288
246
  * @memberof EmailTrackingApiListThreads
289
247
  */
290
248
  readonly order?: string;
291
249
  /**
292
- * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: messages&lt;i&gt;
250
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
293
251
  * @type {string}
294
252
  * @memberof EmailTrackingApiListThreads
295
253
  */
296
254
  readonly expand?: string;
297
255
  /**
298
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
256
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
299
257
  * @type {string}
300
258
  * @memberof EmailTrackingApiListThreads
301
259
  */
@@ -309,7 +267,7 @@ export interface EmailTrackingApiListThreadsRequest {
309
267
  */
310
268
  export declare class EmailTrackingApi extends BaseAPI {
311
269
  /**
312
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
270
+ * undefined **Required Permissions** none
313
271
  * @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
314
272
  * @param {*} [options] Override http request option.
315
273
  * @throws {RequiredError}
@@ -317,7 +275,7 @@ export declare class EmailTrackingApi extends BaseAPI {
317
275
  */
318
276
  closeThread(requestParameters: EmailTrackingApiCloseThreadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailThreadResponseClass, any, {}>>;
319
277
  /**
320
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
278
+ * undefined **Required Permissions** none
321
279
  * @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
322
280
  * @param {*} [options] Override http request option.
323
281
  * @throws {RequiredError}
@@ -325,8 +283,7 @@ export declare class EmailTrackingApi extends BaseAPI {
325
283
  */
326
284
  getThread(requestParameters: EmailTrackingApiGetThreadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailThreadResponseClass, any, {}>>;
327
285
  /**
328
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
329
- * @summary List email messages
286
+ * undefined **Required Permissions** none
330
287
  * @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
331
288
  * @param {*} [options] Override http request option.
332
289
  * @throws {RequiredError}
@@ -334,8 +291,7 @@ export declare class EmailTrackingApi extends BaseAPI {
334
291
  */
335
292
  listMessages(requestParameters: EmailTrackingApiListMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
336
293
  /**
337
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
338
- * @summary List email threads
294
+ * undefined **Required Permissions** none
339
295
  * @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
340
296
  * @param {*} [options] Override http request option.
341
297
  * @throws {RequiredError}