@emilgroup/notification-sdk 0.8.1-beta.30 → 0.8.1-beta.32

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 (57) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +259 -24
  4. package/api/email-tracking-api.ts +32 -24
  5. package/api/email-verifications-api.ts +16 -8
  6. package/api/layouts-api.ts +56 -36
  7. package/api/msgraph-webhooks-api.ts +278 -0
  8. package/api/notification-templates-api.ts +56 -36
  9. package/api/notifications-api.ts +115 -4
  10. package/api.ts +2 -0
  11. package/dist/api/email-messages-api.d.ts +158 -24
  12. package/dist/api/email-messages-api.js +225 -22
  13. package/dist/api/email-tracking-api.d.ts +32 -24
  14. package/dist/api/email-tracking-api.js +30 -22
  15. package/dist/api/email-verifications-api.d.ts +16 -8
  16. package/dist/api/email-verifications-api.js +16 -8
  17. package/dist/api/layouts-api.d.ts +56 -36
  18. package/dist/api/layouts-api.js +52 -32
  19. package/dist/api/msgraph-webhooks-api.d.ts +168 -0
  20. package/dist/api/msgraph-webhooks-api.js +305 -0
  21. package/dist/api/notification-templates-api.d.ts +56 -36
  22. package/dist/api/notification-templates-api.js +52 -32
  23. package/dist/api/notifications-api.d.ts +65 -4
  24. package/dist/api/notifications-api.js +101 -4
  25. package/dist/api.d.ts +1 -0
  26. package/dist/api.js +1 -0
  27. package/dist/models/assign-email-message-entity-body-dto.d.ts +43 -0
  28. package/dist/models/assign-email-message-entity-body-dto.js +22 -0
  29. package/dist/models/assign-email-message-entity-response-class.d.ts +25 -0
  30. package/dist/models/assign-email-message-entity-response-class.js +15 -0
  31. package/dist/models/email-message-class.d.ts +49 -2
  32. package/dist/models/email-message-class.js +16 -2
  33. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  34. package/dist/models/grpc-send-email-request-dto.js +22 -0
  35. package/dist/models/index.d.ts +7 -0
  36. package/dist/models/index.js +7 -0
  37. package/dist/models/inline-attachment-dto.d.ts +36 -0
  38. package/dist/models/inline-attachment-dto.js +15 -0
  39. package/dist/models/send-email-request-dto.d.ts +131 -0
  40. package/dist/models/send-email-request-dto.js +22 -0
  41. package/dist/models/send-email-response-class.d.ts +24 -0
  42. package/dist/models/send-email-response-class.js +15 -0
  43. package/dist/models/send-notification-request-dto.d.ts +1 -0
  44. package/dist/models/send-notification-request-dto.js +2 -1
  45. package/dist/models/unassign-email-message-entity-response-class.d.ts +25 -0
  46. package/dist/models/unassign-email-message-entity-response-class.js +15 -0
  47. package/models/assign-email-message-entity-body-dto.ts +52 -0
  48. package/models/assign-email-message-entity-response-class.ts +31 -0
  49. package/models/email-message-class.ts +53 -3
  50. package/models/grpc-send-email-request-dto.ts +144 -0
  51. package/models/index.ts +7 -0
  52. package/models/inline-attachment-dto.ts +42 -0
  53. package/models/send-email-request-dto.ts +138 -0
  54. package/models/send-email-response-class.ts +30 -0
  55. package/models/send-notification-request-dto.ts +2 -1
  56. package/models/unassign-email-message-entity-response-class.ts +31 -0
  57. package/package.json +1 -1
@@ -93,7 +93,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
96
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
97
+ * @summary Create the layout
97
98
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
98
99
  * @param {string} [authorization] Bearer Token
99
100
  * @param {*} [options] Override http request option.
@@ -141,7 +142,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
141
142
  });
142
143
  },
143
144
  /**
144
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
145
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
146
+ * @summary Delete the layout
145
147
  * @param {number} id
146
148
  * @param {string} [authorization] Bearer Token
147
149
  * @param {*} [options] Override http request option.
@@ -188,7 +190,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
188
190
  });
189
191
  },
190
192
  /**
191
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
193
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
194
+ * @summary Retrieve the layout
192
195
  * @param {number} id
193
196
  * @param {number} id2 Layout id
194
197
  * @param {string} [authorization] Bearer Token
@@ -241,15 +244,16 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
241
244
  });
242
245
  },
243
246
  /**
244
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
247
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
248
+ * @summary List layouts
245
249
  * @param {string} [authorization] Bearer Token
246
250
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
247
251
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
248
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
252
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, name, slug</i>
249
253
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
250
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
251
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
252
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
254
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
255
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: headerTemplate, footerTemplate<i>
256
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, name, slug</i>
253
257
  * @param {*} [options] Override http request option.
254
258
  * @throws {RequiredError}
255
259
  */
