@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
|
@@ -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.
|
|
@@ -66,8 +67,10 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
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 NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
85
88
|
};
|
|
86
89
|
},
|
|
87
90
|
/**
|
|
88
|
-
*
|
|
91
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
92
|
+
* @summary Delete the notification template
|
|
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 NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
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 NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
129
135
|
};
|
|
130
136
|
},
|
|
131
137
|
/**
|
|
132
|
-
*
|
|
138
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
139
|
+
* @summary Retrieve the notification template
|
|
133
140
|
* @param {number} id
|
|
134
141
|
* @param {number} id2
|
|
135
142
|
* @param {string} [authorization] Bearer Token
|
|
@@ -169,8 +176,10 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
169
176
|
localVarQueryParameter['expand'] = expand;
|
|
170
177
|
}
|
|
171
178
|
|
|
172
|
-
|
|
173
|
-
|
|
179
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
180
|
+
const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
181
|
+
if (authorizationValue) {
|
|
182
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
174
183
|
}
|
|
175
184
|
|
|
176
185
|
|
|
@@ -185,15 +194,16 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
185
194
|
};
|
|
186
195
|
},
|
|
187
196
|
/**
|
|
188
|
-
*
|
|
197
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
198
|
+
* @summary List notification templates
|
|
189
199
|
* @param {string} [authorization] Bearer Token
|
|
190
200
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
191
201
|
* @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.
|
|
202
|
+
* @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
203
|
* @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.
|
|
204
|
+
* @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>
|
|
205
|
+
* @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>
|
|
206
|
+
* @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
207
|
* @param {*} [options] Override http request option.
|
|
198
208
|
* @throws {RequiredError}
|
|
199
209
|
*/
|
|
@@ -244,8 +254,10 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
244
254
|
localVarQueryParameter['filters'] = filters;
|
|
245
255
|
}
|
|
246
256
|
|
|
247
|
-
|
|
248
|
-
|
|
257
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
258
|
+
const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
259
|
+
if (authorizationValue) {
|
|
260
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
249
261
|
}
|
|
250
262
|
|
|
251
263
|
|
|
@@ -260,7 +272,8 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
260
272
|
};
|
|
261
273
|
},
|
|
262
274
|
/**
|
|
263
|
-
*
|
|
275
|
+
* 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\"
|
|
276
|
+
* @summary Update the notification template
|
|
264
277
|
* @param {number} id
|
|
265
278
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
266
279
|
* @param {string} [authorization] Bearer Token
|
|
@@ -291,8 +304,10 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
|
|
|
291
304
|
// http bearer authentication required
|
|
292
305
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
293
306
|
|
|
294
|
-
|
|
295
|
-
|
|
307
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
308
|
+
const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
309
|
+
if (authorizationValue) {
|
|
310
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
296
311
|
}
|
|
297
312
|
|
|
298
313
|
|
|
@@ -320,7 +335,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
|
|
|
320
335
|
const localVarAxiosParamCreator = NotificationTemplatesApiAxiosParamCreator(configuration)
|
|
321
336
|
return {
|
|
322
337
|
/**
|
|
323
|
-
*
|
|
338
|
+
* 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\"
|
|
339
|
+
* @summary Create the notification template
|
|
324
340
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
325
341
|
* @param {string} [authorization] Bearer Token
|
|
326
342
|
* @param {*} [options] Override http request option.
|
|
@@ -331,7 +347,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
|
|
|
331
347
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
332
348
|
},
|
|
333
349
|
/**
|
|
334
|
-
*
|
|
350
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
351
|
+
* @summary Delete the notification template
|
|
335
352
|
* @param {number} id
|
|
336
353
|
* @param {string} [authorization] Bearer Token
|
|
337
354
|
* @param {*} [options] Override http request option.
|
|
@@ -342,7 +359,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
|
|
|
342
359
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
343
360
|
},
|
|
344
361
|
/**
|
|
345
|
-
*
|
|
362
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
363
|
+
* @summary Retrieve the notification template
|
|
346
364
|
* @param {number} id
|
|
347
365
|
* @param {number} id2
|
|
348
366
|
* @param {string} [authorization] Bearer Token
|
|
@@ -355,15 +373,16 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
|
|
|
355
373
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
356
374
|
},
|
|
357
375
|
/**
|
|
358
|
-
*
|
|
376
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
377
|
+
* @summary List notification templates
|
|
359
378
|
* @param {string} [authorization] Bearer Token
|
|
360
379
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
361
380
|
* @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.
|
|
381
|
+
* @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
382
|
* @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.
|
|
383
|
+
* @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>
|
|
384
|
+
* @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>
|
|
385
|
+
* @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
386
|
* @param {*} [options] Override http request option.
|
|
368
387
|
* @throws {RequiredError}
|
|
369
388
|
*/
|
|
@@ -372,7 +391,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
|
|
|
372
391
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
373
392
|
},
|
|
374
393
|
/**
|
|
375
|
-
*
|
|
394
|
+
* 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\"
|
|
395
|
+
* @summary Update the notification template
|
|
376
396
|
* @param {number} id
|
|
377
397
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
378
398
|
* @param {string} [authorization] Bearer Token
|
|
@@ -394,7 +414,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
|
|
|
394
414
|
const localVarFp = NotificationTemplatesApiFp(configuration)
|
|
395
415
|
return {
|
|
396
416
|
/**
|
|
397
|
-
*
|
|
417
|
+
* 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\"
|
|
418
|
+
* @summary Create the notification template
|
|
398
419
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
399
420
|
* @param {string} [authorization] Bearer Token
|
|
400
421
|
* @param {*} [options] Override http request option.
|
|
@@ -404,7 +425,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
|
|
|
404
425
|
return localVarFp.createNotificationTemplate(createNotificationTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
405
426
|
},
|
|
406
427
|
/**
|
|
407
|
-
*
|
|
428
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
429
|
+
* @summary Delete the notification template
|
|
408
430
|
* @param {number} id
|
|
409
431
|
* @param {string} [authorization] Bearer Token
|
|
410
432
|
* @param {*} [options] Override http request option.
|
|
@@ -414,7 +436,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
|
|
|
414
436
|
return localVarFp.deleteNotificationTemplate(id, authorization, options).then((request) => request(axios, basePath));
|
|
415
437
|
},
|
|
416
438
|
/**
|
|
417
|
-
*
|
|
439
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
440
|
+
* @summary Retrieve the notification template
|
|
418
441
|
* @param {number} id
|
|
419
442
|
* @param {number} id2
|
|
420
443
|
* @param {string} [authorization] Bearer Token
|
|
@@ -426,15 +449,16 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
|
|
|
426
449
|
return localVarFp.getNotificationTemplate(id, id2, authorization, expand, options).then((request) => request(axios, basePath));
|
|
427
450
|
},
|
|
428
451
|
/**
|
|
429
|
-
*
|
|
452
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
453
|
+
* @summary List notification templates
|
|
430
454
|
* @param {string} [authorization] Bearer Token
|
|
431
455
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
432
456
|
* @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.
|
|
457
|
+
* @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
458
|
* @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.
|
|
459
|
+
* @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>
|
|
460
|
+
* @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>
|
|
461
|
+
* @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
462
|
* @param {*} [options] Override http request option.
|
|
439
463
|
* @throws {RequiredError}
|
|
440
464
|
*/
|
|
@@ -442,7 +466,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
|
|
|
442
466
|
return localVarFp.listNotificationTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
443
467
|
},
|
|
444
468
|
/**
|
|
445
|
-
*
|
|
469
|
+
* 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\"
|
|
470
|
+
* @summary Update the notification template
|
|
446
471
|
* @param {number} id
|
|
447
472
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
448
473
|
* @param {string} [authorization] Bearer Token
|
|
@@ -560,7 +585,7 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
|
|
|
560
585
|
readonly pageToken?: string
|
|
561
586
|
|
|
562
587
|
/**
|
|
563
|
-
* Filter the response by one or multiple fields.
|
|
588
|
+
* 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
589
|
* @type {string}
|
|
565
590
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
566
591
|
*/
|
|
@@ -574,21 +599,21 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
|
|
|
574
599
|
readonly search?: string
|
|
575
600
|
|
|
576
601
|
/**
|
|
577
|
-
*
|
|
602
|
+
* 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
603
|
* @type {string}
|
|
579
604
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
580
605
|
*/
|
|
581
606
|
readonly order?: string
|
|
582
607
|
|
|
583
608
|
/**
|
|
584
|
-
*
|
|
609
|
+
* 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
610
|
* @type {string}
|
|
586
611
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
587
612
|
*/
|
|
588
613
|
readonly expand?: string
|
|
589
614
|
|
|
590
615
|
/**
|
|
591
|
-
* Filters the response by one or multiple fields.
|
|
616
|
+
* 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
617
|
* @type {string}
|
|
593
618
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
594
619
|
*/
|
|
@@ -631,7 +656,8 @@ export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
|
|
|
631
656
|
*/
|
|
632
657
|
export class NotificationTemplatesApi extends BaseAPI {
|
|
633
658
|
/**
|
|
634
|
-
*
|
|
659
|
+
* 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\"
|
|
660
|
+
* @summary Create the notification template
|
|
635
661
|
* @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
|
|
636
662
|
* @param {*} [options] Override http request option.
|
|
637
663
|
* @throws {RequiredError}
|
|
@@ -642,7 +668,8 @@ export class NotificationTemplatesApi extends BaseAPI {
|
|
|
642
668
|
}
|
|
643
669
|
|
|
644
670
|
/**
|
|
645
|
-
*
|
|
671
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
672
|
+
* @summary Delete the notification template
|
|
646
673
|
* @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
|
|
647
674
|
* @param {*} [options] Override http request option.
|
|
648
675
|
* @throws {RequiredError}
|
|
@@ -653,7 +680,8 @@ export class NotificationTemplatesApi extends BaseAPI {
|
|
|
653
680
|
}
|
|
654
681
|
|
|
655
682
|
/**
|
|
656
|
-
*
|
|
683
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
684
|
+
* @summary Retrieve the notification template
|
|
657
685
|
* @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
|
|
658
686
|
* @param {*} [options] Override http request option.
|
|
659
687
|
* @throws {RequiredError}
|
|
@@ -664,7 +692,8 @@ export class NotificationTemplatesApi extends BaseAPI {
|
|
|
664
692
|
}
|
|
665
693
|
|
|
666
694
|
/**
|
|
667
|
-
*
|
|
695
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
696
|
+
* @summary List notification templates
|
|
668
697
|
* @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
|
|
669
698
|
* @param {*} [options] Override http request option.
|
|
670
699
|
* @throws {RequiredError}
|
|
@@ -675,7 +704,8 @@ export class NotificationTemplatesApi extends BaseAPI {
|
|
|
675
704
|
}
|
|
676
705
|
|
|
677
706
|
/**
|
|
678
|
-
*
|
|
707
|
+
* 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\"
|
|
708
|
+
* @summary Update the notification template
|
|
679
709
|
* @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
|
|
680
710
|
* @param {*} [options] Override http request option.
|
|
681
711
|
* @throws {RequiredError}
|