@emilgroup/notification-sdk 0.8.1-beta.4 → 0.8.1-beta.41

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.
Files changed (83) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +36 -24
  4. package/api/email-subscriptions-api.ts +559 -0
  5. package/api/email-tracking-api.ts +263 -32
  6. package/api/email-verifications-api.ts +16 -8
  7. package/api/layouts-api.ts +56 -36
  8. package/api/msgraph-webhooks-api.ts +278 -0
  9. package/api/notification-templates-api.ts +56 -36
  10. package/api/notifications-api.ts +115 -4
  11. package/api.ts +4 -0
  12. package/dist/api/email-messages-api.d.ts +36 -24
  13. package/dist/api/email-messages-api.js +34 -22
  14. package/dist/api/email-subscriptions-api.d.ts +319 -0
  15. package/dist/api/email-subscriptions-api.js +537 -0
  16. package/dist/api/email-tracking-api.d.ts +162 -32
  17. package/dist/api/email-tracking-api.js +227 -28
  18. package/dist/api/email-verifications-api.d.ts +16 -8
  19. package/dist/api/email-verifications-api.js +16 -8
  20. package/dist/api/layouts-api.d.ts +56 -36
  21. package/dist/api/layouts-api.js +52 -32
  22. package/dist/api/msgraph-webhooks-api.d.ts +168 -0
  23. package/dist/api/msgraph-webhooks-api.js +305 -0
  24. package/dist/api/notification-templates-api.d.ts +56 -36
  25. package/dist/api/notification-templates-api.js +52 -32
  26. package/dist/api/notifications-api.d.ts +65 -4
  27. package/dist/api/notifications-api.js +101 -4
  28. package/dist/api.d.ts +2 -0
  29. package/dist/api.js +2 -0
  30. package/dist/models/assign-email-thread-entity-body-dto.d.ts +43 -0
  31. package/dist/models/assign-email-thread-entity-body-dto.js +22 -0
  32. package/dist/models/assign-email-thread-entity-response-class.d.ts +25 -0
  33. package/dist/models/assign-email-thread-entity-response-class.js +15 -0
  34. package/dist/models/email-message-class.d.ts +55 -7
  35. package/dist/models/email-message-class.js +16 -2
  36. package/dist/models/email-subscription-class.d.ts +104 -0
  37. package/dist/models/email-subscription-class.js +23 -0
  38. package/dist/models/email-thread-class.d.ts +6 -5
  39. package/dist/models/entity-ref-class.d.ts +37 -0
  40. package/dist/models/entity-ref-class.js +22 -0
  41. package/dist/models/get-email-subscription-response-class.d.ts +25 -0
  42. package/dist/models/get-email-subscription-response-class.js +15 -0
  43. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  44. package/dist/models/grpc-send-email-request-dto.js +22 -0
  45. package/dist/models/index.d.ts +14 -0
  46. package/dist/models/index.js +14 -0
  47. package/dist/models/inline-attachment-dto.d.ts +36 -0
  48. package/dist/models/inline-attachment-dto.js +15 -0
  49. package/dist/models/list-email-subscriptions-response-class.d.ts +43 -0
  50. package/dist/models/list-email-subscriptions-response-class.js +15 -0
  51. package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +24 -0
  52. package/dist/models/reconcile-email-subscriptions-request-dto.js +15 -0
  53. package/dist/models/reconcile-email-subscriptions-response-class.d.ts +48 -0
  54. package/dist/models/reconcile-email-subscriptions-response-class.js +15 -0
  55. package/dist/models/renew-email-subscription-response-class.d.ts +25 -0
  56. package/dist/models/renew-email-subscription-response-class.js +15 -0
  57. package/dist/models/send-email-request-dto.d.ts +131 -0
  58. package/dist/models/send-email-request-dto.js +22 -0
  59. package/dist/models/send-email-response-class.d.ts +24 -0
  60. package/dist/models/send-email-response-class.js +15 -0
  61. package/dist/models/send-notification-request-dto.d.ts +10 -1
  62. package/dist/models/send-notification-request-dto.js +2 -1
  63. package/dist/models/unassign-email-thread-entity-response-class.d.ts +25 -0
  64. package/dist/models/unassign-email-thread-entity-response-class.js +15 -0
  65. package/models/assign-email-thread-entity-body-dto.ts +52 -0
  66. package/models/assign-email-thread-entity-response-class.ts +31 -0
  67. package/models/email-message-class.ts +59 -8
  68. package/models/email-subscription-class.ts +113 -0
  69. package/models/email-thread-class.ts +6 -5
  70. package/models/entity-ref-class.ts +46 -0
  71. package/models/get-email-subscription-response-class.ts +31 -0
  72. package/models/grpc-send-email-request-dto.ts +144 -0
  73. package/models/index.ts +14 -0
  74. package/models/inline-attachment-dto.ts +42 -0
  75. package/models/list-email-subscriptions-response-class.ts +49 -0
  76. package/models/reconcile-email-subscriptions-request-dto.ts +30 -0
  77. package/models/reconcile-email-subscriptions-response-class.ts +54 -0
  78. package/models/renew-email-subscription-response-class.ts +31 -0
  79. package/models/send-email-request-dto.ts +138 -0
  80. package/models/send-email-response-class.ts +30 -0
  81. package/models/send-notification-request-dto.ts +9 -2
  82. package/models/unassign-email-thread-entity-response-class.ts +31 -0
  83. package/package.json +1 -1
