@emilgroup/notification-sdk 0.1.1-beta.5 → 0.1.1-beta.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/notification-sdk@0.1.1-beta.5 --save
20
+ npm install @emilgroup/notification-sdk@0.1.1-beta.8 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/notification-sdk@0.1.1-beta.5
24
+ yarn add @emilgroup/notification-sdk@0.1.1-beta.8
25
25
  ```
26
26
 
27
27
  And then you can import ``.
@@ -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
  /**
30
32
  * EmailMessagesApi - axios parameter creator
31
33
  * @export
@@ -159,6 +161,81 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
159
161
 
160
162
 
161
163
 
164
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
165
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
166
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
167
+
168
+ return {
169
+ url: toPathString(localVarUrlObj),
170
+ options: localVarRequestOptions,
171
+ };
172
+ },
173
+ /**
174
+ * undefined **Required Permissions** none
175
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
176
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
177
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
178
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
179
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
180
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
181
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
182
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
183
+ * @param {*} [options] Override http request option.
184
+ * @throws {RequiredError}
185
+ */
186
+ listMessages: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
187
+ const localVarPath = `/notificationservice/v1/email-messages`;
188
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
189
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
190
+ let baseOptions;
191
+ let baseAccessToken;
192
+ if (configuration) {
193
+ baseOptions = configuration.baseOptions;
194
+ baseAccessToken = configuration.accessToken;
195
+ }
196
+
197
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
198
+ const localVarHeaderParameter = {} as any;
199
+ const localVarQueryParameter = {} as any;
200
+
201
+ // authentication bearer required
202
+ // http bearer authentication required
203
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
204
+
205
+ if (pageSize !== undefined) {
206
+ localVarQueryParameter['pageSize'] = pageSize;
207
+ }
208
+
209
+ if (pageToken !== undefined) {
210
+ localVarQueryParameter['pageToken'] = pageToken;
211
+ }
212
+
213
+ if (filter !== undefined) {
214
+ localVarQueryParameter['filter'] = filter;
215
+ }
216
+
217
+ if (search !== undefined) {
218
+ localVarQueryParameter['search'] = search;
219
+ }
220
+
221
+ if (order !== undefined) {
222
+ localVarQueryParameter['order'] = order;
223
+ }
224
+
225
+ if (expand !== undefined) {
226
+ localVarQueryParameter['expand'] = expand;
227
+ }
228
+
229
+ if (filters !== undefined) {
230
+ localVarQueryParameter['filters'] = filters;
231
+ }
232
+
233
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
234
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
235
+ }
236
+
237
+
238
+
162
239
  setSearchParams(localVarUrlObj, localVarQueryParameter);
163
240
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
164
241
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -212,6 +289,23 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
212
289
  const localVarAxiosArgs = await localVarAxiosParamCreator.listAttachments(code, authorization, options);
213
290
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
214
291
  },
292
+ /**
293
+ * undefined **Required Permissions** none
294
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
295
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
296
+ * @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.
297
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
298
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
299
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
300
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
301
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
302
+ * @param {*} [options] Override http request option.
303
+ * @throws {RequiredError}
304
+ */
305
+ 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>> {
306
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
307
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
308
+ },
215
309
  }
216
310
  };
217
311
 
@@ -253,6 +347,22 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
253
347
  listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass> {
254
348
  return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
255
349
  },
350
+ /**
351
+ * undefined **Required Permissions** none
352
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
353
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
354
+ * @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.
355
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
356
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
357
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
358
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
359
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
360
+ * @param {*} [options] Override http request option.
361
+ * @throws {RequiredError}
362
+ */
363
+ listMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
364
+ return localVarFp.listMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
365
+ },
256
366
  };
257
367
  };
258
368
 
@@ -326,6 +436,69 @@ export interface EmailMessagesApiListAttachmentsRequest {
326
436
  readonly authorization?: string
327
437
  }
328
438
 
439
+ /**
440
+ * Request parameters for listMessages operation in EmailMessagesApi.
441
+ * @export
442
+ * @interface EmailMessagesApiListMessagesRequest
443
+ */
444
+ export interface EmailMessagesApiListMessagesRequest {
445
+ /**
446
+ * Bearer Token: provided by the login endpoint under the name accessToken.
447
+ * @type {string}
448
+ * @memberof EmailMessagesApiListMessages
449
+ */
450
+ readonly authorization?: string
451
+
452
+ /**
453
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
454
+ * @type {number}
455
+ * @memberof EmailMessagesApiListMessages
456
+ */
457
+ readonly pageSize?: number
458
+
459
+ /**
460
+ * 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.
461
+ * @type {string}
462
+ * @memberof EmailMessagesApiListMessages
463
+ */
464
+ readonly pageToken?: string
465
+
466
+ /**
467
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
468
+ * @type {string}
469
+ * @memberof EmailMessagesApiListMessages
470
+ */
471
+ readonly filter?: string
472
+
473
+ /**
474
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
475
+ * @type {string}
476
+ * @memberof EmailMessagesApiListMessages
477
+ */
478
+ readonly search?: string
479
+
480
+ /**
481
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
482
+ * @type {string}
483
+ * @memberof EmailMessagesApiListMessages
484
+ */
485
+ readonly order?: string
486
+
487
+ /**
488
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
489
+ * @type {string}
490
+ * @memberof EmailMessagesApiListMessages
491
+ */
492
+ readonly expand?: string
493
+
494
+ /**
495
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
496
+ * @type {string}
497
+ * @memberof EmailMessagesApiListMessages
498
+ */
499
+ readonly filters?: string
500
+ }
501
+
329
502
  /**
330
503
  * EmailMessagesApi - object-oriented interface
331
504
  * @export
@@ -365,4 +538,15 @@ export class EmailMessagesApi extends BaseAPI {
365
538
  public listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig) {
366
539
  return EmailMessagesApiFp(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
367
540
  }
541
+
542
+ /**
543
+ * undefined **Required Permissions** none
544
+ * @param {EmailMessagesApiListMessagesRequest} requestParameters Request parameters.
545
+ * @param {*} [options] Override http request option.
546
+ * @throws {RequiredError}
547
+ * @memberof EmailMessagesApi
548
+ */
549
+ public listMessages(requestParameters: EmailMessagesApiListMessagesRequest = {}, options?: AxiosRequestConfig) {
550
+ 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));
551
+ }
368
552
  }
@@ -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
  }
@@ -237,6 +237,77 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
237
237
  });
238
238
  });
239
239
  },
240
+ /**
241
+ * undefined **Required Permissions** none
242
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
243
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
244
+ * @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} [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.
250
+ * @param {*} [options] Override http request option.
251
+ * @throws {RequiredError}
252
+ */
253
+ listMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
254
+ if (options === void 0) { options = {}; }
255
+ return __awaiter(_this, void 0, void 0, function () {
256
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
257
+ return __generator(this, function (_a) {
258
+ switch (_a.label) {
259
+ case 0:
260
+ localVarPath = "/notificationservice/v1/email-messages";
261
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
262
+ if (configuration) {
263
+ baseOptions = configuration.baseOptions;
264
+ baseAccessToken = configuration.accessToken;
265
+ }
266
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
267
+ localVarHeaderParameter = {};
268
+ localVarQueryParameter = {};
269
+ // authentication bearer required
270
+ // http bearer authentication required
271
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
272
+ case 1:
273
+ // authentication bearer required
274
+ // http bearer authentication required
275
+ _a.sent();
276
+ if (pageSize !== undefined) {
277
+ localVarQueryParameter['pageSize'] = pageSize;
278
+ }
279
+ if (pageToken !== undefined) {
280
+ localVarQueryParameter['pageToken'] = pageToken;
281
+ }
282
+ if (filter !== undefined) {
283
+ localVarQueryParameter['filter'] = filter;
284
+ }
285
+ if (search !== undefined) {
286
+ localVarQueryParameter['search'] = search;
287
+ }
288
+ if (order !== undefined) {
289
+ localVarQueryParameter['order'] = order;
290
+ }
291
+ if (expand !== undefined) {
292
+ localVarQueryParameter['expand'] = expand;
293
+ }
294
+ if (filters !== undefined) {
295
+ localVarQueryParameter['filters'] = filters;
296
+ }
297
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
298
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
299
+ }
300
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
301
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
302
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
303
+ return [2 /*return*/, {
304
+ url: (0, common_1.toPathString)(localVarUrlObj),
305
+ options: localVarRequestOptions,
306
+ }];
307
+ }
308
+ });
309
+ });
310
+ },
240
311
  };
241
312
  };
242
313
  exports.EmailMessagesApiAxiosParamCreator = EmailMessagesApiAxiosParamCreator;
@@ -308,6 +379,32 @@ var EmailMessagesApiFp = function (configuration) {
308
379
  });
309
380
  });
310
381
  },
382
+ /**
383
+ * undefined **Required Permissions** none
384
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
385
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
386
+ * @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.
388
+ * @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.
392
+ * @param {*} [options] Override http request option.
393
+ * @throws {RequiredError}
394
+ */
395
+ listMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
396
+ return __awaiter(this, void 0, void 0, function () {
397
+ var localVarAxiosArgs;
398
+ return __generator(this, function (_a) {
399
+ switch (_a.label) {
400
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
401
+ case 1:
402
+ localVarAxiosArgs = _a.sent();
403
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
404
+ }
405
+ });
406
+ });
407
+ },
311
408
  };
312
409
  };
313
410
  exports.EmailMessagesApiFp = EmailMessagesApiFp;
@@ -349,6 +446,22 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
349
446
  listAttachments: function (code, authorization, options) {
350
447
  return localVarFp.listAttachments(code, authorization, options).then(function (request) { return request(axios, basePath); });
351
448
  },
449
+ /**
450
+ * undefined **Required Permissions** none
451
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
452
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
453
+ * @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.
455
+ * @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 {*} [options] Override http request option.
460
+ * @throws {RequiredError}
461
+ */
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); });
464
+ },
352
465
  };
353
466
  };
354
467
  exports.EmailMessagesApiFactory = EmailMessagesApiFactory;
@@ -396,6 +509,18 @@ var EmailMessagesApi = /** @class */ (function (_super) {
396
509
  var _this = this;
397
510
  return (0, exports.EmailMessagesApiFp)(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
398
511
  };
512
+ /**
513
+ * undefined **Required Permissions** none
514
+ * @param {EmailMessagesApiListMessagesRequest} requestParameters Request parameters.
515
+ * @param {*} [options] Override http request option.
516
+ * @throws {RequiredError}
517
+ * @memberof EmailMessagesApi
518
+ */
519
+ EmailMessagesApi.prototype.listMessages = function (requestParameters, options) {
520
+ var _this = this;
521
+ 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); });
523
+ };
399
524
  return EmailMessagesApi;
400
525
  }(base_1.BaseAPI));
401
526
  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",
3
- "version": "0.1.1-beta.5",
3
+ "version": "0.1.1-beta.8",
4
4
  "description": "OpenAPI client for @emilgroup/notification-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [