@emilgroup/notification-sdk-node 1.4.1-beta.28 → 1.4.1-beta.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -22,7 +22,7 @@ import { ListEmailMessagesResponseClass } from '../models';
22
22
  */
23
23
  export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configuration) => {
24
24
  /**
25
- * undefined **Required Permissions** none
25
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
26
26
  * @param {string} code
27
27
  * @param {number} attachmentId
28
28
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -31,7 +31,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
31
31
  */
32
32
  downloadAttachment: (code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
33
  /**
34
- * undefined **Required Permissions** none
34
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
35
35
  * @param {string} code
36
36
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
37
37
  * @param {*} [options] Override http request option.
@@ -39,7 +39,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
39
39
  */
40
40
  getMessage: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
41
  /**
42
- * undefined **Required Permissions** none
42
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
43
43
  * @param {string} code
44
44
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
45
45
  * @param {*} [options] Override http request option.
@@ -47,15 +47,16 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
47
47
  */
48
48
  listAttachments: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
49
49
  /**
50
- * undefined **Required Permissions** none
50
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
51
+ * @summary List email messages
51
52
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
52
53
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
53
54
  * @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.
54
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
55
+ * @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;
55
56
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
56
- * @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.
57
- * @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.
58
- * @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.
57
+ * @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;
58
+ * @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;
59
+ * @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;
59
60
  * @param {*} [options] Override http request option.
60
61
  * @throws {RequiredError}
61
62
  */
@@ -67,7 +68,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
67
68
  */
68
69
  export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
69
70
  /**
70
- * undefined **Required Permissions** none
71
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
71
72
  * @param {string} code
72
73
  * @param {number} attachmentId
73
74
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -76,7 +77,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
76
77
  */
77
78
  downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadAttachmentResponseClass>>;
78
79
  /**
79
- * undefined **Required Permissions** none
80
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
80
81
  * @param {string} code
81
82
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
82
83
  * @param {*} [options] Override http request option.
@@ -84,7 +85,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
84
85
  */
85
86
  getMessage(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailMessageResponseClass>>;
86
87
  /**
87
- * undefined **Required Permissions** none
88
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
88
89
  * @param {string} code
89
90
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
90
91
  * @param {*} [options] Override http request option.
@@ -92,15 +93,16 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
92
93
  */
93
94
  listAttachments(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailAttachmentsResponseClass>>;
94
95
  /**
95
- * undefined **Required Permissions** none
96
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
97
+ * @summary List email messages
96
98
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
97
99
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
98
100
  * @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.
99
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
101
+ * @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;
100
102
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
101
- * @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.
102
- * @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.
103
- * @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.
103
+ * @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;
104
+ * @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;
105
+ * @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;
104
106
  * @param {*} [options] Override http request option.
105
107
  * @throws {RequiredError}
106
108
  */
@@ -112,7 +114,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
112
114
  */
113
115
  export declare const EmailMessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
114
116
  /**
115
- * undefined **Required Permissions** none
117
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
116
118
  * @param {string} code
117
119
  * @param {number} attachmentId
118
120
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -121,7 +123,7 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
121
123
  */
122
124
  downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: any): AxiosPromise<DownloadAttachmentResponseClass>;
123
125
  /**
124
- * undefined **Required Permissions** none
126
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
125
127
  * @param {string} code
126
128
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
127
129
  * @param {*} [options] Override http request option.
@@ -129,7 +131,7 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
129
131
  */
130
132
  getMessage(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailMessageResponseClass>;
131
133
  /**
132
- * undefined **Required Permissions** none
134
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
133
135
  * @param {string} code
134
136
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
135
137
  * @param {*} [options] Override http request option.
@@ -137,15 +139,16 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
137
139
  */
138
140
  listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass>;
139
141
  /**
140
- * undefined **Required Permissions** none
142
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
143
+ * @summary List email messages
141
144
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
142
145
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
143
146
  * @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.
144
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
147
+ * @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
148
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
146
- * @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.
147
- * @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.
148
- * @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.
149
+ * @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;
150
+ * @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;
151
+ * @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;
149
152
  * @param {*} [options] Override http request option.
150
153
  * @throws {RequiredError}
151
154
  */
@@ -239,7 +242,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
239
242
  */
240
243
  readonly pageToken?: string;
241
244
  /**
242
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
245
+ * 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;
243
246
  * @type {string}
244
247
  * @memberof EmailMessagesApiListEmailMessages
245
248
  */
@@ -251,19 +254,19 @@ export interface EmailMessagesApiListEmailMessagesRequest {
251
254
  */
252
255
  readonly search?: string;
253
256
  /**
254
- * 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.
257
+ * 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;
255
258
  * @type {string}
256
259
  * @memberof EmailMessagesApiListEmailMessages
257
260
  */
258
261
  readonly order?: string;
259
262
  /**
260
- * 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.
263
+ * 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;
261
264
  * @type {string}
262
265
  * @memberof EmailMessagesApiListEmailMessages
263
266
  */
264
267
  readonly expand?: string;
265
268
  /**
266
- * 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.
269
+ * 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;
267
270
  * @type {string}
268
271
  * @memberof EmailMessagesApiListEmailMessages
269
272
  */
@@ -277,7 +280,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
277
280
  */
278
281
  export declare class EmailMessagesApi extends BaseAPI {
279
282
  /**
280
- * undefined **Required Permissions** none
283
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
281
284
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
282
285
  * @param {*} [options] Override http request option.
283
286
  * @throws {RequiredError}
@@ -285,7 +288,7 @@ export declare class EmailMessagesApi extends BaseAPI {
285
288
  */
286
289
  downloadAttachment(requestParameters: EmailMessagesApiDownloadAttachmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadAttachmentResponseClass, any, {}>>;
287
290
  /**
288
- * undefined **Required Permissions** none
291
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
289
292
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
290
293
  * @param {*} [options] Override http request option.
291
294
  * @throws {RequiredError}
@@ -293,7 +296,7 @@ export declare class EmailMessagesApi extends BaseAPI {
293
296
  */
294
297
  getMessage(requestParameters: EmailMessagesApiGetMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailMessageResponseClass, any, {}>>;
295
298
  /**
296
- * undefined **Required Permissions** none
299
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
297
300
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
298
301
  * @param {*} [options] Override http request option.
299
302
  * @throws {RequiredError}
@@ -301,7 +304,8 @@ export declare class EmailMessagesApi extends BaseAPI {
301
304
  */
302
305
  listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailAttachmentsResponseClass, any, {}>>;
303
306
  /**
304
- * undefined **Required Permissions** none
307
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
308
+ * @summary List email messages
305
309
  * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
306
310
  * @param {*} [options] Override http request option.
307
311
  * @throws {RequiredError}
@@ -97,7 +97,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * undefined **Required Permissions** none
100
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
101
101
  * @param {string} code
102
102
  * @param {number} attachmentId
103
103
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -148,7 +148,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
148
148
  });
149
149
  },
150
150
  /**
151
- * undefined **Required Permissions** none
151
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
152
152
  * @param {string} code
153
153
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
154
154
  * @param {*} [options] Override http request option.
@@ -195,7 +195,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
195
195
  });
196
196
  },
197
197
  /**
198
- * undefined **Required Permissions** none
198
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
199
199
  * @param {string} code
200
200
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
201
201
  * @param {*} [options] Override http request option.
@@ -242,15 +242,16 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
242
242
  });
243
243
  },
244
244
  /**
245
- * undefined **Required Permissions** none
245
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
246
+ * @summary List email messages
246
247
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
247
248
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
248
249
  * @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.
249
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
250
+ * @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;
250
251
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
251
- * @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.
252
- * @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.
253
- * @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.
252
+ * @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;
253
+ * @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;
254
+ * @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;
254
255
  * @param {*} [options] Override http request option.
255
256
  * @throws {RequiredError}
256
257
  */
@@ -323,7 +324,7 @@ var EmailMessagesApiFp = function (configuration) {
323
324
  var localVarAxiosParamCreator = (0, exports.EmailMessagesApiAxiosParamCreator)(configuration);
324
325
  return {
325
326
  /**
326
- * undefined **Required Permissions** none
327
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
327
328
  * @param {string} code
328
329
  * @param {number} attachmentId
329
330
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -344,7 +345,7 @@ var EmailMessagesApiFp = function (configuration) {
344
345
  });
345
346
  },
346
347
  /**
347
- * undefined **Required Permissions** none
348
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
348
349
  * @param {string} code
349
350
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
350
351
  * @param {*} [options] Override http request option.
@@ -364,7 +365,7 @@ var EmailMessagesApiFp = function (configuration) {
364
365
  });
365
366
  },
366
367
  /**
367
- * undefined **Required Permissions** none
368
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
368
369
  * @param {string} code
369
370
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
370
371
  * @param {*} [options] Override http request option.
@@ -384,15 +385,16 @@ var EmailMessagesApiFp = function (configuration) {
384
385
  });
385
386
  },
386
387
  /**
387
- * undefined **Required Permissions** none
388
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
389
+ * @summary List email messages
388
390
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
389
391
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
390
392
  * @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.
391
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
393
+ * @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;
392
394
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
393
- * @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.
394
- * @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.
395
- * @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.
395
+ * @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;
396
+ * @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;
397
+ * @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;
396
398
  * @param {*} [options] Override http request option.
397
399
  * @throws {RequiredError}
398
400
  */
@@ -420,7 +422,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
420
422
  var localVarFp = (0, exports.EmailMessagesApiFp)(configuration);
421
423
  return {
422
424
  /**
423
- * undefined **Required Permissions** none
425
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
424
426
  * @param {string} code
425
427
  * @param {number} attachmentId
426
428
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -431,7 +433,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
431
433
  return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then(function (request) { return request(axios, basePath); });
432
434
  },
433
435
  /**
434
- * undefined **Required Permissions** none
436
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
435
437
  * @param {string} code
436
438
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
437
439
  * @param {*} [options] Override http request option.
@@ -441,7 +443,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
441
443
  return localVarFp.getMessage(code, authorization, options).then(function (request) { return request(axios, basePath); });
442
444
  },
443
445
  /**
444
- * undefined **Required Permissions** none
446
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
445
447
  * @param {string} code
446
448
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
447
449
  * @param {*} [options] Override http request option.
@@ -451,15 +453,16 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
451
453
  return localVarFp.listAttachments(code, authorization, options).then(function (request) { return request(axios, basePath); });
452
454
  },
453
455
  /**
454
- * undefined **Required Permissions** none
456
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
457
+ * @summary List email messages
455
458
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
456
459
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
457
460
  * @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.
458
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
461
+ * @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;
459
462
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
460
- * @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.
461
- * @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.
462
- * @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.
463
+ * @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;
464
+ * @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;
465
+ * @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;
463
466
  * @param {*} [options] Override http request option.
464
467
  * @throws {RequiredError}
465
468
  */
@@ -481,7 +484,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
481
484
  return _super !== null && _super.apply(this, arguments) || this;
482
485
  }
483
486
  /**
484
- * undefined **Required Permissions** none
487
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
485
488
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
486
489
  * @param {*} [options] Override http request option.
487
490
  * @throws {RequiredError}
@@ -492,7 +495,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
492
495
  return (0, exports.EmailMessagesApiFp)(this.configuration).downloadAttachment(requestParameters.code, requestParameters.attachmentId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
493
496
  };
494
497
  /**
495
- * undefined **Required Permissions** none
498
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
496
499
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
497
500
  * @param {*} [options] Override http request option.
498
501
  * @throws {RequiredError}
@@ -503,7 +506,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
503
506
  return (0, exports.EmailMessagesApiFp)(this.configuration).getMessage(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
504
507
  };
505
508
  /**
506
- * undefined **Required Permissions** none
509
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
507
510
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
508
511
  * @param {*} [options] Override http request option.
509
512
  * @throws {RequiredError}
@@ -514,7 +517,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
514
517
  return (0, exports.EmailMessagesApiFp)(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
515
518
  };
516
519
  /**
517
- * undefined **Required Permissions** none
520
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
521
+ * @summary List email messages
518
522
  * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
519
523
  * @param {*} [options] Override http request option.
520
524
  * @throws {RequiredError}