@@ -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}
@@ -0,0 +1,278 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL NotificationService
5
+ * The EMIL NotificationService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ /**
24
+ * MSGraphWebhooksApi - axios parameter creator
25
+ * @export
26
+ */
27
+ export const MSGraphWebhooksApiAxiosParamCreator = function (configuration?: Configuration) {
28
+ return {
29
+ /**
30
+ * Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the lifecycle events and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
31
+ * @summary Receive Microsoft Graph subscription lifecycle notifications
32
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
33
+ * @param {string} [validationToken] Echoed back as text/plain when present.
34
+ * @param {object} [body] Graph lifecycle collection `{ \"value\": [...] }`.
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ receiveLifecycle: async (tenantSlug: string, validationToken?: string, body?: object, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
39
+ // verify required parameter 'tenantSlug' is not null or undefined
40
+ assertParamExists('receiveLifecycle', 'tenantSlug', tenantSlug)
41
+ const localVarPath = `/notificationservice/v1/webhooks/msgraph/{tenantSlug}/lifecycle`
42
+ .replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)));
43
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
44
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
45
+ let baseOptions;
46
+ let baseAccessToken;
47
+ if (configuration) {
48
+ baseOptions = configuration.baseOptions;
49
+ baseAccessToken = configuration.accessToken;
50
+ }
51
+
52
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
53
+ const localVarHeaderParameter = {} as any;
54
+ const localVarQueryParameter = {} as any;
55
+
56
+ if (validationToken !== undefined) {
57
+ localVarQueryParameter['validationToken'] = validationToken;
58
+ }
59
+
60
+
61
+
62
+ localVarHeaderParameter['Content-Type'] = 'application/json';
63
+
64
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
65
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
66
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
67
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
68
+
69
+ return {
70
+ url: toPathString(localVarUrlObj),
71
+ options: localVarRequestOptions,
72
+ };
73
+ },
74
+ /**
75
+ * Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the notifications and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
76
+ * @summary Receive Microsoft Graph change notifications
77
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
78
+ * @param {string} [validationToken] Echoed back as text/plain when present.
79
+ * @param {object} [body] Graph change-notification collection: &#x60;{ \&quot;value\&quot;: [ ... ] }&#x60;.
80
+ * @param {*} [options] Override http request option.
81
+ * @throws {RequiredError}
82
+ */
83
+ receiveNotifications: async (tenantSlug: string, validationToken?: string, body?: object, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
84
+ // verify required parameter 'tenantSlug' is not null or undefined
85
+ assertParamExists('receiveNotifications', 'tenantSlug', tenantSlug)
86
+ const localVarPath = `/notificationservice/v1/webhooks/msgraph/{tenantSlug}/notifications`
87
+ .replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)));
88
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
89
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
90
+ let baseOptions;
91
+ let baseAccessToken;
92
+ if (configuration) {
93
+ baseOptions = configuration.baseOptions;
94
+ baseAccessToken = configuration.accessToken;
95
+ }
96
+
97
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
98
+ const localVarHeaderParameter = {} as any;
99
+ const localVarQueryParameter = {} as any;
100
+
101
+ if (validationToken !== undefined) {
102
+ localVarQueryParameter['validationToken'] = validationToken;
103
+ }
104
+
105
+
106
+
107
+ localVarHeaderParameter['Content-Type'] = 'application/json';
108
+
109
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
110
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
111
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
112
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
113
+
114
+ return {
115
+ url: toPathString(localVarUrlObj),
116
+ options: localVarRequestOptions,
117
+ };
118
+ },
119
+ }
120
+ };
121
+
122
+ /**
123
+ * MSGraphWebhooksApi - functional programming interface
124
+ * @export
125
+ */
126
+ export const MSGraphWebhooksApiFp = function(configuration?: Configuration) {
127
+ const localVarAxiosParamCreator = MSGraphWebhooksApiAxiosParamCreator(configuration)
128
+ return {
129
+ /**
130
+ * Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the lifecycle events and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
131
+ * @summary Receive Microsoft Graph subscription lifecycle notifications
132
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
133
+ * @param {string} [validationToken] Echoed back as text/plain when present.
134
+ * @param {object} [body] Graph lifecycle collection &#x60;{ \&quot;value\&quot;: [...] }&#x60;.
135
+ * @param {*} [options] Override http request option.
136
+ * @throws {RequiredError}
137
+ */
138
+ async receiveLifecycle(tenantSlug: string, validationToken?: string, body?: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
139
+ const localVarAxiosArgs = await localVarAxiosParamCreator.receiveLifecycle(tenantSlug, validationToken, body, options);
140
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
141
+ },
142
+ /**
143
+ * Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the notifications and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
144
+ * @summary Receive Microsoft Graph change notifications
145
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
146
+ * @param {string} [validationToken] Echoed back as text/plain when present.
147
+ * @param {object} [body] Graph change-notification collection: &#x60;{ \&quot;value\&quot;: [ ... ] }&#x60;.
148
+ * @param {*} [options] Override http request option.
149
+ * @throws {RequiredError}
150
+ */
151
+ async receiveNotifications(tenantSlug: string, validationToken?: string, body?: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
152
+ const localVarAxiosArgs = await localVarAxiosParamCreator.receiveNotifications(tenantSlug, validationToken, body, options);
153
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
154
+ },
155
+ }
156
+ };
157
+
158
+ /**
159
+ * MSGraphWebhooksApi - factory interface
160
+ * @export
161
+ */
162
+ export const MSGraphWebhooksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
163
+ const localVarFp = MSGraphWebhooksApiFp(configuration)
164
+ return {
165
+ /**
166
+ * Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the lifecycle events and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
167
+ * @summary Receive Microsoft Graph subscription lifecycle notifications
168
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
169
+ * @param {string} [validationToken] Echoed back as text/plain when present.
170
+ * @param {object} [body] Graph lifecycle collection &#x60;{ \&quot;value\&quot;: [...] }&#x60;.
171
+ * @param {*} [options] Override http request option.
172
+ * @throws {RequiredError}
173
+ */
174
+ receiveLifecycle(tenantSlug: string, validationToken?: string, body?: object, options?: any): AxiosPromise<void> {
175
+ return localVarFp.receiveLifecycle(tenantSlug, validationToken, body, options).then((request) => request(axios, basePath));
176
+ },
177
+ /**
178
+ * Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the notifications and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
179
+ * @summary Receive Microsoft Graph change notifications
180
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
181
+ * @param {string} [validationToken] Echoed back as text/plain when present.
182
+ * @param {object} [body] Graph change-notification collection: &#x60;{ \&quot;value\&quot;: [ ... ] }&#x60;.
183
+ * @param {*} [options] Override http request option.
184
+ * @throws {RequiredError}
185
+ */
186
+ receiveNotifications(tenantSlug: string, validationToken?: string, body?: object, options?: any): AxiosPromise<void> {
187
+ return localVarFp.receiveNotifications(tenantSlug, validationToken, body, options).then((request) => request(axios, basePath));
188
+ },
189
+ };
190
+ };
191
+
192
+ /**
193
+ * Request parameters for receiveLifecycle operation in MSGraphWebhooksApi.
194
+ * @export
195
+ * @interface MSGraphWebhooksApiReceiveLifecycleRequest
196
+ */
197
+ export interface MSGraphWebhooksApiReceiveLifecycleRequest {
198
+ /**
199
+ * Unique slug identifier representing a tenant.
200
+ * @type {string}
201
+ * @memberof MSGraphWebhooksApiReceiveLifecycle
202
+ */
203
+ readonly tenantSlug: string
204
+
205
+ /**
206
+ * Echoed back as text/plain when present.
207
+ * @type {string}
208
+ * @memberof MSGraphWebhooksApiReceiveLifecycle
209
+ */
210
+ readonly validationToken?: string
211
+
212
+ /**
213
+ * Graph lifecycle collection &#x60;{ \&quot;value\&quot;: [...] }&#x60;.
214
+ * @type {object}
215
+ * @memberof MSGraphWebhooksApiReceiveLifecycle
216
+ */
217
+ readonly body?: object
218
+ }
219
+
220
+ /**
221
+ * Request parameters for receiveNotifications operation in MSGraphWebhooksApi.
222
+ * @export
223
+ * @interface MSGraphWebhooksApiReceiveNotificationsRequest
224
+ */
225
+ export interface MSGraphWebhooksApiReceiveNotificationsRequest {
226
+ /**
227
+ * Unique slug identifier representing a tenant.
228
+ * @type {string}
229
+ * @memberof MSGraphWebhooksApiReceiveNotifications
230
+ */
231
+ readonly tenantSlug: string
232
+
233
+ /**
234
+ * Echoed back as text/plain when present.
235
+ * @type {string}
236
+ * @memberof MSGraphWebhooksApiReceiveNotifications
237
+ */
238
+ readonly validationToken?: string
239
+
240
+ /**
241
+ * Graph change-notification collection: &#x60;{ \&quot;value\&quot;: [ ... ] }&#x60;.
242
+ * @type {object}
243
+ * @memberof MSGraphWebhooksApiReceiveNotifications
244
+ */
245
+ readonly body?: object
246
+ }
247
+
248
+ /**
249
+ * MSGraphWebhooksApi - object-oriented interface
250
+ * @export
251
+ * @class MSGraphWebhooksApi
252
+ * @extends {BaseAPI}
253
+ */
254
+ export class MSGraphWebhooksApi extends BaseAPI {
255
+ /**
256
+ * Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the lifecycle events and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
257
+ * @summary Receive Microsoft Graph subscription lifecycle notifications
258
+ * @param {MSGraphWebhooksApiReceiveLifecycleRequest} requestParameters Request parameters.
259
+ * @param {*} [options] Override http request option.
260
+ * @throws {RequiredError}
261
+ * @memberof MSGraphWebhooksApi
262
+ */
263
+ public receiveLifecycle(requestParameters: MSGraphWebhooksApiReceiveLifecycleRequest, options?: AxiosRequestConfig) {
264
+ return MSGraphWebhooksApiFp(this.configuration).receiveLifecycle(requestParameters.tenantSlug, requestParameters.validationToken, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
265
+ }
266
+
267
+ /**
268
+ * Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the notifications and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
269
+ * @summary Receive Microsoft Graph change notifications
270
+ * @param {MSGraphWebhooksApiReceiveNotificationsRequest} requestParameters Request parameters.
271
+ * @param {*} [options] Override http request option.
272
+ * @throws {RequiredError}
273
+ * @memberof MSGraphWebhooksApi
274
+ */
275
+ public receiveNotifications(requestParameters: MSGraphWebhooksApiReceiveNotificationsRequest, options?: AxiosRequestConfig) {
276
+ return MSGraphWebhooksApiFp(this.configuration).receiveNotifications(requestParameters.tenantSlug, requestParameters.validationToken, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
277
+ }
278
+ }