@emilgroup/notification-sdk 0.8.1-beta.26 → 0.8.1-beta.28

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.
@@ -93,7 +93,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
96
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
97
+ * @summary Create the layout
97
98
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
98
99
  * @param {string} [authorization] Bearer Token
99
100
  * @param {*} [options] Override http request option.
@@ -141,7 +142,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
141
142
  });
142
143
  },
143
144
  /**
144
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
145
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
146
+ * @summary Delete the layout
145
147
  * @param {number} id
146
148
  * @param {string} [authorization] Bearer Token
147
149
  * @param {*} [options] Override http request option.
@@ -188,7 +190,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
188
190
  });
189
191
  },
190
192
  /**
191
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
193
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
194
+ * @summary Retrieve the layout
192
195
  * @param {number} id
193
196
  * @param {number} id2 Layout id
194
197
  * @param {string} [authorization] Bearer Token
@@ -241,15 +244,16 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
241
244
  });
242
245
  },
243
246
  /**
244
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
247
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
248
+ * @summary List layouts
245
249
  * @param {string} [authorization] Bearer Token
246
250
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
247
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.
248
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
252
+ * @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: id, name, slug</i>
249
253
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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.
254
+ * @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, createdAt</i>
255
+ * @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: headerTemplate, footerTemplate<i>
256
+ * @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: id, name, slug</i>
253
257
  * @param {*} [options] Override http request option.
254
258
  * @throws {RequiredError}
255
259
  */
@@ -312,7 +316,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
312
316
  });
313
317
  },
314
318
  /**
315
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
319
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
320
+ * @summary Update the layout
316
321
  * @param {number} id
317
322
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
318
323
  * @param {string} [authorization] Bearer Token
@@ -374,7 +379,8 @@ var LayoutsApiFp = function (configuration) {
374
379
  var localVarAxiosParamCreator = (0, exports.LayoutsApiAxiosParamCreator)(configuration);
375
380
  return {
376
381
  /**
377
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
382
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
383
+ * @summary Create the layout
378
384
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
379
385
  * @param {string} [authorization] Bearer Token
380
386
  * @param {*} [options] Override http request option.
@@ -394,7 +400,8 @@ var LayoutsApiFp = function (configuration) {
394
400
  });
395
401
  },
396
402
  /**
397
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
403
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
404
+ * @summary Delete the layout
398
405
  * @param {number} id
399
406
  * @param {string} [authorization] Bearer Token
400
407
  * @param {*} [options] Override http request option.
@@ -414,7 +421,8 @@ var LayoutsApiFp = function (configuration) {
414
421
  });
415
422
  },
416
423
  /**
417
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
424
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
425
+ * @summary Retrieve the layout
418
426
  * @param {number} id
419
427
  * @param {number} id2 Layout id
420
428
  * @param {string} [authorization] Bearer Token
@@ -435,15 +443,16 @@ var LayoutsApiFp = function (configuration) {
435
443
  });
436
444
  },
437
445
  /**
438
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
446
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
447
+ * @summary List layouts
439
448
  * @param {string} [authorization] Bearer Token
440
449
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
441
450
  * @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.
442
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
451
+ * @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: id, name, slug</i>
443
452
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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.
453
+ * @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, createdAt</i>
454
+ * @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: headerTemplate, footerTemplate<i>
455
+ * @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: id, name, slug</i>
447
456
  * @param {*} [options] Override http request option.
448
457
  * @throws {RequiredError}
449
458
  */
@@ -461,7 +470,8 @@ var LayoutsApiFp = function (configuration) {
461
470
  });
462
471
  },
