@emilgroup/notification-sdk-node 1.3.0 → 1.4.1-beta.0
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/.openapi-generator/FILES +1 -0
- package/README.md +2 -2
- package/api/default-api.ts +8 -4
- package/api/email-verifications-api.ts +8 -8
- package/api/layouts-api.ts +71 -71
- package/api/notification-templates-api.ts +71 -71
- package/api/notifications-api.ts +4 -4
- package/base.ts +55 -20
- package/common.ts +2 -2
- package/configuration.ts +9 -0
- package/dist/api/default-api.d.ts +8 -4
- package/dist/api/default-api.js +8 -4
- package/dist/api/email-verifications-api.d.ts +8 -8
- package/dist/api/email-verifications-api.js +8 -8
- package/dist/api/layouts-api.d.ts +64 -64
- package/dist/api/layouts-api.js +50 -50
- package/dist/api/notification-templates-api.d.ts +64 -64
- package/dist/api/notification-templates-api.js +50 -50
- package/dist/api/notifications-api.d.ts +4 -4
- package/dist/api/notifications-api.js +4 -4
- package/dist/base.d.ts +13 -5
- package/dist/base.js +64 -30
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +6 -0
- package/dist/configuration.js +8 -0
- package/dist/models/html-template-class.d.ts +0 -6
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/models/initiate-email-verification-dto.d.ts +1 -1
- package/dist/models/inline-response200.d.ts +6 -6
- package/dist/models/inline-response503.d.ts +6 -6
- package/dist/models/s3-document-dto.d.ts +36 -0
- package/dist/models/s3-document-dto.js +15 -0
- package/dist/models/send-notification-request-dto.d.ts +3 -2
- package/models/html-template-class.ts +0 -6
- package/models/index.ts +1 -0
- package/models/initiate-email-verification-dto.ts +1 -1
- package/models/inline-response200.ts +6 -6
- package/models/inline-response503.ts +6 -6
- package/models/s3-document-dto.ts +42 -0
- package/models/send-notification-request-dto.ts +3 -2
- package/package.json +1 -1
- package/tsconfig.json +1 -0
package/dist/api/layouts-api.js
CHANGED
|
@@ -97,7 +97,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
101
101
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
102
102
|
* @param {string} [authorization] Bearer Token
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
@@ -145,7 +145,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
145
145
|
});
|
|
146
146
|
},
|
|
147
147
|
/**
|
|
148
|
-
*
|
|
148
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
149
149
|
* @param {number} id
|
|
150
150
|
* @param {string} [authorization] Bearer Token
|
|
151
151
|
* @param {*} [options] Override http request option.
|
|
@@ -192,7 +192,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
192
192
|
});
|
|
193
193
|
},
|
|
194
194
|
/**
|
|
195
|
-
*
|
|
195
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
196
196
|
* @param {number} id
|
|
197
197
|
* @param {number} id2 Layout id
|
|
198
198
|
* @param {string} [authorization] Bearer Token
|
|
@@ -245,19 +245,19 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
245
245
|
});
|
|
246
246
|
},
|
|
247
247
|
/**
|
|
248
|
-
*
|
|
248
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
249
249
|
* @param {string} [authorization] Bearer Token
|
|
250
|
-
* @param {
|
|
251
|
-
* @param {
|
|
252
|
-
* @param {
|
|
253
|
-
* @param {
|
|
254
|
-
* @param {
|
|
255
|
-
* @param {
|
|
256
|
-
* @param {
|
|
250
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
|
+
* @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.
|
|
252
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
253
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
|
+
* @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.
|
|
255
|
+
* @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.
|
|
256
|
+
* @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.
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
258
258
|
* @throws {RequiredError}
|
|
259
259
|
*/
|
|
260
|
-
listLayouts: function (authorization, pageSize, pageToken, filter,
|
|
260
|
+
listLayouts: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
261
261
|
if (options === void 0) { options = {}; }
|
|
262
262
|
return __awaiter(_this, void 0, void 0, function () {
|
|
263
263
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -289,9 +289,6 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
289
289
|
if (filter !== undefined) {
|
|
290
290
|
localVarQueryParameter['filter'] = filter;
|
|
291
291
|
}
|
|
292
|
-
if (filters !== undefined) {
|
|
293
|
-
localVarQueryParameter['filters'] = filters;
|
|
294
|
-
}
|
|
295
292
|
if (search !== undefined) {
|
|
296
293
|
localVarQueryParameter['search'] = search;
|
|
297
294
|
}
|
|
@@ -301,6 +298,9 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
301
298
|
if (expand !== undefined) {
|
|
302
299
|
localVarQueryParameter['expand'] = expand;
|
|
303
300
|
}
|
|
301
|
+
if (filters !== undefined) {
|
|
302
|
+
localVarQueryParameter['filters'] = filters;
|
|
303
|
+
}
|
|
304
304
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
305
305
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
306
306
|
}
|
|
@@ -316,7 +316,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
316
316
|
});
|
|
317
317
|
},
|
|
318
318
|
/**
|
|
319
|
-
*
|
|
319
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
320
320
|
* @param {number} id
|
|
321
321
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
322
322
|
* @param {string} [authorization] Bearer Token
|
|
@@ -378,7 +378,7 @@ var LayoutsApiFp = function (configuration) {
|
|
|
378
378
|
var localVarAxiosParamCreator = (0, exports.LayoutsApiAxiosParamCreator)(configuration);
|
|
379
379
|
return {
|
|
380
380
|
/**
|
|
381
|
-
*
|
|
381
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
382
382
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
383
383
|
* @param {string} [authorization] Bearer Token
|
|
384
384
|
* @param {*} [options] Override http request option.
|
|
@@ -398,7 +398,7 @@ var LayoutsApiFp = function (configuration) {
|
|
|
398
398
|
});
|
|
399
399
|
},
|
|
400
400
|
/**
|
|
401
|
-
*
|
|
401
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
402
402
|
* @param {number} id
|
|
403
403
|
* @param {string} [authorization] Bearer Token
|
|
404
404
|
* @param {*} [options] Override http request option.
|
|
@@ -418,7 +418,7 @@ var LayoutsApiFp = function (configuration) {
|
|
|
418
418
|
});
|
|
419
419
|
},
|
|
420
420
|
/**
|
|
421
|
-
*
|
|
421
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
422
422
|
* @param {number} id
|
|
423
423
|
* @param {number} id2 Layout id
|
|
424
424
|
* @param {string} [authorization] Bearer Token
|
|
@@ -439,24 +439,24 @@ var LayoutsApiFp = function (configuration) {
|
|
|
439
439
|
});
|
|
440
440
|
},
|
|
441
441
|
/**
|
|
442
|
-
*
|
|
442
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
443
443
|
* @param {string} [authorization] Bearer Token
|
|
444
|
-
* @param {
|
|
445
|
-
* @param {
|
|
446
|
-
* @param {
|
|
447
|
-
* @param {
|
|
448
|
-
* @param {
|
|
449
|
-
* @param {
|
|
450
|
-
* @param {
|
|
444
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
445
|
+
* @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.
|
|
446
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
447
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
448
|
+
* @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.
|
|
449
|
+
* @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.
|
|
450
|
+
* @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.
|
|
451
451
|
* @param {*} [options] Override http request option.
|
|
452
452
|
* @throws {RequiredError}
|
|
453
453
|
*/
|
|
454
|
-
listLayouts: function (authorization, pageSize, pageToken, filter,
|
|
454
|
+
listLayouts: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
455
455
|
return __awaiter(this, void 0, void 0, function () {
|
|
456
456
|
var localVarAxiosArgs;
|
|
457
457
|
return __generator(this, function (_a) {
|
|
458
458
|
switch (_a.label) {
|
|
459
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listLayouts(authorization, pageSize, pageToken, filter,
|
|
459
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
460
460
|
case 1:
|
|
461
461
|
localVarAxiosArgs = _a.sent();
|
|
462
462
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -465,7 +465,7 @@ var LayoutsApiFp = function (configuration) {
|
|
|
465
465
|
});
|
|
466
466
|
},
|
|
467
467
|
/**
|
|
468
|
-
*
|
|
468
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
469
469
|
* @param {number} id
|
|
470
470
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
471
471
|
* @param {string} [authorization] Bearer Token
|
|
@@ -496,7 +496,7 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
496
496
|
var localVarFp = (0, exports.LayoutsApiFp)(configuration);
|
|
497
497
|
return {
|
|
498
498
|
/**
|
|
499
|
-
*
|
|
499
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
500
500
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
501
501
|
* @param {string} [authorization] Bearer Token
|
|
502
502
|
* @param {*} [options] Override http request option.
|
|
@@ -506,7 +506,7 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
506
506
|
return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
507
507
|
},
|
|
508
508
|
/**
|
|
509
|
-
*
|
|
509
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
510
510
|
* @param {number} id
|
|
511
511
|
* @param {string} [authorization] Bearer Token
|
|
512
512
|
* @param {*} [options] Override http request option.
|
|
@@ -516,7 +516,7 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
516
516
|
return localVarFp.deleteLayout(id, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
517
517
|
},
|
|
518
518
|
/**
|
|
519
|
-
*
|
|
519
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
520
520
|
* @param {number} id
|
|
521
521
|
* @param {number} id2 Layout id
|
|
522
522
|
* @param {string} [authorization] Bearer Token
|
|
@@ -527,23 +527,23 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
527
527
|
return localVarFp.getLayout(id, id2, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
528
528
|
},
|
|
529
529
|
/**
|
|
530
|
-
*
|
|
530
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
531
531
|
* @param {string} [authorization] Bearer Token
|
|
532
|
-
* @param {
|
|
533
|
-
* @param {
|
|
534
|
-
* @param {
|
|
535
|
-
* @param {
|
|
536
|
-
* @param {
|
|
537
|
-
* @param {
|
|
538
|
-
* @param {
|
|
532
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
533
|
+
* @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.
|
|
534
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
535
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
536
|
+
* @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.
|
|
537
|
+
* @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.
|
|
538
|
+
* @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.
|
|
539
539
|
* @param {*} [options] Override http request option.
|
|
540
540
|
* @throws {RequiredError}
|
|
541
541
|
*/
|
|
542
|
-
listLayouts: function (authorization, pageSize, pageToken, filter,
|
|
543
|
-
return localVarFp.listLayouts(authorization, pageSize, pageToken, filter,
|
|
542
|
+
listLayouts: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
543
|
+
return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
544
544
|
},
|
|
545
545
|
/**
|
|
546
|
-
*
|
|
546
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
547
547
|
* @param {number} id
|
|
548
548
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
549
549
|
* @param {string} [authorization] Bearer Token
|
|
@@ -568,7 +568,7 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
568
568
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
569
569
|
}
|
|
570
570
|
/**
|
|
571
|
-
*
|
|
571
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
572
572
|
* @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
|
|
573
573
|
* @param {*} [options] Override http request option.
|
|
574
574
|
* @throws {RequiredError}
|
|
@@ -579,7 +579,7 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
579
579
|
return (0, exports.LayoutsApiFp)(this.configuration).createLayout(requestParameters.createLayoutRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
580
580
|
};
|
|
581
581
|
/**
|
|
582
|
-
*
|
|
582
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
583
583
|
* @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
|
|
584
584
|
* @param {*} [options] Override http request option.
|
|
585
585
|
* @throws {RequiredError}
|
|
@@ -590,7 +590,7 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
590
590
|
return (0, exports.LayoutsApiFp)(this.configuration).deleteLayout(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
591
591
|
};
|
|
592
592
|
/**
|
|
593
|
-
*
|
|
593
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
594
594
|
* @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
|
|
595
595
|
* @param {*} [options] Override http request option.
|
|
596
596
|
* @throws {RequiredError}
|
|
@@ -601,7 +601,7 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
601
601
|
return (0, exports.LayoutsApiFp)(this.configuration).getLayout(requestParameters.id, requestParameters.id2, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
602
602
|
};
|
|
603
603
|
/**
|
|
604
|
-
*
|
|
604
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
605
605
|
* @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
|
|
606
606
|
* @param {*} [options] Override http request option.
|
|
607
607
|
* @throws {RequiredError}
|
|
@@ -610,10 +610,10 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
610
610
|
LayoutsApi.prototype.listLayouts = function (requestParameters, options) {
|
|
611
611
|
var _this = this;
|
|
612
612
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
613
|
-
return (0, exports.LayoutsApiFp)(this.configuration).listLayouts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.
|
|
613
|
+
return (0, exports.LayoutsApiFp)(this.configuration).listLayouts(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); });
|
|
614
614
|
};
|
|
615
615
|
/**
|
|
616
|
-
*
|
|
616
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
617
617
|
* @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
|
|
618
618
|
* @param {*} [options] Override http request option.
|
|
619
619
|
* @throws {RequiredError}
|
|
@@ -24,7 +24,7 @@ import { UpdateNotificationTemplateResponseClass } from '../models';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
28
28
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
29
29
|
* @param {string} [authorization] Bearer Token
|
|
30
30
|
* @param {*} [options] Override http request option.
|
|
@@ -32,7 +32,7 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
|
|
|
32
32
|
*/
|
|
33
33
|
createNotificationTemplate: (createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
36
36
|
* @param {number} id
|
|
37
37
|
* @param {string} [authorization] Bearer Token
|
|
38
38
|
* @param {*} [options] Override http request option.
|
|
@@ -40,7 +40,7 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
|
|
|
40
40
|
*/
|
|
41
41
|
deleteNotificationTemplate: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
44
44
|
* @param {number} id
|
|
45
45
|
* @param {number} id2
|
|
46
46
|
* @param {string} [authorization] Bearer Token
|
|
@@ -50,21 +50,21 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
|
|
|
50
50
|
*/
|
|
51
51
|
getNotificationTemplate: (id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
52
|
/**
|
|
53
|
-
*
|
|
53
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
54
54
|
* @param {string} [authorization] Bearer Token
|
|
55
|
-
* @param {
|
|
56
|
-
* @param {
|
|
57
|
-
* @param {
|
|
58
|
-
* @param {
|
|
59
|
-
* @param {
|
|
60
|
-
* @param {
|
|
61
|
-
* @param {
|
|
55
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
56
|
+
* @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.
|
|
57
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
58
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
59
|
+
* @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.
|
|
60
|
+
* @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.
|
|
61
|
+
* @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.
|
|
62
62
|
* @param {*} [options] Override http request option.
|
|
63
63
|
* @throws {RequiredError}
|
|
64
64
|
*/
|
|
65
|
-
listNotificationTemplates: (authorization?: string, pageSize?:
|
|
65
|
+
listNotificationTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
66
|
/**
|
|
67
|
-
*
|
|
67
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
68
68
|
* @param {number} id
|
|
69
69
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
70
70
|
* @param {string} [authorization] Bearer Token
|
|
@@ -79,7 +79,7 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
|
|
|
79
79
|
*/
|
|
80
80
|
export declare const NotificationTemplatesApiFp: (configuration?: Configuration) => {
|
|
81
81
|
/**
|
|
82
|
-
*
|
|
82
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
83
83
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
84
84
|
* @param {string} [authorization] Bearer Token
|
|
85
85
|
* @param {*} [options] Override http request option.
|
|
@@ -87,7 +87,7 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
|
|
|
87
87
|
*/
|
|
88
88
|
createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNotificationTemplateResponseClass>>;
|
|
89
89
|
/**
|
|
90
|
-
*
|
|
90
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
91
91
|
* @param {number} id
|
|
92
92
|
* @param {string} [authorization] Bearer Token
|
|
93
93
|
* @param {*} [options] Override http request option.
|
|
@@ -95,7 +95,7 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
|
|
|
95
95
|
*/
|
|
96
96
|
deleteNotificationTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
97
97
|
/**
|
|
98
|
-
*
|
|
98
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
99
99
|
* @param {number} id
|
|
100
100
|
* @param {number} id2
|
|
101
101
|
* @param {string} [authorization] Bearer Token
|
|
@@ -105,21 +105,21 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
|
|
|
105
105
|
*/
|
|
106
106
|
getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNotificationTemplateResponseClass>>;
|
|
107
107
|
/**
|
|
108
|
-
*
|
|
108
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
109
109
|
* @param {string} [authorization] Bearer Token
|
|
110
|
-
* @param {
|
|
111
|
-
* @param {
|
|
112
|
-
* @param {
|
|
113
|
-
* @param {
|
|
114
|
-
* @param {
|
|
115
|
-
* @param {
|
|
116
|
-
* @param {
|
|
110
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
111
|
+
* @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.
|
|
112
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
113
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
114
|
+
* @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.
|
|
115
|
+
* @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.
|
|
116
|
+
* @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.
|
|
117
117
|
* @param {*} [options] Override http request option.
|
|
118
118
|
* @throws {RequiredError}
|
|
119
119
|
*/
|
|
120
|
-
listNotificationTemplates(authorization?: string, pageSize?:
|
|
120
|
+
listNotificationTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNotificationTemplatesResponseClass>>;
|
|
121
121
|
/**
|
|
122
|
-
*
|
|
122
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
123
123
|
* @param {number} id
|
|
124
124
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
125
125
|
* @param {string} [authorization] Bearer Token
|
|
@@ -134,7 +134,7 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
|
|
|
134
134
|
*/
|
|
135
135
|
export declare const NotificationTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
136
136
|
/**
|
|
137
|
-
*
|
|
137
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
138
138
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
139
139
|
* @param {string} [authorization] Bearer Token
|
|
140
140
|
* @param {*} [options] Override http request option.
|
|
@@ -142,7 +142,7 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
|
|
|
142
142
|
*/
|
|
143
143
|
createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateNotificationTemplateResponseClass>;
|
|
144
144
|
/**
|
|
145
|
-
*
|
|
145
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
146
146
|
* @param {number} id
|
|
147
147
|
* @param {string} [authorization] Bearer Token
|
|
148
148
|
* @param {*} [options] Override http request option.
|
|
@@ -150,7 +150,7 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
|
|
|
150
150
|
*/
|
|
151
151
|
deleteNotificationTemplate(id: number, authorization?: string, options?: any): AxiosPromise<object>;
|
|
152
152
|
/**
|
|
153
|
-
*
|
|
153
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
154
154
|
* @param {number} id
|
|
155
155
|
* @param {number} id2
|
|
156
156
|
* @param {string} [authorization] Bearer Token
|
|
@@ -160,21 +160,21 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
|
|
|
160
160
|
*/
|
|
161
161
|
getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetNotificationTemplateResponseClass>;
|
|
162
162
|
/**
|
|
163
|
-
*
|
|
163
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
164
164
|
* @param {string} [authorization] Bearer Token
|
|
165
|
-
* @param {
|
|
166
|
-
* @param {
|
|
167
|
-
* @param {
|
|
168
|
-
* @param {
|
|
169
|
-
* @param {
|
|
170
|
-
* @param {
|
|
171
|
-
* @param {
|
|
165
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
166
|
+
* @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.
|
|
167
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
168
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
169
|
+
* @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.
|
|
170
|
+
* @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.
|
|
171
|
+
* @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.
|
|
172
172
|
* @param {*} [options] Override http request option.
|
|
173
173
|
* @throws {RequiredError}
|
|
174
174
|
*/
|
|
175
|
-
listNotificationTemplates(authorization?: string, pageSize?:
|
|
175
|
+
listNotificationTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListNotificationTemplatesResponseClass>;
|
|
176
176
|
/**
|
|
177
|
-
*
|
|
177
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
178
178
|
* @param {number} id
|
|
179
179
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
180
180
|
* @param {string} [authorization] Bearer Token
|
|
@@ -265,47 +265,47 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
|
|
|
265
265
|
*/
|
|
266
266
|
readonly authorization?: string;
|
|
267
267
|
/**
|
|
268
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
269
|
-
* @type {
|
|
268
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
269
|
+
* @type {number}
|
|
270
270
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
271
271
|
*/
|
|
272
|
-
readonly pageSize?:
|
|
272
|
+
readonly pageSize?: number;
|
|
273
273
|
/**
|
|
274
|
-
* 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,
|
|
275
|
-
* @type {
|
|
274
|
+
* 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.
|
|
275
|
+
* @type {string}
|
|
276
276
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
277
277
|
*/
|
|
278
|
-
readonly pageToken?:
|
|
278
|
+
readonly pageToken?: string;
|
|
279
279
|
/**
|
|
280
280
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
281
|
-
* @type {
|
|
281
|
+
* @type {string}
|
|
282
282
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
283
283
|
*/
|
|
284
|
-
readonly filter?:
|
|
284
|
+
readonly filter?: string;
|
|
285
285
|
/**
|
|
286
|
-
*
|
|
287
|
-
* @type {
|
|
286
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
287
|
+
* @type {string}
|
|
288
288
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
289
289
|
*/
|
|
290
|
-
readonly
|
|
290
|
+
readonly search?: string;
|
|
291
291
|
/**
|
|
292
|
-
*
|
|
293
|
-
* @type {
|
|
292
|
+
* 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.
|
|
293
|
+
* @type {string}
|
|
294
294
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
295
295
|
*/
|
|
296
|
-
readonly
|
|
296
|
+
readonly order?: string;
|
|
297
297
|
/**
|
|
298
|
-
*
|
|
299
|
-
* @type {
|
|
298
|
+
* 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.
|
|
299
|
+
* @type {string}
|
|
300
300
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
301
301
|
*/
|
|
302
|
-
readonly
|
|
302
|
+
readonly expand?: string;
|
|
303
303
|
/**
|
|
304
|
-
*
|
|
305
|
-
* @type {
|
|
304
|
+
* 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.
|
|
305
|
+
* @type {string}
|
|
306
306
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
307
307
|
*/
|
|
308
|
-
readonly
|
|
308
|
+
readonly filters?: string;
|
|
309
309
|
}
|
|
310
310
|
/**
|
|
311
311
|
* Request parameters for updateNotificationTemplate operation in NotificationTemplatesApi.
|
|
@@ -340,7 +340,7 @@ export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
|
|
|
340
340
|
*/
|
|
341
341
|
export declare class NotificationTemplatesApi extends BaseAPI {
|
|
342
342
|
/**
|
|
343
|
-
*
|
|
343
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
344
344
|
* @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
|
|
345
345
|
* @param {*} [options] Override http request option.
|
|
346
346
|
* @throws {RequiredError}
|
|
@@ -348,7 +348,7 @@ export declare class NotificationTemplatesApi extends BaseAPI {
|
|
|
348
348
|
*/
|
|
349
349
|
createNotificationTemplate(requestParameters: NotificationTemplatesApiCreateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateNotificationTemplateResponseClass, any>>;
|
|
350
350
|
/**
|
|
351
|
-
*
|
|
351
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
352
352
|
* @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
|
|
353
353
|
* @param {*} [options] Override http request option.
|
|
354
354
|
* @throws {RequiredError}
|
|
@@ -356,7 +356,7 @@ export declare class NotificationTemplatesApi extends BaseAPI {
|
|
|
356
356
|
*/
|
|
357
357
|
deleteNotificationTemplate(requestParameters: NotificationTemplatesApiDeleteNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
358
358
|
/**
|
|
359
|
-
*
|
|
359
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
360
360
|
* @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
|
|
361
361
|
* @param {*} [options] Override http request option.
|
|
362
362
|
* @throws {RequiredError}
|
|
@@ -364,7 +364,7 @@ export declare class NotificationTemplatesApi extends BaseAPI {
|
|
|
364
364
|
*/
|
|
365
365
|
getNotificationTemplate(requestParameters: NotificationTemplatesApiGetNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNotificationTemplateResponseClass, any>>;
|
|
366
366
|
/**
|
|
367
|
-
*
|
|
367
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
368
368
|
* @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
|
|
369
369
|
* @param {*} [options] Override http request option.
|
|
370
370
|
* @throws {RequiredError}
|
|
@@ -372,7 +372,7 @@ export declare class NotificationTemplatesApi extends BaseAPI {
|
|
|
372
372
|
*/
|
|
373
373
|
listNotificationTemplates(requestParameters?: NotificationTemplatesApiListNotificationTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNotificationTemplatesResponseClass, any>>;
|
|
374
374
|
/**
|
|
375
|
-
*
|
|
375
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
376
376
|
* @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
|
|
377
377
|
* @param {*} [options] Override http request option.
|
|
378
378
|
* @throws {RequiredError}
|