@emilgroup/notification-sdk 0.8.1-beta.38 → 0.8.1-beta.4
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 -8
- package/README.md +2 -2
- package/api/email-messages-api.ts +24 -259
- 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 -158
- package/dist/api/email-messages-api.js +22 -225
- 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 -7
- package/dist/models/index.js +0 -7
- package/dist/models/send-notification-request-dto.d.ts +0 -9
- package/dist/models/send-notification-request-dto.js +1 -2
- package/models/email-message-class.ts +3 -53
- package/models/index.ts +0 -7
- package/models/send-notification-request-dto.ts +1 -8
- 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/dist/models/unassign-email-message-entity-response-class.d.ts +0 -25
- package/dist/models/unassign-email-message-entity-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
- package/models/unassign-email-message-entity-response-class.ts +0 -31
package/dist/api/layouts-api.js
CHANGED
|
@@ -93,8 +93,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
97
|
-
* @summary Create the layout
|
|
96
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
98
97
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
99
98
|
* @param {string} [authorization] Bearer Token
|
|
100
99
|
* @param {*} [options] Override http request option.
|
|
@@ -142,8 +141,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
142
141
|
});
|
|
143
142
|
},
|
|
144
143
|
/**
|
|
145
|
-
*
|
|
146
|
-
* @summary Delete the layout
|
|
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 LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
190
188
|
});
|
|
191
189
|
},
|
|
192
190
|
/**
|
|
193
|
-
*
|
|
194
|
-
* @summary Retrieve the layout
|
|
191
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
195
192
|
* @param {number} id
|
|
196
193
|
* @param {number} id2 Layout id
|
|
197
194
|
* @param {string} [authorization] Bearer Token
|
|
@@ -244,16 +241,15 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
244
241
|
});
|
|
245
242
|
},
|
|
246
243
|
/**
|
|
247
|
-
*
|
|
248
|
-
* @summary List layouts
|
|
244
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
249
245
|
* @param {string} [authorization] Bearer Token
|
|
250
246
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
247
|
* @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.
|
|
252
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
248
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
253
249
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
|
-
* @param {string} [order]
|
|
255
|
-
* @param {string} [expand]
|
|
256
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
250
|
+
* @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.
|
|
251
|
+
* @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.
|
|
252
|
+
* @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.
|
|
257
253
|
* @param {*} [options] Override http request option.
|
|
258
254
|
* @throws {RequiredError}
|
|
259
255
|
*/
|
|
@@ -316,8 +312,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
316
312
|
});
|
|
317
313
|
},
|
|
318
314
|
/**
|
|
319
|
-
*
|
|
320
|
-
* @summary Update the layout
|
|
315
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
321
316
|
* @param {number} id
|
|
322
317
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
323
318
|
* @param {string} [authorization] Bearer Token
|
|
@@ -379,8 +374,7 @@ var LayoutsApiFp = function (configuration) {
|
|
|
379
374
|
var localVarAxiosParamCreator = (0, exports.LayoutsApiAxiosParamCreator)(configuration);
|
|
380
375
|
return {
|
|
381
376
|
/**
|
|
382
|
-
*
|
|
383
|
-
* @summary Create the layout
|
|
377
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
384
378
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
385
379
|
* @param {string} [authorization] Bearer Token
|
|
386
380
|
* @param {*} [options] Override http request option.
|
|
@@ -400,8 +394,7 @@ var LayoutsApiFp = function (configuration) {
|
|
|
400
394
|
});
|
|
401
395
|
},
|
|
402
396
|
/**
|
|
403
|
-
*
|
|
404
|
-
* @summary Delete the layout
|
|
397
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
405
398
|
* @param {number} id
|
|
406
399
|
* @param {string} [authorization] Bearer Token
|
|
407
400
|
* @param {*} [options] Override http request option.
|
|
@@ -421,8 +414,7 @@ var LayoutsApiFp = function (configuration) {
|
|
|
421
414
|
});
|
|
422
415
|
},
|
|
423
416
|
/**
|
|
424
|
-
*
|
|
425
|
-
* @summary Retrieve the layout
|
|
417
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
426
418
|
* @param {number} id
|
|
427
419
|
* @param {number} id2 Layout id
|
|
428
420
|
* @param {string} [authorization] Bearer Token
|
|
@@ -443,16 +435,15 @@ var LayoutsApiFp = function (configuration) {
|
|
|
443
435
|
});
|
|
444
436
|
},
|
|
445
437
|
/**
|
|
446
|
-
*
|
|
447
|
-
* @summary List layouts
|
|
438
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
448
439
|
* @param {string} [authorization] Bearer Token
|
|
449
440
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
450
441
|
* @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.
|
|
451
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
442
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
452
443
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
453
|
-
* @param {string} [order]
|
|
454
|
-
* @param {string} [expand]
|
|
455
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
444
|
+
* @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.
|
|
445
|
+
* @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.
|
|
446
|
+
* @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.
|
|
456
447
|
* @param {*} [options] Override http request option.
|
|
457
448
|
* @throws {RequiredError}
|
|
458
449
|
*/
|
|
@@ -470,8 +461,7 @@ var LayoutsApiFp = function (configuration) {
|
|
|
470
461
|
});
|
|
471
462
|
},
|
|
472
463
|
/**
|
|
473
|
-
*
|
|
474
|
-
* @summary Update the layout
|
|
464
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
475
465
|
* @param {number} id
|
|
476
466
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
477
467
|
* @param {string} [authorization] Bearer Token
|
|
@@ -502,8 +492,7 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
502
492
|
var localVarFp = (0, exports.LayoutsApiFp)(configuration);
|
|
503
493
|
return {
|
|
504
494
|
/**
|
|
505
|
-
*
|
|
506
|
-
* @summary Create the layout
|
|
495
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
507
496
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
508
497
|
* @param {string} [authorization] Bearer Token
|
|
509
498
|
* @param {*} [options] Override http request option.
|
|
@@ -513,8 +502,7 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
513
502
|
return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
514
503
|
},
|
|
515
504
|
/**
|
|
516
|
-
*
|
|
517
|
-
* @summary Delete the layout
|
|
505
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
518
506
|
* @param {number} id
|
|
519
507
|
* @param {string} [authorization] Bearer Token
|
|
520
508
|
* @param {*} [options] Override http request option.
|
|
@@ -524,8 +512,7 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
524
512
|
return localVarFp.deleteLayout(id, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
525
513
|
},
|
|
526
514
|
/**
|
|
527
|
-
*
|
|
528
|
-
* @summary Retrieve the layout
|
|
515
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
529
516
|
* @param {number} id
|
|
530
517
|
* @param {number} id2 Layout id
|
|
531
518
|
* @param {string} [authorization] Bearer Token
|
|
@@ -536,16 +523,15 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
536
523
|
return localVarFp.getLayout(id, id2, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
537
524
|
},
|
|
538
525
|
/**
|
|
539
|
-
*
|
|
540
|
-
* @summary List layouts
|
|
526
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
541
527
|
* @param {string} [authorization] Bearer Token
|
|
542
528
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
543
529
|
* @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.
|
|
544
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
530
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
545
531
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
546
|
-
* @param {string} [order]
|
|
547
|
-
* @param {string} [expand]
|
|
548
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
532
|
+
* @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.
|
|
533
|
+
* @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.
|
|
534
|
+
* @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.
|
|
549
535
|
* @param {*} [options] Override http request option.
|
|
550
536
|
* @throws {RequiredError}
|
|
551
537
|
*/
|
|
@@ -553,8 +539,7 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
553
539
|
return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
554
540
|
},
|
|
555
541
|
/**
|
|
556
|
-
*
|
|
557
|
-
* @summary Update the layout
|
|
542
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
558
543
|
* @param {number} id
|
|
559
544
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
560
545
|
* @param {string} [authorization] Bearer Token
|
|
@@ -579,8 +564,7 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
579
564
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
580
565
|
}
|
|
581
566
|
/**
|
|
582
|
-
*
|
|
583
|
-
* @summary Create the layout
|
|
567
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
584
568
|
* @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
|
|
585
569
|
* @param {*} [options] Override http request option.
|
|
586
570
|
* @throws {RequiredError}
|
|
@@ -591,8 +575,7 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
591
575
|
return (0, exports.LayoutsApiFp)(this.configuration).createLayout(requestParameters.createLayoutRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
592
576
|
};
|
|
593
577
|
/**
|
|
594
|
-
*
|
|
595
|
-
* @summary Delete the layout
|
|
578
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
596
579
|
* @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
|
|
597
580
|
* @param {*} [options] Override http request option.
|
|
598
581
|
* @throws {RequiredError}
|
|
@@ -603,8 +586,7 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
603
586
|
return (0, exports.LayoutsApiFp)(this.configuration).deleteLayout(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
604
587
|
};
|
|
605
588
|
/**
|
|
606
|
-
*
|
|
607
|
-
* @summary Retrieve the layout
|
|
589
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
608
590
|
* @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
|
|
609
591
|
* @param {*} [options] Override http request option.
|
|
610
592
|
* @throws {RequiredError}
|
|
@@ -615,8 +597,7 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
615
597
|
return (0, exports.LayoutsApiFp)(this.configuration).getLayout(requestParameters.id, requestParameters.id2, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
616
598
|
};
|
|
617
599
|
/**
|
|
618
|
-
*
|
|
619
|
-
* @summary List layouts
|
|
600
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
620
601
|
* @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
|
|
621
602
|
* @param {*} [options] Override http request option.
|
|
622
603
|
* @throws {RequiredError}
|
|
@@ -628,8 +609,7 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
628
609
|
return (0, exports.LayoutsApiFp)(this.configuration).listLayouts(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); });
|
|
629
610
|
};
|
|
630
611
|
/**
|
|
631
|
-
*
|
|
632
|
-
* @summary Update the layout
|
|
612
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
633
613
|
* @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
|
|
634
614
|
* @param {*} [options] Override http request option.
|
|
635
615
|
* @throws {RequiredError}
|
|
@@ -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}
|