463
472
  /**
464
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
473
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
474
+ * @summary Update the layout
465
475
  * @param {number} id
466
476
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
467
477
  * @param {string} [authorization] Bearer Token
@@ -492,7 +502,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
492
502
  var localVarFp = (0, exports.LayoutsApiFp)(configuration);
493
503
  return {
494
504
  /**
495
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
505
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
506
+ * @summary Create the layout
496
507
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
497
508
  * @param {string} [authorization] Bearer Token
498
509
  * @param {*} [options] Override http request option.
@@ -502,7 +513,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
502
513
  return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
503
514
  },
504
515
  /**
505
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
516
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
517
+ * @summary Delete the layout
506
518
  * @param {number} id
507
519
  * @param {string} [authorization] Bearer Token
508
520
  * @param {*} [options] Override http request option.
@@ -512,7 +524,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
512
524
  return localVarFp.deleteLayout(id, authorization, options).then(function (request) { return request(axios, basePath); });
513
525
  },
514
526
  /**
515
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
527
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
528
+ * @summary Retrieve the layout
516
529
  * @param {number} id
517
530
  * @param {number} id2 Layout id
518
531
  * @param {string} [authorization] Bearer Token
@@ -523,15 +536,16 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
523
536
  return localVarFp.getLayout(id, id2, authorization, options).then(function (request) { return request(axios, basePath); });
524
537
  },
525
538
  /**
526
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
539
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
540
+ * @summary List layouts
527
541
  * @param {string} [authorization] Bearer Token
528
542
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
529
543
  * @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.
530
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
544
+ * @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: id, name, slug</i>
531
545
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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.
546
+ * @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, createdAt</i>
547
+ * @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: headerTemplate, footerTemplate<i>
548
+ * @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: id, name, slug</i>
535
549
  * @param {*} [options] Override http request option.
536
550
  * @throws {RequiredError}
537
551
  */
@@ -539,7 +553,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
539
553
  return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
540
554
  },
