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