@emilgroup/notification-sdk 0.8.1-beta.29 → 0.8.1-beta.30
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 -7
- package/README.md +2 -2
- package/api/email-messages-api.ts +24 -156
- package/api/email-tracking-api.ts +24 -32
- package/api/email-verifications-api.ts +8 -16
- package/api/layouts-api.ts +36 -56
- package/api/notification-templates-api.ts +36 -56
- package/api/notifications-api.ts +4 -115
- package/api.ts +0 -2
- package/dist/api/email-messages-api.d.ts +24 -102
- package/dist/api/email-messages-api.js +22 -133
- package/dist/api/email-tracking-api.d.ts +24 -32
- package/dist/api/email-tracking-api.js +22 -30
- package/dist/api/email-verifications-api.d.ts +8 -16
- package/dist/api/email-verifications-api.js +8 -16
- package/dist/api/layouts-api.d.ts +36 -56
- package/dist/api/layouts-api.js +32 -52
- package/dist/api/notification-templates-api.d.ts +36 -56
- package/dist/api/notification-templates-api.js +32 -52
- package/dist/api/notifications-api.d.ts +4 -65
- package/dist/api/notifications-api.js +4 -101
- package/dist/api.d.ts +0 -1
- package/dist/api.js +0 -1
- package/dist/models/email-message-class.d.ts +2 -49
- package/dist/models/email-message-class.js +2 -16
- package/dist/models/index.d.ts +0 -6
- package/dist/models/index.js +0 -6
- package/dist/models/send-notification-request-dto.d.ts +0 -1
- package/dist/models/send-notification-request-dto.js +1 -2
- package/models/email-message-class.ts +3 -53
- package/models/index.ts +0 -6
- package/models/send-notification-request-dto.ts +1 -2
- package/package.json +1 -1
- package/api/msgraph-webhooks-api.ts +0 -278
- package/dist/api/msgraph-webhooks-api.d.ts +0 -168
- package/dist/api/msgraph-webhooks-api.js +0 -305
- package/dist/models/assign-email-message-entity-body-dto.d.ts +0 -43
- package/dist/models/assign-email-message-entity-body-dto.js +0 -22
- package/dist/models/assign-email-message-entity-response-class.d.ts +0 -25
- package/dist/models/assign-email-message-entity-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/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/models/assign-email-message-entity-body-dto.ts +0 -52
- package/models/assign-email-message-entity-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/send-email-request-dto.ts +0 -138
- package/models/send-email-response-class.ts +0 -30
|
@@ -24,8 +24,7 @@ import { UpdateNotificationTemplateResponseClass } from '../models';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
28
|
-
* @summary Create the notification template
|
|
27
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
29
28
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
30
29
|
* @param {string} [authorization] Bearer Token
|
|
31
30
|
* @param {*} [options] Override http request option.
|
|
@@ -33,8 +32,7 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
|
|
|
33
32
|
*/
|
|
34
33
|
createNotificationTemplate: (createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
34
|
/**
|
|
36
|
-
*
|
|
37
|
-
* @summary Delete the notification template
|
|
35
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
38
36
|
* @param {number} id
|
|
39
37
|
* @param {string} [authorization] Bearer Token
|
|
40
38
|
* @param {*} [options] Override http request option.
|
|
@@ -42,8 +40,7 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
|
|
|
42
40
|
*/
|
|
43
41
|
deleteNotificationTemplate: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
42
|
/**
|
|
45
|
-
*
|
|
46
|
-
* @summary Retrieve the notification template
|
|
43
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
47
44
|
* @param {number} id
|
|
48
45
|
* @param {number} id2
|
|
49
46
|
* @param {string} [authorization] Bearer Token
|
|
@@ -53,23 +50,21 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
|
|
|
53
50
|
*/
|
|
54
51
|
getNotificationTemplate: (id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
52
|
/**
|
|
56
|
-
*
|
|
57
|
-
* @summary List notification templates
|
|
53
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
58
54
|
* @param {string} [authorization] Bearer Token
|
|
59
55
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
60
56
|
* @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.
|
|
61
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
57
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
62
58
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
63
|
-
* @param {string} [order]
|
|
64
|
-
* @param {string} [expand]
|
|
65
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
59
|
+
* @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.
|
|
60
|
+
* @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.
|
|
61
|
+
* @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.
|
|
66
62
|
* @param {*} [options] Override http request option.
|
|
67
63
|
* @throws {RequiredError}
|
|
68
64
|
*/
|
|
69
65
|
listNotificationTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
66
|
/**
|
|
71
|
-
*
|
|
72
|
-
* @summary Update the notification template
|
|
67
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
73
68
|
* @param {number} id
|
|
74
69
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
75
70
|
* @param {string} [authorization] Bearer Token
|
|
@@ -84,8 +79,7 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
|
|
|
84
79
|
*/
|
|
85
80
|
export declare const NotificationTemplatesApiFp: (configuration?: Configuration) => {
|
|
86
81
|
/**
|
|
87
|
-
*
|
|
88
|
-
* @summary Create the notification template
|
|
82
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
89
83
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
90
84
|
* @param {string} [authorization] Bearer Token
|
|
91
85
|
* @param {*} [options] Override http request option.
|
|
@@ -93,8 +87,7 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
|
|
|
93
87
|
*/
|
|
94
88
|
createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNotificationTemplateResponseClass>>;
|
|
95
89
|
/**
|
|
96
|
-
*
|
|
97
|
-
* @summary Delete the notification template
|
|
90
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
98
91
|
* @param {number} id
|
|
99
92
|
* @param {string} [authorization] Bearer Token
|
|
100
93
|
* @param {*} [options] Override http request option.
|
|
@@ -102,8 +95,7 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
|
|
|
102
95
|
*/
|
|
103
96
|
deleteNotificationTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
104
97
|
/**
|
|
105
|
-
*
|
|
106
|
-
* @summary Retrieve the notification template
|
|
98
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
107
99
|
* @param {number} id
|
|
108
100
|
* @param {number} id2
|
|
109
101
|
* @param {string} [authorization] Bearer Token
|
|
@@ -113,23 +105,21 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
|
|
|
113
105
|
*/
|
|
114
106
|
getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNotificationTemplateResponseClass>>;
|
|
115
107
|
/**
|
|
116
|
-
*
|
|
117
|
-
* @summary List notification templates
|
|
108
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
118
109
|
* @param {string} [authorization] Bearer Token
|
|
119
110
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
120
111
|
* @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.
|
|
121
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
112
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
122
113
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
123
|
-
* @param {string} [order]
|
|
124
|
-
* @param {string} [expand]
|
|
125
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
114
|
+
* @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.
|
|
115
|
+
* @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.
|
|
116
|
+
* @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.
|
|
126
117
|
* @param {*} [options] Override http request option.
|
|
127
118
|
* @throws {RequiredError}
|
|
128
119
|
*/
|
|
129
120
|
listNotificationTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNotificationTemplatesResponseClass>>;
|
|
130
121
|
/**
|
|
131
|
-
*
|
|
132
|
-
* @summary Update the notification template
|
|
122
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
133
123
|
* @param {number} id
|
|
134
124
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
135
125
|
* @param {string} [authorization] Bearer Token
|
|
@@ -144,8 +134,7 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
|
|
|
144
134
|
*/
|
|
145
135
|
export declare const NotificationTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
146
136
|
/**
|
|
147
|
-
*
|
|
148
|
-
* @summary Create the notification template
|
|
137
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
149
138
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
150
139
|
* @param {string} [authorization] Bearer Token
|
|
151
140
|
* @param {*} [options] Override http request option.
|
|
@@ -153,8 +142,7 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
|
|
|
153
142
|
*/
|
|
154
143
|
createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateNotificationTemplateResponseClass>;
|
|
155
144
|
/**
|
|
156
|
-
*
|
|
157
|
-
* @summary Delete the notification template
|
|
145
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
158
146
|
* @param {number} id
|
|
159
147
|
* @param {string} [authorization] Bearer Token
|
|
160
148
|
* @param {*} [options] Override http request option.
|
|
@@ -162,8 +150,7 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
|
|
|
162
150
|
*/
|
|
163
151
|
deleteNotificationTemplate(id: number, authorization?: string, options?: any): AxiosPromise<object>;
|
|
164
152
|
/**
|
|
165
|
-
*
|
|
166
|
-
* @summary Retrieve the notification template
|
|
153
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
167
154
|
* @param {number} id
|
|
168
155
|
* @param {number} id2
|
|
169
156
|
* @param {string} [authorization] Bearer Token
|
|
@@ -173,23 +160,21 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
|
|
|
173
160
|
*/
|
|
174
161
|
getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetNotificationTemplateResponseClass>;
|
|
175
162
|
/**
|
|
176
|
-
*
|
|
177
|
-
* @summary List notification templates
|
|
163
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
178
164
|
* @param {string} [authorization] Bearer Token
|
|
179
165
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
180
166
|
* @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.
|
|
181
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
167
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
182
168
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
183
|
-
* @param {string} [order]
|
|
184
|
-
* @param {string} [expand]
|
|
185
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
169
|
+
* @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.
|
|
170
|
+
* @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.
|
|
171
|
+
* @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.
|
|
186
172
|
* @param {*} [options] Override http request option.
|
|
187
173
|
* @throws {RequiredError}
|
|
188
174
|
*/
|
|
189
175
|
listNotificationTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListNotificationTemplatesResponseClass>;
|
|
190
176
|
/**
|
|
191
|
-
*
|
|
192
|
-
* @summary Update the notification template
|
|
177
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
193
178
|
* @param {number} id
|
|
194
179
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
195
180
|
* @param {string} [authorization] Bearer Token
|
|
@@ -292,7 +277,7 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
|
|
|
292
277
|
*/
|
|
293
278
|
readonly pageToken?: string;
|
|
294
279
|
/**
|
|
295
|
-
* Filter the response by one or multiple fields.
|
|
280
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
296
281
|
* @type {string}
|
|
297
282
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
298
283
|
*/
|
|
@@ -304,19 +289,19 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
|
|
|
304
289
|
*/
|
|
305
290
|
readonly search?: string;
|
|
306
291
|
/**
|
|
307
|
-
*
|
|
292
|
+
* 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.
|
|
308
293
|
* @type {string}
|
|
309
294
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
310
295
|
*/
|
|
311
296
|
readonly order?: string;
|
|
312
297
|
/**
|
|
313
|
-
*
|
|
298
|
+
* 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.
|
|
314
299
|
* @type {string}
|
|
315
300
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
316
301
|
*/
|
|
317
302
|
readonly expand?: string;
|
|
318
303
|
/**
|
|
319
|
-
* Filters the response by one or multiple fields.
|
|
304
|
+
* 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.
|
|
320
305
|
* @type {string}
|
|
321
306
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
322
307
|
*/
|
|
@@ -355,8 +340,7 @@ export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
|
|
|
355
340
|
*/
|
|
356
341
|
export declare class NotificationTemplatesApi extends BaseAPI {
|
|
357
342
|
/**
|
|
358
|
-
*
|
|
359
|
-
* @summary Create the notification template
|
|
343
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
360
344
|
* @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
|
|
361
345
|
* @param {*} [options] Override http request option.
|
|
362
346
|
* @throws {RequiredError}
|
|
@@ -364,8 +348,7 @@ export declare class NotificationTemplatesApi extends BaseAPI {
|
|
|
364
348
|
*/
|
|
365
349
|
createNotificationTemplate(requestParameters: NotificationTemplatesApiCreateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateNotificationTemplateResponseClass, any, {}>>;
|
|
366
350
|
/**
|
|
367
|
-
*
|
|
368
|
-
* @summary Delete the notification template
|
|
351
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
369
352
|
* @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
|
|
370
353
|
* @param {*} [options] Override http request option.
|
|
371
354
|
* @throws {RequiredError}
|
|
@@ -373,8 +356,7 @@ export declare class NotificationTemplatesApi extends BaseAPI {
|
|
|
373
356
|
*/
|
|
374
357
|
deleteNotificationTemplate(requestParameters: NotificationTemplatesApiDeleteNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
375
358
|
/**
|
|
376
|
-
*
|
|
377
|
-
* @summary Retrieve the notification template
|
|
359
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
378
360
|
* @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
|
|
379
361
|
* @param {*} [options] Override http request option.
|
|
380
362
|
* @throws {RequiredError}
|
|
@@ -382,8 +364,7 @@ export declare class NotificationTemplatesApi extends BaseAPI {
|
|
|
382
364
|
*/
|
|
383
365
|
getNotificationTemplate(requestParameters: NotificationTemplatesApiGetNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNotificationTemplateResponseClass, any, {}>>;
|
|
384
366
|
/**
|
|
385
|
-
*
|
|
386
|
-
* @summary List notification templates
|
|
367
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
387
368
|
* @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
|
|
388
369
|
* @param {*} [options] Override http request option.
|
|
389
370
|
* @throws {RequiredError}
|
|
@@ -391,8 +372,7 @@ export declare class NotificationTemplatesApi extends BaseAPI {
|
|
|
391
372
|
*/
|
|
392
373
|
listNotificationTemplates(requestParameters?: NotificationTemplatesApiListNotificationTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNotificationTemplatesResponseClass, any, {}>>;
|
|
393
374
|
/**
|
|
394
|
-
*
|
|
395
|
-
* @summary Update the notification template
|
|
375
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
396
376
|
* @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
|
|
397
377
|
* @param {*} [options] Override http request option.
|
|
398
378
|
* @throws {RequiredError}
|
|
@@ -93,8 +93,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
97
|
-
* @summary Create the notification template
|
|
96
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
98
97
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
99
98
|
* @param {string} [authorization] Bearer Token
|
|
100
99
|
* @param {*} [options] Override http request option.
|
|
@@ -142,8 +141,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
142
141
|
});
|
|
143
142
|
},
|
|
144
143
|
/**
|
|
145
|
-
*
|
|
146
|
-
* @summary Delete the notification template
|
|
144
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
147
145
|
* @param {number} id
|
|
148
146
|
* @param {string} [authorization] Bearer Token
|
|
149
147
|
* @param {*} [options] Override http request option.
|
|
@@ -190,8 +188,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
190
188
|
});
|
|
191
189
|
},
|
|
192
190
|
/**
|
|
193
|
-
*
|
|
194
|
-
* @summary Retrieve the notification template
|
|
191
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
195
192
|
* @param {number} id
|
|
196
193
|
* @param {number} id2
|
|
197
194
|
* @param {string} [authorization] Bearer Token
|
|
@@ -248,16 +245,15 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
248
245
|
});
|
|
249
246
|
},
|
|
250
247
|
/**
|
|
251
|
-
*
|
|
252
|
-
* @summary List notification templates
|
|
248
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
253
249
|
* @param {string} [authorization] Bearer Token
|
|
254
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
255
251
|
* @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.
|
|
256
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
252
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
257
253
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
258
|
-
* @param {string} [order]
|
|
259
|
-
* @param {string} [expand]
|
|
260
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
254
|
+
* @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.
|
|
255
|
+
* @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.
|
|
256
|
+
* @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.
|
|
261
257
|
* @param {*} [options] Override http request option.
|
|
262
258
|
* @throws {RequiredError}
|
|
263
259
|
*/
|
|
@@ -320,8 +316,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
320
316
|
});
|
|
321
317
|
},
|
|
322
318
|
/**
|
|
323
|
-
*
|
|
324
|
-
* @summary Update the notification template
|
|
319
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
325
320
|
* @param {number} id
|
|
326
321
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
327
322
|
* @param {string} [authorization] Bearer Token
|
|
@@ -383,8 +378,7 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
383
378
|
var localVarAxiosParamCreator = (0, exports.NotificationTemplatesApiAxiosParamCreator)(configuration);
|
|
384
379
|
return {
|
|
385
380
|
/**
|
|
386
|
-
*
|
|
387
|
-
* @summary Create the notification template
|
|
381
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
388
382
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
389
383
|
* @param {string} [authorization] Bearer Token
|
|
390
384
|
* @param {*} [options] Override http request option.
|
|
@@ -404,8 +398,7 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
404
398
|
});
|
|
405
399
|
},
|
|
406
400
|
/**
|
|
407
|
-
*
|
|
408
|
-
* @summary Delete the notification template
|
|
401
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
409
402
|
* @param {number} id
|
|
410
403
|
* @param {string} [authorization] Bearer Token
|
|
411
404
|
* @param {*} [options] Override http request option.
|
|
@@ -425,8 +418,7 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
425
418
|
});
|
|
426
419
|
},
|
|
427
420
|
/**
|
|
428
|
-
*
|
|
429
|
-
* @summary Retrieve the notification template
|
|
421
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
430
422
|
* @param {number} id
|
|
431
423
|
* @param {number} id2
|
|
432
424
|
* @param {string} [authorization] Bearer Token
|
|
@@ -448,16 +440,15 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
448
440
|
});
|
|
449
441
|
},
|
|
450
442
|
/**
|
|
451
|
-
*
|
|
452
|
-
* @summary List notification templates
|
|
443
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
453
444
|
* @param {string} [authorization] Bearer Token
|
|
454
445
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
455
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.
|
|
456
|
-
* @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.
|
|
457
448
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
458
|
-
* @param {string} [order]
|
|
459
|
-
* @param {string} [expand]
|
|
460
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
449
|
+
* @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.
|
|
450
|
+
* @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.
|
|
451
|
+
* @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.
|
|
461
452
|
* @param {*} [options] Override http request option.
|
|
462
453
|
* @throws {RequiredError}
|
|
463
454
|
*/
|
|
@@ -475,8 +466,7 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
475
466
|
});
|
|
476
467
|
},
|
|
477
468
|
/**
|
|
478
|
-
*
|
|
479
|
-
* @summary Update the notification template
|
|
469
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
480
470
|
* @param {number} id
|
|
481
471
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
482
472
|
* @param {string} [authorization] Bearer Token
|
|
@@ -507,8 +497,7 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
507
497
|
var localVarFp = (0, exports.NotificationTemplatesApiFp)(configuration);
|
|
508
498
|
return {
|
|
509
499
|
/**
|
|
510
|
-
*
|
|
511
|
-
* @summary Create the notification template
|
|
500
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
512
501
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
513
502
|
* @param {string} [authorization] Bearer Token
|
|
514
503
|
* @param {*} [options] Override http request option.
|
|
@@ -518,8 +507,7 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
518
507
|
return localVarFp.createNotificationTemplate(createNotificationTemplateRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
519
508
|
},
|
|
520
509
|
/**
|
|
521
|
-
*
|
|
522
|
-
* @summary Delete the notification template
|
|
510
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
523
511
|
* @param {number} id
|
|
524
512
|
* @param {string} [authorization] Bearer Token
|
|
525
513
|
* @param {*} [options] Override http request option.
|
|
@@ -529,8 +517,7 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
529
517
|
return localVarFp.deleteNotificationTemplate(id, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
530
518
|
},
|
|
531
519
|
/**
|
|
532
|
-
*
|
|
533
|
-
* @summary Retrieve the notification template
|
|
520
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
534
521
|
* @param {number} id
|
|
535
522
|
* @param {number} id2
|
|
536
523
|
* @param {string} [authorization] Bearer Token
|
|
@@ -542,16 +529,15 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
542
529
|
return localVarFp.getNotificationTemplate(id, id2, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
543
530
|
},
|
|
544
531
|
/**
|
|
545
|
-
*
|
|
546
|
-
* @summary List notification templates
|
|
532
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
547
533
|
* @param {string} [authorization] Bearer Token
|
|
548
534
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
549
535
|
* @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.
|
|
550
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
536
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
551
537
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
552
|
-
* @param {string} [order]
|
|
553
|
-
* @param {string} [expand]
|
|
554
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
538
|
+
* @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.
|
|
539
|
+
* @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.
|
|
540
|
+
* @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.
|
|
555
541
|
* @param {*} [options] Override http request option.
|
|
556
542
|
* @throws {RequiredError}
|
|
557
543
|
*/
|
|
@@ -559,8 +545,7 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
559
545
|
return localVarFp.listNotificationTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
560
546
|
},
|
|
561
547
|
/**
|
|
562
|
-
*
|
|
563
|
-
* @summary Update the notification template
|
|
548
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
564
549
|
* @param {number} id
|
|
565
550
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
566
551
|
* @param {string} [authorization] Bearer Token
|
|
@@ -585,8 +570,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
585
570
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
586
571
|
}
|
|
587
572
|
/**
|
|
588
|
-
*
|
|
589
|
-
* @summary Create the notification template
|
|
573
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
590
574
|
* @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
|
|
591
575
|
* @param {*} [options] Override http request option.
|
|
592
576
|
* @throws {RequiredError}
|
|
@@ -597,8 +581,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
597
581
|
return (0, exports.NotificationTemplatesApiFp)(this.configuration).createNotificationTemplate(requestParameters.createNotificationTemplateRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
598
582
|
};
|
|
599
583
|
/**
|
|
600
|
-
*
|
|
601
|
-
* @summary Delete the notification template
|
|
584
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
602
585
|
* @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
|
|
603
586
|
* @param {*} [options] Override http request option.
|
|
604
587
|
* @throws {RequiredError}
|
|
@@ -609,8 +592,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
609
592
|
return (0, exports.NotificationTemplatesApiFp)(this.configuration).deleteNotificationTemplate(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
610
593
|
};
|
|
611
594
|
/**
|
|
612
|
-
*
|
|
613
|
-
* @summary Retrieve the notification template
|
|
595
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
614
596
|
* @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
|
|
615
597
|
* @param {*} [options] Override http request option.
|
|
616
598
|
* @throws {RequiredError}
|
|
@@ -621,8 +603,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
621
603
|
return (0, exports.NotificationTemplatesApiFp)(this.configuration).getNotificationTemplate(requestParameters.id, requestParameters.id2, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
622
604
|
};
|
|
623
605
|
/**
|
|
624
|
-
*
|
|
625
|
-
* @summary List notification templates
|
|
606
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
626
607
|
* @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
|
|
627
608
|
* @param {*} [options] Override http request option.
|
|
628
609
|
* @throws {RequiredError}
|
|
@@ -634,8 +615,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
634
615
|
return (0, exports.NotificationTemplatesApiFp)(this.configuration).listNotificationTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
635
616
|
};
|
|
636
617
|
/**
|
|
637
|
-
*
|
|
638
|
-
* @summary Update the notification template
|
|
618
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
639
619
|
* @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
|
|
640
620
|
* @param {*} [options] Override http request option.
|
|
641
621
|
* @throws {RequiredError}
|