@emilgroup/notification-sdk 0.1.1-beta.14 → 0.1.1-beta.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/notification-sdk@0.1.1-beta.14 --save
20
+ npm install @emilgroup/notification-sdk@0.1.1-beta.16 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/notification-sdk@0.1.1-beta.14
24
+ yarn add @emilgroup/notification-sdk@0.1.1-beta.16
25
25
  ```
26
26
 
27
27
  And then you can import ``.
@@ -35,7 +35,7 @@ import { ListEmailMessagesResponseClass } from '../models';
35
35
  export const EmailMessagesApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- * undefined **Required Permissions** none
38
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
39
39
  * @param {string} code
40
40
  * @param {number} attachmentId
41
41
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -83,7 +83,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
83
83
  };
84
84
  },
85
85
  /**
86
- * undefined **Required Permissions** none
86
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
87
87
  * @param {string} code
88
88
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
89
  * @param {*} [options] Override http request option.
@@ -127,7 +127,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
127
127
  };
128
128
  },
129
129
  /**
130
- * undefined **Required Permissions** none
130
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
131
131
  * @param {string} code
132
132
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
133
133
  * @param {*} [options] Override http request option.
@@ -171,15 +171,16 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
171
171
  };
172
172
  },
173
173
  /**
174
- * undefined **Required Permissions** none
174
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
175
+ * @summary List email messages
175
176
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
176
177
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
177
178
  * @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.
178
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
179
+ * @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>
179
180
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
180
- * @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.
181
- * @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.
182
- * @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.
181
+ * @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>
182
+ * @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>
183
+ * @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>
183
184
  * @param {*} [options] Override http request option.
184
185
  * @throws {RequiredError}
185
186
  */
@@ -256,7 +257,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
256
257
  const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
257
258
  return {
258
259
  /**
259
- * undefined **Required Permissions** none
260
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
260
261
  * @param {string} code
261
262
  * @param {number} attachmentId
262
263
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -268,7 +269,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
268
269
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
269
270
  },
270
271
  /**
271
- * undefined **Required Permissions** none
272
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
272
273
  * @param {string} code
273
274
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
274
275
  * @param {*} [options] Override http request option.
@@ -279,7 +280,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
279
280
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
280
281
  },
281
282
  /**
282
- * undefined **Required Permissions** none
283
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
283
284
  * @param {string} code
284
285
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
285
286
  * @param {*} [options] Override http request option.
@@ -290,15 +291,16 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
290
291
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
291
292
  },
292
293
  /**
293
- * undefined **Required Permissions** none
294
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
295
+ * @summary List email messages
294
296
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
295
297
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
296
298
  * @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.
297
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
299
+ * @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>
298
300
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
299
- * @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.
300
- * @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.
301
- * @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.
301
+ * @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>
302
+ * @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>
303
+ * @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>
302
304
  * @param {*} [options] Override http request option.
303
305
  * @throws {RequiredError}
304
306
  */
@@ -317,7 +319,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
317
319
  const localVarFp = EmailMessagesApiFp(configuration)
318
320
  return {
319
321
  /**
320
- * undefined **Required Permissions** none
322
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
321
323
  * @param {string} code
322
324
  * @param {number} attachmentId
323
325
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -328,7 +330,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
328
330
  return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
329
331
  },
330
332
  /**
331
- * undefined **Required Permissions** none
333
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
332
334
  * @param {string} code
333
335
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
334
336
  * @param {*} [options] Override http request option.
@@ -338,7 +340,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
338
340
  return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
339
341
  },
340
342
  /**
341
- * undefined **Required Permissions** none
343
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
342
344
  * @param {string} code
343
345
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
344
346
  * @param {*} [options] Override http request option.
@@ -348,15 +350,16 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
348
350
  return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
349
351
  },
350
352
  /**
351
- * undefined **Required Permissions** none
353
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
354
+ * @summary List email messages
352
355
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
353
356
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
354
357
  * @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.
355
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
358
+ * @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>
356
359
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
357
- * @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.
358
- * @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.
359
- * @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.
360
+ * @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>
361
+ * @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>
362
+ * @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>
360
363
  * @param {*} [options] Override http request option.
361
364
  * @throws {RequiredError}
362
365
  */
@@ -464,7 +467,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
464
467
  readonly pageToken?: string
465
468
 
466
469
  /**
467
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
470
+ * 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>
468
471
  * @type {string}
469
472
  * @memberof EmailMessagesApiListEmailMessages
470
473
  */
@@ -478,21 +481,21 @@ export interface EmailMessagesApiListEmailMessagesRequest {
478
481
  readonly search?: string
479
482
 
480
483
  /**
481
- * 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.
484
+ * 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>
482
485
  * @type {string}
483
486
  * @memberof EmailMessagesApiListEmailMessages
484
487
  */
485
488
  readonly order?: string
486
489
 
487
490
  /**
488
- * 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.
491
+ * 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>
489
492
  * @type {string}
490
493
  * @memberof EmailMessagesApiListEmailMessages
491
494
  */
492
495
  readonly expand?: string
493
496
 
494
497
  /**
495
- * 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.
498
+ * 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>
496
499
  * @type {string}
497
500
  * @memberof EmailMessagesApiListEmailMessages
498
501
  */
@@ -507,7 +510,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
507
510
  */
508
511
  export class EmailMessagesApi extends BaseAPI {
509
512
  /**
510
- * undefined **Required Permissions** none
513
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
511
514
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
512
515
  * @param {*} [options] Override http request option.
513
516
  * @throws {RequiredError}
@@ -518,7 +521,7 @@ export class EmailMessagesApi extends BaseAPI {
518
521
  }
519
522
 
520
523
  /**
521
- * undefined **Required Permissions** none
524
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
522
525
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
523
526
  * @param {*} [options] Override http request option.
524
527
  * @throws {RequiredError}
@@ -529,7 +532,7 @@ export class EmailMessagesApi extends BaseAPI {
529
532
  }
530
533
 
531
534
  /**
532
- * undefined **Required Permissions** none
535
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
533
536
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
534
537
  * @param {*} [options] Override http request option.
535
538
  * @throws {RequiredError}
@@ -540,7 +543,8 @@ export class EmailMessagesApi extends BaseAPI {
540
543
  }
541
544
 
542
545
  /**
543
- * undefined **Required Permissions** none
546
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
547
+ * @summary List email messages
544
548
  * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
545
549
  * @param {*} [options] Override http request option.
546
550
  * @throws {RequiredError}
@@ -33,7 +33,7 @@ import { ListEmailThreadsResponseClass } from '../models';
33
33
  export const EmailTrackingApiAxiosParamCreator = function (configuration?: Configuration) {
34
34
  return {
35
35
  /**
36
- * undefined **Required Permissions** none
36
+ * undefined **Required Permissions** \"notification-management.email-messages.update\"
37
37
  * @param {string} code
38
38
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
39
39
  * @param {*} [options] Override http request option.
@@ -77,7 +77,7 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
77
77
  };
78
78
  },
79
79
  /**
80
- * undefined **Required Permissions** none
80
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
81
81
  * @param {string} code
82
82
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
83
83
  * @param {*} [options] Override http request option.
@@ -121,13 +121,18 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
121
121
  };
122
122
  },
123
123
  /**
124
- * undefined **Required Permissions** none
124
+ * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
125
+ * @summary List email messages
125
126
  * @param {string} code
126
127
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
128
+ * @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>
129
+ * @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>
130
+ * @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>
131
+ * @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>
127
132
  * @param {*} [options] Override http request option.
128
133
  * @throws {RequiredError}
129
134
  */
130
- listMessages: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
135
+ listMessages: async (code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
131
136
  // verify required parameter 'code' is not null or undefined
132
137
  assertParamExists('listMessages', 'code', code)
133
138
  const localVarPath = `/notificationservice/v1/email-threads/{code}/messages`
@@ -149,6 +154,22 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
149
154
  // http bearer authentication required
150
155
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
151
156
 
157
+ if (filter !== undefined) {
158
+ localVarQueryParameter['filter'] = filter;
159
+ }
160
+
161
+ if (filters !== undefined) {
162
+ localVarQueryParameter['filters'] = filters;
163
+ }
164
+
165
+ if (order !== undefined) {
166
+ localVarQueryParameter['order'] = order;
167
+ }
168
+
169
+ if (expand !== undefined) {
170
+ localVarQueryParameter['expand'] = expand;
171
+ }
172
+
152
173
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
153
174
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
154
175
  }
@@ -165,15 +186,16 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
165
186
  };
166
187
  },
167
188
  /**
168
- * undefined **Required Permissions** none
189
+ * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
190
+ * @summary List email threads
169
191
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
170
192
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
171
193
  * @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.
172
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
194
+ * @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;
173
195
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
174
- * @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.
175
- * @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.
176
- * @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.
196
+ * @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;
197
+ * @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;
198
+ * @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;
177
199
  * @param {*} [options] Override http request option.
178
200
  * @throws {RequiredError}
179
201
  */
@@ -250,7 +272,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
250
272
  const localVarAxiosParamCreator = EmailTrackingApiAxiosParamCreator(configuration)
251
273
  return {
252
274
  /**
253
- * undefined **Required Permissions** none
275
+ * undefined **Required Permissions** \"notification-management.email-messages.update\"
254
276
  * @param {string} code
255
277
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
256
278
  * @param {*} [options] Override http request option.
@@ -261,7 +283,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
261
283
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
262
284
  },
263
285
  /**
264
- * undefined **Required Permissions** none
286
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
265
287
  * @param {string} code
266
288
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
267
289
  * @param {*} [options] Override http request option.
@@ -272,26 +294,32 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
272
294
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
273
295
  },
274
296
  /**
275
- * undefined **Required Permissions** none
297
+ * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
298
+ * @summary List email messages
276
299
  * @param {string} code
277
300
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
301
+ * @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;
302
+ * @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;
303
+ * @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;
304
+ * @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;
278
305
  * @param {*} [options] Override http request option.
279
306
  * @throws {RequiredError}
280
307
  */
281
- async listMessages(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>> {
282
- const localVarAxiosArgs = await localVarAxiosParamCreator.listMessages(code, authorization, options);
308
+ async listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>> {
309
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listMessages(code, authorization, filter, filters, order, expand, options);
283
310
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
284
311
  },
285
312
  /**
286
- * undefined **Required Permissions** none
313
+ * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
314
+ * @summary List email threads
287
315
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
288
316
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
289
317
  * @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.
290
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
318
+ * @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;
291
319
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
292
- * @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.
293
- * @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.
294
- * @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.
320
+ * @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;
321
+ * @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;
322
+ * @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;
295
323
  * @param {*} [options] Override http request option.
296
324
  * @throws {RequiredError}
297
325
  */
@@ -310,7 +338,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
310
338
  const localVarFp = EmailTrackingApiFp(configuration)
311
339
  return {
312
340
  /**
313
- * undefined **Required Permissions** none
341
+ * undefined **Required Permissions** \"notification-management.email-messages.update\"
314
342
  * @param {string} code
315
343
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
316
344
  * @param {*} [options] Override http request option.
@@ -320,7 +348,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
320
348
  return localVarFp.closeThread(code, authorization, options).then((request) => request(axios, basePath));
321
349
  },
322
350
  /**
323
- * undefined **Required Permissions** none
351
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
324
352
  * @param {string} code
325
353
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
326
354
  * @param {*} [options] Override http request option.
@@ -330,25 +358,31 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
330
358
  return localVarFp.getThread(code, authorization, options).then((request) => request(axios, basePath));
331
359
  },
332
360
  /**
333
- * undefined **Required Permissions** none
361
+ * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
362
+ * @summary List email messages
334
363
  * @param {string} code
335
364
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
365
+ * @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;
366
+ * @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;
367
+ * @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;
368
+ * @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;
336
369
  * @param {*} [options] Override http request option.
337
370
  * @throws {RequiredError}
338
371
  */
339
- listMessages(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
340
- return localVarFp.listMessages(code, authorization, options).then((request) => request(axios, basePath));
372
+ listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
373
+ return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
341
374
  },
342
375
  /**
343
- * undefined **Required Permissions** none
376
+ * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
377
+ * @summary List email threads
344
378
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
345
379
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
346
380
  * @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.
347
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
381
+ * @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;
348
382
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
349
- * @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.
350
- * @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.
351
- * @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.
383
+ * @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;
384
+ * @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;
385
+ * @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;
352
386
  * @param {*} [options] Override http request option.
353
387
  * @throws {RequiredError}
354
388
  */
@@ -419,6 +453,34 @@ export interface EmailTrackingApiListMessagesRequest {
419
453
  * @memberof EmailTrackingApiListMessages
420
454
  */
421
455
  readonly authorization?: string
456
+
457
+ /**
458
+ * 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;
459
+ * @type {string}
460
+ * @memberof EmailTrackingApiListMessages
461
+ */
462
+ readonly filter?: string
463
+
464
+ /**
465
+ * 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;
466
+ * @type {string}
467
+ * @memberof EmailTrackingApiListMessages
468
+ */
469
+ readonly filters?: string
470
+
471
+ /**
472
+ * 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;
473
+ * @type {string}
474
+ * @memberof EmailTrackingApiListMessages
475
+ */
476
+ readonly order?: string
477
+
478
+ /**
479
+ * 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;
480
+ * @type {string}
481
+ * @memberof EmailTrackingApiListMessages
482
+ */
483
+ readonly expand?: string
422
484
  }
423
485
 
424
486
  /**
@@ -449,7 +511,7 @@ export interface EmailTrackingApiListThreadsRequest {
449
511
  readonly pageToken?: string
450
512
 
451
513
  /**
452
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
514
+ * 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;
453
515
  * @type {string}
454
516
  * @memberof EmailTrackingApiListThreads
455
517
  */
@@ -463,21 +525,21 @@ export interface EmailTrackingApiListThreadsRequest {
463
525
  readonly search?: string
464
526
 
465
527
  /**
466
- * 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.
528
+ * 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;
467
529
  * @type {string}
468
530
  * @memberof EmailTrackingApiListThreads
469
531
  */
470
532
  readonly order?: string
471
533
 
472
534
  /**
473
- * 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.
535
+ * 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;
474
536
  * @type {string}
475
537
  * @memberof EmailTrackingApiListThreads
476
538
  */
477
539
  readonly expand?: string
478
540
 
479
541
  /**
480
- * 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.
542
+ * 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;
481
543
  * @type {string}
482
544
  * @memberof EmailTrackingApiListThreads
483
545
  */
@@ -492,7 +554,7 @@ export interface EmailTrackingApiListThreadsRequest {
492
554
  */
493
555
  export class EmailTrackingApi extends BaseAPI {
494
556
  /**
495
- * undefined **Required Permissions** none
557
+ * undefined **Required Permissions** \"notification-management.email-messages.update\"
496
558
  * @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
497
559
  * @param {*} [options] Override http request option.
498
560
  * @throws {RequiredError}
@@ -503,7 +565,7 @@ export class EmailTrackingApi extends BaseAPI {
503
565
  }
504
566
 
505
567
  /**
506
- * undefined **Required Permissions** none
568
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
507
569
  * @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
508
570
  * @param {*} [options] Override http request option.
509
571
  * @throws {RequiredError}
@@ -514,18 +576,20 @@ export class EmailTrackingApi extends BaseAPI {
514
576
  }
515
577
 
516
578
  /**
517
- * undefined **Required Permissions** none
579
+ * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
580
+ * @summary List email messages
518
581
  * @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
519
582
  * @param {*} [options] Override http request option.
520
583
  * @throws {RequiredError}
521
584
  * @memberof EmailTrackingApi
522
585
  */
523
586
  public listMessages(requestParameters: EmailTrackingApiListMessagesRequest, options?: AxiosRequestConfig) {
524
- return EmailTrackingApiFp(this.configuration).listMessages(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
587
+ return EmailTrackingApiFp(this.configuration).listMessages(requestParameters.code, requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
525
588
  }
526
589
 
527
590
  /**
528
- * undefined **Required Permissions** none
591
+ * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
592
+ * @summary List email threads
529
593
  * @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
530
594
  * @param {*} [options] Override http request option.
531
595
  * @throws {RequiredError}