@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/default-api.js
CHANGED
|
@@ -97,7 +97,8 @@ var DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* Returns the health status of the notification service. This endpoint is used to monitor the operational status of the notification service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
101
|
+
* @summary Health Check
|
|
101
102
|
* @param {*} [options] Override http request option.
|
|
102
103
|
* @throws {RequiredError}
|
|
103
104
|
*/
|
|
@@ -136,7 +137,8 @@ var DefaultApiFp = function (configuration) {
|
|
|
136
137
|
var localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
|
|
137
138
|
return {
|
|
138
139
|
/**
|
|
139
|
-
*
|
|
140
|
+
* Returns the health status of the notification service. This endpoint is used to monitor the operational status of the notification service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
141
|
+
* @summary Health Check
|
|
140
142
|
* @param {*} [options] Override http request option.
|
|
141
143
|
* @throws {RequiredError}
|
|
142
144
|
*/
|
|
@@ -164,7 +166,8 @@ var DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
164
166
|
var localVarFp = (0, exports.DefaultApiFp)(configuration);
|
|
165
167
|
return {
|
|
166
168
|
/**
|
|
167
|
-
*
|
|
169
|
+
* Returns the health status of the notification service. This endpoint is used to monitor the operational status of the notification service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
170
|
+
* @summary Health Check
|
|
168
171
|
* @param {*} [options] Override http request option.
|
|
169
172
|
* @throws {RequiredError}
|
|
170
173
|
*/
|
|
@@ -186,7 +189,8 @@ var DefaultApi = /** @class */ (function (_super) {
|
|
|
186
189
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
187
190
|
}
|
|
188
191
|
/**
|
|
189
|
-
*
|
|
192
|
+
* Returns the health status of the notification service. This endpoint is used to monitor the operational status of the notification service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
193
|
+
* @summary Health Check
|
|
190
194
|
* @param {*} [options] Override http request option.
|
|
191
195
|
* @throws {RequiredError}
|
|
192
196
|
* @memberof DefaultApi
|
|
@@ -22,7 +22,7 @@ import { InitiateEmailVerificationResponseClass } from '../models';
|
|
|
22
22
|
*/
|
|
23
23
|
export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* undefined **Required Permissions** none
|
|
26
26
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
27
27
|
* @param {string} [authorization] Bearer Token
|
|
28
28
|
* @param {*} [options] Override http request option.
|
|
@@ -30,7 +30,7 @@ export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Co
|
|
|
30
30
|
*/
|
|
31
31
|
completeEmailVerification: (completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* undefined **Required Permissions** none
|
|
34
34
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
35
35
|
* @param {string} [authorization] Bearer Token
|
|
36
36
|
* @param {*} [options] Override http request option.
|
|
@@ -44,7 +44,7 @@ export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Co
|
|
|
44
44
|
*/
|
|
45
45
|
export declare const EmailVerificationsApiFp: (configuration?: Configuration) => {
|
|
46
46
|
/**
|
|
47
|
-
*
|
|
47
|
+
* undefined **Required Permissions** none
|
|
48
48
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
49
49
|
* @param {string} [authorization] Bearer Token
|
|
50
50
|
* @param {*} [options] Override http request option.
|
|
@@ -52,7 +52,7 @@ export declare const EmailVerificationsApiFp: (configuration?: Configuration) =>
|
|
|
52
52
|
*/
|
|
53
53
|
completeEmailVerification(completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompleteEmailVerificationResponseClass>>;
|
|
54
54
|
/**
|
|
55
|
-
*
|
|
55
|
+
* undefined **Required Permissions** none
|
|
56
56
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
57
57
|
* @param {string} [authorization] Bearer Token
|
|
58
58
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +66,7 @@ export declare const EmailVerificationsApiFp: (configuration?: Configuration) =>
|
|
|
66
66
|
*/
|
|
67
67
|
export declare const EmailVerificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* undefined **Required Permissions** none
|
|
70
70
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
71
71
|
* @param {string} [authorization] Bearer Token
|
|
72
72
|
* @param {*} [options] Override http request option.
|
|
@@ -74,7 +74,7 @@ export declare const EmailVerificationsApiFactory: (configuration?: Configuratio
|
|
|
74
74
|
*/
|
|
75
75
|
completeEmailVerification(completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: any): AxiosPromise<CompleteEmailVerificationResponseClass>;
|
|
76
76
|
/**
|
|
77
|
-
*
|
|
77
|
+
* undefined **Required Permissions** none
|
|
78
78
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
79
79
|
* @param {string} [authorization] Bearer Token
|
|
80
80
|
* @param {*} [options] Override http request option.
|
|
@@ -128,7 +128,7 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
|
|
|
128
128
|
*/
|
|
129
129
|
export declare class EmailVerificationsApi extends BaseAPI {
|
|
130
130
|
/**
|
|
131
|
-
*
|
|
131
|
+
* undefined **Required Permissions** none
|
|
132
132
|
* @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
|
|
133
133
|
* @param {*} [options] Override http request option.
|
|
134
134
|
* @throws {RequiredError}
|
|
@@ -136,7 +136,7 @@ export declare class EmailVerificationsApi extends BaseAPI {
|
|
|
136
136
|
*/
|
|
137
137
|
completeEmailVerification(requestParameters: EmailVerificationsApiCompleteEmailVerificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompleteEmailVerificationResponseClass, any>>;
|
|
138
138
|
/**
|
|
139
|
-
*
|
|
139
|
+
* undefined **Required Permissions** none
|
|
140
140
|
* @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
|
|
141
141
|
* @param {*} [options] Override http request option.
|
|
142
142
|
* @throws {RequiredError}
|
|
@@ -97,7 +97,7 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* undefined **Required Permissions** none
|
|
101
101
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
102
102
|
* @param {string} [authorization] Bearer Token
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
@@ -145,7 +145,7 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
|
|
|
145
145
|
});
|
|
146
146
|
},
|
|
147
147
|
/**
|
|
148
|
-
*
|
|
148
|
+
* undefined **Required Permissions** none
|
|
149
149
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
150
150
|
* @param {string} [authorization] Bearer Token
|
|
151
151
|
* @param {*} [options] Override http request option.
|
|
@@ -203,7 +203,7 @@ var EmailVerificationsApiFp = function (configuration) {
|
|
|
203
203
|
var localVarAxiosParamCreator = (0, exports.EmailVerificationsApiAxiosParamCreator)(configuration);
|
|
204
204
|
return {
|
|
205
205
|
/**
|
|
206
|
-
*
|
|
206
|
+
* undefined **Required Permissions** none
|
|
207
207
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
208
208
|
* @param {string} [authorization] Bearer Token
|
|
209
209
|
* @param {*} [options] Override http request option.
|
|
@@ -223,7 +223,7 @@ var EmailVerificationsApiFp = function (configuration) {
|
|
|
223
223
|
});
|
|
224
224
|
},
|
|
225
225
|
/**
|
|
226
|
-
*
|
|
226
|
+
* undefined **Required Permissions** none
|
|
227
227
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
228
228
|
* @param {string} [authorization] Bearer Token
|
|
229
229
|
* @param {*} [options] Override http request option.
|
|
@@ -253,7 +253,7 @@ var EmailVerificationsApiFactory = function (configuration, basePath, axios) {
|
|
|
253
253
|
var localVarFp = (0, exports.EmailVerificationsApiFp)(configuration);
|
|
254
254
|
return {
|
|
255
255
|
/**
|
|
256
|
-
*
|
|
256
|
+
* undefined **Required Permissions** none
|
|
257
257
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
258
258
|
* @param {string} [authorization] Bearer Token
|
|
259
259
|
* @param {*} [options] Override http request option.
|
|
@@ -263,7 +263,7 @@ var EmailVerificationsApiFactory = function (configuration, basePath, axios) {
|
|
|
263
263
|
return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
264
264
|
},
|
|
265
265
|
/**
|
|
266
|
-
*
|
|
266
|
+
* undefined **Required Permissions** none
|
|
267
267
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
268
268
|
* @param {string} [authorization] Bearer Token
|
|
269
269
|
* @param {*} [options] Override http request option.
|
|
@@ -287,7 +287,7 @@ var EmailVerificationsApi = /** @class */ (function (_super) {
|
|
|
287
287
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
288
288
|
}
|
|
289
289
|
/**
|
|
290
|
-
*
|
|
290
|
+
* undefined **Required Permissions** none
|
|
291
291
|
* @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
|
|
292
292
|
* @param {*} [options] Override http request option.
|
|
293
293
|
* @throws {RequiredError}
|
|
@@ -298,7 +298,7 @@ var EmailVerificationsApi = /** @class */ (function (_super) {
|
|
|
298
298
|
return (0, exports.EmailVerificationsApiFp)(this.configuration).completeEmailVerification(requestParameters.completeEmailVerificationDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
299
299
|
};
|
|
300
300
|
/**
|
|
301
|
-
*
|
|
301
|
+
* undefined **Required Permissions** none
|
|
302
302
|
* @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
|
|
303
303
|
* @param {*} [options] Override http request option.
|
|
304
304
|
* @throws {RequiredError}
|
|
@@ -24,7 +24,7 @@ import { UpdateLayoutResponseClass } from '../models';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
28
28
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
29
29
|
* @param {string} [authorization] Bearer Token
|
|
30
30
|
* @param {*} [options] Override http request option.
|
|
@@ -32,7 +32,7 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
32
32
|
*/
|
|
33
33
|
createLayout: (createLayoutRequestDto: CreateLayoutRequestDto, 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 LayoutsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
40
40
|
*/
|
|
41
41
|
deleteLayout: (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 Layout id
|
|
46
46
|
* @param {string} [authorization] Bearer Token
|
|
@@ -49,21 +49,21 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
49
49
|
*/
|
|
50
50
|
getLayout: (id: number, id2: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51
51
|
/**
|
|
52
|
-
*
|
|
52
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
53
53
|
* @param {string} [authorization] Bearer Token
|
|
54
|
-
* @param {
|
|
55
|
-
* @param {
|
|
56
|
-
* @param {
|
|
57
|
-
* @param {
|
|
58
|
-
* @param {
|
|
59
|
-
* @param {
|
|
60
|
-
* @param {
|
|
54
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
55
|
+
* @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.
|
|
56
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
57
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
58
|
+
* @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.
|
|
59
|
+
* @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.
|
|
60
|
+
* @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.
|
|
61
61
|
* @param {*} [options] Override http request option.
|
|
62
62
|
* @throws {RequiredError}
|
|
63
63
|
*/
|
|
64
|
-
listLayouts: (authorization?: string, pageSize?:
|
|
64
|
+
listLayouts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
65
|
/**
|
|
66
|
-
*
|
|
66
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
67
67
|
* @param {number} id
|
|
68
68
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
69
69
|
* @param {string} [authorization] Bearer Token
|
|
@@ -78,7 +78,7 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
78
78
|
*/
|
|
79
79
|
export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
80
80
|
/**
|
|
81
|
-
*
|
|
81
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
82
82
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
83
83
|
* @param {string} [authorization] Bearer Token
|
|
84
84
|
* @param {*} [options] Override http request option.
|
|
@@ -86,7 +86,7 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
86
86
|
*/
|
|
87
87
|
createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLayoutResponseClass>>;
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
90
90
|
* @param {number} id
|
|
91
91
|
* @param {string} [authorization] Bearer Token
|
|
92
92
|
* @param {*} [options] Override http request option.
|
|
@@ -94,7 +94,7 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
94
94
|
*/
|
|
95
95
|
deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
96
96
|
/**
|
|
97
|
-
*
|
|
97
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
98
98
|
* @param {number} id
|
|
99
99
|
* @param {number} id2 Layout id
|
|
100
100
|
* @param {string} [authorization] Bearer Token
|
|
@@ -103,21 +103,21 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
103
103
|
*/
|
|
104
104
|
getLayout(id: number, id2: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLayoutResponseClass>>;
|
|
105
105
|
/**
|
|
106
|
-
*
|
|
106
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
107
107
|
* @param {string} [authorization] Bearer Token
|
|
108
|
-
* @param {
|
|
109
|
-
* @param {
|
|
110
|
-
* @param {
|
|
111
|
-
* @param {
|
|
112
|
-
* @param {
|
|
113
|
-
* @param {
|
|
114
|
-
* @param {
|
|
108
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
109
|
+
* @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.
|
|
110
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
111
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
112
|
+
* @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.
|
|
113
|
+
* @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.
|
|
114
|
+
* @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.
|
|
115
115
|
* @param {*} [options] Override http request option.
|
|
116
116
|
* @throws {RequiredError}
|
|
117
117
|
*/
|
|
118
|
-
listLayouts(authorization?: string, pageSize?:
|
|
118
|
+
listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLayoutsResponseClass>>;
|
|
119
119
|
/**
|
|
120
|
-
*
|
|
120
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
121
121
|
* @param {number} id
|
|
122
122
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
123
123
|
* @param {string} [authorization] Bearer Token
|
|
@@ -132,7 +132,7 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
132
132
|
*/
|
|
133
133
|
export declare const LayoutsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
134
134
|
/**
|
|
135
|
-
*
|
|
135
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
136
136
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
137
137
|
* @param {string} [authorization] Bearer Token
|
|
138
138
|
* @param {*} [options] Override http request option.
|
|
@@ -140,7 +140,7 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
|
|
|
140
140
|
*/
|
|
141
141
|
createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLayoutResponseClass>;
|
|
142
142
|
/**
|
|
143
|
-
*
|
|
143
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
144
144
|
* @param {number} id
|
|
145
145
|
* @param {string} [authorization] Bearer Token
|
|
146
146
|
* @param {*} [options] Override http request option.
|
|
@@ -148,7 +148,7 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
|
|
|
148
148
|
*/
|
|
149
149
|
deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<object>;
|
|
150
150
|
/**
|
|
151
|
-
*
|
|
151
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
152
152
|
* @param {number} id
|
|
153
153
|
* @param {number} id2 Layout id
|
|
154
154
|
* @param {string} [authorization] Bearer Token
|
|
@@ -157,21 +157,21 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
|
|
|
157
157
|
*/
|
|
158
158
|
getLayout(id: number, id2: number, authorization?: string, options?: any): AxiosPromise<GetLayoutResponseClass>;
|
|
159
159
|
/**
|
|
160
|
-
*
|
|
160
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
161
161
|
* @param {string} [authorization] Bearer Token
|
|
162
|
-
* @param {
|
|
163
|
-
* @param {
|
|
164
|
-
* @param {
|
|
165
|
-
* @param {
|
|
166
|
-
* @param {
|
|
167
|
-
* @param {
|
|
168
|
-
* @param {
|
|
162
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
163
|
+
* @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.
|
|
164
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
165
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
166
|
+
* @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.
|
|
167
|
+
* @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.
|
|
168
|
+
* @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.
|
|
169
169
|
* @param {*} [options] Override http request option.
|
|
170
170
|
* @throws {RequiredError}
|
|
171
171
|
*/
|
|
172
|
-
listLayouts(authorization?: string, pageSize?:
|
|
172
|
+
listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLayoutsResponseClass>;
|
|
173
173
|
/**
|
|
174
|
-
*
|
|
174
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
175
175
|
* @param {number} id
|
|
176
176
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
177
177
|
* @param {string} [authorization] Bearer Token
|
|
@@ -256,47 +256,47 @@ export interface LayoutsApiListLayoutsRequest {
|
|
|
256
256
|
*/
|
|
257
257
|
readonly authorization?: string;
|
|
258
258
|
/**
|
|
259
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
260
|
-
* @type {
|
|
259
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
260
|
+
* @type {number}
|
|
261
261
|
* @memberof LayoutsApiListLayouts
|
|
262
262
|
*/
|
|
263
|
-
readonly pageSize?:
|
|
263
|
+
readonly pageSize?: number;
|
|
264
264
|
/**
|
|
265
|
-
* 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,
|
|
266
|
-
* @type {
|
|
265
|
+
* 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.
|
|
266
|
+
* @type {string}
|
|
267
267
|
* @memberof LayoutsApiListLayouts
|
|
268
268
|
*/
|
|
269
|
-
readonly pageToken?:
|
|
269
|
+
readonly pageToken?: string;
|
|
270
270
|
/**
|
|
271
271
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
272
|
-
* @type {
|
|
272
|
+
* @type {string}
|
|
273
273
|
* @memberof LayoutsApiListLayouts
|
|
274
274
|
*/
|
|
275
|
-
readonly filter?:
|
|
275
|
+
readonly filter?: string;
|
|
276
276
|
/**
|
|
277
|
-
*
|
|
278
|
-
* @type {
|
|
277
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
278
|
+
* @type {string}
|
|
279
279
|
* @memberof LayoutsApiListLayouts
|
|
280
280
|
*/
|
|
281
|
-
readonly
|
|
281
|
+
readonly search?: string;
|
|
282
282
|
/**
|
|
283
|
-
*
|
|
284
|
-
* @type {
|
|
283
|
+
* 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.
|
|
284
|
+
* @type {string}
|
|
285
285
|
* @memberof LayoutsApiListLayouts
|
|
286
286
|
*/
|
|
287
|
-
readonly
|
|
287
|
+
readonly order?: string;
|
|
288
288
|
/**
|
|
289
|
-
*
|
|
290
|
-
* @type {
|
|
289
|
+
* 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.
|
|
290
|
+
* @type {string}
|
|
291
291
|
* @memberof LayoutsApiListLayouts
|
|
292
292
|
*/
|
|
293
|
-
readonly
|
|
293
|
+
readonly expand?: string;
|
|
294
294
|
/**
|
|
295
|
-
*
|
|
296
|
-
* @type {
|
|
295
|
+
* 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.
|
|
296
|
+
* @type {string}
|
|
297
297
|
* @memberof LayoutsApiListLayouts
|
|
298
298
|
*/
|
|
299
|
-
readonly
|
|
299
|
+
readonly filters?: string;
|
|
300
300
|
}
|
|
301
301
|
/**
|
|
302
302
|
* Request parameters for updateLayout operation in LayoutsApi.
|
|
@@ -331,7 +331,7 @@ export interface LayoutsApiUpdateLayoutRequest {
|
|
|
331
331
|
*/
|
|
332
332
|
export declare class LayoutsApi extends BaseAPI {
|
|
333
333
|
/**
|
|
334
|
-
*
|
|
334
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
335
335
|
* @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
|
|
336
336
|
* @param {*} [options] Override http request option.
|
|
337
337
|
* @throws {RequiredError}
|
|
@@ -339,7 +339,7 @@ export declare class LayoutsApi extends BaseAPI {
|
|
|
339
339
|
*/
|
|
340
340
|
createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLayoutResponseClass, any>>;
|
|
341
341
|
/**
|
|
342
|
-
*
|
|
342
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
343
343
|
* @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
|
|
344
344
|
* @param {*} [options] Override http request option.
|
|
345
345
|
* @throws {RequiredError}
|
|
@@ -347,7 +347,7 @@ export declare class LayoutsApi extends BaseAPI {
|
|
|
347
347
|
*/
|
|
348
348
|
deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
349
349
|
/**
|
|
350
|
-
*
|
|
350
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
351
351
|
* @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
|
|
352
352
|
* @param {*} [options] Override http request option.
|
|
353
353
|
* @throws {RequiredError}
|
|
@@ -355,7 +355,7 @@ export declare class LayoutsApi extends BaseAPI {
|
|
|
355
355
|
*/
|
|
356
356
|
getLayout(requestParameters: LayoutsApiGetLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLayoutResponseClass, any>>;
|
|
357
357
|
/**
|
|
358
|
-
*
|
|
358
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
359
359
|
* @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
|
|
360
360
|
* @param {*} [options] Override http request option.
|
|
361
361
|
* @throws {RequiredError}
|
|
@@ -363,7 +363,7 @@ export declare class LayoutsApi extends BaseAPI {
|
|
|
363
363
|
*/
|
|
364
364
|
listLayouts(requestParameters?: LayoutsApiListLayoutsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLayoutsResponseClass, any>>;
|
|
365
365
|
/**
|
|
366
|
-
*
|
|
366
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
367
367
|
* @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
|
|
368
368
|
* @param {*} [options] Override http request option.
|
|
369
369
|
* @throws {RequiredError}
|