@@ -312,7 +316,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
312
316
  });
313
317
  },
314
318
  /**
315
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
319
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
320
+ * @summary Update the layout
316
321
  * @param {number} id
317
322
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
318
323
  * @param {string} [authorization] Bearer Token
@@ -374,7 +379,8 @@ var LayoutsApiFp = function (configuration) {
374
379
  var localVarAxiosParamCreator = (0, exports.LayoutsApiAxiosParamCreator)(configuration);
375
380
  return {
376
381
  /**
377
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
382
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
383
+ * @summary Create the layout
378
384
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
379
385
  * @param {string} [authorization] Bearer Token
380
386
  * @param {*} [options] Override http request option.
@@ -394,7 +400,8 @@ var LayoutsApiFp = function (configuration) {
394
400
  });
395
401
  },
396
402
  /**
397
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
403
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
404
+ * @summary Delete the layout
398
405
  * @param {number} id
399
406
  * @param {string} [authorization] Bearer Token
400
407
  * @param {*} [options] Override http request option.
@@ -414,7 +421,8 @@ var LayoutsApiFp = function (configuration) {
414
421
  });
415
422
  },
416
423
  /**
417
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
424
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
425
+ * @summary Retrieve the layout
418
426
  * @param {number} id
419
427
  * @param {number} id2 Layout id
420
428
  * @param {string} [authorization] Bearer Token
@@ -435,15 +443,16 @@ var LayoutsApiFp = function (configuration) {
435
443
  });
436
444
  },
437
445
  /**
438
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
446
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
447
+ * @summary List layouts
439
448
  * @param {string} [authorization] Bearer Token
440
449
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
441
450
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
442
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
451
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, name, slug</i>
443
452
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
444
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
445
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
446
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
453
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
454
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: headerTemplate, footerTemplate<i>
455
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, name, slug</i>
447
456
  * @param {*} [options] Override http request option.
448
457
  * @throws {RequiredError}
449
458
  */
@@ -461,7 +470,8 @@ var LayoutsApiFp = function (configuration) {
461
470
  });
462
471
  },
463
472
  /**
464
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
473
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
474
+ * @summary Update the layout
465
475
  * @param {number} id
466
476
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
467
477
  * @param {string} [authorization] Bearer Token
@@ -492,7 +502,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
492
502
  var localVarFp = (0, exports.LayoutsApiFp)(configuration);
493
503
  return {
494
504
  /**
495
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
505
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
506
+ * @summary Create the layout
496
507
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
497
508
  * @param {string} [authorization] Bearer Token
498
509
  * @param {*} [options] Override http request option.
@@ -502,7 +513,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
502
513
  return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
503
514
  },
504
515
  /**
505
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
516
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
517
+ * @summary Delete the layout
506
518
  * @param {number} id
507
519
  * @param {string} [authorization] Bearer Token
508
520
  * @param {*} [options] Override http request option.
@@ -512,7 +524,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
512
524
  return localVarFp.deleteLayout(id, authorization, options).then(function (request) { return request(axios, basePath); });
513
525
  },
514
526
  /**
515
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
527
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
528
+ * @summary Retrieve the layout
516
529
  * @param {number} id
517
530
  * @param {number} id2 Layout id
518
531
  * @param {string} [authorization] Bearer Token
@@ -523,15 +536,16 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
523
536
  return localVarFp.getLayout(id, id2, authorization, options).then(function (request) { return request(axios, basePath); });
524
537
  },
525
538
  /**
526
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
539
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
540
+ * @summary List layouts
527
541
  * @param {string} [authorization] Bearer Token
528
542
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
529
543
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
530
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
544
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, name, slug</i>
531
545
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
532
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
533
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
534
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
546
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
547
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: headerTemplate, footerTemplate<i>
548
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, name, slug</i>
535
549
  * @param {*} [options] Override http request option.
536
550
  * @throws {RequiredError}
537
551
  */
@@ -539,7 +553,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
539
553
  return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
540
554
  },
