@emilgroup/notification-sdk-node 1.4.1-beta.19 → 1.4.1-beta.22

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-node@1.4.1-beta.19 --save
20
+ npm install @emilgroup/notification-sdk-node@1.4.1-beta.22 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/notification-sdk-node@1.4.1-beta.19
24
+ yarn add @emilgroup/notification-sdk-node@1.4.1-beta.22
25
25
  ```
26
26
 
27
27
  And then you can import `LayoutApi`.
@@ -26,6 +26,8 @@ import { DownloadAttachmentResponseClass } from '../models';
26
26
  import { GetEmailMessageResponseClass } from '../models';
27
27
  // @ts-ignore
28
28
  import { ListEmailAttachmentsResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { ListEmailMessagesResponseClass } from '../models';
29
31
  // URLSearchParams not necessarily used
30
32
  // @ts-ignore
31
33
  import { URL, URLSearchParams } from 'url';
@@ -163,6 +165,81 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
163
165
 
164
166
 
165
167
 
168
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
169
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
170
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
171
+
172
+ return {
173
+ url: toPathString(localVarUrlObj),
174
+ options: localVarRequestOptions,
175
+ };
176
+ },
177
+ /**
178
+ * undefined **Required Permissions** none
179
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
180
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
181
+ * @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.
182
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
183
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
184
+ * @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.
185
+ * @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.
186
+ * @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.
187
+ * @param {*} [options] Override http request option.
188
+ * @throws {RequiredError}
189
+ */
190
+ listMessages: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
191
+ const localVarPath = `/notificationservice/v1/email-messages`;
192
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
193
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
194
+ let baseOptions;
195
+ let baseAccessToken;
196
+ if (configuration) {
197
+ baseOptions = configuration.baseOptions;
198
+ baseAccessToken = configuration.accessToken;
199
+ }
200
+
201
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
202
+ const localVarHeaderParameter = {} as any;
203
+ const localVarQueryParameter = {} as any;
204
+
205
+ // authentication bearer required
206
+ // http bearer authentication required
207
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
208
+
209
+ if (pageSize !== undefined) {
210
+ localVarQueryParameter['pageSize'] = pageSize;
211
+ }
212
+
213
+ if (pageToken !== undefined) {
214
+ localVarQueryParameter['pageToken'] = pageToken;
215
+ }
216
+
217
+ if (filter !== undefined) {
218
+ localVarQueryParameter['filter'] = filter;
219
+ }
220
+
221
+ if (search !== undefined) {
222
+ localVarQueryParameter['search'] = search;
223
+ }
224
+
225
+ if (order !== undefined) {
226
+ localVarQueryParameter['order'] = order;
227
+ }
228
+
229
+ if (expand !== undefined) {
230
+ localVarQueryParameter['expand'] = expand;
231
+ }
232
+
233
+ if (filters !== undefined) {
234
+ localVarQueryParameter['filters'] = filters;
235
+ }
236
+
237
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
238
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
239
+ }
240
+
241
+
242
+
166
243
  setSearchParams(localVarUrlObj, localVarQueryParameter);
167
244
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
168
245
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -216,6 +293,23 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
216
293
  const localVarAxiosArgs = await localVarAxiosParamCreator.listAttachments(code, authorization, options);
217
294
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
218
295
  },
296
+ /**
297
+ * undefined **Required Permissions** none
298
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
299
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
300
+ * @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.
301
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
302
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
303
+ * @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.
304
+ * @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.
305
+ * @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.
306
+ * @param {*} [options] Override http request option.
307
+ * @throws {RequiredError}
308
+ */
309
+ async 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>> {
310
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
311
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
312
+ },
219
313
  }
220
314
  };
221
315
 
@@ -257,6 +351,22 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
257
351
  listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass> {
258
352
  return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
259
353
  },
354
+ /**
355
+ * undefined **Required Permissions** none
356
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
357
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
358
+ * @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.
359
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
360
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
361
+ * @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.
362
+ * @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.
363
+ * @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.
364
+ * @param {*} [options] Override http request option.
365
+ * @throws {RequiredError}
366
+ */
367
+ listMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
368
+ return localVarFp.listMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
369
+ },
260
370
  };
261
371
  };
262
372
 
@@ -330,6 +440,69 @@ export interface EmailMessagesApiListAttachmentsRequest {
330
440
  readonly authorization?: string
331
441
  }
332
442
 
443
+ /**
444
+ * Request parameters for listMessages operation in EmailMessagesApi.
445
+ * @export
446
+ * @interface EmailMessagesApiListMessagesRequest
447
+ */
448
+ export interface EmailMessagesApiListMessagesRequest {
449
+ /**
450
+ * Bearer Token: provided by the login endpoint under the name accessToken.
451
+ * @type {string}
452
+ * @memberof EmailMessagesApiListMessages
453
+ */
454
+ readonly authorization?: string
455
+
456
+ /**
457
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
458
+ * @type {number}
459
+ * @memberof EmailMessagesApiListMessages
460
+ */
461
+ readonly pageSize?: number
462
+
463
+ /**
464
+ * 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.
465
+ * @type {string}
466
+ * @memberof EmailMessagesApiListMessages
467
+ */
468
+ readonly pageToken?: string
469
+
470
+ /**
471
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
472
+ * @type {string}
473
+ * @memberof EmailMessagesApiListMessages
474
+ */
475
+ readonly filter?: string
476
+
477
+ /**
478
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
479
+ * @type {string}
480
+ * @memberof EmailMessagesApiListMessages
481
+ */
482
+ readonly search?: string
483
+
484
+ /**
485
+ * 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.
486
+ * @type {string}
487
+ * @memberof EmailMessagesApiListMessages
488
+ */
489
+ readonly order?: string
490
+
491
+ /**
492
+ * 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.
493
+ * @type {string}
494
+ * @memberof EmailMessagesApiListMessages
495
+ */
496
+ readonly expand?: string
497
+
498
+ /**
499
+ * 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.
500
+ * @type {string}
501
+ * @memberof EmailMessagesApiListMessages
502
+ */
503
+ readonly filters?: string
504
+ }
505
+
333
506
  /**
334
507
  * EmailMessagesApi - object-oriented interface
335
508
  * @export
@@ -369,4 +542,15 @@ export class EmailMessagesApi extends BaseAPI {
369
542
  public listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig) {
370
543
  return EmailMessagesApiFp(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
371
544
  }
545
+
546
+ /**
547
+ * undefined **Required Permissions** none
548
+ * @param {EmailMessagesApiListMessagesRequest} requestParameters Request parameters.
549
+ * @param {*} [options] Override http request option.
550
+ * @throws {RequiredError}
551
+ * @memberof EmailMessagesApi
552
+ */
553
+ public listMessages(requestParameters: EmailMessagesApiListMessagesRequest = {}, options?: AxiosRequestConfig) {
554
+ return EmailMessagesApiFp(this.configuration).listMessages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
555
+ }
372
556
  }
@@ -15,6 +15,7 @@ import { RequestArgs, BaseAPI } from '../base';
15
15
  import { DownloadAttachmentResponseClass } from '../models';
16
16
  import { GetEmailMessageResponseClass } from '../models';
17
17
  import { ListEmailAttachmentsResponseClass } from '../models';
18
+ import { ListEmailMessagesResponseClass } from '../models';
18
19
  /**
19
20
  * EmailMessagesApi - axios parameter creator
20
21
  * @export
@@ -45,6 +46,20 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
45
46
  * @throws {RequiredError}
46
47
  */
47
48
  listAttachments: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
49
+ /**
50
+ * undefined **Required Permissions** none
51
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
52
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
53
+ * @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} [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.
59
+ * @param {*} [options] Override http request option.
60
+ * @throws {RequiredError}
61
+ */
62
+ listMessages: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
48
63
  };
49
64
  /**
50
65
  * EmailMessagesApi - functional programming interface
@@ -76,6 +91,20 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
76
91
  * @throws {RequiredError}
77
92
  */
78
93
  listAttachments(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailAttachmentsResponseClass>>;
94
+ /**
95
+ * undefined **Required Permissions** none
96
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
97
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
98
+ * @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.
100
+ * @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.
104
+ * @param {*} [options] Override http request option.
105
+ * @throws {RequiredError}
106
+ */
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>>;
79
108
  };
80
109
  /**
81
110
  * EmailMessagesApi - factory interface
@@ -107,6 +136,20 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
107
136
  * @throws {RequiredError}
108
137
  */
109
138
  listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass>;
139
+ /**
140
+ * undefined **Required Permissions** none
141
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
142
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
143
+ * @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.
145
+ * @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 {*} [options] Override http request option.
150
+ * @throws {RequiredError}
151
+ */
152
+ listMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
110
153
  };
111
154
  /**
112
155
  * Request parameters for downloadAttachment operation in EmailMessagesApi.
@@ -171,6 +214,61 @@ export interface EmailMessagesApiListAttachmentsRequest {
171
214
  */
172
215
  readonly authorization?: string;
173
216
  }
217
+ /**
218
+ * Request parameters for listMessages operation in EmailMessagesApi.
219
+ * @export
220
+ * @interface EmailMessagesApiListMessagesRequest
221
+ */
222
+ export interface EmailMessagesApiListMessagesRequest {
223
+ /**
224
+ * Bearer Token: provided by the login endpoint under the name accessToken.
225
+ * @type {string}
226
+ * @memberof EmailMessagesApiListMessages
227
+ */
228
+ readonly authorization?: string;
229
+ /**
230
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
231
+ * @type {number}
232
+ * @memberof EmailMessagesApiListMessages
233
+ */
234
+ readonly pageSize?: number;
235
+ /**
236
+ * 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
+ * @type {string}
238
+ * @memberof EmailMessagesApiListMessages
239
+ */
240
+ readonly pageToken?: string;
241
+ /**
242
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
243
+ * @type {string}
244
+ * @memberof EmailMessagesApiListMessages
245
+ */
246
+ readonly filter?: string;
247
+ /**
248
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
249
+ * @type {string}
250
+ * @memberof EmailMessagesApiListMessages
251
+ */
252
+ readonly search?: string;
253
+ /**
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.
255
+ * @type {string}
256
+ * @memberof EmailMessagesApiListMessages
257
+ */
258
+ readonly order?: string;
259
+ /**
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.
261
+ * @type {string}
262
+ * @memberof EmailMessagesApiListMessages
263
+ */
264
+ readonly expand?: string;
265
+ /**
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.
267
+ * @type {string}
268
+ * @memberof EmailMessagesApiListMessages
269
+ */
270
+ readonly filters?: string;
271
+ }
174
272
  /**
175
273
  * EmailMessagesApi - object-oriented interface
176
274
  * @export
@@ -202,4 +300,12 @@ export declare class EmailMessagesApi extends BaseAPI {
202
300
  * @memberof EmailMessagesApi
203
301
  */
204
302
  listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailAttachmentsResponseClass, any, {}>>;
303
+ /**
304
+ * undefined **Required Permissions** none
305
+ * @param {EmailMessagesApiListMessagesRequest} requestParameters Request parameters.
306
+ * @param {*} [options] Override http request option.
307
+ * @throws {RequiredError}
308
+ * @memberof EmailMessagesApi
309
+ */
310
+ listMessages(requestParameters?: EmailMessagesApiListMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
205
311
  }
@@ -241,6 +241,77 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
241
241
  });
242
242
  });
243
243
  },
244
+ /**
245
+ * undefined **Required Permissions** none
246
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
247
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
248
+ * @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} [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.
254
+ * @param {*} [options] Override http request option.
255
+ * @throws {RequiredError}
256
+ */
257
+ listMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
258
+ if (options === void 0) { options = {}; }
259
+ return __awaiter(_this, void 0, void 0, function () {
260
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
261
+ return __generator(this, function (_a) {
262
+ switch (_a.label) {
263
+ case 0:
264
+ localVarPath = "/notificationservice/v1/email-messages";
265
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
266
+ if (configuration) {
267
+ baseOptions = configuration.baseOptions;
268
+ baseAccessToken = configuration.accessToken;
269
+ }
270
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
271
+ localVarHeaderParameter = {};
272
+ localVarQueryParameter = {};
273
+ // authentication bearer required
274
+ // http bearer authentication required
275
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
276
+ case 1:
277
+ // authentication bearer required
278
+ // http bearer authentication required
279
+ _a.sent();
280
+ if (pageSize !== undefined) {
281
+ localVarQueryParameter['pageSize'] = pageSize;
282
+ }
283
+ if (pageToken !== undefined) {
284
+ localVarQueryParameter['pageToken'] = pageToken;
285
+ }
286
+ if (filter !== undefined) {
287
+ localVarQueryParameter['filter'] = filter;
288
+ }
289
+ if (search !== undefined) {
290
+ localVarQueryParameter['search'] = search;
291
+ }
292
+ if (order !== undefined) {
293
+ localVarQueryParameter['order'] = order;
294
+ }
295
+ if (expand !== undefined) {
296
+ localVarQueryParameter['expand'] = expand;
297
+ }
298
+ if (filters !== undefined) {
299
+ localVarQueryParameter['filters'] = filters;
300
+ }
301
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
302
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
303
+ }
304
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
305
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
306
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
307
+ return [2 /*return*/, {
308
+ url: (0, common_1.toPathString)(localVarUrlObj),
309
+ options: localVarRequestOptions,
310
+ }];
311
+ }
312
+ });
313
+ });
314
+ },
244
315
  };
245
316
  };
246
317
  exports.EmailMessagesApiAxiosParamCreator = EmailMessagesApiAxiosParamCreator;
@@ -312,6 +383,32 @@ var EmailMessagesApiFp = function (configuration) {
312
383
  });
313
384
  });
314
385
  },
386
+ /**
387
+ * undefined **Required Permissions** none
388
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
389
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
390
+ * @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.
392
+ * @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.
396
+ * @param {*} [options] Override http request option.
397
+ * @throws {RequiredError}
398
+ */
399
+ listMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
400
+ return __awaiter(this, void 0, void 0, function () {
401
+ var localVarAxiosArgs;
402
+ return __generator(this, function (_a) {
403
+ switch (_a.label) {
404
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
405
+ case 1:
406
+ localVarAxiosArgs = _a.sent();
407
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
408
+ }
409
+ });
410
+ });
411
+ },
315
412
  };
316
413
  };
317
414
  exports.EmailMessagesApiFp = EmailMessagesApiFp;
@@ -353,6 +450,22 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
353
450
  listAttachments: function (code, authorization, options) {
354
451
  return localVarFp.listAttachments(code, authorization, options).then(function (request) { return request(axios, basePath); });
355
452
  },
453
+ /**
454
+ * undefined **Required Permissions** none
455
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
456
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
457
+ * @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.
459
+ * @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 {*} [options] Override http request option.
464
+ * @throws {RequiredError}
465
+ */
466
+ listMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
467
+ return localVarFp.listMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
468
+ },
356
469
  };
357
470
  };
358
471
  exports.EmailMessagesApiFactory = EmailMessagesApiFactory;
@@ -400,6 +513,18 @@ var EmailMessagesApi = /** @class */ (function (_super) {
400
513
  var _this = this;
401
514
  return (0, exports.EmailMessagesApiFp)(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
402
515
  };
516
+ /**
517
+ * undefined **Required Permissions** none
518
+ * @param {EmailMessagesApiListMessagesRequest} requestParameters Request parameters.
519
+ * @param {*} [options] Override http request option.
520
+ * @throws {RequiredError}
521
+ * @memberof EmailMessagesApi
522
+ */
523
+ EmailMessagesApi.prototype.listMessages = function (requestParameters, options) {
524
+ var _this = this;
525
+ if (requestParameters === void 0) { requestParameters = {}; }
526
+ 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); });
527
+ };
403
528
  return EmailMessagesApi;
404
529
  }(base_1.BaseAPI));
405
530
  exports.EmailMessagesApi = EmailMessagesApi;
@@ -124,6 +124,18 @@ export interface EmailMessageClass {
124
124
  * @memberof EmailMessageClass
125
125
  */
126
126
  'attachments': Array<EmailAttachmentClass>;
127
+ /**
128
+ * Entity type this message is associated with
129
+ * @type {string}
130
+ * @memberof EmailMessageClass
131
+ */
132
+ 'entityType': string;
133
+ /**
134
+ * Entity code this message is associated with
135
+ * @type {string}
136
+ * @memberof EmailMessageClass
137
+ */
138
+ 'entityCode': string;
127
139
  }
128
140
  export declare const EmailMessageClassDirectionEnum: {
129
141
  readonly Outbound: "outbound";
@@ -129,6 +129,18 @@ export interface EmailMessageClass {
129
129
  * @memberof EmailMessageClass
130
130
  */
131
131
  'attachments': Array<EmailAttachmentClass>;
132
+ /**
133
+ * Entity type this message is associated with
134
+ * @type {string}
135
+ * @memberof EmailMessageClass
136
+ */
137
+ 'entityType': string;
138
+ /**
139
+ * Entity code this message is associated with
140
+ * @type {string}
141
+ * @memberof EmailMessageClass
142
+ */
143
+ 'entityCode': string;
132
144
  }
133
145
 
134
146
  export const EmailMessageClassDirectionEnum = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/notification-sdk-node",
3
- "version": "1.4.1-beta.19",
3
+ "version": "1.4.1-beta.22",
4
4
  "description": "OpenAPI client for @emilgroup/notification-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [