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

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,8 +39,7 @@ import { UpdateLayoutResponseClass } from '../models';
39
39
  export const LayoutsApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
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
42
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
44
43
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
45
44
  * @param {string} [authorization] Bearer Token
46
45
  * @param {*} [options] Override http request option.
@@ -86,8 +85,7 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
86
85
  };
87
86
  },
88
87
  /**
89
- * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
90
- * @summary Delete the layout
88
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
91
89
  * @param {number} id
92
90
  * @param {string} [authorization] Bearer Token
93
91
  * @param {*} [options] Override http request option.
@@ -131,8 +129,7 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
131
129
  };
132
130
  },
133
131
  /**
134
- * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
135
- * @summary Retrieve the layout
132
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
136
133
  * @param {number} id
137
134
  * @param {number} id2 Layout id
138
135
  * @param {string} [authorization] Bearer Token
@@ -183,16 +180,15 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
183
180
  };
184
181
  },
185
182
  /**
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
183
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
188
184
  * @param {string} [authorization] Bearer Token
189
185
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
190
186
  * @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.
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>
187
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
192
188
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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>
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.
196
192
  * @param {*} [options] Override http request option.
197
193
  * @throws {RequiredError}
198
194
  */
@@ -259,8 +255,7 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
259
255
  };
260
256
  },
261
257
  /**
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
258
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
264
259
  * @param {number} id
265
260
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
266
261
  * @param {string} [authorization] Bearer Token
@@ -320,8 +315,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
320
315
  const localVarAxiosParamCreator = LayoutsApiAxiosParamCreator(configuration)
321
316
  return {
322
317
  /**
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
318
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
325
319
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
326
320
  * @param {string} [authorization] Bearer Token
327
321
  * @param {*} [options] Override http request option.
@@ -332,8 +326,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
332
326
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
333
327
  },
334
328
  /**
335
- * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
336
- * @summary Delete the layout
329
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
337
330
  * @param {number} id
338
331
  * @param {string} [authorization] Bearer Token
339
332
  * @param {*} [options] Override http request option.
@@ -344,8 +337,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
344
337
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
345
338
  },
346
339
  /**
347
- * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
348
- * @summary Retrieve the layout
340
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
349
341
  * @param {number} id
350
342
  * @param {number} id2 Layout id
351
343
  * @param {string} [authorization] Bearer Token
@@ -357,16 +349,15 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
357
349
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
358
350
  },
359
351
  /**
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
352
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
362
353
  * @param {string} [authorization] Bearer Token
363
354
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
364
355
  * @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.
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>
356
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
366
357
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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>
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.
370
361
  * @param {*} [options] Override http request option.
371
362
  * @throws {RequiredError}
372
363
  */
@@ -375,8 +366,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
375
366
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
376
367
  },
377
368
  /**
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
369
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
380
370
  * @param {number} id
381
371
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
382
372
  * @param {string} [authorization] Bearer Token
@@ -398,8 +388,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
398
388
  const localVarFp = LayoutsApiFp(configuration)
399
389
  return {
400
390
  /**
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
391
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
403
392
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
404
393
  * @param {string} [authorization] Bearer Token
405
394
  * @param {*} [options] Override http request option.
@@ -409,8 +398,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
409
398
  return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then((request) => request(axios, basePath));
410
399
  },
411
400
  /**
412
- * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
413
- * @summary Delete the layout
401
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
414
402
  * @param {number} id
415
403
  * @param {string} [authorization] Bearer Token
416
404
  * @param {*} [options] Override http request option.
@@ -420,8 +408,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
420
408
  return localVarFp.deleteLayout(id, authorization, options).then((request) => request(axios, basePath));
421
409
  },
422
410
  /**
423
- * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
424
- * @summary Retrieve the layout
411
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
425
412
  * @param {number} id
426
413
  * @param {number} id2 Layout id
427
414
  * @param {string} [authorization] Bearer Token
@@ -432,16 +419,15 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
432
419
  return localVarFp.getLayout(id, id2, authorization, options).then((request) => request(axios, basePath));
433
420
  },
434
421
  /**
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
422
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
437
423
  * @param {string} [authorization] Bearer Token
438
424
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
439
425
  * @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.
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>
426
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
441
427
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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>
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.
445
431
  * @param {*} [options] Override http request option.
446
432
  * @throws {RequiredError}
447
433
  */
@@ -449,8 +435,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
449
435
  return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
450
436
  },
451
437
  /**
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
438
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
454
439
  * @param {number} id
455
440
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
456
441
  * @param {string} [authorization] Bearer Token
@@ -561,7 +546,7 @@ export interface LayoutsApiListLayoutsRequest {
561
546
  readonly pageToken?: string
562
547
 
563
548
  /**
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>
549
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
565
550
  * @type {string}
566
551
  * @memberof LayoutsApiListLayouts
567
552
  */
@@ -575,21 +560,21 @@ export interface LayoutsApiListLayoutsRequest {
575
560
  readonly search?: string
576
561
 
577
562
  /**
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>
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.
579
564
  * @type {string}
580
565
  * @memberof LayoutsApiListLayouts
581
566
  */
582
567
  readonly order?: string
583
568
 
584
569
  /**
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>
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.
586
571
  * @type {string}
587
572
  * @memberof LayoutsApiListLayouts
588
573
  */
589
574
  readonly expand?: string
590
575
 
591
576
  /**
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>
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.
593
578
  * @type {string}
594
579
  * @memberof LayoutsApiListLayouts
595
580
  */
@@ -632,8 +617,7 @@ export interface LayoutsApiUpdateLayoutRequest {
632
617
  */
633
618
  export class LayoutsApi extends BaseAPI {
634
619
  /**
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
620
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
637
621
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
638
622
  * @param {*} [options] Override http request option.
639
623
  * @throws {RequiredError}
@@ -644,8 +628,7 @@ export class LayoutsApi extends BaseAPI {
644
628
  }
645
629
 
646
630
  /**
647
- * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
648
- * @summary Delete the layout
631
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
649
632
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
650
633
  * @param {*} [options] Override http request option.
651
634
  * @throws {RequiredError}
@@ -656,8 +639,7 @@ export class LayoutsApi extends BaseAPI {
656
639
  }
657
640
 
658
641
  /**
659
- * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
660
- * @summary Retrieve the layout
642
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
661
643
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
662
644
  * @param {*} [options] Override http request option.
663
645
  * @throws {RequiredError}
@@ -668,8 +650,7 @@ export class LayoutsApi extends BaseAPI {
668
650
  }
669
651
 
670
652
  /**
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
653
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
673
654
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
674
655
  * @param {*} [options] Override http request option.
675
656
  * @throws {RequiredError}
@@ -680,8 +661,7 @@ export class LayoutsApi extends BaseAPI {
680
661
  }
681
662
 
682
663
  /**
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
664
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
685
665
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
686
666
  * @param {*} [options] Override http request option.
687
667
  * @throws {RequiredError}
@@ -39,8 +39,7 @@ import { UpdateNotificationTemplateResponseClass } from '../models';
39
39
  export const NotificationTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
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
42
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
44
43
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
45
44
  * @param {string} [authorization] Bearer Token
46
45
  * @param {*} [options] Override http request option.
@@ -86,8 +85,7 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
86
85
  };
87
86
  },
88
87
  /**
89
- * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
90
- * @summary Delete the notification template
88
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
91
89
  * @param {number} id
92
90
  * @param {string} [authorization] Bearer Token
93
91
  * @param {*} [options] Override http request option.
@@ -131,8 +129,7 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
131
129
  };
132
130
  },
133
131
  /**
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
132
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
136
133
  * @param {number} id
137
134
  * @param {number} id2
138
135
  * @param {string} [authorization] Bearer Token
@@ -188,16 +185,15 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
188
185
  };
189
186
  },
190
187
  /**
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
188
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
193
189
  * @param {string} [authorization] Bearer Token
194
190
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
195
191
  * @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.
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>
192
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
197
193
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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>
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.
201
197
  * @param {*} [options] Override http request option.
202
198
  * @throws {RequiredError}
203
199
  */
@@ -264,8 +260,7 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
264
260
  };
265
261
  },
266
262
  /**
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
263
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
269
264
  * @param {number} id
270
265
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
271
266
  * @param {string} [authorization] Bearer Token
@@ -325,8 +320,7 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
325
320
  const localVarAxiosParamCreator = NotificationTemplatesApiAxiosParamCreator(configuration)
326
321
  return {
327
322
  /**
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
323
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
330
324
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
331
325
  * @param {string} [authorization] Bearer Token
332
326
  * @param {*} [options] Override http request option.
@@ -337,8 +331,7 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
337
331
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
338
332
  },
339
333
  /**
340
- * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
341
- * @summary Delete the notification template
334
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
342
335
  * @param {number} id
343
336
  * @param {string} [authorization] Bearer Token
344
337
  * @param {*} [options] Override http request option.
@@ -349,8 +342,7 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
349
342
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
350
343
  },
351
344
  /**
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
345
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
354
346
  * @param {number} id
355
347
  * @param {number} id2
356
348
  * @param {string} [authorization] Bearer Token
@@ -363,16 +355,15 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
363
355
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
364
356
  },
365
357
  /**
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
358
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
368
359
  * @param {string} [authorization] Bearer Token
369
360
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
370
361
  * @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.
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>
362
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
372
363
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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>
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.
376
367
  * @param {*} [options] Override http request option.
377
368
  * @throws {RequiredError}
378
369
  */
@@ -381,8 +372,7 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
381
372
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
382
373
  },
