@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
|
@@ -35,7 +35,8 @@ import { InitiateEmailVerificationResponseClass } from '../models';
|
|
|
35
35
|
export const EmailVerificationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
39
|
+
* @summary Complete an email verification
|
|
39
40
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
40
41
|
* @param {string} [authorization] Bearer Token
|
|
41
42
|
* @param {*} [options] Override http request option.
|
|
@@ -62,8 +63,10 @@ export const EmailVerificationsApiAxiosParamCreator = function (configuration?:
|
|
|
62
63
|
// http bearer authentication required
|
|
63
64
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
64
65
|
|
|
65
|
-
|
|
66
|
-
|
|
66
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
67
|
+
const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
68
|
+
if (authorizationValue) {
|
|
69
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
67
70
|
}
|
|
68
71
|
|
|
69
72
|
|
|
@@ -81,7 +84,8 @@ export const EmailVerificationsApiAxiosParamCreator = function (configuration?:
|
|
|
81
84
|
};
|
|
82
85
|
},
|
|
83
86
|
/**
|
|
84
|
-
*
|
|
87
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
88
|
+
* @summary Initiate an email verification
|
|
85
89
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
86
90
|
* @param {string} [authorization] Bearer Token
|
|
87
91
|
* @param {*} [options] Override http request option.
|
|
@@ -108,8 +112,10 @@ export const EmailVerificationsApiAxiosParamCreator = function (configuration?:
|
|
|
108
112
|
// http bearer authentication required
|
|
109
113
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
110
114
|
|
|
111
|
-
|
|
112
|
-
|
|
115
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
116
|
+
const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
117
|
+
if (authorizationValue) {
|
|
118
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
113
119
|
}
|
|
114
120
|
|
|
115
121
|
|
|
@@ -137,7 +143,8 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
|
|
|
137
143
|
const localVarAxiosParamCreator = EmailVerificationsApiAxiosParamCreator(configuration)
|
|
138
144
|
return {
|
|
139
145
|
/**
|
|
140
|
-
*
|
|
146
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
147
|
+
* @summary Complete an email verification
|
|
141
148
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
142
149
|
* @param {string} [authorization] Bearer Token
|
|
143
150
|
* @param {*} [options] Override http request option.
|
|
@@ -148,7 +155,8 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
|
|
|
148
155
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
149
156
|
},
|
|
150
157
|
/**
|
|
151
|
-
*
|
|
158
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
159
|
+
* @summary Initiate an email verification
|
|
152
160
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
153
161
|
* @param {string} [authorization] Bearer Token
|
|
154
162
|
* @param {*} [options] Override http request option.
|
|
@@ -169,7 +177,8 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
|
|
|
169
177
|
const localVarFp = EmailVerificationsApiFp(configuration)
|
|
170
178
|
return {
|
|
171
179
|
/**
|
|
172
|
-
*
|
|
180
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
181
|
+
* @summary Complete an email verification
|
|
173
182
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
174
183
|
* @param {string} [authorization] Bearer Token
|
|
175
184
|
* @param {*} [options] Override http request option.
|
|
@@ -179,7 +188,8 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
|
|
|
179
188
|
return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then((request) => request(axios, basePath));
|
|
180
189
|
},
|
|
181
190
|
/**
|
|
182
|
-
*
|
|
191
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
192
|
+
* @summary Initiate an email verification
|
|
183
193
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
184
194
|
* @param {string} [authorization] Bearer Token
|
|
185
195
|
* @param {*} [options] Override http request option.
|
|
@@ -241,7 +251,8 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
|
|
|
241
251
|
*/
|
|
242
252
|
export class EmailVerificationsApi extends BaseAPI {
|
|
243
253
|
/**
|
|
244
|
-
*
|
|
254
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
255
|
+
* @summary Complete an email verification
|
|
245
256
|
* @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
|
|
246
257
|
* @param {*} [options] Override http request option.
|
|
247
258
|
* @throws {RequiredError}
|
|
@@ -252,7 +263,8 @@ export class EmailVerificationsApi extends BaseAPI {
|
|
|
252
263
|
}
|
|
253
264
|
|
|
254
265
|
/**
|
|
255
|
-
*
|
|
266
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
267
|
+
* @summary Initiate an email verification
|
|
256
268
|
* @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
|
|
257
269
|
* @param {*} [options] Override http request option.
|
|
258
270
|
* @throws {RequiredError}
|
package/api/layouts-api.ts
CHANGED
|
@@ -39,7 +39,8 @@ import { UpdateLayoutResponseClass } from '../models';
|
|
|
39
39
|
export const LayoutsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40
40
|
return {
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
42
|
+
* Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
|
|
43
|
+
* @summary Create the layout
|
|
43
44
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
44
45
|
* @param {string} [authorization] Bearer Token
|
|
45
46
|
* @param {*} [options] Override http request option.
|
|
@@ -66,8 +67,10 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
66
67
|
// http bearer authentication required
|
|
67
68
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
68
69
|
|
|
69
|
-
|
|
70
|
-
|
|
70
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
71
|
+
const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
72
|
+
if (authorizationValue) {
|
|
73
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
71
74
|
}
|
|
72
75
|
|
|
73
76
|
|
|
@@ -85,7 +88,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
85
88
|
};
|
|
86
89
|
},
|
|
87
90
|
/**
|
|
88
|
-
*
|
|
91
|
+
* Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
92
|
+
* @summary Delete the layout
|
|
89
93
|
* @param {number} id
|
|
90
94
|
* @param {string} [authorization] Bearer Token
|
|
91
95
|
* @param {*} [options] Override http request option.
|
|
@@ -113,8 +117,10 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
113
117
|
// http bearer authentication required
|
|
114
118
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
115
119
|
|
|
116
|
-
|
|
117
|
-
|
|
120
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
121
|
+
const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
122
|
+
if (authorizationValue) {
|
|
123
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
118
124
|
}
|
|
119
125
|
|
|
120
126
|
|
|
@@ -129,7 +135,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
129
135
|
};
|
|
130
136
|
},
|
|
131
137
|
/**
|
|
132
|
-
*
|
|
138
|
+
* Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
139
|
+
* @summary Retrieve the layout
|
|
133
140
|
* @param {number} id
|
|
134
141
|
* @param {number} id2 Layout id
|
|
135
142
|
* @param {string} [authorization] Bearer Token
|
|
@@ -164,8 +171,10 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
164
171
|
localVarQueryParameter['id'] = id2;
|
|
165
172
|
}
|
|
166
173
|
|
|
167
|
-
|
|
168
|
-
|
|
174
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
175
|
+
const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
176
|
+
if (authorizationValue) {
|
|
177
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
169
178
|
}
|
|
170
179
|
|
|
171
180
|
|
|
@@ -180,15 +189,16 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
180
189
|
};
|
|
181
190
|
},
|
|
182
191
|
/**
|
|
183
|
-
*
|
|
192
|
+
* Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
193
|
+
* @summary List layouts
|
|
184
194
|
* @param {string} [authorization] Bearer Token
|
|
185
195
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
186
196
|
* @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.
|
|
187
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
197
|
+
* @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>
|
|
188
198
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
189
|
-
* @param {string} [order]
|
|
190
|
-
* @param {string} [expand]
|
|
191
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
199
|
+
* @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>
|
|
200
|
+
* @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>
|
|
201
|
+
* @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>
|
|
192
202
|
* @param {*} [options] Override http request option.
|
|
193
203
|
* @throws {RequiredError}
|
|
194
204
|
*/
|
|
@@ -239,8 +249,10 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
239
249
|
localVarQueryParameter['filters'] = filters;
|
|
240
250
|
}
|
|
241
251
|
|
|
242
|
-
|
|
243
|
-
|
|
252
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
253
|
+
const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
254
|
+
if (authorizationValue) {
|
|
255
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
244
256
|
}
|
|
245
257
|
|
|
246
258
|
|
|
@@ -255,7 +267,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
255
267
|
};
|
|
256
268
|
},
|
|
257
269
|
/**
|
|
258
|
-
*
|
|
270
|
+
* 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\"
|
|
271
|
+
* @summary Update the layout
|
|
259
272
|
* @param {number} id
|
|
260
273
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
261
274
|
* @param {string} [authorization] Bearer Token
|
|
@@ -286,8 +299,10 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
286
299
|
// http bearer authentication required
|
|
287
300
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
288
301
|
|
|
289
|
-
|
|
290
|
-
|
|
302
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
303
|
+
const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
304
|
+
if (authorizationValue) {
|
|
305
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
291
306
|
}
|
|
292
307
|
|
|
293
308
|
|
|
@@ -315,7 +330,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
|
|
|
315
330
|
const localVarAxiosParamCreator = LayoutsApiAxiosParamCreator(configuration)
|
|
316
331
|
return {
|
|
317
332
|
/**
|
|
318
|
-
*
|
|
333
|
+
* Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
|
|
334
|
+
* @summary Create the layout
|
|
319
335
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
320
336
|
* @param {string} [authorization] Bearer Token
|
|
321
337
|
* @param {*} [options] Override http request option.
|
|
@@ -326,7 +342,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
|
|
|
326
342
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
327
343
|
},
|
|
328
344
|
/**
|
|
329
|
-
*
|
|
345
|
+
* Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
346
|
+
* @summary Delete the layout
|
|
330
347
|
* @param {number} id
|
|
331
348
|
* @param {string} [authorization] Bearer Token
|
|
332
349
|
* @param {*} [options] Override http request option.
|
|
@@ -337,7 +354,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
|
|
|
337
354
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
338
355
|
},
|
|
339
356
|
/**
|
|
340
|
-
*
|
|
357
|
+
* Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
358
|
+
* @summary Retrieve the layout
|
|
341
359
|
* @param {number} id
|
|
342
360
|
* @param {number} id2 Layout id
|
|
343
361
|
* @param {string} [authorization] Bearer Token
|
|
@@ -349,15 +367,16 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
|
|
|
349
367
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
350
368
|
},
|
|
351
369
|
/**
|
|
352
|
-
*
|
|
370
|
+
* Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
371
|
+
* @summary List layouts
|
|
353
372
|
* @param {string} [authorization] Bearer Token
|
|
354
373
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
355
374
|
* @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.
|
|
356
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
375
|
+
* @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>
|
|
357
376
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
358
|
-
* @param {string} [order]
|
|
359
|
-
* @param {string} [expand]
|
|
360
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
377
|
+
* @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>
|
|
378
|
+
* @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>
|
|
379
|
+
* @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>
|
|
361
380
|
* @param {*} [options] Override http request option.
|
|
362
381
|
* @throws {RequiredError}
|
|
363
382
|
*/
|
|
@@ -366,7 +385,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
|
|
|
366
385
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
367
386
|
},
|
|
368
387
|
/**
|
|
369
|
-
*
|
|
388
|
+
* 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\"
|
|
389
|
+
* @summary Update the layout
|
|
370
390
|
* @param {number} id
|
|
371
391
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
372
392
|
* @param {string} [authorization] Bearer Token
|
|
@@ -388,7 +408,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
|
|
|
388
408
|
const localVarFp = LayoutsApiFp(configuration)
|
|
389
409
|
return {
|
|
390
410
|
/**
|
|
391
|
-
*
|
|
411
|
+
* Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
|
|
412
|
+
* @summary Create the layout
|
|
392
413
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
393
414
|
* @param {string} [authorization] Bearer Token
|
|
394
415
|
* @param {*} [options] Override http request option.
|
|
@@ -398,7 +419,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
|
|
|
398
419
|
return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
399
420
|
},
|
|
400
421
|
/**
|
|
401
|
-
*
|
|
422
|
+
* Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
423
|
+
* @summary Delete the layout
|
|
402
424
|
* @param {number} id
|
|
403
425
|
* @param {string} [authorization] Bearer Token
|
|
404
426
|
* @param {*} [options] Override http request option.
|
|
@@ -408,7 +430,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
|
|
|
408
430
|
return localVarFp.deleteLayout(id, authorization, options).then((request) => request(axios, basePath));
|
|
409
431
|
},
|
|
410
432
|
/**
|
|
411
|
-
*
|
|
433
|
+
* Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
434
|
+
* @summary Retrieve the layout
|
|
412
435
|
* @param {number} id
|
|
413
436
|
* @param {number} id2 Layout id
|
|
414
437
|
* @param {string} [authorization] Bearer Token
|
|
@@ -419,15 +442,16 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
|
|
|
419
442
|
return localVarFp.getLayout(id, id2, authorization, options).then((request) => request(axios, basePath));
|
|
420
443
|
},
|
|
421
444
|
/**
|
|
422
|
-
*
|
|
445
|
+
* Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
446
|
+
* @summary List layouts
|
|
423
447
|
* @param {string} [authorization] Bearer Token
|
|
424
448
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
425
449
|
* @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.
|
|
426
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
450
|
+
* @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>
|
|
427
451
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
428
|
-
* @param {string} [order]
|
|
429
|
-
* @param {string} [expand]
|
|
430
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
452
|
+
* @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>
|
|
453
|
+
* @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>
|
|
454
|
+
* @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>
|
|
431
455
|
* @param {*} [options] Override http request option.
|
|
432
456
|
* @throws {RequiredError}
|
|
433
457
|
*/
|
|
@@ -435,7 +459,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
|
|
|
435
459
|
return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
436
460
|
},
|
|
437
461
|
/**
|
|
438
|
-
*
|
|
462
|
+
* 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\"
|
|
463
|
+
* @summary Update the layout
|
|
439
464
|
* @param {number} id
|
|
440
465
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
441
466
|
* @param {string} [authorization] Bearer Token
|
|
@@ -546,7 +571,7 @@ export interface LayoutsApiListLayoutsRequest {
|
|
|
546
571
|
readonly pageToken?: string
|
|
547
572
|
|
|
548
573
|
/**
|
|
549
|
-
* Filter the response by one or multiple fields.
|
|
574
|
+
* 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>
|
|
550
575
|
* @type {string}
|
|
551
576
|
* @memberof LayoutsApiListLayouts
|
|
552
577
|
*/
|
|
@@ -560,21 +585,21 @@ export interface LayoutsApiListLayoutsRequest {
|
|
|
560
585
|
readonly search?: string
|
|
561
586
|
|
|
562
587
|
/**
|
|
563
|
-
*
|
|
588
|
+
* 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>
|
|
564
589
|
* @type {string}
|
|
565
590
|
* @memberof LayoutsApiListLayouts
|
|
566
591
|
*/
|
|
567
592
|
readonly order?: string
|
|
568
593
|
|
|
569
594
|
/**
|
|
570
|
-
*
|
|
595
|
+
* 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>
|
|
571
596
|
* @type {string}
|
|
572
597
|
* @memberof LayoutsApiListLayouts
|
|
573
598
|
*/
|
|
574
599
|
readonly expand?: string
|
|
575
600
|
|
|
576
601
|
/**
|
|
577
|
-
* Filters the response by one or multiple fields.
|
|
602
|
+
* 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>
|
|
578
603
|
* @type {string}
|
|
579
604
|
* @memberof LayoutsApiListLayouts
|
|
580
605
|
*/
|
|
@@ -617,7 +642,8 @@ export interface LayoutsApiUpdateLayoutRequest {
|
|
|
617
642
|
*/
|
|
618
643
|
export class LayoutsApi extends BaseAPI {
|
|
619
644
|
/**
|
|
620
|
-
*
|
|
645
|
+
* Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
|
|
646
|
+
* @summary Create the layout
|
|
621
647
|
* @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
|
|
622
648
|
* @param {*} [options] Override http request option.
|
|
623
649
|
* @throws {RequiredError}
|
|
@@ -628,7 +654,8 @@ export class LayoutsApi extends BaseAPI {
|
|
|
628
654
|
}
|
|
629
655
|
|
|
630
656
|
/**
|
|
631
|
-
*
|
|
657
|
+
* Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
658
|
+
* @summary Delete the layout
|
|
632
659
|
* @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
|
|
633
660
|
* @param {*} [options] Override http request option.
|
|
634
661
|
* @throws {RequiredError}
|
|
@@ -639,7 +666,8 @@ export class LayoutsApi extends BaseAPI {
|
|
|
639
666
|
}
|
|
640
667
|
|
|
641
668
|
/**
|
|
642
|
-
*
|
|
669
|
+
* Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
670
|
+
* @summary Retrieve the layout
|
|
643
671
|
* @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
|
|
644
672
|
* @param {*} [options] Override http request option.
|
|
645
673
|
* @throws {RequiredError}
|
|
@@ -650,7 +678,8 @@ export class LayoutsApi extends BaseAPI {
|
|
|
650
678
|
}
|
|
651
679
|
|
|
652
680
|
/**
|
|
653
|
-
*
|
|
681
|
+
* Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
682
|
+
* @summary List layouts
|
|
654
683
|
* @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
|
|
655
684
|
* @param {*} [options] Override http request option.
|
|
656
685
|
* @throws {RequiredError}
|
|
@@ -661,7 +690,8 @@ export class LayoutsApi extends BaseAPI {
|
|
|
661
690
|
}
|
|
662
691
|
|
|
663
692
|
/**
|
|
664
|
-
*
|
|
693
|
+
* 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\"
|
|
694
|
+
* @summary Update the layout
|
|
665
695
|
* @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
|
|
666
696
|
* @param {*} [options] Override http request option.
|
|
667
697
|
* @throws {RequiredError}
|