@emilgroup/notification-sdk 0.8.1-beta.21 → 0.8.1-beta.24

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.
@@ -41,8 +41,8 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
41
41
  * @summary List email messages
42
42
  * @param {string} code
43
43
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
44
- * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
45
- * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
44
+ * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
45
+ * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
46
46
  * @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, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
47
47
  * @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: attachments<i>
48
48
  * @param {*} [options] Override http request option.
@@ -91,8 +91,8 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
91
91
  * @summary List email messages
92
92
  * @param {string} code
93
93
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
94
- * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
95
- * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
94
+ * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
95
+ * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
96
96
  * @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, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
97
97
  * @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: attachments<i>
98
98
  * @param {*} [options] Override http request option.
@@ -141,8 +141,8 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
141
141
  * @summary List email messages
142
142
  * @param {string} code
143
143
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
144
- * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
145
- * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
144
+ * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
145
+ * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
146
146
  * @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, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
147
147
  * @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: attachments<i>
148
148
  * @param {*} [options] Override http request option.
@@ -222,13 +222,13 @@ export interface EmailTrackingApiListMessagesRequest {
222
222
  */
223
223
  readonly authorization?: string;
224
224
  /**
225
- * 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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
225
+ * 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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
226
226
  * @type {string}
227
227
  * @memberof EmailTrackingApiListMessages
228
228
  */
229
229
  readonly filter?: string;
230
230
  /**
231
- * 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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
231
+ * 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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
232
232
  * @type {string}
233
233
  * @memberof EmailTrackingApiListMessages
234
234
  */
@@ -191,8 +191,8 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
191
191
  * @summary List email messages
192
192
  * @param {string} code
193
193
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
194
- * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
194
+ * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
196
196
  * @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, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
197
197
  * @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: attachments<i>
198
198
  * @param {*} [options] Override http request option.
@@ -377,8 +377,8 @@ var EmailTrackingApiFp = function (configuration) {
377
377
  * @summary List email messages
378
378
  * @param {string} code
379
379
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
380
- * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
381
- * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
380
+ * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
381
+ * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
382
382
  * @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, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
383
383
  * @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: attachments<i>
384
384
  * @param {*} [options] Override http request option.
@@ -459,8 +459,8 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
459
459
  * @summary List email messages
460
460
  * @param {string} code
461
461
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
462
- * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
463
- * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
462
+ * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
463
+ * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
464
464
  * @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, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
465
465
  * @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: attachments<i>
466
466
  * @param {*} [options] Override http request option.
@@ -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
+ }
@@ -0,0 +1,305 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL NotificationService
6
+ * The EMIL NotificationService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __extends = (this && this.__extends) || (function () {
16
+ var extendStatics = function (d, b) {
17
+ extendStatics = Object.setPrototypeOf ||
18
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
19
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
20
+ return extendStatics(d, b);
21
+ };
22
+ return function (d, b) {
23
+ if (typeof b !== "function" && b !== null)
24
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
25
+ extendStatics(d, b);
26
+ function __() { this.constructor = d; }
27
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
+ };
29
+ })();
30
+ var __assign = (this && this.__assign) || function () {
31
+ __assign = Object.assign || function(t) {
32
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
33
+ s = arguments[i];
34
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
35
+ t[p] = s[p];
36
+ }
37
+ return t;
38
+ };
39
+ return __assign.apply(this, arguments);
40
+ };
41
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
42
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
43
+ return new (P || (P = Promise))(function (resolve, reject) {
44
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
45
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
46
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
47
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
48
+ });
49
+ };
50
+ var __generator = (this && this.__generator) || function (thisArg, body) {
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
+ function verb(n) { return function (v) { return step([n, v]); }; }
54
+ function step(op) {
55
+ if (f) throw new TypeError("Generator is already executing.");
56
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
57
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
58
+ if (y = 0, t) op = [op[0] & 2, t.value];
59
+ switch (op[0]) {
60
+ case 0: case 1: t = op; break;
61
+ case 4: _.label++; return { value: op[1], done: false };
62
+ case 5: _.label++; y = op[1]; op = [0]; continue;
63
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
64
+ default:
65
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
66
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
67
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
68
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
69
+ if (t[2]) _.ops.pop();
70
+ _.trys.pop(); continue;
71
+ }
72
+ op = body.call(thisArg, _);
73
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
74
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
+ }
76
+ };
77
+ var __importDefault = (this && this.__importDefault) || function (mod) {
78
+ return (mod && mod.__esModule) ? mod : { "default": mod };
79
+ };
80
+ Object.defineProperty(exports, "__esModule", { value: true });
81
+ exports.MSGraphWebhooksApi = exports.MSGraphWebhooksApiFactory = exports.MSGraphWebhooksApiFp = exports.MSGraphWebhooksApiAxiosParamCreator = void 0;
82
+ var axios_1 = __importDefault(require("axios"));
83
+ // Some imports not used depending on template conditions
84
+ // @ts-ignore
85
+ var common_1 = require("../common");
86
+ // @ts-ignore
87
+ var base_1 = require("../base");
88
+ /**
89
+ * MSGraphWebhooksApi - axios parameter creator
90
+ * @export
91
+ */
92
+ var MSGraphWebhooksApiAxiosParamCreator = function (configuration) {
93
+ var _this = this;
94
+ return {
95
+ /**
96
+ * 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
97
+ * @summary Receive Microsoft Graph subscription lifecycle notifications
98
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
99
+ * @param {string} [validationToken] Echoed back as text/plain when present.
100
+ * @param {object} [body] Graph lifecycle collection &#x60;{ \&quot;value\&quot;: [...] }&#x60;.
101
+ * @param {*} [options] Override http request option.
102
+ * @throws {RequiredError}
103
+ */
104
+ receiveLifecycle: function (tenantSlug, validationToken, body, options) {
105
+ if (options === void 0) { options = {}; }
106
+ return __awaiter(_this, void 0, void 0, function () {
107
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
108
+ return __generator(this, function (_a) {
109
+ // verify required parameter 'tenantSlug' is not null or undefined
110
+ (0, common_1.assertParamExists)('receiveLifecycle', 'tenantSlug', tenantSlug);
111
+ localVarPath = "/notificationservice/v1/webhooks/msgraph/{tenantSlug}/lifecycle"
112
+ .replace("{".concat("tenantSlug", "}"), encodeURIComponent(String(tenantSlug)));
113
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
114
+ if (configuration) {
115
+ baseOptions = configuration.baseOptions;
116
+ baseAccessToken = configuration.accessToken;
117
+ }
118
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
119
+ localVarHeaderParameter = {};
120
+ localVarQueryParameter = {};
121
+ if (validationToken !== undefined) {
122
+ localVarQueryParameter['validationToken'] = validationToken;
123
+ }
124
+ localVarHeaderParameter['Content-Type'] = 'application/json';
125
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
126
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
127
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
128
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
129
+ return [2 /*return*/, {
130
+ url: (0, common_1.toPathString)(localVarUrlObj),
131
+ options: localVarRequestOptions,
132
+ }];
133
+ });
134
+ });
135
+ },
136
+ /**
137
+ * 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
138
+ * @summary Receive Microsoft Graph change notifications
139
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
140
+ * @param {string} [validationToken] Echoed back as text/plain when present.
141
+ * @param {object} [body] Graph change-notification collection: &#x60;{ \&quot;value\&quot;: [ ... ] }&#x60;.
142
+ * @param {*} [options] Override http request option.
143
+ * @throws {RequiredError}
144
+ */
145
+ receiveNotifications: function (tenantSlug, validationToken, body, options) {
146
+ if (options === void 0) { options = {}; }
147
+ return __awaiter(_this, void 0, void 0, function () {
148
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
149
+ return __generator(this, function (_a) {
150
+ // verify required parameter 'tenantSlug' is not null or undefined
151
+ (0, common_1.assertParamExists)('receiveNotifications', 'tenantSlug', tenantSlug);
152
+ localVarPath = "/notificationservice/v1/webhooks/msgraph/{tenantSlug}/notifications"
153
+ .replace("{".concat("tenantSlug", "}"), encodeURIComponent(String(tenantSlug)));
154
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
155
+ if (configuration) {
156
+ baseOptions = configuration.baseOptions;
157
+ baseAccessToken = configuration.accessToken;
158
+ }
159
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
160
+ localVarHeaderParameter = {};
161
+ localVarQueryParameter = {};
162
+ if (validationToken !== undefined) {
163
+ localVarQueryParameter['validationToken'] = validationToken;
164
+ }
165
+ localVarHeaderParameter['Content-Type'] = 'application/json';
166
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
167
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
168
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
169
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
170
+ return [2 /*return*/, {
171
+ url: (0, common_1.toPathString)(localVarUrlObj),
172
+ options: localVarRequestOptions,
173
+ }];
174
+ });
175
+ });
176
+ },
177
+ };
178
+ };
179
+ exports.MSGraphWebhooksApiAxiosParamCreator = MSGraphWebhooksApiAxiosParamCreator;
180
+ /**
181
+ * MSGraphWebhooksApi - functional programming interface
182
+ * @export
183
+ */
184
+ var MSGraphWebhooksApiFp = function (configuration) {
185
+ var localVarAxiosParamCreator = (0, exports.MSGraphWebhooksApiAxiosParamCreator)(configuration);
186
+ return {
187
+ /**
188
+ * 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
189
+ * @summary Receive Microsoft Graph subscription lifecycle notifications
190
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
191
+ * @param {string} [validationToken] Echoed back as text/plain when present.
192
+ * @param {object} [body] Graph lifecycle collection &#x60;{ \&quot;value\&quot;: [...] }&#x60;.
193
+ * @param {*} [options] Override http request option.
194
+ * @throws {RequiredError}
195
+ */
196
+ receiveLifecycle: function (tenantSlug, validationToken, body, options) {
197
+ return __awaiter(this, void 0, void 0, function () {
198
+ var localVarAxiosArgs;
199
+ return __generator(this, function (_a) {
200
+ switch (_a.label) {
201
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.receiveLifecycle(tenantSlug, validationToken, body, options)];
202
+ case 1:
203
+ localVarAxiosArgs = _a.sent();
204
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
205
+ }
206
+ });
207
+ });
208
+ },
209
+ /**
210
+ * 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
211
+ * @summary Receive Microsoft Graph change notifications
212
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
213
+ * @param {string} [validationToken] Echoed back as text/plain when present.
214
+ * @param {object} [body] Graph change-notification collection: &#x60;{ \&quot;value\&quot;: [ ... ] }&#x60;.
215
+ * @param {*} [options] Override http request option.
216
+ * @throws {RequiredError}
217
+ */
218
+ receiveNotifications: function (tenantSlug, validationToken, body, options) {
219
+ return __awaiter(this, void 0, void 0, function () {
220
+ var localVarAxiosArgs;
221
+ return __generator(this, function (_a) {
222
+ switch (_a.label) {
223
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.receiveNotifications(tenantSlug, validationToken, body, options)];
224
+ case 1:
225
+ localVarAxiosArgs = _a.sent();
226
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
227
+ }
228
+ });
229
+ });
230
+ },
231
+ };
232
+ };
233
+ exports.MSGraphWebhooksApiFp = MSGraphWebhooksApiFp;
234
+ /**
235
+ * MSGraphWebhooksApi - factory interface
236
+ * @export
237
+ */
238
+ var MSGraphWebhooksApiFactory = function (configuration, basePath, axios) {
239
+ var localVarFp = (0, exports.MSGraphWebhooksApiFp)(configuration);
240
+ return {
241
+ /**
242
+ * 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
243
+ * @summary Receive Microsoft Graph subscription lifecycle notifications
244
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
245
+ * @param {string} [validationToken] Echoed back as text/plain when present.
246
+ * @param {object} [body] Graph lifecycle collection &#x60;{ \&quot;value\&quot;: [...] }&#x60;.
247
+ * @param {*} [options] Override http request option.
248
+ * @throws {RequiredError}
249
+ */
250
+ receiveLifecycle: function (tenantSlug, validationToken, body, options) {
251
+ return localVarFp.receiveLifecycle(tenantSlug, validationToken, body, options).then(function (request) { return request(axios, basePath); });
252
+ },
253
+ /**
254
+ * 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
255
+ * @summary Receive Microsoft Graph change notifications
256
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
257
+ * @param {string} [validationToken] Echoed back as text/plain when present.
258
+ * @param {object} [body] Graph change-notification collection: &#x60;{ \&quot;value\&quot;: [ ... ] }&#x60;.
259
+ * @param {*} [options] Override http request option.
260
+ * @throws {RequiredError}
261
+ */
262
+ receiveNotifications: function (tenantSlug, validationToken, body, options) {
263
+ return localVarFp.receiveNotifications(tenantSlug, validationToken, body, options).then(function (request) { return request(axios, basePath); });
264
+ },
265
+ };
266
+ };
267
+ exports.MSGraphWebhooksApiFactory = MSGraphWebhooksApiFactory;
268
+ /**
269
+ * MSGraphWebhooksApi - object-oriented interface
270
+ * @export
271
+ * @class MSGraphWebhooksApi
272
+ * @extends {BaseAPI}
273
+ */
274
+ var MSGraphWebhooksApi = /** @class */ (function (_super) {
275
+ __extends(MSGraphWebhooksApi, _super);
276
+ function MSGraphWebhooksApi() {
277
+ return _super !== null && _super.apply(this, arguments) || this;
278
+ }
279
+ /**
280
+ * 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
281
+ * @summary Receive Microsoft Graph subscription lifecycle notifications
282
+ * @param {MSGraphWebhooksApiReceiveLifecycleRequest} requestParameters Request parameters.
283
+ * @param {*} [options] Override http request option.
284
+ * @throws {RequiredError}
285
+ * @memberof MSGraphWebhooksApi
286
+ */
287
+ MSGraphWebhooksApi.prototype.receiveLifecycle = function (requestParameters, options) {
288
+ var _this = this;
289
+ return (0, exports.MSGraphWebhooksApiFp)(this.configuration).receiveLifecycle(requestParameters.tenantSlug, requestParameters.validationToken, requestParameters.body, options).then(function (request) { return request(_this.axios, _this.basePath); });
290
+ };
291
+ /**
292
+ * 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
293
+ * @summary Receive Microsoft Graph change notifications
294
+ * @param {MSGraphWebhooksApiReceiveNotificationsRequest} requestParameters Request parameters.
295
+ * @param {*} [options] Override http request option.
296
+ * @throws {RequiredError}
297
+ * @memberof MSGraphWebhooksApi
298
+ */
299
+ MSGraphWebhooksApi.prototype.receiveNotifications = function (requestParameters, options) {
300
+ var _this = this;
301
+ return (0, exports.MSGraphWebhooksApiFp)(this.configuration).receiveNotifications(requestParameters.tenantSlug, requestParameters.validationToken, requestParameters.body, options).then(function (request) { return request(_this.axios, _this.basePath); });
302
+ };
303
+ return MSGraphWebhooksApi;
304
+ }(base_1.BaseAPI));
305
+ exports.MSGraphWebhooksApi = MSGraphWebhooksApi;
package/dist/api.d.ts CHANGED
@@ -14,5 +14,6 @@ export * from './api/email-tracking-api';
14
14
  export * from './api/email-verifications-api';
15
15
  export * from './api/health-api';
16
16
  export * from './api/layouts-api';
17
+ export * from './api/msgraph-webhooks-api';
17
18
  export * from './api/notification-templates-api';
18
19
  export * from './api/notifications-api';
package/dist/api.js CHANGED
@@ -32,5 +32,6 @@ __exportStar(require("./api/email-tracking-api"), exports);
32
32
  __exportStar(require("./api/email-verifications-api"), exports);
33
33
  __exportStar(require("./api/health-api"), exports);
34
34
  __exportStar(require("./api/layouts-api"), exports);
35
+ __exportStar(require("./api/msgraph-webhooks-api"), exports);
35
36
  __exportStar(require("./api/notification-templates-api"), exports);
36
37
  __exportStar(require("./api/notifications-api"), exports);