383
374
  /**
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
375
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
386
376
  * @param {number} id
387
377
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
388
378
  * @param {string} [authorization] Bearer Token
@@ -404,8 +394,7 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
404
394
  const localVarFp = NotificationTemplatesApiFp(configuration)
405
395
  return {
406
396
  /**
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
397
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
409
398
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
410
399
  * @param {string} [authorization] Bearer Token
411
400
  * @param {*} [options] Override http request option.
@@ -415,8 +404,7 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
415
404
  return localVarFp.createNotificationTemplate(createNotificationTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
416
405
  },
417
406
  /**
418
- * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
419
- * @summary Delete the notification template
407
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
420
408
  * @param {number} id
421
409
  * @param {string} [authorization] Bearer Token
422
410
  * @param {*} [options] Override http request option.
@@ -426,8 +414,7 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
426
414
  return localVarFp.deleteNotificationTemplate(id, authorization, options).then((request) => request(axios, basePath));
427
415
  },
428
416
  /**
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
417
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
431
418
  * @param {number} id
432
419
  * @param {number} id2
433
420
  * @param {string} [authorization] Bearer Token
@@ -439,16 +426,15 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
439
426
  return localVarFp.getNotificationTemplate(id, id2, authorization, expand, options).then((request) => request(axios, basePath));
440
427
  },
441
428
  /**
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
429
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
444
430
  * @param {string} [authorization] Bearer Token
445
431
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
446
432
  * @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.
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>
433
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
448
434
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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>
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.
452
438
  * @param {*} [options] Override http request option.
453
439
  * @throws {RequiredError}
454
440
  */
@@ -456,8 +442,7 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
456
442
  return localVarFp.listNotificationTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
457
443
  },
458
444
  /**
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
445
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
461
446
  * @param {number} id
462
447
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
463
448
  * @param {string} [authorization] Bearer Token
@@ -575,7 +560,7 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
575
560
  readonly pageToken?: string
576
561
 
577
562
  /**
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>
563
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
579
564
  * @type {string}
580
565
  * @memberof NotificationTemplatesApiListNotificationTemplates
581
566
  */
@@ -589,21 +574,21 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
589
574
  readonly search?: string
590
575
 
591
576
  /**
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>
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.
593
578
  * @type {string}
594
579
  * @memberof NotificationTemplatesApiListNotificationTemplates
595
580
  */
596
581
  readonly order?: string
597
582
 
