@emilgroup/notification-sdk 0.1.1-beta.8 → 0.1.1-beta.9
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 +2 -2
- package/api/email-messages-api.ts +19 -19
- package/dist/api/email-messages-api.d.ts +16 -16
- package/dist/api/email-messages-api.js +8 -8
- package/package.json +1 -1
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.
|
|
20
|
+
npm install @emilgroup/notification-sdk@0.1.1-beta.9 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/notification-sdk@0.1.1-beta.
|
|
24
|
+
yarn add @emilgroup/notification-sdk@0.1.1-beta.9
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -183,7 +183,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
186
|
-
|
|
186
|
+
listEmailMessages: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
187
187
|
const localVarPath = `/notificationservice/v1/email-messages`;
|
|
188
188
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
189
189
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -302,8 +302,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
302
302
|
* @param {*} [options] Override http request option.
|
|
303
303
|
* @throws {RequiredError}
|
|
304
304
|
*/
|
|
305
|
-
async
|
|
306
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
305
|
+
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>> {
|
|
306
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
307
307
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
308
308
|
},
|
|
309
309
|
}
|
|
@@ -360,8 +360,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
360
360
|
* @param {*} [options] Override http request option.
|
|
361
361
|
* @throws {RequiredError}
|
|
362
362
|
*/
|
|
363
|
-
|
|
364
|
-
return localVarFp.
|
|
363
|
+
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
|
|
364
|
+
return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
365
365
|
},
|
|
366
366
|
};
|
|
367
367
|
};
|
|
@@ -437,64 +437,64 @@ export interface EmailMessagesApiListAttachmentsRequest {
|
|
|
437
437
|
}
|
|
438
438
|
|
|
439
439
|
/**
|
|
440
|
-
* Request parameters for
|
|
440
|
+
* Request parameters for listEmailMessages operation in EmailMessagesApi.
|
|
441
441
|
* @export
|
|
442
|
-
* @interface
|
|
442
|
+
* @interface EmailMessagesApiListEmailMessagesRequest
|
|
443
443
|
*/
|
|
444
|
-
export interface
|
|
444
|
+
export interface EmailMessagesApiListEmailMessagesRequest {
|
|
445
445
|
/**
|
|
446
446
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
447
447
|
* @type {string}
|
|
448
|
-
* @memberof
|
|
448
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
449
449
|
*/
|
|
450
450
|
readonly authorization?: string
|
|
451
451
|
|
|
452
452
|
/**
|
|
453
453
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
454
454
|
* @type {number}
|
|
455
|
-
* @memberof
|
|
455
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
456
456
|
*/
|
|
457
457
|
readonly pageSize?: number
|
|
458
458
|
|
|
459
459
|
/**
|
|
460
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
461
461
|
* @type {string}
|
|
462
|
-
* @memberof
|
|
462
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
463
463
|
*/
|
|
464
464
|
readonly pageToken?: string
|
|
465
465
|
|
|
466
466
|
/**
|
|
467
467
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
468
468
|
* @type {string}
|
|
469
|
-
* @memberof
|
|
469
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
470
470
|
*/
|
|
471
471
|
readonly filter?: string
|
|
472
472
|
|
|
473
473
|
/**
|
|
474
474
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
475
475
|
* @type {string}
|
|
476
|
-
* @memberof
|
|
476
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
477
477
|
*/
|
|
478
478
|
readonly search?: string
|
|
479
479
|
|
|
480
480
|
/**
|
|
481
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
482
|
* @type {string}
|
|
483
|
-
* @memberof
|
|
483
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
484
484
|
*/
|
|
485
485
|
readonly order?: string
|
|
486
486
|
|
|
487
487
|
/**
|
|
488
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
489
|
* @type {string}
|
|
490
|
-
* @memberof
|
|
490
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
491
491
|
*/
|
|
492
492
|
readonly expand?: string
|
|
493
493
|
|
|
494
494
|
/**
|
|
495
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
496
|
* @type {string}
|
|
497
|
-
* @memberof
|
|
497
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
498
498
|
*/
|
|
499
499
|
readonly filters?: string
|
|
500
500
|
}
|
|
@@ -541,12 +541,12 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
541
541
|
|
|
542
542
|
/**
|
|
543
543
|
* undefined **Required Permissions** none
|
|
544
|
-
* @param {
|
|
544
|
+
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
545
545
|
* @param {*} [options] Override http request option.
|
|
546
546
|
* @throws {RequiredError}
|
|
547
547
|
* @memberof EmailMessagesApi
|
|
548
548
|
*/
|
|
549
|
-
public
|
|
550
|
-
return EmailMessagesApiFp(this.configuration).
|
|
549
|
+
public listEmailMessages(requestParameters: EmailMessagesApiListEmailMessagesRequest = {}, options?: AxiosRequestConfig) {
|
|
550
|
+
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));
|
|
551
551
|
}
|
|
552
552
|
}
|
|
@@ -59,7 +59,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
59
59
|
* @param {*} [options] Override http request option.
|
|
60
60
|
* @throws {RequiredError}
|
|
61
61
|
*/
|
|
62
|
-
|
|
62
|
+
listEmailMessages: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
63
63
|
};
|
|
64
64
|
/**
|
|
65
65
|
* EmailMessagesApi - functional programming interface
|
|
@@ -104,7 +104,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
104
104
|
* @param {*} [options] Override http request option.
|
|
105
105
|
* @throws {RequiredError}
|
|
106
106
|
*/
|
|
107
|
-
|
|
107
|
+
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
|
|
108
108
|
};
|
|
109
109
|
/**
|
|
110
110
|
* EmailMessagesApi - factory interface
|
|
@@ -149,7 +149,7 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
149
149
|
* @param {*} [options] Override http request option.
|
|
150
150
|
* @throws {RequiredError}
|
|
151
151
|
*/
|
|
152
|
-
|
|
152
|
+
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
|
|
153
153
|
};
|
|
154
154
|
/**
|
|
155
155
|
* Request parameters for downloadAttachment operation in EmailMessagesApi.
|
|
@@ -215,57 +215,57 @@ export interface EmailMessagesApiListAttachmentsRequest {
|
|
|
215
215
|
readonly authorization?: string;
|
|
216
216
|
}
|
|
217
217
|
/**
|
|
218
|
-
* Request parameters for
|
|
218
|
+
* Request parameters for listEmailMessages operation in EmailMessagesApi.
|
|
219
219
|
* @export
|
|
220
|
-
* @interface
|
|
220
|
+
* @interface EmailMessagesApiListEmailMessagesRequest
|
|
221
221
|
*/
|
|
222
|
-
export interface
|
|
222
|
+
export interface EmailMessagesApiListEmailMessagesRequest {
|
|
223
223
|
/**
|
|
224
224
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
225
225
|
* @type {string}
|
|
226
|
-
* @memberof
|
|
226
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
227
227
|
*/
|
|
228
228
|
readonly authorization?: string;
|
|
229
229
|
/**
|
|
230
230
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
231
231
|
* @type {number}
|
|
232
|
-
* @memberof
|
|
232
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
233
233
|
*/
|
|
234
234
|
readonly pageSize?: number;
|
|
235
235
|
/**
|
|
236
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
237
237
|
* @type {string}
|
|
238
|
-
* @memberof
|
|
238
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
239
239
|
*/
|
|
240
240
|
readonly pageToken?: string;
|
|
241
241
|
/**
|
|
242
242
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
243
243
|
* @type {string}
|
|
244
|
-
* @memberof
|
|
244
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
245
245
|
*/
|
|
246
246
|
readonly filter?: string;
|
|
247
247
|
/**
|
|
248
248
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
249
249
|
* @type {string}
|
|
250
|
-
* @memberof
|
|
250
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
251
251
|
*/
|
|
252
252
|
readonly search?: string;
|
|
253
253
|
/**
|
|
254
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
255
|
* @type {string}
|
|
256
|
-
* @memberof
|
|
256
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
257
257
|
*/
|
|
258
258
|
readonly order?: string;
|
|
259
259
|
/**
|
|
260
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
261
|
* @type {string}
|
|
262
|
-
* @memberof
|
|
262
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
263
263
|
*/
|
|
264
264
|
readonly expand?: string;
|
|
265
265
|
/**
|
|
266
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
267
|
* @type {string}
|
|
268
|
-
* @memberof
|
|
268
|
+
* @memberof EmailMessagesApiListEmailMessages
|
|
269
269
|
*/
|
|
270
270
|
readonly filters?: string;
|
|
271
271
|
}
|
|
@@ -302,10 +302,10 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
302
302
|
listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailAttachmentsResponseClass, any, {}>>;
|
|
303
303
|
/**
|
|
304
304
|
* undefined **Required Permissions** none
|
|
305
|
-
* @param {
|
|
305
|
+
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
306
306
|
* @param {*} [options] Override http request option.
|
|
307
307
|
* @throws {RequiredError}
|
|
308
308
|
* @memberof EmailMessagesApi
|
|
309
309
|
*/
|
|
310
|
-
|
|
310
|
+
listEmailMessages(requestParameters?: EmailMessagesApiListEmailMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
|
|
311
311
|
}
|
|
@@ -250,7 +250,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
250
250
|
* @param {*} [options] Override http request option.
|
|
251
251
|
* @throws {RequiredError}
|
|
252
252
|
*/
|
|
253
|
-
|
|
253
|
+
listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
254
254
|
if (options === void 0) { options = {}; }
|
|
255
255
|
return __awaiter(_this, void 0, void 0, function () {
|
|
256
256
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -392,12 +392,12 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
392
392
|
* @param {*} [options] Override http request option.
|
|
393
393
|
* @throws {RequiredError}
|
|
394
394
|
*/
|
|
395
|
-
|
|
395
|
+
listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
396
396
|
return __awaiter(this, void 0, void 0, function () {
|
|
397
397
|
var localVarAxiosArgs;
|
|
398
398
|
return __generator(this, function (_a) {
|
|
399
399
|
switch (_a.label) {
|
|
400
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
400
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
401
401
|
case 1:
|
|
402
402
|
localVarAxiosArgs = _a.sent();
|
|
403
403
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -459,8 +459,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
459
459
|
* @param {*} [options] Override http request option.
|
|
460
460
|
* @throws {RequiredError}
|
|
461
461
|
*/
|
|
462
|
-
|
|
463
|
-
return localVarFp.
|
|
462
|
+
listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
463
|
+
return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
464
464
|
},
|
|
465
465
|
};
|
|
466
466
|
};
|
|
@@ -511,15 +511,15 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
511
511
|
};
|
|
512
512
|
/**
|
|
513
513
|
* undefined **Required Permissions** none
|
|
514
|
-
* @param {
|
|
514
|
+
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
515
515
|
* @param {*} [options] Override http request option.
|
|
516
516
|
* @throws {RequiredError}
|
|
517
517
|
* @memberof EmailMessagesApi
|
|
518
518
|
*/
|
|
519
|
-
EmailMessagesApi.prototype.
|
|
519
|
+
EmailMessagesApi.prototype.listEmailMessages = function (requestParameters, options) {
|
|
520
520
|
var _this = this;
|
|
521
521
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
522
|
-
return (0, exports.EmailMessagesApiFp)(this.configuration).
|
|
522
|
+
return (0, exports.EmailMessagesApiFp)(this.configuration).listEmailMessages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
523
523
|
};
|
|
524
524
|
return EmailMessagesApi;
|
|
525
525
|
}(base_1.BaseAPI));
|