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

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 (62) hide show
  1. package/.openapi-generator/FILES +0 -9
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +24 -36
  4. package/api/email-tracking-api.ts +32 -263
  5. package/api/email-verifications-api.ts +8 -16
  6. package/api/layouts-api.ts +36 -56
  7. package/api/notification-templates-api.ts +36 -56
  8. package/api/notifications-api.ts +4 -115
  9. package/api.ts +0 -2
  10. package/dist/api/email-messages-api.d.ts +24 -36
  11. package/dist/api/email-messages-api.js +22 -34
  12. package/dist/api/email-tracking-api.d.ts +32 -162
  13. package/dist/api/email-tracking-api.js +28 -227
  14. package/dist/api/email-verifications-api.d.ts +8 -16
  15. package/dist/api/email-verifications-api.js +8 -16
  16. package/dist/api/layouts-api.d.ts +36 -56
  17. package/dist/api/layouts-api.js +32 -52
  18. package/dist/api/notification-templates-api.d.ts +36 -56
  19. package/dist/api/notification-templates-api.js +32 -52
  20. package/dist/api/notifications-api.d.ts +4 -65
  21. package/dist/api/notifications-api.js +4 -101
  22. package/dist/api.d.ts +0 -1
  23. package/dist/api.js +0 -1
  24. package/dist/models/email-message-class.d.ts +7 -49
  25. package/dist/models/email-message-class.js +2 -16
  26. package/dist/models/email-thread-class.d.ts +5 -6
  27. package/dist/models/index.d.ts +0 -8
  28. package/dist/models/index.js +0 -8
  29. package/dist/models/send-notification-request-dto.d.ts +1 -10
  30. package/dist/models/send-notification-request-dto.js +1 -2
  31. package/models/email-message-class.ts +8 -53
  32. package/models/email-thread-class.ts +5 -6
  33. package/models/index.ts +0 -8
  34. package/models/send-notification-request-dto.ts +2 -9
  35. package/package.json +1 -1
  36. package/api/msgraph-webhooks-api.ts +0 -278
  37. package/dist/api/msgraph-webhooks-api.d.ts +0 -168
  38. package/dist/api/msgraph-webhooks-api.js +0 -305
  39. package/dist/models/assign-email-thread-entity-body-dto.d.ts +0 -43
  40. package/dist/models/assign-email-thread-entity-body-dto.js +0 -22
  41. package/dist/models/assign-email-thread-entity-response-class.d.ts +0 -25
  42. package/dist/models/assign-email-thread-entity-response-class.js +0 -15
  43. package/dist/models/entity-ref-class.d.ts +0 -37
  44. package/dist/models/entity-ref-class.js +0 -22
  45. package/dist/models/grpc-send-email-request-dto.d.ts +0 -137
  46. package/dist/models/grpc-send-email-request-dto.js +0 -22
  47. package/dist/models/inline-attachment-dto.d.ts +0 -36
  48. package/dist/models/inline-attachment-dto.js +0 -15
  49. package/dist/models/send-email-request-dto.d.ts +0 -131
  50. package/dist/models/send-email-request-dto.js +0 -22
  51. package/dist/models/send-email-response-class.d.ts +0 -24
  52. package/dist/models/send-email-response-class.js +0 -15
  53. package/dist/models/unassign-email-thread-entity-response-class.d.ts +0 -25
  54. package/dist/models/unassign-email-thread-entity-response-class.js +0 -15
  55. package/models/assign-email-thread-entity-body-dto.ts +0 -52
  56. package/models/assign-email-thread-entity-response-class.ts +0 -31
  57. package/models/entity-ref-class.ts +0 -46
  58. package/models/grpc-send-email-request-dto.ts +0 -144
  59. package/models/inline-attachment-dto.ts +0 -42
  60. package/models/send-email-request-dto.ts +0 -138
  61. package/models/send-email-response-class.ts +0 -30
  62. package/models/unassign-email-thread-entity-response-class.ts +0 -31
@@ -13,7 +13,6 @@
13
13
  */
14
14
 
15
15
 
16
- import { EntityRefClass } from './entity-ref-class';
17
16
 
18
17
  /**
19
18
  *
@@ -34,17 +33,17 @@ export interface EmailThreadClass {
34
33
  */
35
34
  'code': string;
