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

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.16 --save
20
+ npm install @emilgroup/notification-sdk@0.1.1-beta.5 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/notification-sdk@0.1.1-beta.16
24
+ yarn add @emilgroup/notification-sdk@0.1.1-beta.5
25
25
  ```
26
26
 
27
27
  And then you can import ``.
@@ -26,8 +26,6 @@ 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';
31
29
  /**
32
30
  * EmailMessagesApi - axios parameter creator
33
31
  * @export
@@ -35,7 +33,7 @@ import { ListEmailMessagesResponseClass } from '../models';
35
33
  export const EmailMessagesApiAxiosParamCreator = function (configuration?: Configuration) {
36
34
  return {
37
35
  /**
38
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
36
+ * undefined **Required Permissions** none
39
37
  * @param {string} code
40
38
  * @param {number} attachmentId
41
39
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -83,7 +81,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
83
81
  };
84
82
  },
85
83
  /**
86
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
84
+ * undefined **Required Permissions** none
87
85
  * @param {string} code
88
86
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
87
  * @param {*} [options] Override http request option.
@@ -127,7 +125,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
127
125
  };
128
126
  },
129
127
  /**
130
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
128
+ * undefined **Required Permissions** none
131
129
  * @param {string} code
132
130
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
133
131
  * @param {*} [options] Override http request option.
@@ -161,82 +159,6 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
161
159
 
162
160
 
163
161
 
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
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
175
- * @summary List email messages
176
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
177
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
178
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
179
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
180
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
181
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
182
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
183
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
184
- * @param {*} [options] Override http request option.
185
- * @throws {RequiredError}
186
- */
187
- listEmailMessages: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
188
- const localVarPath = `/notificationservice/v1/email-messages`;
189
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
190
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
191
- let baseOptions;
192
- let baseAccessToken;
193
- if (configuration) {
194
- baseOptions = configuration.baseOptions;
195
- baseAccessToken = configuration.accessToken;
196
- }
197
-
198
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
199
- const localVarHeaderParameter = {} as any;
200
- const localVarQueryParameter = {} as any;
201
-
202
- // authentication bearer required
203
- // http bearer authentication required
204
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
205
-
206
- if (pageSize !== undefined) {
207
- localVarQueryParameter['pageSize'] = pageSize;
208
- }
209
-
210
- if (pageToken !== undefined) {
211
- localVarQueryParameter['pageToken'] = pageToken;
212
- }
213
-
214
- if (filter !== undefined) {
215
- localVarQueryParameter['filter'] = filter;
216
- }
217
-
218
- if (search !== undefined) {
219
- localVarQueryParameter['search'] = search;
220
- }
221
-
222
- if (order !== undefined) {
223
- localVarQueryParameter['order'] = order;
224
- }
225
-
226
- if (expand !== undefined) {
227
- localVarQueryParameter['expand'] = expand;
228
- }
229
-
230
- if (filters !== undefined) {
231
- localVarQueryParameter['filters'] = filters;
232
- }
233
-
234
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
235
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
236
- }
237
-
238
-
239
-
240
162
  setSearchParams(localVarUrlObj, localVarQueryParameter);
241
163
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
242
164
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -257,7 +179,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
257
179
  const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
258
180
  return {
259
181
  /**
260
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
182
+ * undefined **Required Permissions** none
261
183
  * @param {string} code
262
184
  * @param {number} attachmentId
263
185
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -269,7 +191,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
269
191
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
270
192
  },
271
193
  /**
272
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
194
+ * undefined **Required Permissions** none
273
195
  * @param {string} code
274
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
275
197
  * @param {*} [options] Override http request option.
@@ -280,7 +202,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
280
202
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
281
203
  },
282
204
  /**
283
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
205
+ * undefined **Required Permissions** none
284
206
  * @param {string} code
285
207
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
286
208
  * @param {*} [options] Override http request option.
@@ -290,24 +212,6 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
290
212
  const localVarAxiosArgs = await localVarAxiosParamCreator.listAttachments(code, authorization, options);
291
213
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
292
214
  },
293
- /**
294
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
295
- * @summary List email messages
296
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
297
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
298
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
299
- * @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;
300
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
301
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&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;
302
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
303
- * @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;
304
- * @param {*} [options] Override http request option.
305
- * @throws {RequiredError}
306
- */
307
- async 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>> {
308
- const localVarAxiosArgs = await localVarAxiosParamCreator.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
309
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
310
- },
311
215
  }
312
216
  };
313
217
 
@@ -319,7 +223,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
319
223
  const localVarFp = EmailMessagesApiFp(configuration)
320
224
  return {
321
225
  /**
322
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
226
+ * undefined **Required Permissions** none
323
227
  * @param {string} code
324
228
  * @param {number} attachmentId
325
229
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -330,7 +234,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
330
234
  return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
331
235
  },
332
236
  /**
333
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
237
+ * undefined **Required Permissions** none
334
238
  * @param {string} code
335
239
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
336
240
  * @param {*} [options] Override http request option.
@@ -340,7 +244,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
340
244
  return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
341
245
  },
342
246
  /**
343
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
247
+ * undefined **Required Permissions** none
344
248
  * @param {string} code
345
249
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
346
250
  * @param {*} [options] Override http request option.
@@ -349,23 +253,6 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
349
253
  listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass> {
350
254
  return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
351
255
  },
352
- /**
353
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
354
- * @summary List email messages
355
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
356
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
357
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
358
- * @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;
359
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
360
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&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;
361
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
362
- * @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;
363
- * @param {*} [options] Override http request option.
364
- * @throws {RequiredError}
365
- */
366
- listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
367
- return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
368
- },
369
256
  };
370
257
  };
371
258
 
@@ -439,69 +326,6 @@ export interface EmailMessagesApiListAttachmentsRequest {
439
326
  readonly authorization?: string
440
327
  }
441
328
 
442
- /**
443
- * Request parameters for listEmailMessages operation in EmailMessagesApi.
444
- * @export
445
- * @interface EmailMessagesApiListEmailMessagesRequest
446
- */
447
- export interface EmailMessagesApiListEmailMessagesRequest {
448
- /**
449
- * Bearer Token: provided by the login endpoint under the name accessToken.
450
- * @type {string}
451
- * @memberof EmailMessagesApiListEmailMessages
452
- */
453
- readonly authorization?: string
454
-
455
- /**
456
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
457
- * @type {number}
458
- * @memberof EmailMessagesApiListEmailMessages
459
- */
460
- readonly pageSize?: number
461
-
462
- /**
463
- * 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.
464
- * @type {string}
465
- * @memberof EmailMessagesApiListEmailMessages
466
- */
467
- readonly pageToken?: string
468
-
469
- /**
470
- * 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;
471
- * @type {string}
472
- * @memberof EmailMessagesApiListEmailMessages
473
- */
474
- readonly filter?: string
475
-
476
- /**
477
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
478
- * @type {string}
479
- * @memberof EmailMessagesApiListEmailMessages
480
- */
481
- readonly search?: string
482
-
483
- /**
484
- * 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;
485
- * @type {string}
486
- * @memberof EmailMessagesApiListEmailMessages
487
- */
488
- readonly order?: string
489
-
490
- /**
491
- * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
492
- * @type {string}
493
- * @memberof EmailMessagesApiListEmailMessages
494
- */
495
- readonly expand?: string
496
-
497
- /**
498
- * 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;
499
- * @type {string}
500
- * @memberof EmailMessagesApiListEmailMessages
501
- */
502
- readonly filters?: string
503
- }
504
-
505
329
  /**
506
330
  * EmailMessagesApi - object-oriented interface
507
331
  * @export
@@ -510,7 +334,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
510
334
  */
511
335
  export class EmailMessagesApi extends BaseAPI {
512
336
  /**
513
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
337
+ * undefined **Required Permissions** none
514
338
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
515
339
  * @param {*} [options] Override http request option.
516
340
  * @throws {RequiredError}
@@ -521,7 +345,7 @@ export class EmailMessagesApi extends BaseAPI {
521
345
  }
522
346
 
523
347
  /**
524
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
348
+ * undefined **Required Permissions** none
525
349
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
526
350
  * @param {*} [options] Override http request option.
527
351
  * @throws {RequiredError}
@@ -532,7 +356,7 @@ export class EmailMessagesApi extends BaseAPI {
532
356
  }
533
357
 
534
358
  /**
535
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
359
+ * undefined **Required Permissions** none
536
360
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
537
361
  * @param {*} [options] Override http request option.
538
362
  * @throws {RequiredError}
@@ -541,16 +365,4 @@ export class EmailMessagesApi extends BaseAPI {
541
365
  public listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig) {
542
366
  return EmailMessagesApiFp(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
543
367
  }
544
-
545
- /**
546
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
547
- * @summary List email messages
548
- * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
549
- * @param {*} [options] Override http request option.
550
- * @throws {RequiredError}
551
- * @memberof EmailMessagesApi
552
- */
553
- public listEmailMessages(requestParameters: EmailMessagesApiListEmailMessagesRequest = {}, options?: AxiosRequestConfig) {
554
- return EmailMessagesApiFp(this.configuration).listEmailMessages(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
- }
556
368
  }