@emilgroup/notification-sdk 0.1.1-beta.8 → 0.2.1-beta.11

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,19 +47,20 @@ 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
  */
62
- listMessages: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
63
+ listEmailMessages: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
63
64
  };
64
65
  /**
65
66
  * EmailMessagesApi - functional programming interface
@@ -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,19 +93,20 @@ 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
  */
107
- listMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
109
+ listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
108
110
  };
109
111
  /**
110
112
  * EmailMessagesApi - factory interface
@@ -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,19 +139,20 @@ 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
  */
152
- listMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
155
+ listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
153
156
  };
154
157
  /**
155
158
  * Request parameters for downloadAttachment operation in EmailMessagesApi.
@@ -215,57 +218,57 @@ export interface EmailMessagesApiListAttachmentsRequest {
215
218
  readonly authorization?: string;
216
219
  }
217
220
  /**
218
- * Request parameters for listMessages operation in EmailMessagesApi.
221
+ * Request parameters for listEmailMessages operation in EmailMessagesApi.
219
222
  * @export
220
- * @interface EmailMessagesApiListMessagesRequest
223
+ * @interface EmailMessagesApiListEmailMessagesRequest
221
224
  */
222
- export interface EmailMessagesApiListMessagesRequest {
225
+ export interface EmailMessagesApiListEmailMessagesRequest {
223
226
  /**
224
227
  * Bearer Token: provided by the login endpoint under the name accessToken.
225
228
  * @type {string}
226
- * @memberof EmailMessagesApiListMessages
229
+ * @memberof EmailMessagesApiListEmailMessages
227
230
  */
228
231
  readonly authorization?: string;
229
232
  /**
230
233
  * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
231
234
  * @type {number}
232
- * @memberof EmailMessagesApiListMessages
235
+ * @memberof EmailMessagesApiListEmailMessages
233
236
  */
234
237
  readonly pageSize?: number;
235
238
  /**
236
239
  * 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.
237
240
  * @type {string}
238
- * @memberof EmailMessagesApiListMessages
241
+ * @memberof EmailMessagesApiListEmailMessages
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
- * @memberof EmailMessagesApiListMessages
247
+ * @memberof EmailMessagesApiListEmailMessages
245
248
  */
246
249
  readonly filter?: string;
247
250
  /**
248
251
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
249
252
  * @type {string}
250
- * @memberof EmailMessagesApiListMessages
253
+ * @memberof EmailMessagesApiListEmailMessages
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
- * @memberof EmailMessagesApiListMessages
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
- * @memberof EmailMessagesApiListMessages
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
- * @memberof EmailMessagesApiListMessages
271
+ * @memberof EmailMessagesApiListEmailMessages
269
272
  */
270
273
  readonly filters?: string;
271
274
  }
@@ -277,7 +280,7 @@ export interface EmailMessagesApiListMessagesRequest {
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,11 +304,12 @@ 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
305
- * @param {EmailMessagesApiListMessagesRequest} requestParameters Request parameters.
307
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
308
+ * @summary List email messages
309
+ * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
306
310
  * @param {*} [options] Override http request option.
307
311
  * @throws {RequiredError}
308
312
  * @memberof EmailMessagesApi
309
313
  */
310
- listMessages(requestParameters?: EmailMessagesApiListMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
314
+ listEmailMessages(requestParameters?: EmailMessagesApiListEmailMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
311
315
  }
@@ -93,7 +93,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** none
96
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
97
97
  * @param {string} code
98
98
  * @param {number} attachmentId
99
99
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -144,7 +144,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
144
144
  });
145
145
  },
146
146
  /**
147
- * undefined **Required Permissions** none
147
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
148
148
  * @param {string} code
149
149
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
150
150
  * @param {*} [options] Override http request option.
@@ -191,7 +191,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
191
191
  });
192
192
  },
193
193
  /**
194
- * undefined **Required Permissions** none
194
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
195
195
  * @param {string} code
196
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
197
197
  * @param {*} [options] Override http request option.
@@ -238,19 +238,20 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
238
238
  });
239
239
  },
240
240
  /**
241
- * undefined **Required Permissions** none
241
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
242
+ * @summary List email messages
242
243
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
243
244
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
244
245
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
245
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
246
+ * @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;
246
247
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
247
- * @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.
248
- * @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.
249
- * @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.
248
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&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;
249
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
250
+ * @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;
250
251
  * @param {*} [options] Override http request option.
251
252
  * @throws {RequiredError}
252
253
  */
253
- listMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
254
+ listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
254
255
  if (options === void 0) { options = {}; }