36
35
  /**
37
- * The entity the thread, and every message in it, is linked to. Not set while the thread is unassigned.
38
- * @type {EntityRefClass}
36
+ * Entity type associated with this thread
37
+ * @type {string}
39
38
  * @memberof EmailThreadClass
40
39
  */
41
- 'entityRef'?: EntityRefClass;
40
+ 'entityType': string;
42
41
  /**
43
- * Number of the entity the thread is linked to
42
+ * Entity code associated with this thread
44
43
  * @type {string}
45
44
  * @memberof EmailThreadClass
46
45
  */
47
- 'entityNumber'?: string;
46
+ 'entityCode': string;
48
47
  /**
49
48
  * Email subject of the thread
50
49
  * @type {string}
package/models/index.ts CHANGED
@@ -1,5 +1,3 @@
1
- export * from './assign-email-thread-entity-body-dto';
2
- export * from './assign-email-thread-entity-response-class';
3
1
  export * from './complete-email-verification-dto';
4
2
  export * from './complete-email-verification-response-class';
5
3
  export * from './create-layout-request-dto';
@@ -12,18 +10,15 @@ export * from './download-attachment-response-class';
12
10
  export * from './email-attachment-class';
13
11
  export * from './email-message-class';
14
12
  export * from './email-thread-class';
15
- export * from './entity-ref-class';
16
13
  export * from './get-email-message-response-class';
17
14
  export * from './get-email-thread-response-class';
18
15
  export * from './get-layout-request-dto';
19
16
  export * from './get-layout-response-class';
20
17
  export * from './get-notification-template-request-dto';
21
18
  export * from './get-notification-template-response-class';
22
- export * from './grpc-send-email-request-dto';
23
19
  export * from './html-template-class';
24
20
  export * from './initiate-email-verification-dto';
25
21
  export * from './initiate-email-verification-response-class';
26
- export * from './inline-attachment-dto';
27
22
  export * from './inline-response200';
28
23
  export * from './inline-response503';
29
24
  export * from './layout-class';
@@ -34,11 +29,8 @@ export * from './list-layouts-response-class';
34
29
  export * from './list-notification-templates-response-class';
35
30
  export * from './notification-template-class';
36
31
  export * from './s3-document-dto';
37
- export * from './send-email-request-dto';
38
- export * from './send-email-response-class';
39
32
  export * from './send-notification-request-dto';
40
33
  export * from './send-notification-response-class';
41
- export * from './unassign-email-thread-entity-response-class';
42
34
  export * from './update-html-template-request-dto';
43
35
  export * from './update-layout-request-dto';
44
36
  export * from './update-layout-response-class';
@@ -88,7 +88,7 @@ export interface SendNotificationRequestDto {
88
88
  */
89
89
  'entityCode'?: string;
90
90
  /**
91
- * Reply-To address for email reply tracking. Auto-generated when reply tracking is enabled.
91
+ * Reply-To address for email reply tracking. Auto-generated when entityType and entityCode are provided.
92
92
  * @type {string}
93
93
  * @memberof SendNotificationRequestDto
94
94
  */
@@ -111,19 +111,12 @@ export interface SendNotificationRequestDto {
111
111
  * @memberof SendNotificationRequestDto
112
112
  */
113
113
  'references': Array<string>;
114
- /**
115
- * Custom headers to set on the outgoing email
116
- * @type {{ [key: string]: string; }}
117
- * @memberof SendNotificationRequestDto
118
- */
119
- 'customHeaders': { [key: string]: string; };
120
114
  }
121
115
 
122
116
  export const SendNotificationRequestDtoEntityTypeEnum = {
123
117
  Claim: 'Claim',
124
118
  Policy: 'Policy',
125
- Lead: 'Lead',
126
- Partner: 'Partner'
119
+ Lead: 'Lead'
127
120
  } as const;
128
121
 
129
122
  export type SendNotificationRequestDtoEntityTypeEnum = typeof SendNotificationRequestDtoEntityTypeEnum[keyof typeof SendNotificationRequestDtoEntityTypeEnum];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/notification-sdk",
3
- "version": "0.8.1-beta.39",
3
+ "version": "0.8.1-beta.4",
4
4
  "description": "OpenAPI client for @emilgroup/notification-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [
@@ -1,278 +0,0 @@
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 &#x60;{ \&quot;value\&quot;: [...] }&#x60;.
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
- }
@@ -1,168 +0,0 @@
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 &#x60;{ \&quot;value\&quot;: [...] }&#x60;.
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
- }