598
583
  /**
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>
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.
600
585
  * @type {string}
601
586
  * @memberof NotificationTemplatesApiListNotificationTemplates
602
587
  */
603
588
  readonly expand?: string
604
589
 
605
590
  /**
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>
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.
607
592
  * @type {string}
608
593
  * @memberof NotificationTemplatesApiListNotificationTemplates
609
594
  */
@@ -646,8 +631,7 @@ export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
646
631
  */
647
632
  export class NotificationTemplatesApi extends BaseAPI {
648
633
  /**
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
634
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
651
635
  * @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
652
636
  * @param {*} [options] Override http request option.
653
637
  * @throws {RequiredError}
@@ -658,8 +642,7 @@ export class NotificationTemplatesApi extends BaseAPI {
658
642
  }
659
643
 
660
644
  /**
661
- * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
662
- * @summary Delete the notification template
645
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
663
646
  * @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
664
647
  * @param {*} [options] Override http request option.
665
648
  * @throws {RequiredError}
@@ -670,8 +653,7 @@ export class NotificationTemplatesApi extends BaseAPI {
670
653
  }
671
654
 
672
655
  /**
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
656
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
675
657
  * @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
676
658
  * @param {*} [options] Override http request option.
677
659
  * @throws {RequiredError}
@@ -682,8 +664,7 @@ export class NotificationTemplatesApi extends BaseAPI {
682
664
  }
683
665
 
684
666
  /**
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
667
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
687
668
  * @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
688
669
  * @param {*} [options] Override http request option.
689
670
  * @throws {RequiredError}
@@ -694,8 +675,7 @@ export class NotificationTemplatesApi extends BaseAPI {
694
675
  }
695
676
 
696
677
  /**
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
678
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
699
679
  * @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
700
680
  * @param {*} [options] Override http request option.
701
681
  * @throws {RequiredError}
@@ -31,8 +31,7 @@ import { SendNotificationResponseClass } from '../models';
31
31
  export const NotificationsApiAxiosParamCreator = function (configuration?: Configuration) {
32
32
  return {
33
33
  /**
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
34
+ * undefined **Required Permissions** none
36
35
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
37
36
  * @param {string} [authorization] Bearer Token
38
37
  * @param {*} [options] Override http request option.
@@ -88,8 +87,7 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
88
87
  const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration)
89
88
  return {
90
89
  /**
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
90
+ * undefined **Required Permissions** none
93
91
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
94
92
  * @param {string} [authorization] Bearer Token
95
93
  * @param {*} [options] Override http request option.
@@ -110,8 +108,7 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
110
108
  const localVarFp = NotificationsApiFp(configuration)
111
109
  return {
112
110
  /**
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
111
+ * undefined **Required Permissions** none
115
112
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
116
113
  * @param {string} [authorization] Bearer Token
117
114
  * @param {*} [options] Override http request option.
@@ -152,8 +149,7 @@ export interface NotificationsApiSendNotificationRequest {
152
149
  */
153
150
  export class NotificationsApi extends BaseAPI {
154
151
  /**
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
152
+ * undefined **Required Permissions** none
157
153
  * @param {NotificationsApiSendNotificationRequest} requestParameters Request parameters.
158
154
  * @param {*} [options] Override http request option.
159
155
  * @throws {RequiredError}
package/api.ts CHANGED
@@ -25,7 +25,6 @@ import { EmailTrackingApi } from './api';
25
25
  import { EmailVerificationsApi } from './api';
26
26
  import { HealthApi } from './api';
27
27
  import { LayoutsApi } from './api';
28
- import { MSGraphWebhooksApi } from './api';
29
28
  import { NotificationTemplatesApi } from './api';
30
29
  import { NotificationsApi } from './api';
31
30
 
@@ -35,7 +34,6 @@ export * from './api/email-tracking-api';
35
34
  export * from './api/email-verifications-api';
36
35
  export * from './api/health-api';
37
36
  export * from './api/layouts-api';
38
- export * from './api/msgraph-webhooks-api';
39
37
  export * from './api/notification-templates-api';
40
38
  export * from './api/notifications-api';
41
39