541
555
  /**
542
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
556
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
557
+ * @summary Update the layout
543
558
  * @param {number} id
544
559
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
545
560
  * @param {string} [authorization] Bearer Token
@@ -564,7 +579,8 @@ var LayoutsApi = /** @class */ (function (_super) {
564
579
  return _super !== null && _super.apply(this, arguments) || this;
565
580
  }
566
581
  /**
567
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
582
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
583
+ * @summary Create the layout
568
584
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
569
585
  * @param {*} [options] Override http request option.
570
586
  * @throws {RequiredError}
@@ -575,7 +591,8 @@ var LayoutsApi = /** @class */ (function (_super) {
575
591
  return (0, exports.LayoutsApiFp)(this.configuration).createLayout(requestParameters.createLayoutRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
576
592
  };
577
593
  /**
578
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
594
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
595
+ * @summary Delete the layout
579
596
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
580
597
  * @param {*} [options] Override http request option.
581
598
  * @throws {RequiredError}
@@ -586,7 +603,8 @@ var LayoutsApi = /** @class */ (function (_super) {
586
603
  return (0, exports.LayoutsApiFp)(this.configuration).deleteLayout(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
587
604
  };
588
605
  /**
589
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
606
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
607
+ * @summary Retrieve the layout
590
608
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
591
609
  * @param {*} [options] Override http request option.
592
610
  * @throws {RequiredError}
@@ -597,7 +615,8 @@ var LayoutsApi = /** @class */ (function (_super) {
597
615
  return (0, exports.LayoutsApiFp)(this.configuration).getLayout(requestParameters.id, requestParameters.id2, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
598
616
  };
599
617
  /**
600
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
618
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
619
+ * @summary List layouts
601
620
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
602
621
  * @param {*} [options] Override http request option.
603
622
  * @throws {RequiredError}
@@ -609,7 +628,8 @@ var LayoutsApi = /** @class */ (function (_super) {
609
628
  return (0, exports.LayoutsApiFp)(this.configuration).listLayouts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
610
629
  };
611
630
  /**
612
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
631
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
632
+ * @summary Update the layout
613
633
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
614
634
  * @param {*} [options] Override http request option.
615
635
  * @throws {RequiredError}
@@ -0,0 +1,168 @@
1
+ /**
2
+ * EMIL NotificationService
3
+ * The EMIL NotificationService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ /**
16
+ * MSGraphWebhooksApi - axios parameter creator
17
+ * @export
18
+ */
19
+ export declare const MSGraphWebhooksApiAxiosParamCreator: (configuration?: Configuration) => {
20
+ /**
21
+ * 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
22
+ * @summary Receive Microsoft Graph subscription lifecycle notifications
23
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
24
+ * @param {string} [validationToken] Echoed back as text/plain when present.
25
+ * @param {object} [body] Graph lifecycle collection `{ \"value\": [...] }`.
26
+ * @param {*} [options] Override http request option.
27
+ * @throws {RequiredError}
28
+ */
29
+ receiveLifecycle: (tenantSlug: string, validationToken?: string, body?: object, options?: AxiosRequestConfig) => Promise<RequestArgs>;
30
+ /**
31
+ * 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
32
+ * @summary Receive Microsoft Graph change notifications
33
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
34
+ * @param {string} [validationToken] Echoed back as text/plain when present.
35
+ * @param {object} [body] Graph change-notification collection: &#x60;{ \&quot;value\&quot;: [ ... ] }&#x60;.
36
+ * @param {*} [options] Override http request option.
37
+ * @throws {RequiredError}
38
+ */
39
+ receiveNotifications: (tenantSlug: string, validationToken?: string, body?: object, options?: AxiosRequestConfig) => Promise<RequestArgs>;
40
+ };
41
+ /**
42
+ * MSGraphWebhooksApi - functional programming interface
43
+ * @export
44
+ */
45
+ export declare const MSGraphWebhooksApiFp: (configuration?: Configuration) => {
46
+ /**
47
+ * 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
48
+ * @summary Receive Microsoft Graph subscription lifecycle notifications
49
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
50
+ * @param {string} [validationToken] Echoed back as text/plain when present.
51
+ * @param {object} [body] Graph lifecycle collection &#x60;{ \&quot;value\&quot;: [...] }&#x60;.
52
+ * @param {*} [options] Override http request option.
53
+ * @throws {RequiredError}
54
+ */
55
+ receiveLifecycle(tenantSlug: string, validationToken?: string, body?: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
56
+ /**
57
+ * 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
58
+ * @summary Receive Microsoft Graph change notifications
59
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
60
+ * @param {string} [validationToken] Echoed back as text/plain when present.
61
+ * @param {object} [body] Graph change-notification collection: &#x60;{ \&quot;value\&quot;: [ ... ] }&#x60;.
62
+ * @param {*} [options] Override http request option.
63
+ * @throws {RequiredError}
64
+ */
65
+ receiveNotifications(tenantSlug: string, validationToken?: string, body?: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
66
+ };
67
+ /**
68
+ * MSGraphWebhooksApi - factory interface
69
+ * @export
70
+ */
71
+ export declare const MSGraphWebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
72
+ /**
73
+ * 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
74
+ * @summary Receive Microsoft Graph subscription lifecycle notifications
75
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
76
+ * @param {string} [validationToken] Echoed back as text/plain when present.
77
+ * @param {object} [body] Graph lifecycle collection &#x60;{ \&quot;value\&quot;: [...] }&#x60;.
78
+ * @param {*} [options] Override http request option.
79
+ * @throws {RequiredError}
80
+ */
81
+ receiveLifecycle(tenantSlug: string, validationToken?: string, body?: object, options?: any): AxiosPromise<void>;
82
+ /**
83
+ * 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
84
+ * @summary Receive Microsoft Graph change notifications
85
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
86
+ * @param {string} [validationToken] Echoed back as text/plain when present.
87
+ * @param {object} [body] Graph change-notification collection: &#x60;{ \&quot;value\&quot;: [ ... ] }&#x60;.
88
+ * @param {*} [options] Override http request option.
89
+ * @throws {RequiredError}
90
+ */
91
+ receiveNotifications(tenantSlug: string, validationToken?: string, body?: object, options?: any): AxiosPromise<void>;
92
+ };
93
+ /**
94
+ * Request parameters for receiveLifecycle operation in MSGraphWebhooksApi.
95
+ * @export
96
+ * @interface MSGraphWebhooksApiReceiveLifecycleRequest
97
+ */
98
+ export interface MSGraphWebhooksApiReceiveLifecycleRequest {
99
+ /**
100
+ * Unique slug identifier representing a tenant.
101
+ * @type {string}
102
+ * @memberof MSGraphWebhooksApiReceiveLifecycle
103
+ */
104
+ readonly tenantSlug: string;
105
+ /**
106
+ * Echoed back as text/plain when present.
107
+ * @type {string}
108
+ * @memberof MSGraphWebhooksApiReceiveLifecycle
109
+ */
110
+ readonly validationToken?: string;
111
+ /**
112
+ * Graph lifecycle collection &#x60;{ \&quot;value\&quot;: [...] }&#x60;.
113
+ * @type {object}
114
+ * @memberof MSGraphWebhooksApiReceiveLifecycle
115
+ */
116
+ readonly body?: object;
117
+ }
118
+ /**
119
+ * Request parameters for receiveNotifications operation in MSGraphWebhooksApi.
120
+ * @export
121
+ * @interface MSGraphWebhooksApiReceiveNotificationsRequest
122
+ */
123
+ export interface MSGraphWebhooksApiReceiveNotificationsRequest {
124
+ /**
125
+ * Unique slug identifier representing a tenant.
126
+ * @type {string}
127
+ * @memberof MSGraphWebhooksApiReceiveNotifications
128
+ */
129
+ readonly tenantSlug: string;
130
+ /**
131
+ * Echoed back as text/plain when present.
132
+ * @type {string}
133
+ * @memberof MSGraphWebhooksApiReceiveNotifications
134
+ */
135
+ readonly validationToken?: string;
136
+ /**
137
+ * Graph change-notification collection: &#x60;{ \&quot;value\&quot;: [ ... ] }&#x60;.
138
+ * @type {object}
139
+ * @memberof MSGraphWebhooksApiReceiveNotifications
140
+ */
141
+ readonly body?: object;
142
+ }
143
+ /**
144
+ * MSGraphWebhooksApi - object-oriented interface
145
+ * @export
146
+ * @class MSGraphWebhooksApi
147
+ * @extends {BaseAPI}
148
+ */
149
+ export declare class MSGraphWebhooksApi extends BaseAPI {
150
+ /**
151
+ * 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
152
+ * @summary Receive Microsoft Graph subscription lifecycle notifications
153
+ * @param {MSGraphWebhooksApiReceiveLifecycleRequest} requestParameters Request parameters.
154
+ * @param {*} [options] Override http request option.
155
+ * @throws {RequiredError}
156
+ * @memberof MSGraphWebhooksApi
157
+ */
158
+ receiveLifecycle(requestParameters: MSGraphWebhooksApiReceiveLifecycleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
159
+ /**
160
+ * 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
161
+ * @summary Receive Microsoft Graph change notifications
162
+ * @param {MSGraphWebhooksApiReceiveNotificationsRequest} requestParameters Request parameters.
163
+ * @param {*} [options] Override http request option.
164
+ * @throws {RequiredError}
165
+ * @memberof MSGraphWebhooksApi
166
+ */
167
+ receiveNotifications(requestParameters: MSGraphWebhooksApiReceiveNotificationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
168
+ }