@emilgroup/notification-sdk 0.8.1-beta.30 → 0.8.1-beta.32
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 +8 -0
- package/README.md +2 -2
- package/api/email-messages-api.ts +259 -24
- package/api/email-tracking-api.ts +32 -24
- package/api/email-verifications-api.ts +16 -8
- package/api/layouts-api.ts +56 -36
- package/api/msgraph-webhooks-api.ts +278 -0
- package/api/notification-templates-api.ts +56 -36
- package/api/notifications-api.ts +115 -4
- package/api.ts +2 -0
- package/dist/api/email-messages-api.d.ts +158 -24
- package/dist/api/email-messages-api.js +225 -22
- package/dist/api/email-tracking-api.d.ts +32 -24
- package/dist/api/email-tracking-api.js +30 -22
- package/dist/api/email-verifications-api.d.ts +16 -8
- package/dist/api/email-verifications-api.js +16 -8
- package/dist/api/layouts-api.d.ts +56 -36
- package/dist/api/layouts-api.js +52 -32
- 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 +56 -36
- package/dist/api/notification-templates-api.js +52 -32
- package/dist/api/notifications-api.d.ts +65 -4
- package/dist/api/notifications-api.js +101 -4
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/assign-email-message-entity-body-dto.d.ts +43 -0
- package/dist/models/assign-email-message-entity-body-dto.js +22 -0
- package/dist/models/assign-email-message-entity-response-class.d.ts +25 -0
- package/dist/models/assign-email-message-entity-response-class.js +15 -0
- package/dist/models/email-message-class.d.ts +49 -2
- package/dist/models/email-message-class.js +16 -2
- 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 +7 -0
- package/dist/models/index.js +7 -0
- package/dist/models/inline-attachment-dto.d.ts +36 -0
- package/dist/models/inline-attachment-dto.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 +1 -0
- package/dist/models/send-notification-request-dto.js +2 -1
- package/dist/models/unassign-email-message-entity-response-class.d.ts +25 -0
- package/dist/models/unassign-email-message-entity-response-class.js +15 -0
- package/models/assign-email-message-entity-body-dto.ts +52 -0
- package/models/assign-email-message-entity-response-class.ts +31 -0
- package/models/email-message-class.ts +53 -3
- package/models/grpc-send-email-request-dto.ts +144 -0
- package/models/index.ts +7 -0
- package/models/inline-attachment-dto.ts +42 -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 +2 -1
- package/models/unassign-email-message-entity-response-class.ts +31 -0
- package/package.json +1 -1
|
@@ -0,0 +1,278 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL NotificationService
|
|
5
|
+
* The EMIL NotificationService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
17
|
+
import { Configuration } from '../configuration';
|
|
18
|
+
// Some imports not used depending on template conditions
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
|
+
// @ts-ignore
|
|
22
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
|
+
/**
|
|
24
|
+
* MSGraphWebhooksApi - axios parameter creator
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
export const MSGraphWebhooksApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
28
|
+
return {
|
|
29
|
+
/**
|
|
30
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the lifecycle events and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
31
|
+
* @summary Receive Microsoft Graph subscription lifecycle notifications
|
|
32
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
33
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
34
|
+
* @param {object} [body] Graph lifecycle collection `{ \"value\": [...] }`.
|
|
35
|
+
* @param {*} [options] Override http request option.
|
|
36
|
+
* @throws {RequiredError}
|
|
37
|
+
*/
|
|
38
|
+
receiveLifecycle: async (tenantSlug: string, validationToken?: string, body?: object, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39
|
+
// verify required parameter 'tenantSlug' is not null or undefined
|
|
40
|
+
assertParamExists('receiveLifecycle', 'tenantSlug', tenantSlug)
|
|
41
|
+
const localVarPath = `/notificationservice/v1/webhooks/msgraph/{tenantSlug}/lifecycle`
|
|
42
|
+
.replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)));
|
|
43
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
44
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
45
|
+
let baseOptions;
|
|
46
|
+
let baseAccessToken;
|
|
47
|
+
if (configuration) {
|
|
48
|
+
baseOptions = configuration.baseOptions;
|
|
49
|
+
baseAccessToken = configuration.accessToken;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
53
|
+
const localVarHeaderParameter = {} as any;
|
|
54
|
+
const localVarQueryParameter = {} as any;
|
|
55
|
+
|
|
56
|
+
if (validationToken !== undefined) {
|
|
57
|
+
localVarQueryParameter['validationToken'] = validationToken;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
63
|
+
|
|
64
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
65
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
67
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
68
|
+
|
|
69
|
+
return {
|
|
70
|
+
url: toPathString(localVarUrlObj),
|
|
71
|
+
options: localVarRequestOptions,
|
|
72
|
+
};
|
|
73
|
+
},
|
|
74
|
+
/**
|
|
75
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the notifications and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
76
|
+
* @summary Receive Microsoft Graph change notifications
|
|
77
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
78
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
79
|
+
* @param {object} [body] Graph change-notification collection: `{ \"value\": [ ... ] }`.
|
|
80
|
+
* @param {*} [options] Override http request option.
|
|
81
|
+
* @throws {RequiredError}
|
|
82
|
+
*/
|
|
83
|
+
receiveNotifications: async (tenantSlug: string, validationToken?: string, body?: object, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
84
|
+
// verify required parameter 'tenantSlug' is not null or undefined
|
|
85
|
+
assertParamExists('receiveNotifications', 'tenantSlug', tenantSlug)
|
|
86
|
+
const localVarPath = `/notificationservice/v1/webhooks/msgraph/{tenantSlug}/notifications`
|
|
87
|
+
.replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)));
|
|
88
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
89
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
90
|
+
let baseOptions;
|
|
91
|
+
let baseAccessToken;
|
|
92
|
+
if (configuration) {
|
|
93
|
+
baseOptions = configuration.baseOptions;
|
|
94
|
+
baseAccessToken = configuration.accessToken;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
98
|
+
const localVarHeaderParameter = {} as any;
|
|
99
|
+
const localVarQueryParameter = {} as any;
|
|
100
|
+
|
|
101
|
+
if (validationToken !== undefined) {
|
|
102
|
+
localVarQueryParameter['validationToken'] = validationToken;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
108
|
+
|
|
109
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
110
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
111
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
112
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
113
|
+
|
|
114
|
+
return {
|
|
115
|
+
url: toPathString(localVarUrlObj),
|
|
116
|
+
options: localVarRequestOptions,
|
|
117
|
+
};
|
|
118
|
+
},
|
|
119
|
+
}
|
|
120
|
+
};
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* MSGraphWebhooksApi - functional programming interface
|
|
124
|
+
* @export
|
|
125
|
+
*/
|
|
126
|
+
export const MSGraphWebhooksApiFp = function(configuration?: Configuration) {
|
|
127
|
+
const localVarAxiosParamCreator = MSGraphWebhooksApiAxiosParamCreator(configuration)
|
|
128
|
+
return {
|
|
129
|
+
/**
|
|
130
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the lifecycle events and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
131
|
+
* @summary Receive Microsoft Graph subscription lifecycle notifications
|
|
132
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
133
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
134
|
+
* @param {object} [body] Graph lifecycle collection `{ \"value\": [...] }`.
|
|
135
|
+
* @param {*} [options] Override http request option.
|
|
136
|
+
* @throws {RequiredError}
|
|
137
|
+
*/
|
|
138
|
+
async receiveLifecycle(tenantSlug: string, validationToken?: string, body?: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
139
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.receiveLifecycle(tenantSlug, validationToken, body, options);
|
|
140
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
141
|
+
},
|
|
142
|
+
/**
|
|
143
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the notifications and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
144
|
+
* @summary Receive Microsoft Graph change notifications
|
|
145
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
146
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
147
|
+
* @param {object} [body] Graph change-notification collection: `{ \"value\": [ ... ] }`.
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
async receiveNotifications(tenantSlug: string, validationToken?: string, body?: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
152
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.receiveNotifications(tenantSlug, validationToken, body, options);
|
|
153
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
154
|
+
},
|
|
155
|
+
}
|
|
156
|
+
};
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* MSGraphWebhooksApi - factory interface
|
|
160
|
+
* @export
|
|
161
|
+
*/
|
|
162
|
+
export const MSGraphWebhooksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
163
|
+
const localVarFp = MSGraphWebhooksApiFp(configuration)
|
|
164
|
+
return {
|
|
165
|
+
/**
|
|
166
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the lifecycle events and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
167
|
+
* @summary Receive Microsoft Graph subscription lifecycle notifications
|
|
168
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
169
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
170
|
+
* @param {object} [body] Graph lifecycle collection `{ \"value\": [...] }`.
|
|
171
|
+
* @param {*} [options] Override http request option.
|
|
172
|
+
* @throws {RequiredError}
|
|
173
|
+
*/
|
|
174
|
+
receiveLifecycle(tenantSlug: string, validationToken?: string, body?: object, options?: any): AxiosPromise<void> {
|
|
175
|
+
return localVarFp.receiveLifecycle(tenantSlug, validationToken, body, options).then((request) => request(axios, basePath));
|
|
176
|
+
},
|
|
177
|
+
/**
|
|
178
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the notifications and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
179
|
+
* @summary Receive Microsoft Graph change notifications
|
|
180
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
181
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
182
|
+
* @param {object} [body] Graph change-notification collection: `{ \"value\": [ ... ] }`.
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
receiveNotifications(tenantSlug: string, validationToken?: string, body?: object, options?: any): AxiosPromise<void> {
|
|
187
|
+
return localVarFp.receiveNotifications(tenantSlug, validationToken, body, options).then((request) => request(axios, basePath));
|
|
188
|
+
},
|
|
189
|
+
};
|
|
190
|
+
};
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* Request parameters for receiveLifecycle operation in MSGraphWebhooksApi.
|
|
194
|
+
* @export
|
|
195
|
+
* @interface MSGraphWebhooksApiReceiveLifecycleRequest
|
|
196
|
+
*/
|
|
197
|
+
export interface MSGraphWebhooksApiReceiveLifecycleRequest {
|
|
198
|
+
/**
|
|
199
|
+
* Unique slug identifier representing a tenant.
|
|
200
|
+
* @type {string}
|
|
201
|
+
* @memberof MSGraphWebhooksApiReceiveLifecycle
|
|
202
|
+
*/
|
|
203
|
+
readonly tenantSlug: string
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* Echoed back as text/plain when present.
|
|
207
|
+
* @type {string}
|
|
208
|
+
* @memberof MSGraphWebhooksApiReceiveLifecycle
|
|
209
|
+
*/
|
|
210
|
+
readonly validationToken?: string
|
|
211
|
+
|
|
212
|
+
/**
|
|
213
|
+
* Graph lifecycle collection `{ \"value\": [...] }`.
|
|
214
|
+
* @type {object}
|
|
215
|
+
* @memberof MSGraphWebhooksApiReceiveLifecycle
|
|
216
|
+
*/
|
|
217
|
+
readonly body?: object
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
/**
|
|
221
|
+
* Request parameters for receiveNotifications operation in MSGraphWebhooksApi.
|
|
222
|
+
* @export
|
|
223
|
+
* @interface MSGraphWebhooksApiReceiveNotificationsRequest
|
|
224
|
+
*/
|
|
225
|
+
export interface MSGraphWebhooksApiReceiveNotificationsRequest {
|
|
226
|
+
/**
|
|
227
|
+
* Unique slug identifier representing a tenant.
|
|
228
|
+
* @type {string}
|
|
229
|
+
* @memberof MSGraphWebhooksApiReceiveNotifications
|
|
230
|
+
*/
|
|
231
|
+
readonly tenantSlug: string
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* Echoed back as text/plain when present.
|
|
235
|
+
* @type {string}
|
|
236
|
+
* @memberof MSGraphWebhooksApiReceiveNotifications
|
|
237
|
+
*/
|
|
238
|
+
readonly validationToken?: string
|
|
239
|
+
|
|
240
|
+
/**
|
|
241
|
+
* Graph change-notification collection: `{ \"value\": [ ... ] }`.
|
|
242
|
+
* @type {object}
|
|
243
|
+
* @memberof MSGraphWebhooksApiReceiveNotifications
|
|
244
|
+
*/
|
|
245
|
+
readonly body?: object
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* MSGraphWebhooksApi - object-oriented interface
|
|
250
|
+
* @export
|
|
251
|
+
* @class MSGraphWebhooksApi
|
|
252
|
+
* @extends {BaseAPI}
|
|
253
|
+
*/
|
|
254
|
+
export class MSGraphWebhooksApi extends BaseAPI {
|
|
255
|
+
/**
|
|
256
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the lifecycle events and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
257
|
+
* @summary Receive Microsoft Graph subscription lifecycle notifications
|
|
258
|
+
* @param {MSGraphWebhooksApiReceiveLifecycleRequest} requestParameters Request parameters.
|
|
259
|
+
* @param {*} [options] Override http request option.
|
|
260
|
+
* @throws {RequiredError}
|
|
261
|
+
* @memberof MSGraphWebhooksApi
|
|
262
|
+
*/
|
|
263
|
+
public receiveLifecycle(requestParameters: MSGraphWebhooksApiReceiveLifecycleRequest, options?: AxiosRequestConfig) {
|
|
264
|
+
return MSGraphWebhooksApiFp(this.configuration).receiveLifecycle(requestParameters.tenantSlug, requestParameters.validationToken, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the notifications and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
269
|
+
* @summary Receive Microsoft Graph change notifications
|
|
270
|
+
* @param {MSGraphWebhooksApiReceiveNotificationsRequest} requestParameters Request parameters.
|
|
271
|
+
* @param {*} [options] Override http request option.
|
|
272
|
+
* @throws {RequiredError}
|
|
273
|
+
* @memberof MSGraphWebhooksApi
|
|
274
|
+
*/
|
|
275
|
+
public receiveNotifications(requestParameters: MSGraphWebhooksApiReceiveNotificationsRequest, options?: AxiosRequestConfig) {
|
|
276
|
+
return MSGraphWebhooksApiFp(this.configuration).receiveNotifications(requestParameters.tenantSlug, requestParameters.validationToken, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
277
|
+
}
|
|
278
|
+
}
|
|
@@ -39,7 +39,8 @@ import { UpdateNotificationTemplateResponseClass } from '../models';
|
|
|
39
39
|
export const NotificationTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40
40
|
return {
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
42
|
+
* Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
|
|
43
|
+
* @summary Create the notification template
|
|
43
44
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
44
45
|
* @param {string} [authorization] Bearer Token
|
|
45
46
|
* @param {*} [options] Override http request option.
|
|
@@ -85,7 +86,8 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
85
86
|
};
|
|
86
87
|
},
|
|
87
88
|
/**
|
|
88
|
-
*
|
|
89
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
90
|
+
* @summary Delete the notification template
|
|
89
91
|
* @param {number} id
|
|
90
92
|
* @param {string} [authorization] Bearer Token
|
|
91
93
|
* @param {*} [options] Override http request option.
|
|
@@ -129,7 +131,8 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
129
131
|
};
|
|
130
132
|
},
|
|
131
133
|
/**
|
|
132
|
-
*
|
|
134
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
135
|
+
* @summary Retrieve the notification template
|
|
133
136
|
* @param {number} id
|
|
134
137
|
* @param {number} id2
|
|
135
138
|
* @param {string} [authorization] Bearer Token
|
|
@@ -185,15 +188,16 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
185
188
|
};
|
|
186
189
|
},
|
|
187
190
|
/**
|
|
188
|
-
*
|
|
191
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
192
|
+
* @summary List notification templates
|
|
189
193
|
* @param {string} [authorization] Bearer Token
|
|
190
194
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
191
195
|
* @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.
|
|
192
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
196
|
+
* @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: name, slug</i>
|
|
193
197
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
194
|
-
* @param {string} [order]
|
|
195
|
-
* @param {string} [expand]
|
|
196
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
198
|
+
* @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, name, createdAt</i>
|
|
199
|
+
* @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
|
|
200
|
+
* @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: name, slug</i>
|
|
197
201
|
* @param {*} [options] Override http request option.
|
|
198
202
|
* @throws {RequiredError}
|
|
199
203
|
*/
|
|
@@ -260,7 +264,8 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
260
264
|
};
|
|
261
265
|
},
|
|
262
266
|
/**
|
|
263
|
-
*
|
|
267
|
+
* Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
268
|
+
* @summary Update the notification template
|
|
264
269
|
* @param {number} id
|
|
265
270
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
266
271
|
* @param {string} [authorization] Bearer Token
|
|
@@ -320,7 +325,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
|
|
|
320
325
|
const localVarAxiosParamCreator = NotificationTemplatesApiAxiosParamCreator(configuration)
|
|
321
326
|
return {
|
|
322
327
|
/**
|
|
323
|
-
*
|
|
328
|
+
* Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
|
|
329
|
+
* @summary Create the notification template
|
|
324
330
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
325
331
|
* @param {string} [authorization] Bearer Token
|
|
326
332
|
* @param {*} [options] Override http request option.
|
|
@@ -331,7 +337,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
|
|
|
331
337
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
332
338
|
},
|
|
333
339
|
/**
|
|
334
|
-
*
|
|
340
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
341
|
+
* @summary Delete the notification template
|
|
335
342
|
* @param {number} id
|
|
336
343
|
* @param {string} [authorization] Bearer Token
|
|
337
344
|
* @param {*} [options] Override http request option.
|
|
@@ -342,7 +349,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
|
|
|
342
349
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
343
350
|
},
|
|
344
351
|
/**
|
|
345
|
-
*
|
|
352
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
353
|
+
* @summary Retrieve the notification template
|
|
346
354
|
* @param {number} id
|
|
347
355
|
* @param {number} id2
|
|
348
356
|
* @param {string} [authorization] Bearer Token
|
|
@@ -355,15 +363,16 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
|
|
|
355
363
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
356
364
|
},
|
|
357
365
|
/**
|
|
358
|
-
*
|
|
366
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
367
|
+
* @summary List notification templates
|
|
359
368
|
* @param {string} [authorization] Bearer Token
|
|
360
369
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
361
370
|
* @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.
|
|
362
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
371
|
+
* @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: name, slug</i>
|
|
363
372
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
364
|
-
* @param {string} [order]
|
|
365
|
-
* @param {string} [expand]
|
|
366
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
373
|
+
* @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, name, createdAt</i>
|
|
374
|
+
* @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
|
|
375
|
+
* @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: name, slug</i>
|
|
367
376
|
* @param {*} [options] Override http request option.
|
|
368
377
|
* @throws {RequiredError}
|
|
369
378
|
*/
|
|
@@ -372,7 +381,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
|
|
|
372
381
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
373
382
|
},
|
|
374
383
|
/**
|
|
375
|
-
*
|
|
384
|
+
* Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
385
|
+
* @summary Update the notification template
|
|
376
386
|
* @param {number} id
|
|
377
387
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
378
388
|
* @param {string} [authorization] Bearer Token
|
|
@@ -394,7 +404,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
|
|
|
394
404
|
const localVarFp = NotificationTemplatesApiFp(configuration)
|
|
395
405
|
return {
|
|
396
406
|
/**
|
|
397
|
-
*
|
|
407
|
+
* Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
|
|
408
|
+
* @summary Create the notification template
|
|
398
409
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
399
410
|
* @param {string} [authorization] Bearer Token
|
|
400
411
|
* @param {*} [options] Override http request option.
|
|
@@ -404,7 +415,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
|
|
|
404
415
|
return localVarFp.createNotificationTemplate(createNotificationTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
405
416
|
},
|
|
406
417
|
/**
|
|
407
|
-
*
|
|
418
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
419
|
+
* @summary Delete the notification template
|
|
408
420
|
* @param {number} id
|
|
409
421
|
* @param {string} [authorization] Bearer Token
|
|
410
422
|
* @param {*} [options] Override http request option.
|
|
@@ -414,7 +426,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
|
|
|
414
426
|
return localVarFp.deleteNotificationTemplate(id, authorization, options).then((request) => request(axios, basePath));
|
|
415
427
|
},
|
|
416
428
|
/**
|
|
417
|
-
*
|
|
429
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
430
|
+
* @summary Retrieve the notification template
|
|
418
431
|
* @param {number} id
|
|
419
432
|
* @param {number} id2
|
|
420
433
|
* @param {string} [authorization] Bearer Token
|
|
@@ -426,15 +439,16 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
|
|
|
426
439
|
return localVarFp.getNotificationTemplate(id, id2, authorization, expand, options).then((request) => request(axios, basePath));
|
|
427
440
|
},
|
|
428
441
|
/**
|
|
429
|
-
*
|
|
442
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
443
|
+
* @summary List notification templates
|
|
430
444
|
* @param {string} [authorization] Bearer Token
|
|
431
445
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
432
446
|
* @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.
|
|
433
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
447
|
+
* @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: name, slug</i>
|
|
434
448
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
435
|
-
* @param {string} [order]
|
|
436
|
-
* @param {string} [expand]
|
|
437
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
449
|
+
* @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, name, createdAt</i>
|
|
450
|
+
* @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
|
|
451
|
+
* @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: name, slug</i>
|
|
438
452
|
* @param {*} [options] Override http request option.
|
|
439
453
|
* @throws {RequiredError}
|
|
440
454
|
*/
|
|
@@ -442,7 +456,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
|
|
|
442
456
|
return localVarFp.listNotificationTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
443
457
|
},
|
|
444
458
|
/**
|
|
445
|
-
*
|
|
459
|
+
* Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
460
|
+
* @summary Update the notification template
|
|
446
461
|
* @param {number} id
|
|
447
462
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
448
463
|
* @param {string} [authorization] Bearer Token
|
|
@@ -560,7 +575,7 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
|
|
|
560
575
|
readonly pageToken?: string
|
|
561
576
|
|
|
562
577
|
/**
|
|
563
|
-
* Filter the response by one or multiple fields.
|
|
578
|
+
* 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: name, slug</i>
|
|
564
579
|
* @type {string}
|
|
565
580
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
566
581
|
*/
|
|
@@ -574,21 +589,21 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
|
|
|
574
589
|
readonly search?: string
|
|
575
590
|
|
|
576
591
|
/**
|
|
577
|
-
*
|
|
592
|
+
* 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, name, createdAt</i>
|
|
578
593
|
* @type {string}
|
|
579
594
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
580
595
|
*/
|
|
581
596
|
readonly order?: string
|
|
582
597
|
|
|
583
598
|
/**
|
|
584
|
-
*
|
|
599
|
+
* 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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
|
|
585
600
|
* @type {string}
|
|
586
601
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
587
602
|
*/
|
|
588
603
|
readonly expand?: string
|
|
589
604
|
|
|
590
605
|
/**
|
|
591
|
-
* Filters the response by one or multiple fields.
|
|
606
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: name, slug</i>
|
|
592
607
|
* @type {string}
|
|
593
608
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
594
609
|
*/
|
|
@@ -631,7 +646,8 @@ export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
|
|
|
631
646
|
*/
|
|
632
647
|
export class NotificationTemplatesApi extends BaseAPI {
|
|
633
648
|
/**
|
|
634
|
-
*
|
|
649
|
+
* Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
|
|
650
|
+
* @summary Create the notification template
|
|
635
651
|
* @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
|
|
636
652
|
* @param {*} [options] Override http request option.
|
|
637
653
|
* @throws {RequiredError}
|
|
@@ -642,7 +658,8 @@ export class NotificationTemplatesApi extends BaseAPI {
|
|
|
642
658
|
}
|
|
643
659
|
|
|
644
660
|
/**
|
|
645
|
-
*
|
|
661
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
662
|
+
* @summary Delete the notification template
|
|
646
663
|
* @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
|
|
647
664
|
* @param {*} [options] Override http request option.
|
|
648
665
|
* @throws {RequiredError}
|
|
@@ -653,7 +670,8 @@ export class NotificationTemplatesApi extends BaseAPI {
|
|
|
653
670
|
}
|
|
654
671
|
|
|
655
672
|
/**
|
|
656
|
-
*
|
|
673
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
674
|
+
* @summary Retrieve the notification template
|
|
657
675
|
* @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
|
|
658
676
|
* @param {*} [options] Override http request option.
|
|
659
677
|
* @throws {RequiredError}
|
|
@@ -664,7 +682,8 @@ export class NotificationTemplatesApi extends BaseAPI {
|
|
|
664
682
|
}
|
|
665
683
|
|
|
666
684
|
/**
|
|
667
|
-
*
|
|
685
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
686
|
+
* @summary List notification templates
|
|
668
687
|
* @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
|
|
669
688
|
* @param {*} [options] Override http request option.
|
|
670
689
|
* @throws {RequiredError}
|
|
@@ -675,7 +694,8 @@ export class NotificationTemplatesApi extends BaseAPI {
|
|
|
675
694
|
}
|
|
676
695
|
|
|
677
696
|
/**
|
|
678
|
-
*
|
|
697
|
+
* Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
698
|
+
* @summary Update the notification template
|
|
679
699
|
* @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
|
|
680
700
|
* @param {*} [options] Override http request option.
|
|
681
701
|
* @throws {RequiredError}
|