255
256
  return __awaiter(_this, void 0, void 0, function () {
256
257
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -319,7 +320,7 @@ var EmailMessagesApiFp = function (configuration) {
319
320
  var localVarAxiosParamCreator = (0, exports.EmailMessagesApiAxiosParamCreator)(configuration);
320
321
  return {
321
322
  /**
322
- * undefined **Required Permissions** none
323
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
323
324
  * @param {string} code
324
325
  * @param {number} attachmentId
325
326
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -340,7 +341,7 @@ var EmailMessagesApiFp = function (configuration) {
340
341
  });
341
342
  },
342
343
  /**
343
- * undefined **Required Permissions** none
344
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
344
345
  * @param {string} code
345
346
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
346
347
  * @param {*} [options] Override http request option.
@@ -360,7 +361,7 @@ var EmailMessagesApiFp = function (configuration) {
360
361
  });
361
362
  },
362
363
  /**
363
- * undefined **Required Permissions** none
364
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
364
365
  * @param {string} code
365
366
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
366
367
  * @param {*} [options] Override http request option.
@@ -380,24 +381,25 @@ var EmailMessagesApiFp = function (configuration) {
380
381
  });
381
382
  },
382
383
  /**
383
- * undefined **Required Permissions** none
384
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
385
+ * @summary List email messages
384
386
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
385
387
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
386
388
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
387
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
389
+ * @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;
388
390
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
389
- * @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.
390
- * @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.
391
- * @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.
391
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&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;
392
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
393
+ * @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;
392
394
  * @param {*} [options] Override http request option.
393
395
  * @throws {RequiredError}
394
396
  */
395
- listMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
397
+ listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
396
398
  return __awaiter(this, void 0, void 0, function () {
397
399
  var localVarAxiosArgs;
398
400
  return __generator(this, function (_a) {
399
401
  switch (_a.label) {
400
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
402
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
401
403
  case 1:
402
404
  localVarAxiosArgs = _a.sent();
403
405
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -416,7 +418,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
416
418
  var localVarFp = (0, exports.EmailMessagesApiFp)(configuration);
417
419
  return {
418
420
  /**
419
- * undefined **Required Permissions** none
421
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
420
422
  * @param {string} code
421
423
  * @param {number} attachmentId
422
424
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -427,7 +429,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
427
429
  return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then(function (request) { return request(axios, basePath); });
428
430
  },
429
431
  /**
430
- * undefined **Required Permissions** none
432
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
431
433
  * @param {string} code
432
434
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
433
435
  * @param {*} [options] Override http request option.
@@ -437,7 +439,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
437
439
  return localVarFp.getMessage(code, authorization, options).then(function (request) { return request(axios, basePath); });
438
440
  },
439
441
  /**
440
- * undefined **Required Permissions** none
442
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
441
443
  * @param {string} code
442
444
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
443
445
  * @param {*} [options] Override http request option.
@@ -447,20 +449,21 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
447
449
  return localVarFp.listAttachments(code, authorization, options).then(function (request) { return request(axios, basePath); });
448
450
  },
449
451
  /**
450
- * undefined **Required Permissions** none
452
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
453
+ * @summary List email messages
451
454
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
452
455
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
453
456
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
454
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
457
+ * @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;
455
458
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
456
- * @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.
457
- * @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.
458
- * @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.
459
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&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;
460
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
461
+ * @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;
459
462
  * @param {*} [options] Override http request option.
460
463
  * @throws {RequiredError}
461
464
  */
462
- listMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
463
- return localVarFp.listMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
465
+ listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
466
+ return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
464
467
  },
465
468
  };
466
469
  };
@@ -477,7 +480,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
477
480
  return _super !== null && _super.apply(this, arguments) || this;
478
481
  }
479
482
  /**
480
- * undefined **Required Permissions** none
483
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
481
484
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
482
485
  * @param {*} [options] Override http request option.
483
486
  * @throws {RequiredError}
@@ -488,7 +491,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
488
491
  return (0, exports.EmailMessagesApiFp)(this.configuration).downloadAttachment(requestParameters.code, requestParameters.attachmentId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
489
492
  };
490
493
  /**
491
- * undefined **Required Permissions** none
494
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
492
495
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
493
496
  * @param {*} [options] Override http request option.
494
497
  * @throws {RequiredError}
@@ -499,7 +502,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
499
502
  return (0, exports.EmailMessagesApiFp)(this.configuration).getMessage(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
500
503
  };
501
504
  /**
502
- * undefined **Required Permissions** none
505
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
503
506
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
504
507
  * @param {*} [options] Override http request option.
505
508
  * @throws {RequiredError}
@@ -510,16 +513,17 @@ var EmailMessagesApi = /** @class */ (function (_super) {
510
513
  return (0, exports.EmailMessagesApiFp)(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
511
514
  };
512
515
  /**
513
- * undefined **Required Permissions** none
514
- * @param {EmailMessagesApiListMessagesRequest} requestParameters Request parameters.
516
+ * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
517
+ * @summary List email messages
518
+ * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
515
519
  * @param {*} [options] Override http request option.
516
520
  * @throws {RequiredError}
517
521
  * @memberof EmailMessagesApi
518
522
  */
519
- EmailMessagesApi.prototype.listMessages = function (requestParameters, options) {
523
+ EmailMessagesApi.prototype.listEmailMessages = function (requestParameters, options) {
520
524
  var _this = this;
521
525
  if (requestParameters === void 0) { requestParameters = {}; }
522
- return (0, exports.EmailMessagesApiFp)(this.configuration).listMessages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
526
+ return (0, exports.EmailMessagesApiFp)(this.configuration).listEmailMessages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
523
527
  };
524
528
  return EmailMessagesApi;
525
529
  }(base_1.BaseAPI));