@emilgroup/notification-sdk 0.8.1-beta.27 → 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.
@@ -39,7 +39,8 @@ import { UpdateLayoutResponseClass } from '../models';
39
39
  export const LayoutsApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
42
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
43
+ * @summary Create the layout
43
44
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
44
45
  * @param {string} [authorization] Bearer Token
45
46
  * @param {*} [options] Override http request option.
@@ -85,7 +86,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
85
86
  };
86
87
  },
87
88
  /**
88
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
89
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
90
+ * @summary Delete the layout
89
91
  * @param {number} id
90
92
  * @param {string} [authorization] Bearer Token
91
93
  * @param {*} [options] Override http request option.
@@ -129,7 +131,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
129
131
  };
130
132
  },
131
133
  /**
132
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
134
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
135
+ * @summary Retrieve the layout
133
136
  * @param {number} id
134
137
  * @param {number} id2 Layout id
135
138
  * @param {string} [authorization] Bearer Token
@@ -180,15 +183,16 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
180
183
  };
181
184
  },
182
185
  /**
183
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
186
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
187
+ * @summary List layouts
184
188
  * @param {string} [authorization] Bearer Token
185
189
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
186
190
  * @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.
187
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
191
+ * @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>
188
192
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
189
- * @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.
190
- * @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.
191
- * @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.
193
+ * @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>
194
+ * @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>
195
+ * @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>
192
196
  * @param {*} [options] Override http request option.
193
197
  * @throws {RequiredError}
194
198
  */
@@ -255,7 +259,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
255
259
  };
256
260
  },
257
261
  /**
258
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
262
+ * 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\"
263
+ * @summary Update the layout
259
264
  * @param {number} id
260
265
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
261
266
  * @param {string} [authorization] Bearer Token
@@ -315,7 +320,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
315
320
  const localVarAxiosParamCreator = LayoutsApiAxiosParamCreator(configuration)
316
321
  return {
317
322
  /**
318
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
323
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
324
+ * @summary Create the layout
319
325
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
320
326
  * @param {string} [authorization] Bearer Token
321
327
  * @param {*} [options] Override http request option.
@@ -326,7 +332,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
326
332
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
327
333
  },
328
334
  /**
329
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
335
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
336
+ * @summary Delete the layout
330
337
  * @param {number} id
331
338
  * @param {string} [authorization] Bearer Token
332
339
  * @param {*} [options] Override http request option.
@@ -337,7 +344,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
337
344
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
338
345
  },
339
346
  /**
340
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
347
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
348
+ * @summary Retrieve the layout
341
349
  * @param {number} id
342
350
  * @param {number} id2 Layout id
343
351
  * @param {string} [authorization] Bearer Token
@@ -349,15 +357,16 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
349
357
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
350
358
  },
351
359
  /**
352
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
360
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
361
+ * @summary List layouts
353
362
  * @param {string} [authorization] Bearer Token
354
363
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
355
364
  * @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.
356
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
365
+ * @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>
357
366
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
358
- * @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.
359
- * @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.
360
- * @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.
367
+ * @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>
368
+ * @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>
369
+ * @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>
361
370
  * @param {*} [options] Override http request option.
362
371
  * @throws {RequiredError}
363
372
  */
@@ -366,7 +375,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
366
375
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
367
376
  },
368
377
  /**
369
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
378
+ * 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\"
379
+ * @summary Update the layout
370
380
  * @param {number} id
371
381
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
372
382
  * @param {string} [authorization] Bearer Token
@@ -388,7 +398,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
388
398
  const localVarFp = LayoutsApiFp(configuration)
389
399
  return {
390
400
  /**
391
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
401
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
402
+ * @summary Create the layout
392
403
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
393
404
  * @param {string} [authorization] Bearer Token
394
405
  * @param {*} [options] Override http request option.
@@ -398,7 +409,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
398
409
  return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then((request) => request(axios, basePath));
399
410
  },
400
411
  /**
401
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
412
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
413
+ * @summary Delete the layout
402
414
  * @param {number} id
403
415
  * @param {string} [authorization] Bearer Token
404
416
  * @param {*} [options] Override http request option.
@@ -408,7 +420,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
408
420
  return localVarFp.deleteLayout(id, authorization, options).then((request) => request(axios, basePath));
409
421
  },
410
422
  /**
411
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
423
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
424
+ * @summary Retrieve the layout
412
425
  * @param {number} id
413
426
  * @param {number} id2 Layout id
414
427
  * @param {string} [authorization] Bearer Token
@@ -419,15 +432,16 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
419
432
  return localVarFp.getLayout(id, id2, authorization, options).then((request) => request(axios, basePath));
420
433
  },
421
434
  /**
422
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
435
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
436
+ * @summary List layouts
423
437
  * @param {string} [authorization] Bearer Token
424
438
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
425
439
  * @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.
426
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
440
+ * @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>
427
441
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
428
- * @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.
429
- * @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.
430
- * @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.
442
+ * @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>
443
+ * @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>
444
+ * @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>
431
445
  * @param {*} [options] Override http request option.
432
446
  * @throws {RequiredError}
433
447
  */
