@emilgroup/notification-sdk 0.8.1-beta.6 → 0.8.1-beta.60
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 +23 -0
- package/README.md +2 -2
- package/api/email-mailboxes-api.ts +150 -0
- package/api/email-messages-api.ts +56 -36
- package/api/email-subscriptions-api.ts +781 -0
- package/api/email-tracking-api.ts +291 -48
- package/api/email-verifications-api.ts +24 -12
- package/api/layouts-api.ts +76 -46
- package/api/msgraph-webhooks-api.ts +278 -0
- package/api/notification-templates-api.ts +76 -46
- package/api/notifications-api.ts +121 -6
- package/api.ts +6 -0
- package/base.ts +174 -41
- package/common.ts +3 -2
- package/configuration.ts +20 -0
- package/dist/api/email-mailboxes-api.d.ts +87 -0
- package/dist/api/email-mailboxes-api.js +221 -0
- package/dist/api/email-messages-api.d.ts +44 -32
- package/dist/api/email-messages-api.js +62 -40
- package/dist/api/email-subscriptions-api.d.ts +432 -0
- package/dist/api/email-subscriptions-api.js +738 -0
- package/dist/api/email-tracking-api.d.ts +174 -44
- package/dist/api/email-tracking-api.js +261 -48
- package/dist/api/email-verifications-api.d.ts +18 -10
- package/dist/api/email-verifications-api.js +30 -16
- package/dist/api/health-api.d.ts +1 -1
- package/dist/api/layouts-api.d.ts +61 -41
- package/dist/api/layouts-api.js +81 -50
- package/dist/api/msgraph-webhooks-api.d.ts +168 -0
- package/dist/api/msgraph-webhooks-api.js +305 -0
- package/dist/api/notification-templates-api.d.ts +61 -41
- package/dist/api/notification-templates-api.js +81 -50
- package/dist/api/notifications-api.d.ts +66 -5
- package/dist/api/notifications-api.js +111 -8
- package/dist/api.d.ts +3 -0
- package/dist/api.js +3 -0
- package/dist/base.d.ts +24 -0
- package/dist/base.js +178 -59
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -0
- package/dist/configuration.d.ts +17 -0
- package/dist/configuration.js +2 -0
- package/dist/models/assign-email-thread-entity-body-dto.d.ts +43 -0
- package/dist/models/assign-email-thread-entity-body-dto.js +22 -0
- package/dist/models/assign-email-thread-entity-response-class.d.ts +25 -0
- package/dist/models/assign-email-thread-entity-response-class.js +15 -0
- package/dist/models/catch-up-email-subscription-response-class.d.ts +24 -0
- package/dist/models/catch-up-email-subscription-response-class.js +15 -0
- package/dist/models/catch-up-email-subscriptions-request-dto.d.ts +24 -0
- package/dist/models/catch-up-email-subscriptions-request-dto.js +15 -0
- package/dist/models/catch-up-email-subscriptions-response-class.d.ts +30 -0
- package/dist/models/catch-up-email-subscriptions-response-class.js +15 -0
- package/dist/models/email-mailbox-class.d.ts +47 -0
- package/dist/models/email-mailbox-class.js +20 -0
- package/dist/models/email-message-class.d.ts +73 -7
- package/dist/models/email-message-class.js +22 -3
- package/dist/models/email-message-summary-class.d.ts +98 -0
- package/dist/models/email-message-summary-class.js +33 -0
- package/dist/models/email-subscription-class.d.ts +110 -0
- package/dist/models/email-subscription-class.js +23 -0
- package/dist/models/email-thread-class.d.ts +37 -5
- package/dist/models/entity-ref-class.d.ts +37 -0
- package/dist/models/entity-ref-class.js +22 -0
- package/dist/models/get-email-subscription-response-class.d.ts +25 -0
- package/dist/models/get-email-subscription-response-class.js +15 -0
- package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
- package/dist/models/grpc-send-email-request-dto.js +22 -0
- package/dist/models/index.d.ts +20 -0
- package/dist/models/index.js +20 -0
- package/dist/models/inline-attachment-dto.d.ts +36 -0
- package/dist/models/inline-attachment-dto.js +15 -0
- package/dist/models/list-email-mailboxes-response-class.d.ts +43 -0
- package/dist/models/list-email-mailboxes-response-class.js +15 -0
- package/dist/models/list-email-subscriptions-response-class.d.ts +43 -0
- package/dist/models/list-email-subscriptions-response-class.js +15 -0
- package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +24 -0
- package/dist/models/reconcile-email-subscriptions-request-dto.js +15 -0
- package/dist/models/reconcile-email-subscriptions-response-class.d.ts +48 -0
- package/dist/models/reconcile-email-subscriptions-response-class.js +15 -0
- package/dist/models/renew-email-subscription-response-class.d.ts +25 -0
- package/dist/models/renew-email-subscription-response-class.js +15 -0
- package/dist/models/send-email-request-dto.d.ts +131 -0
- package/dist/models/send-email-request-dto.js +22 -0
- package/dist/models/send-email-response-class.d.ts +24 -0
- package/dist/models/send-email-response-class.js +15 -0
- package/dist/models/send-notification-request-dto.d.ts +10 -1
- package/dist/models/send-notification-request-dto.js +2 -1
- package/dist/models/unassign-email-thread-entity-response-class.d.ts +25 -0
- package/dist/models/unassign-email-thread-entity-response-class.js +15 -0
- package/models/assign-email-thread-entity-body-dto.ts +52 -0
- package/models/assign-email-thread-entity-response-class.ts +31 -0
- package/models/catch-up-email-subscription-response-class.ts +30 -0
- package/models/catch-up-email-subscriptions-request-dto.ts +30 -0
- package/models/catch-up-email-subscriptions-response-class.ts +36 -0
- package/models/email-mailbox-class.ts +56 -0
- package/models/email-message-class.ts +78 -8
- package/models/email-message-summary-class.ts +109 -0
- package/models/email-subscription-class.ts +119 -0
- package/models/email-thread-class.ts +37 -5
- package/models/entity-ref-class.ts +46 -0
- package/models/get-email-subscription-response-class.ts +31 -0
- package/models/grpc-send-email-request-dto.ts +144 -0
- package/models/index.ts +20 -0
- package/models/inline-attachment-dto.ts +42 -0
- package/models/list-email-mailboxes-response-class.ts +49 -0
- package/models/list-email-subscriptions-response-class.ts +49 -0
- package/models/reconcile-email-subscriptions-request-dto.ts +30 -0
- package/models/reconcile-email-subscriptions-response-class.ts +54 -0
- package/models/renew-email-subscription-response-class.ts +31 -0
- package/models/send-email-request-dto.ts +138 -0
- package/models/send-email-response-class.ts +30 -0
- package/models/send-notification-request-dto.ts +9 -2
- package/models/unassign-email-thread-entity-response-class.ts +31 -0
- package/package.json +2 -2
|
@@ -22,7 +22,8 @@ import { InitiateEmailVerificationResponseClass } from '../models';
|
|
|
22
22
|
*/
|
|
23
23
|
export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
26
|
+
* @summary Complete an email verification
|
|
26
27
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
27
28
|
* @param {string} [authorization] Bearer Token
|
|
28
29
|
* @param {*} [options] Override http request option.
|
|
@@ -30,7 +31,8 @@ export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Co
|
|
|
30
31
|
*/
|
|
31
32
|
completeEmailVerification: (completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
33
|
/**
|
|
33
|
-
*
|
|
34
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
35
|
+
* @summary Initiate an email verification
|
|
34
36
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
35
37
|
* @param {string} [authorization] Bearer Token
|
|
36
38
|
* @param {*} [options] Override http request option.
|
|
@@ -44,7 +46,8 @@ export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Co
|
|
|
44
46
|
*/
|
|
45
47
|
export declare const EmailVerificationsApiFp: (configuration?: Configuration) => {
|
|
46
48
|
/**
|
|
47
|
-
*
|
|
49
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
50
|
+
* @summary Complete an email verification
|
|
48
51
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
49
52
|
* @param {string} [authorization] Bearer Token
|
|
50
53
|
* @param {*} [options] Override http request option.
|
|
@@ -52,7 +55,8 @@ export declare const EmailVerificationsApiFp: (configuration?: Configuration) =>
|
|
|
52
55
|
*/
|
|
53
56
|
completeEmailVerification(completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompleteEmailVerificationResponseClass>>;
|
|
54
57
|
/**
|
|
55
|
-
*
|
|
58
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
59
|
+
* @summary Initiate an email verification
|
|
56
60
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
57
61
|
* @param {string} [authorization] Bearer Token
|
|
58
62
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +70,8 @@ export declare const EmailVerificationsApiFp: (configuration?: Configuration) =>
|
|
|
66
70
|
*/
|
|
67
71
|
export declare const EmailVerificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
68
72
|
/**
|
|
69
|
-
*
|
|
73
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
74
|
+
* @summary Complete an email verification
|
|
70
75
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
71
76
|
* @param {string} [authorization] Bearer Token
|
|
72
77
|
* @param {*} [options] Override http request option.
|
|
@@ -74,7 +79,8 @@ export declare const EmailVerificationsApiFactory: (configuration?: Configuratio
|
|
|
74
79
|
*/
|
|
75
80
|
completeEmailVerification(completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: any): AxiosPromise<CompleteEmailVerificationResponseClass>;
|
|
76
81
|
/**
|
|
77
|
-
*
|
|
82
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
83
|
+
* @summary Initiate an email verification
|
|
78
84
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
79
85
|
* @param {string} [authorization] Bearer Token
|
|
80
86
|
* @param {*} [options] Override http request option.
|
|
@@ -128,19 +134,21 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
|
|
|
128
134
|
*/
|
|
129
135
|
export declare class EmailVerificationsApi extends BaseAPI {
|
|
130
136
|
/**
|
|
131
|
-
*
|
|
137
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
138
|
+
* @summary Complete an email verification
|
|
132
139
|
* @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
|
|
133
140
|
* @param {*} [options] Override http request option.
|
|
134
141
|
* @throws {RequiredError}
|
|
135
142
|
* @memberof EmailVerificationsApi
|
|
136
143
|
*/
|
|
137
|
-
completeEmailVerification(requestParameters: EmailVerificationsApiCompleteEmailVerificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompleteEmailVerificationResponseClass, any, {}>>;
|
|
144
|
+
completeEmailVerification(requestParameters: EmailVerificationsApiCompleteEmailVerificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompleteEmailVerificationResponseClass, any, {}, any>>;
|
|
138
145
|
/**
|
|
139
|
-
*
|
|
146
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
147
|
+
* @summary Initiate an email verification
|
|
140
148
|
* @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
|
|
141
149
|
* @param {*} [options] Override http request option.
|
|
142
150
|
* @throws {RequiredError}
|
|
143
151
|
* @memberof EmailVerificationsApi
|
|
144
152
|
*/
|
|
145
|
-
initiateEmailVerification(requestParameters: EmailVerificationsApiInitiateEmailVerificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiateEmailVerificationResponseClass, any, {}>>;
|
|
153
|
+
initiateEmailVerification(requestParameters: EmailVerificationsApiInitiateEmailVerificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiateEmailVerificationResponseClass, any, {}, any>>;
|
|
146
154
|
}
|
|
@@ -93,7 +93,8 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
96
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
97
|
+
* @summary Complete an email verification
|
|
97
98
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
98
99
|
* @param {string} [authorization] Bearer Token
|
|
99
100
|
* @param {*} [options] Override http request option.
|
|
@@ -102,7 +103,7 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
|
|
|
102
103
|
completeEmailVerification: function (completeEmailVerificationDto, authorization, options) {
|
|
103
104
|
if (options === void 0) { options = {}; }
|
|
104
105
|
return __awaiter(_this, void 0, void 0, function () {
|
|
105
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
106
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
106
107
|
return __generator(this, function (_a) {
|
|
107
108
|
switch (_a.label) {
|
|
108
109
|
case 0:
|
|
@@ -119,13 +120,16 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
|
|
|
119
120
|
localVarQueryParameter = {};
|
|
120
121
|
// authentication bearer required
|
|
121
122
|
// http bearer authentication required
|
|
122
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
123
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
124
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
125
|
+
];
|
|
123
126
|
case 1:
|
|
124
127
|
// authentication bearer required
|
|
125
128
|
// http bearer authentication required
|
|
126
129
|
_a.sent();
|
|
127
|
-
|
|
128
|
-
|
|
130
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
131
|
+
if (authorizationValue) {
|
|
132
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
129
133
|
}
|
|
130
134
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
131
135
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -141,7 +145,8 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
|
|
|
141
145
|
});
|
|
142
146
|
},
|
|
143
147
|
/**
|
|
144
|
-
*
|
|
148
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
149
|
+
* @summary Initiate an email verification
|
|
145
150
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
146
151
|
* @param {string} [authorization] Bearer Token
|
|
147
152
|
* @param {*} [options] Override http request option.
|
|
@@ -150,7 +155,7 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
|
|
|
150
155
|
initiateEmailVerification: function (initiateEmailVerificationDto, authorization, options) {
|
|
151
156
|
if (options === void 0) { options = {}; }
|
|
152
157
|
return __awaiter(_this, void 0, void 0, function () {
|
|
153
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
158
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
154
159
|
return __generator(this, function (_a) {
|
|
155
160
|
switch (_a.label) {
|
|
156
161
|
case 0:
|
|
@@ -167,13 +172,16 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
|
|
|
167
172
|
localVarQueryParameter = {};
|
|
168
173
|
// authentication bearer required
|
|
169
174
|
// http bearer authentication required
|
|
170
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
175
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
176
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
177
|
+
];
|
|
171
178
|
case 1:
|
|
172
179
|
// authentication bearer required
|
|
173
180
|
// http bearer authentication required
|
|
174
181
|
_a.sent();
|
|
175
|
-
|
|
176
|
-
|
|
182
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
183
|
+
if (authorizationValue) {
|
|
184
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
177
185
|
}
|
|
178
186
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
179
187
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -199,7 +207,8 @@ var EmailVerificationsApiFp = function (configuration) {
|
|
|
199
207
|
var localVarAxiosParamCreator = (0, exports.EmailVerificationsApiAxiosParamCreator)(configuration);
|
|
200
208
|
return {
|
|
201
209
|
/**
|
|
202
|
-
*
|
|
210
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
211
|
+
* @summary Complete an email verification
|
|
203
212
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
204
213
|
* @param {string} [authorization] Bearer Token
|
|
205
214
|
* @param {*} [options] Override http request option.
|
|
@@ -219,7 +228,8 @@ var EmailVerificationsApiFp = function (configuration) {
|
|
|
219
228
|
});
|
|
220
229
|
},
|
|
221
230
|
/**
|
|
222
|
-
*
|
|
231
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
232
|
+
* @summary Initiate an email verification
|
|
223
233
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
224
234
|
* @param {string} [authorization] Bearer Token
|
|
225
235
|
* @param {*} [options] Override http request option.
|
|
@@ -249,7 +259,8 @@ var EmailVerificationsApiFactory = function (configuration, basePath, axios) {
|
|
|
249
259
|
var localVarFp = (0, exports.EmailVerificationsApiFp)(configuration);
|
|
250
260
|
return {
|
|
251
261
|
/**
|
|
252
|
-
*
|
|
262
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
263
|
+
* @summary Complete an email verification
|
|
253
264
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
254
265
|
* @param {string} [authorization] Bearer Token
|
|
255
266
|
* @param {*} [options] Override http request option.
|
|
@@ -259,7 +270,8 @@ var EmailVerificationsApiFactory = function (configuration, basePath, axios) {
|
|
|
259
270
|
return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
260
271
|
},
|
|
261
272
|
/**
|
|
262
|
-
*
|
|
273
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
274
|
+
* @summary Initiate an email verification
|
|
263
275
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
264
276
|
* @param {string} [authorization] Bearer Token
|
|
265
277
|
* @param {*} [options] Override http request option.
|
|
@@ -283,7 +295,8 @@ var EmailVerificationsApi = /** @class */ (function (_super) {
|
|
|
283
295
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
284
296
|
}
|
|
285
297
|
/**
|
|
286
|
-
*
|
|
298
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
299
|
+
* @summary Complete an email verification
|
|
287
300
|
* @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
|
|
288
301
|
* @param {*} [options] Override http request option.
|
|
289
302
|
* @throws {RequiredError}
|
|
@@ -294,7 +307,8 @@ var EmailVerificationsApi = /** @class */ (function (_super) {
|
|
|
294
307
|
return (0, exports.EmailVerificationsApiFp)(this.configuration).completeEmailVerification(requestParameters.completeEmailVerificationDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
295
308
|
};
|
|
296
309
|
/**
|
|
297
|
-
*
|
|
310
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
311
|
+
* @summary Initiate an email verification
|
|
298
312
|
* @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
|
|
299
313
|
* @param {*} [options] Override http request option.
|
|
300
314
|
* @throws {RequiredError}
|
package/dist/api/health-api.d.ts
CHANGED
|
@@ -66,5 +66,5 @@ export declare class HealthApi extends BaseAPI {
|
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
* @memberof HealthApi
|
|
68
68
|
*/
|
|
69
|
-
check(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineResponse200, any, {}>>;
|
|
69
|
+
check(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineResponse200, any, {}, any>>;
|
|
70
70
|
}
|
|
@@ -24,7 +24,8 @@ import { UpdateLayoutResponseClass } from '../models';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
|
|
28
|
+
* @summary Create the layout
|
|
28
29
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
29
30
|
* @param {string} [authorization] Bearer Token
|
|
30
31
|
* @param {*} [options] Override http request option.
|
|
@@ -32,7 +33,8 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
32
33
|
*/
|
|
33
34
|
createLayout: (createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
35
|
/**
|
|
35
|
-
*
|
|
36
|
+
* Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
37
|
+
* @summary Delete the layout
|
|
36
38
|
* @param {number} id
|
|
37
39
|
* @param {string} [authorization] Bearer Token
|
|
38
40
|
* @param {*} [options] Override http request option.
|
|
@@ -40,7 +42,8 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
40
42
|
*/
|
|
41
43
|
deleteLayout: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
44
|
/**
|
|
43
|
-
*
|
|
45
|
+
* Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
46
|
+
* @summary Retrieve the layout
|
|
44
47
|
* @param {number} id
|
|
45
48
|
* @param {number} id2 Layout id
|
|
46
49
|
* @param {string} [authorization] Bearer Token
|
|
@@ -49,21 +52,23 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
49
52
|
*/
|
|
50
53
|
getLayout: (id: number, id2: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51
54
|
/**
|
|
52
|
-
*
|
|
55
|
+
* Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
56
|
+
* @summary List layouts
|
|
53
57
|
* @param {string} [authorization] Bearer Token
|
|
54
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
55
59
|
* @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.
|
|
60
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, name, slug</i>
|
|
57
61
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
58
|
-
* @param {string} [order]
|
|
59
|
-
* @param {string} [expand]
|
|
60
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
62
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
63
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: headerTemplate, footerTemplate<i>
|
|
64
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, name, slug</i>
|
|
61
65
|
* @param {*} [options] Override http request option.
|
|
62
66
|
* @throws {RequiredError}
|
|
63
67
|
*/
|
|
64
68
|
listLayouts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
69
|
/**
|
|
66
|
-
*
|
|
70
|
+
* Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
71
|
+
* @summary Update the layout
|
|
67
72
|
* @param {number} id
|
|
68
73
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
69
74
|
* @param {string} [authorization] Bearer Token
|
|
@@ -78,7 +83,8 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
78
83
|
*/
|
|
79
84
|
export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
80
85
|
/**
|
|
81
|
-
*
|
|
86
|
+
* Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
|
|
87
|
+
* @summary Create the layout
|
|
82
88
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
83
89
|
* @param {string} [authorization] Bearer Token
|
|
84
90
|
* @param {*} [options] Override http request option.
|
|
@@ -86,7 +92,8 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
86
92
|
*/
|
|
87
93
|
createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLayoutResponseClass>>;
|
|
88
94
|
/**
|
|
89
|
-
*
|
|
95
|
+
* Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
96
|
+
* @summary Delete the layout
|
|
90
97
|
* @param {number} id
|
|
91
98
|
* @param {string} [authorization] Bearer Token
|
|
92
99
|
* @param {*} [options] Override http request option.
|
|
@@ -94,7 +101,8 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
94
101
|
*/
|
|
95
102
|
deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
96
103
|
/**
|
|
97
|
-
*
|
|
104
|
+
* Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
105
|
+
* @summary Retrieve the layout
|
|
98
106
|
* @param {number} id
|
|
99
107
|
* @param {number} id2 Layout id
|
|
100
108
|
* @param {string} [authorization] Bearer Token
|
|
@@ -103,21 +111,23 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
103
111
|
*/
|
|
104
112
|
getLayout(id: number, id2: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLayoutResponseClass>>;
|
|
105
113
|
/**
|
|
106
|
-
*
|
|
114
|
+
* Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
115
|
+
* @summary List layouts
|
|
107
116
|
* @param {string} [authorization] Bearer Token
|
|
108
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
109
118
|
* @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.
|
|
119
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, name, slug</i>
|
|
111
120
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
112
|
-
* @param {string} [order]
|
|
113
|
-
* @param {string} [expand]
|
|
114
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
121
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
122
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: headerTemplate, footerTemplate<i>
|
|
123
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, name, slug</i>
|
|
115
124
|
* @param {*} [options] Override http request option.
|
|
116
125
|
* @throws {RequiredError}
|
|
117
126
|
*/
|
|
118
127
|
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
128
|
/**
|
|
120
|
-
*
|
|
129
|
+
* Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
130
|
+
* @summary Update the layout
|
|
121
131
|
* @param {number} id
|
|
122
132
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
123
133
|
* @param {string} [authorization] Bearer Token
|
|
@@ -132,7 +142,8 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
132
142
|
*/
|
|
133
143
|
export declare const LayoutsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
134
144
|
/**
|
|
135
|
-
*
|
|
145
|
+
* Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
|
|
146
|
+
* @summary Create the layout
|
|
136
147
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
137
148
|
* @param {string} [authorization] Bearer Token
|
|
138
149
|
* @param {*} [options] Override http request option.
|
|
@@ -140,7 +151,8 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
|
|
|
140
151
|
*/
|
|
141
152
|
createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLayoutResponseClass>;
|
|
142
153
|
/**
|
|
143
|
-
*
|
|
154
|
+
* Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
155
|
+
* @summary Delete the layout
|
|
144
156
|
* @param {number} id
|
|
145
157
|
* @param {string} [authorization] Bearer Token
|
|
146
158
|
* @param {*} [options] Override http request option.
|
|
@@ -148,7 +160,8 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
|
|
|
148
160
|
*/
|
|
149
161
|
deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<object>;
|
|
150
162
|
/**
|
|
151
|
-
*
|
|
163
|
+
* Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
164
|
+
* @summary Retrieve the layout
|
|
152
165
|
* @param {number} id
|
|
153
166
|
* @param {number} id2 Layout id
|
|
154
167
|
* @param {string} [authorization] Bearer Token
|
|
@@ -157,21 +170,23 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
|
|
|
157
170
|
*/
|
|
158
171
|
getLayout(id: number, id2: number, authorization?: string, options?: any): AxiosPromise<GetLayoutResponseClass>;
|
|
159
172
|
/**
|
|
160
|
-
*
|
|
173
|
+
* Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
174
|
+
* @summary List layouts
|
|
161
175
|
* @param {string} [authorization] Bearer Token
|
|
162
176
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
163
177
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
164
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
178
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, name, slug</i>
|
|
165
179
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
166
|
-
* @param {string} [order]
|
|
167
|
-
* @param {string} [expand]
|
|
168
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
180
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
181
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: headerTemplate, footerTemplate<i>
|
|
182
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, name, slug</i>
|
|
169
183
|
* @param {*} [options] Override http request option.
|
|
170
184
|
* @throws {RequiredError}
|
|
171
185
|
*/
|
|
172
186
|
listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLayoutsResponseClass>;
|
|
173
187
|
/**
|
|
174
|
-
*
|
|
188
|
+
* Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
189
|
+
* @summary Update the layout
|
|
175
190
|
* @param {number} id
|
|
176
191
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
177
192
|
* @param {string} [authorization] Bearer Token
|
|
@@ -268,7 +283,7 @@ export interface LayoutsApiListLayoutsRequest {
|
|
|
268
283
|
*/
|
|
269
284
|
readonly pageToken?: string;
|
|
270
285
|
/**
|
|
271
|
-
* Filter the response by one or multiple fields.
|
|
286
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, name, slug</i>
|
|
272
287
|
* @type {string}
|
|
273
288
|
* @memberof LayoutsApiListLayouts
|
|
274
289
|
*/
|
|
@@ -280,19 +295,19 @@ export interface LayoutsApiListLayoutsRequest {
|
|
|
280
295
|
*/
|
|
281
296
|
readonly search?: string;
|
|
282
297
|
/**
|
|
283
|
-
*
|
|
298
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
284
299
|
* @type {string}
|
|
285
300
|
* @memberof LayoutsApiListLayouts
|
|
286
301
|
*/
|
|
287
302
|
readonly order?: string;
|
|
288
303
|
/**
|
|
289
|
-
*
|
|
304
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: headerTemplate, footerTemplate<i>
|
|
290
305
|
* @type {string}
|
|
291
306
|
* @memberof LayoutsApiListLayouts
|
|
292
307
|
*/
|
|
293
308
|
readonly expand?: string;
|
|
294
309
|
/**
|
|
295
|
-
* Filters the response by one or multiple fields.
|
|
310
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, name, slug</i>
|
|
296
311
|
* @type {string}
|
|
297
312
|
* @memberof LayoutsApiListLayouts
|
|
298
313
|
*/
|
|
@@ -331,43 +346,48 @@ export interface LayoutsApiUpdateLayoutRequest {
|
|
|
331
346
|
*/
|
|
332
347
|
export declare class LayoutsApi extends BaseAPI {
|
|
333
348
|
/**
|
|
334
|
-
*
|
|
349
|
+
* Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
|
|
350
|
+
* @summary Create the layout
|
|
335
351
|
* @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
|
|
336
352
|
* @param {*} [options] Override http request option.
|
|
337
353
|
* @throws {RequiredError}
|
|
338
354
|
* @memberof LayoutsApi
|
|
339
355
|
*/
|
|
340
|
-
createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLayoutResponseClass, any, {}>>;
|
|
356
|
+
createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLayoutResponseClass, any, {}, any>>;
|
|
341
357
|
/**
|
|
342
|
-
*
|
|
358
|
+
* Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
359
|
+
* @summary Delete the layout
|
|
343
360
|
* @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
|
|
344
361
|
* @param {*} [options] Override http request option.
|
|
345
362
|
* @throws {RequiredError}
|
|
346
363
|
* @memberof LayoutsApi
|
|
347
364
|
*/
|
|
348
|
-
deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
365
|
+
deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}, any>>;
|
|
349
366
|
/**
|
|
350
|
-
*
|
|
367
|
+
* Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
368
|
+
* @summary Retrieve the layout
|
|
351
369
|
* @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
|
|
352
370
|
* @param {*} [options] Override http request option.
|
|
353
371
|
* @throws {RequiredError}
|
|
354
372
|
* @memberof LayoutsApi
|
|
355
373
|
*/
|
|
356
|
-
getLayout(requestParameters: LayoutsApiGetLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLayoutResponseClass, any, {}>>;
|
|
374
|
+
getLayout(requestParameters: LayoutsApiGetLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLayoutResponseClass, any, {}, any>>;
|
|
357
375
|
/**
|
|
358
|
-
*
|
|
376
|
+
* Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
377
|
+
* @summary List layouts
|
|
359
378
|
* @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
|
|
360
379
|
* @param {*} [options] Override http request option.
|
|
361
380
|
* @throws {RequiredError}
|
|
362
381
|
* @memberof LayoutsApi
|
|
363
382
|
*/
|
|
364
|
-
listLayouts(requestParameters?: LayoutsApiListLayoutsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLayoutsResponseClass, any, {}>>;
|
|
383
|
+
listLayouts(requestParameters?: LayoutsApiListLayoutsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLayoutsResponseClass, any, {}, any>>;
|
|
365
384
|
/**
|
|
366
|
-
*
|
|
385
|
+
* Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
386
|
+
* @summary Update the layout
|
|
367
387
|
* @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
|
|
368
388
|
* @param {*} [options] Override http request option.
|
|
369
389
|
* @throws {RequiredError}
|
|
370
390
|
* @memberof LayoutsApi
|
|
371
391
|
*/
|
|
372
|
-
updateLayout(requestParameters: LayoutsApiUpdateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateLayoutResponseClass, any, {}>>;
|
|
392
|
+
updateLayout(requestParameters: LayoutsApiUpdateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateLayoutResponseClass, any, {}, any>>;
|
|
373
393
|
}
|