541
555
  /**
542
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
556
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
557
+ * @summary Update the layout
543
558
  * @param {number} id
544
559
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
545
560
  * @param {string} [authorization] Bearer Token
@@ -564,7 +579,8 @@ var LayoutsApi = /** @class */ (function (_super) {
564
579
  return _super !== null && _super.apply(this, arguments) || this;
565
580
  }
566
581
  /**
567
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
582
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
583
+ * @summary Create the layout
568
584
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
569
585
  * @param {*} [options] Override http request option.
570
586
  * @throws {RequiredError}
@@ -575,7 +591,8 @@ var LayoutsApi = /** @class */ (function (_super) {
575
591
  return (0, exports.LayoutsApiFp)(this.configuration).createLayout(requestParameters.createLayoutRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
576
592
  };
577
593
  /**
578
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
594
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
595
+ * @summary Delete the layout
579
596
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
580
597
  * @param {*} [options] Override http request option.
581
598
  * @throws {RequiredError}
@@ -586,7 +603,8 @@ var LayoutsApi = /** @class */ (function (_super) {
586
603
  return (0, exports.LayoutsApiFp)(this.configuration).deleteLayout(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
587
604
  };
588
605
  /**
589
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
606
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
607
+ * @summary Retrieve the layout
590
608
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
591
609
  * @param {*} [options] Override http request option.
592
610
  * @throws {RequiredError}
@@ -597,7 +615,8 @@ var LayoutsApi = /** @class */ (function (_super) {
597
615
  return (0, exports.LayoutsApiFp)(this.configuration).getLayout(requestParameters.id, requestParameters.id2, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
598
616
  };
599
617
  /**
600
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
618
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
619
+ * @summary List layouts
601
620
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
602
621
  * @param {*} [options] Override http request option.
603
622
  * @throws {RequiredError}
@@ -609,7 +628,8 @@ var LayoutsApi = /** @class */ (function (_super) {
609
628
  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); });
610
629
  };
611
630
  /**
612
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
631
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
632
+ * @summary Update the layout
613
633
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
614
634
  * @param {*} [options] Override http request option.
615
635
  * @throws {RequiredError}
@@ -24,7 +24,8 @@ import { UpdateNotificationTemplateResponseClass } from '../models';
24
24
  */
25
25
  export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
26
26
  /**
27
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
27
+ * 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\"
28
+ * @summary Create the notification template
28
29
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
29
30
  * @param {string} [authorization] Bearer Token
30
31
  * @param {*} [options] Override http request option.
@@ -32,7 +33,8 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
32
33
  */
33
34
  createNotificationTemplate: (createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
35
  /**
35
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
36
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
37
+ * @summary Delete the notification template
36
38
  * @param {number} id
37
39
  * @param {string} [authorization] Bearer Token
38
40
  * @param {*} [options] Override http request option.
@@ -40,7 +42,8 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
40
42
  */
41
43
  deleteNotificationTemplate: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
44
  /**
43
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
45
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
46
+ * @summary Retrieve the notification template
44
47
  * @param {number} id
45
48
  * @param {number} id2
46
49
  * @param {string} [authorization] Bearer Token
@@ -50,21 +53,23 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
50
53
  */
51
54
  getNotificationTemplate: (id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
55
  /**
53
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
56
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
57
+ * @summary List notification templates
54
58
  * @param {string} [authorization] Bearer Token
55
59
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
56
60
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
57
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
61
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: name, slug&lt;/i&gt;
58
62
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
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.
63
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, createdAt&lt;/i&gt;
64
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias&lt;i&gt;
65
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: name, slug&lt;/i&gt;
62
66
  * @param {*} [options] Override http request option.
63
67
  * @throws {RequiredError}
64
68
  */
65
69
  listNotificationTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
66
70
  /**
67
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
71
+ * 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\"
72
+ * @summary Update the notification template
68
73
  * @param {number} id
69
74
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
70
75
  * @param {string} [authorization] Bearer Token
@@ -79,7 +84,8 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
79
84
  */
80
85
  export declare const NotificationTemplatesApiFp: (configuration?: Configuration) => {
81
86
  /**
82
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
87
+ * 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\"
88
+ * @summary Create the notification template
83
89
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
84
90
  * @param {string} [authorization] Bearer Token
85
91
  * @param {*} [options] Override http request option.
@@ -87,7 +93,8 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
87
93
  */
88
94
  createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNotificationTemplateResponseClass>>;
89
95
  /**
90
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
96
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
97
+ * @summary Delete the notification template
91
98
  * @param {number} id
92
99
  * @param {string} [authorization] Bearer Token
93
100
  * @param {*} [options] Override http request option.
@@ -95,7 +102,8 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
95
102
  */
96
103
  deleteNotificationTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
97
104
  /**
98
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
105
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
106
+ * @summary Retrieve the notification template
99
107
  * @param {number} id
100
108
  * @param {number} id2
101
109
  * @param {string} [authorization] Bearer Token
@@ -105,21 +113,23 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
105
113
  */
106
114
  getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNotificationTemplateResponseClass>>;
107
115
  /**
108
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
116
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
117
+ * @summary List notification templates
109
118
  * @param {string} [authorization] Bearer Token
110
119
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
111
120
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
112
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
121
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: name, slug&lt;/i&gt;
113
122
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
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.
123
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, createdAt&lt;/i&gt;
124
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias&lt;i&gt;
125
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: name, slug&lt;/i&gt;
117
126
  * @param {*} [options] Override http request option.
118
127
  * @throws {RequiredError}
119
128
  */
120
129
  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>>;
121
130
  /**
122
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
131
+ * 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\"
132
+ * @summary Update the notification template
123
133
  * @param {number} id
124
134
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
125
135
  * @param {string} [authorization] Bearer Token
@@ -134,7 +144,8 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
134
144
  */
135
145
  export declare const NotificationTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
136
146
  /**
137
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
147
+ * 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\"
148
+ * @summary Create the notification template
138
149
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
139
150
  * @param {string} [authorization] Bearer Token
140
151
  * @param {*} [options] Override http request option.
@@ -142,7 +153,8 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
142
153
  */
143
154
  createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateNotificationTemplateResponseClass>;
144
155
  /**
145
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
156
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
157
+ * @summary Delete the notification template
146
158
  * @param {number} id
147
159
  * @param {string} [authorization] Bearer Token
148
160
  * @param {*} [options] Override http request option.
@@ -150,7 +162,8 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
150
162
  */
151
163
  deleteNotificationTemplate(id: number, authorization?: string, options?: any): AxiosPromise<object>;
152
164
  /**
153
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
165
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
166
+ * @summary Retrieve the notification template
154
167
  * @param {number} id
155
168
  * @param {number} id2
156
169
  * @param {string} [authorization] Bearer Token
@@ -160,21 +173,23 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
160
173
  */
161
174
  getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetNotificationTemplateResponseClass>;
162
175
  /**
163
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
176
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
177
+ * @summary List notification templates
164
178
  * @param {string} [authorization] Bearer Token
165
179
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
166
180
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
167
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
181
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: name, slug&lt;/i&gt;
168
182
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
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.
183
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, createdAt&lt;/i&gt;
184
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias&lt;i&gt;
185
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: name, slug&lt;/i&gt;
172
186
  * @param {*} [options] Override http request option.
173
187
  * @throws {RequiredError}
174
188
  */
175
189
  listNotificationTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListNotificationTemplatesResponseClass>;
176
190
  /**
177
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
191
+ * 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\"
192
+ * @summary Update the notification template
178
193
  * @param {number} id
179
194
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
180
195
  * @param {string} [authorization] Bearer Token
@@ -277,7 +292,7 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
277
292
  */
278
293
  readonly pageToken?: string;
279
294
  /**
280
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
295
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: name, slug&lt;/i&gt;
281
296
  * @type {string}
282
297
  * @memberof NotificationTemplatesApiListNotificationTemplates
283
298
  */
@@ -289,19 +304,19 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
289
304
  */
290
305
  readonly search?: string;
291
306
  /**
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.
307
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, createdAt&lt;/i&gt;
293
308
  * @type {string}
294
309
  * @memberof NotificationTemplatesApiListNotificationTemplates
295
310
  */
296
311
  readonly order?: string;
297
312
  /**
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.
313
+ * 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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias&lt;i&gt;
299
314
  * @type {string}
300
315
  * @memberof NotificationTemplatesApiListNotificationTemplates
301
316
  */
302
317
  readonly expand?: string;
303
318
  /**
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.
319
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: name, slug&lt;/i&gt;
305
320
  * @type {string}
306
321
  * @memberof NotificationTemplatesApiListNotificationTemplates
307
322
  */
@@ -340,7 +355,8 @@ export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
340
355
  */
341
356
  export declare class NotificationTemplatesApi extends BaseAPI {
342
357
  /**
343
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
358
+ * 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\"
359
+ * @summary Create the notification template
344
360
  * @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
345
361
  * @param {*} [options] Override http request option.
346
362
  * @throws {RequiredError}
@@ -348,7 +364,8 @@ export declare class NotificationTemplatesApi extends BaseAPI {
348
364
  */
349
365
  createNotificationTemplate(requestParameters: NotificationTemplatesApiCreateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateNotificationTemplateResponseClass, any, {}>>;
350
366
  /**
351
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
367
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
368
+ * @summary Delete the notification template
352
369
  * @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
353
370
  * @param {*} [options] Override http request option.
354
371
  * @throws {RequiredError}
@@ -356,7 +373,8 @@ export declare class NotificationTemplatesApi extends BaseAPI {
356
373
  */
357
374
  deleteNotificationTemplate(requestParameters: NotificationTemplatesApiDeleteNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
358
375
  /**
359
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
376
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
377
+ * @summary Retrieve the notification template
360
378
  * @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
361
379
  * @param {*} [options] Override http request option.
362
380
  * @throws {RequiredError}
@@ -364,7 +382,8 @@ export declare class NotificationTemplatesApi extends BaseAPI {
364
382
  */
365
383
  getNotificationTemplate(requestParameters: NotificationTemplatesApiGetNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNotificationTemplateResponseClass, any, {}>>;
366
384
  /**
367
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
385
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
386
+ * @summary List notification templates
368
387
  * @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
369
388
  * @param {*} [options] Override http request option.
370
389
  * @throws {RequiredError}
@@ -372,7 +391,8 @@ export declare class NotificationTemplatesApi extends BaseAPI {
372
391
  */
373
392
  listNotificationTemplates(requestParameters?: NotificationTemplatesApiListNotificationTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNotificationTemplatesResponseClass, any, {}>>;
374
393
  /**
375
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
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 {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
377
397
  * @param {*} [options] Override http request option.
378
398
  * @throws {RequiredError}