@@ -435,7 +449,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
435
449
  return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
436
450
  },
437
451
  /**
438
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
452
+ * 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\"
453
+ * @summary Update the layout
439
454
  * @param {number} id
440
455
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
441
456
  * @param {string} [authorization] Bearer Token
@@ -546,7 +561,7 @@ export interface LayoutsApiListLayoutsRequest {
546
561
  readonly pageToken?: string
547
562
 
548
563
  /**
549
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
564
+ * 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>
550
565
  * @type {string}
551
566
  * @memberof LayoutsApiListLayouts
552
567
  */
@@ -560,21 +575,21 @@ export interface LayoutsApiListLayoutsRequest {
560
575
  readonly search?: string
561
576
 
562
577
  /**
563
- * 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.
578
+ * 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>
564
579
  * @type {string}
565
580
  * @memberof LayoutsApiListLayouts
566
581
  */
567
582
  readonly order?: string
568
583
 
569
584
  /**
570
- * 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.
585
+ * 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>
571
586
  * @type {string}
572
587
  * @memberof LayoutsApiListLayouts
573
588
  */
574
589
  readonly expand?: string
575
590
 
576
591
  /**
577
- * 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.
592
+ * 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>
578
593
  * @type {string}
579
594
  * @memberof LayoutsApiListLayouts
580
595
  */
@@ -617,7 +632,8 @@ export interface LayoutsApiUpdateLayoutRequest {
617
632
  */
618
633
  export class LayoutsApi extends BaseAPI {
619
634
  /**
620
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
635
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
636
+ * @summary Create the layout
621
637
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
622
638
  * @param {*} [options] Override http request option.
623
639
  * @throws {RequiredError}
@@ -628,7 +644,8 @@ export class LayoutsApi extends BaseAPI {
628
644
  }
629
645
 
630
646
  /**
631
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
647
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
648
+ * @summary Delete the layout
632
649
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
633
650
  * @param {*} [options] Override http request option.
634
651
  * @throws {RequiredError}
@@ -639,7 +656,8 @@ export class LayoutsApi extends BaseAPI {
639
656
  }
640
657
 
641
658
  /**
642
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
659
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
660
+ * @summary Retrieve the layout
643
661
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
644
662
  * @param {*} [options] Override http request option.
645
663
  * @throws {RequiredError}
@@ -650,7 +668,8 @@ export class LayoutsApi extends BaseAPI {
650
668
  }
651
669
 
652
670
  /**
653
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
671
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
672
+ * @summary List layouts
654
673
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
655
674
  * @param {*} [options] Override http request option.
656
675
  * @throws {RequiredError}
@@ -661,7 +680,8 @@ export class LayoutsApi extends BaseAPI {
661
680
  }
662
681
 
663
682
  /**
664
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
683
+ * 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\"
684
+ * @summary Update the layout
665
685
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
666
686
  * @param {*} [options] Override http request option.
667
687
  * @throws {RequiredError}
@@ -39,7 +39,8 @@ import { UpdateNotificationTemplateResponseClass } from '../models';
39
39
  export const NotificationTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
42
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
43
+ * @summary Create the notification template
43
44
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
44
45
  * @param {string} [authorization] Bearer Token
45
46
  * @param {*} [options] Override http request option.
@@ -85,7 +86,8 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
85
86
  };
86
87
  },
87
88
  /**
88
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
89
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
90
+ * @summary Delete the notification template
89
91
  * @param {number} id
90
92
  * @param {string} [authorization] Bearer Token
91
93
  * @param {*} [options] Override http request option.
@@ -129,7 +131,8 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
129
131
  };
130
132
  },
131
133
  /**
132
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
134
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
135
+ * @summary Retrieve the notification template
133
136
  * @param {number} id
134
137
  * @param {number} id2
135
138
  * @param {string} [authorization] Bearer Token
@@ -185,15 +188,16 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
185
188
  };
186
189
  },
187
190
  /**
188
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
191
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
192
+ * @summary List notification templates
189
193
  * @param {string} [authorization] Bearer Token
190
194
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
191
195
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
192
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
196
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: name, slug</i>
193
197
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
194
- * @param {string} [order] 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.
195
- * @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.
196
- * @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.
198
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, name, createdAt</i>
199
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
200
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: name, slug</i>
197
201
  * @param {*} [options] Override http request option.
198
202
  * @throws {RequiredError}
199
203
  */
@@ -260,7 +264,8 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
260
264
  };
261
265
  },
262
266
  /**
263
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
267
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
268
+ * @summary Update the notification template
264
269
  * @param {number} id
265
270
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
266
271
  * @param {string} [authorization] Bearer Token
@@ -320,7 +325,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
320
325
  const localVarAxiosParamCreator = NotificationTemplatesApiAxiosParamCreator(configuration)
321
326
  return {
322
327
  /**
323
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
328
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
329
+ * @summary Create the notification template
324
330
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
325
331
  * @param {string} [authorization] Bearer Token
326
332
  * @param {*} [options] Override http request option.
@@ -331,7 +337,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
331
337
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
332
338
  },
333
339
  /**
334
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
340
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
341
+ * @summary Delete the notification template
335
342
  * @param {number} id
336
343
  * @param {string} [authorization] Bearer Token
337
344
  * @param {*} [options] Override http request option.
@@ -342,7 +349,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
342
349
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
343
350
  },
344
351
  /**
345
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
352
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
353
+ * @summary Retrieve the notification template
346
354
  * @param {number} id
347
355
  * @param {number} id2
348
356
  * @param {string} [authorization] Bearer Token
@@ -355,15 +363,16 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
355
363
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
356
364
  },
357
365
  /**
358
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
366
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
367
+ * @summary List notification templates
359
368
  * @param {string} [authorization] Bearer Token
360
369
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
361
370
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
362
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
371
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: name, slug</i>
363
372
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
364
- * @param {string} [order] 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.
365
- * @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.
366
- * @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.
373
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, name, createdAt</i>
374
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
375
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: name, slug</i>
367
376
  * @param {*} [options] Override http request option.
368
377
  * @throws {RequiredError}
369
378
  */
@@ -372,7 +381,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
372
381
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
373
382
  },
374
383
  /**
375
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
384
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
385
+ * @summary Update the notification template
376
386
  * @param {number} id
377
387
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
378
388
  * @param {string} [authorization] Bearer Token
@@ -394,7 +404,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
394
404
  const localVarFp = NotificationTemplatesApiFp(configuration)
395
405
  return {
396
406
  /**
397
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
407
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
408
+ * @summary Create the notification template
398
409
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
399
410
  * @param {string} [authorization] Bearer Token
400
411
  * @param {*} [options] Override http request option.
@@ -404,7 +415,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
404
415
  return localVarFp.createNotificationTemplate(createNotificationTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
405
416
  },
406
417
  /**
407
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
418
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
419
+ * @summary Delete the notification template
408
420
  * @param {number} id
409
421
  * @param {string} [authorization] Bearer Token
410
422
  * @param {*} [options] Override http request option.
@@ -414,7 +426,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
414
426
  return localVarFp.deleteNotificationTemplate(id, authorization, options).then((request) => request(axios, basePath));
415
427
  },
416
428
  /**
417
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
429
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
430
+ * @summary Retrieve the notification template
418
431
  * @param {number} id
419
432
  * @param {number} id2
420
433
  * @param {string} [authorization] Bearer Token
@@ -426,15 +439,16 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
426
439
  return localVarFp.getNotificationTemplate(id, id2, authorization, expand, options).then((request) => request(axios, basePath));
427
440
  },
428
441
  /**
429
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
442
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
443
+ * @summary List notification templates
430
444
  * @param {string} [authorization] Bearer Token
431
445
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
432
446
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
433
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
447
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: name, slug</i>
434
448
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
435
- * @param {string} [order] 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.
436
- * @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.
437
- * @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.
449
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, name, createdAt</i>
450
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
451
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: name, slug</i>
438
452
  * @param {*} [options] Override http request option.
439
453
  * @throws {RequiredError}
440
454
  */
@@ -442,7 +456,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
442
456
  return localVarFp.listNotificationTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
443
457
  },
444
458
  /**
445
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
459
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
460
+ * @summary Update the notification template
446
461
  * @param {number} id
447
462
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
448
463
  * @param {string} [authorization] Bearer Token
@@ -560,7 +575,7 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
560
575
  readonly pageToken?: string
561
576
 
562
577
  /**
563
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
578
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: name, slug</i>
564
579
  * @type {string}
565
580
  * @memberof NotificationTemplatesApiListNotificationTemplates
566
581
  */
@@ -574,21 +589,21 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
574
589
  readonly search?: string
575
590
 
576
591
  /**
577
- * 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.
592
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, name, createdAt</i>
578
593
  * @type {string}
579
594
  * @memberof NotificationTemplatesApiListNotificationTemplates
580
595
  */
581
596
  readonly order?: string
582
597
 
583
598
  /**
584
- * 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.
599
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
585
600
  * @type {string}
586
601
  * @memberof NotificationTemplatesApiListNotificationTemplates
587
602
  */
588
603
  readonly expand?: string
589
604
 
590
605
  /**
591
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
606
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: name, slug</i>
592
607
  * @type {string}
593
608
  * @memberof NotificationTemplatesApiListNotificationTemplates
594
609
  */
@@ -631,7 +646,8 @@ export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
631
646
  */
632
647
  export class NotificationTemplatesApi extends BaseAPI {
633
648
  /**
634
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
649
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
650
+ * @summary Create the notification template
635
651
  * @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
636
652
  * @param {*} [options] Override http request option.
637
653
  * @throws {RequiredError}
@@ -642,7 +658,8 @@ export class NotificationTemplatesApi extends BaseAPI {
642
658
  }
643
659
 
644
660
  /**
645
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
661
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
662
+ * @summary Delete the notification template
646
663
  * @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
647
664
  * @param {*} [options] Override http request option.
648
665
  * @throws {RequiredError}
@@ -653,7 +670,8 @@ export class NotificationTemplatesApi extends BaseAPI {
653
670
  }
654
671
 
655
672
  /**
656
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
673
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
674
+ * @summary Retrieve the notification template
657
675
  * @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
658
676
  * @param {*} [options] Override http request option.
659
677
  * @throws {RequiredError}
@@ -664,7 +682,8 @@ export class NotificationTemplatesApi extends BaseAPI {
664
682
  }
665
683
 
666
684
  /**
667
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
685
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
686
+ * @summary List notification templates
668
687
  * @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
669
688
  * @param {*} [options] Override http request option.
670
689
  * @throws {RequiredError}
@@ -675,7 +694,8 @@ export class NotificationTemplatesApi extends BaseAPI {
675
694
  }
676
695
 
677
696
  /**
678
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
697
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
698
+ * @summary Update the notification template
679
699
  * @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
680
700
  * @param {*} [options] Override http request option.
681
701
  * @throws {RequiredError}
@@ -31,7 +31,8 @@ import { SendNotificationResponseClass } from '../models';
31
31
  export const NotificationsApiAxiosParamCreator = function (configuration?: Configuration) {
32
32
  return {
33
33
  /**
34
- * undefined **Required Permissions** none
34
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
35
+ * @summary Send a notification
35
36
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
36
37
  * @param {string} [authorization] Bearer Token
37
38
  * @param {*} [options] Override http request option.
@@ -87,7 +88,8 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
87
88
  const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration)
88
89
  return {
89
90
  /**
90
- * undefined **Required Permissions** none
91
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
92
+ * @summary Send a notification
91
93
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
92
94
  * @param {string} [authorization] Bearer Token
93
95
  * @param {*} [options] Override http request option.
@@ -108,7 +110,8 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
108
110
  const localVarFp = NotificationsApiFp(configuration)
109
111
  return {
110
112
  /**
111
- * undefined **Required Permissions** none
113
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
114
+ * @summary Send a notification
112
115
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
113
116
  * @param {string} [authorization] Bearer Token
114
117
  * @param {*} [options] Override http request option.
@@ -149,7 +152,8 @@ export interface NotificationsApiSendNotificationRequest {
149
152
  */
150
153
  export class NotificationsApi extends BaseAPI {
151
154
  /**
152
- * undefined **Required Permissions** none
155
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
156
+ * @summary Send a notification
153
157
  * @param {NotificationsApiSendNotificationRequest} requestParameters Request parameters.
154
158
  * @param {*} [options] Override http request option.
155
159
  * @throws {RequiredError}