@emilgroup/notification-sdk 0.8.1-beta.59 → 0.8.1-beta.6

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 (110) hide show
  1. package/.openapi-generator/FILES +0 -23
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +36 -56
  4. package/api/email-tracking-api.ts +48 -291
  5. package/api/email-verifications-api.ts +12 -24
  6. package/api/layouts-api.ts +46 -76
  7. package/api/notification-templates-api.ts +46 -76
  8. package/api/notifications-api.ts +6 -121
  9. package/api.ts +0 -6
  10. package/base.ts +41 -174
  11. package/configuration.ts +0 -20
  12. package/dist/api/email-messages-api.d.ts +28 -40
  13. package/dist/api/email-messages-api.js +40 -62
  14. package/dist/api/email-tracking-api.d.ts +40 -170
  15. package/dist/api/email-tracking-api.js +48 -261
  16. package/dist/api/email-verifications-api.d.ts +8 -16
  17. package/dist/api/email-verifications-api.js +16 -30
  18. package/dist/api/layouts-api.d.ts +36 -56
  19. package/dist/api/layouts-api.js +50 -81
  20. package/dist/api/notification-templates-api.d.ts +36 -56
  21. package/dist/api/notification-templates-api.js +50 -81
  22. package/dist/api/notifications-api.d.ts +4 -65
  23. package/dist/api/notifications-api.js +8 -111
  24. package/dist/api.d.ts +0 -3
  25. package/dist/api.js +0 -3
  26. package/dist/base.d.ts +0 -24
  27. package/dist/base.js +59 -178
  28. package/dist/configuration.d.ts +0 -17
  29. package/dist/configuration.js +0 -2
  30. package/dist/models/email-message-class.d.ts +7 -73
  31. package/dist/models/email-message-class.js +3 -22
  32. package/dist/models/email-thread-class.d.ts +5 -37
  33. package/dist/models/index.d.ts +0 -20
  34. package/dist/models/index.js +0 -20
  35. package/dist/models/send-notification-request-dto.d.ts +1 -10
  36. package/dist/models/send-notification-request-dto.js +1 -2
  37. package/models/email-message-class.ts +8 -78
  38. package/models/email-thread-class.ts +5 -37
  39. package/models/index.ts +0 -20
  40. package/models/send-notification-request-dto.ts +2 -9
  41. package/package.json +1 -1
  42. package/api/email-mailboxes-api.ts +0 -150
  43. package/api/email-subscriptions-api.ts +0 -781
  44. package/api/msgraph-webhooks-api.ts +0 -278
  45. package/dist/api/email-mailboxes-api.d.ts +0 -87
  46. package/dist/api/email-mailboxes-api.js +0 -221
  47. package/dist/api/email-subscriptions-api.d.ts +0 -432
  48. package/dist/api/email-subscriptions-api.js +0 -738
  49. package/dist/api/msgraph-webhooks-api.d.ts +0 -168
  50. package/dist/api/msgraph-webhooks-api.js +0 -305
  51. package/dist/models/assign-email-thread-entity-body-dto.d.ts +0 -43
  52. package/dist/models/assign-email-thread-entity-body-dto.js +0 -22
  53. package/dist/models/assign-email-thread-entity-response-class.d.ts +0 -25
  54. package/dist/models/assign-email-thread-entity-response-class.js +0 -15
  55. package/dist/models/catch-up-email-subscription-response-class.d.ts +0 -24
  56. package/dist/models/catch-up-email-subscription-response-class.js +0 -15
  57. package/dist/models/catch-up-email-subscriptions-request-dto.d.ts +0 -24
  58. package/dist/models/catch-up-email-subscriptions-request-dto.js +0 -15
  59. package/dist/models/catch-up-email-subscriptions-response-class.d.ts +0 -30
  60. package/dist/models/catch-up-email-subscriptions-response-class.js +0 -15
  61. package/dist/models/email-mailbox-class.d.ts +0 -47
  62. package/dist/models/email-mailbox-class.js +0 -20
  63. package/dist/models/email-message-summary-class.d.ts +0 -98
  64. package/dist/models/email-message-summary-class.js +0 -33
  65. package/dist/models/email-subscription-class.d.ts +0 -110
  66. package/dist/models/email-subscription-class.js +0 -23
  67. package/dist/models/entity-ref-class.d.ts +0 -37
  68. package/dist/models/entity-ref-class.js +0 -22
  69. package/dist/models/get-email-subscription-response-class.d.ts +0 -25
  70. package/dist/models/get-email-subscription-response-class.js +0 -15
  71. package/dist/models/grpc-send-email-request-dto.d.ts +0 -137
  72. package/dist/models/grpc-send-email-request-dto.js +0 -22
  73. package/dist/models/inline-attachment-dto.d.ts +0 -36
  74. package/dist/models/inline-attachment-dto.js +0 -15
  75. package/dist/models/list-email-mailboxes-response-class.d.ts +0 -43
  76. package/dist/models/list-email-mailboxes-response-class.js +0 -15
  77. package/dist/models/list-email-subscriptions-response-class.d.ts +0 -43
  78. package/dist/models/list-email-subscriptions-response-class.js +0 -15
  79. package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +0 -24
  80. package/dist/models/reconcile-email-subscriptions-request-dto.js +0 -15
  81. package/dist/models/reconcile-email-subscriptions-response-class.d.ts +0 -48
  82. package/dist/models/reconcile-email-subscriptions-response-class.js +0 -15
  83. package/dist/models/renew-email-subscription-response-class.d.ts +0 -25
  84. package/dist/models/renew-email-subscription-response-class.js +0 -15
  85. package/dist/models/send-email-request-dto.d.ts +0 -131
  86. package/dist/models/send-email-request-dto.js +0 -22
  87. package/dist/models/send-email-response-class.d.ts +0 -24
  88. package/dist/models/send-email-response-class.js +0 -15
  89. package/dist/models/unassign-email-thread-entity-response-class.d.ts +0 -25
  90. package/dist/models/unassign-email-thread-entity-response-class.js +0 -15
  91. package/models/assign-email-thread-entity-body-dto.ts +0 -52
  92. package/models/assign-email-thread-entity-response-class.ts +0 -31
  93. package/models/catch-up-email-subscription-response-class.ts +0 -30
  94. package/models/catch-up-email-subscriptions-request-dto.ts +0 -30
  95. package/models/catch-up-email-subscriptions-response-class.ts +0 -36
  96. package/models/email-mailbox-class.ts +0 -56
  97. package/models/email-message-summary-class.ts +0 -109
  98. package/models/email-subscription-class.ts +0 -119
  99. package/models/entity-ref-class.ts +0 -46
  100. package/models/get-email-subscription-response-class.ts +0 -31
  101. package/models/grpc-send-email-request-dto.ts +0 -144
  102. package/models/inline-attachment-dto.ts +0 -42
  103. package/models/list-email-mailboxes-response-class.ts +0 -49
  104. package/models/list-email-subscriptions-response-class.ts +0 -49
  105. package/models/reconcile-email-subscriptions-request-dto.ts +0 -30
  106. package/models/reconcile-email-subscriptions-response-class.ts +0 -54
  107. package/models/renew-email-subscription-response-class.ts +0 -31
  108. package/models/send-email-request-dto.ts +0 -138
  109. package/models/send-email-response-class.ts +0 -30
  110. package/models/unassign-email-thread-entity-response-class.ts +0 -31
@@ -1,781 +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
- // @ts-ignore
24
- import { CatchUpEmailSubscriptionResponseClass } from '../models';
25
- // @ts-ignore
26
- import { CatchUpEmailSubscriptionsRequestDto } from '../models';
27
- // @ts-ignore
28
- import { CatchUpEmailSubscriptionsResponseClass } from '../models';
29
- // @ts-ignore
30
- import { GetEmailSubscriptionResponseClass } from '../models';
31
- // @ts-ignore
32
- import { ListEmailSubscriptionsResponseClass } from '../models';
33
- // @ts-ignore
34
- import { ReconcileEmailSubscriptionsRequestDto } from '../models';
35
- // @ts-ignore
36
- import { ReconcileEmailSubscriptionsResponseClass } from '../models';
37
- // @ts-ignore
38
- import { RenewEmailSubscriptionResponseClass } from '../models';
39
- /**
40
- * EmailSubscriptionsApi - axios parameter creator
41
- * @export
42
- */
43
- export const EmailSubscriptionsApiAxiosParamCreator = function (configuration?: Configuration) {
44
- return {
45
- /**
46
- * Queues a catch-up for this subscription: Microsoft Graph is asked for every change to the folder since the last catch-up, and mail that never arrived through a notification is ingested. Returns straight away; queued is false when the subscription is being deleted. **Required Permissions** \"tenant-management.settings.update\"
47
- * @summary Catch up missed mail for the email subscription
48
- * @param {number} id
49
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
50
- * @param {*} [options] Override http request option.
51
- * @throws {RequiredError}
52
- */
53
- catchUpEmailSubscription: async (id: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
54
- // verify required parameter 'id' is not null or undefined
55
- assertParamExists('catchUpEmailSubscription', 'id', id)
56
- const localVarPath = `/notificationservice/v1/email-subscriptions/{id}/catch-up`
57
- .replace(`{${"id"}}`, encodeURIComponent(String(id)));
58
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
59
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
60
- let baseOptions;
61
- let baseAccessToken;
62
- if (configuration) {
63
- baseOptions = configuration.baseOptions;
64
- baseAccessToken = configuration.accessToken;
65
- }
66
-
67
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
68
- const localVarHeaderParameter = {} as any;
69
- const localVarQueryParameter = {} as any;
70
-
71
- // authentication bearer required
72
- // http bearer authentication required
73
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
74
-
75
- // Only Authorization falls back to the configured token; an empty value is never sent.
76
- const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
77
- if (authorizationValue) {
78
- localVarHeaderParameter['Authorization'] = String(authorizationValue);
79
- }
80
-
81
-
82
-
83
- setSearchParams(localVarUrlObj, localVarQueryParameter);
84
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
85
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
86
-
87
- return {
88
- url: toPathString(localVarUrlObj),
89
- options: localVarRequestOptions,
90
- };
91
- },
92
- /**
93
- * Queues a catch-up for every subscription of the email channel: Microsoft Graph is asked for every change since the last catch-up, and mail that never arrived through a notification is ingested. Returns straight away with how many catch-ups were queued. **Required Permissions** \"tenant-management.settings.update\"
94
- * @summary Catch up missed mail for all email subscriptions
95
- * @param {CatchUpEmailSubscriptionsRequestDto} catchUpEmailSubscriptionsRequestDto
96
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
97
- * @param {*} [options] Override http request option.
98
- * @throws {RequiredError}
99
- */
100
- catchUpEmailSubscriptions: async (catchUpEmailSubscriptionsRequestDto: CatchUpEmailSubscriptionsRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
101
- // verify required parameter 'catchUpEmailSubscriptionsRequestDto' is not null or undefined
102
- assertParamExists('catchUpEmailSubscriptions', 'catchUpEmailSubscriptionsRequestDto', catchUpEmailSubscriptionsRequestDto)
103
- const localVarPath = `/notificationservice/v1/email-subscriptions/catch-up`;
104
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
105
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
106
- let baseOptions;
107
- let baseAccessToken;
108
- if (configuration) {
109
- baseOptions = configuration.baseOptions;
110
- baseAccessToken = configuration.accessToken;
111
- }
112
-
113
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
114
- const localVarHeaderParameter = {} as any;
115
- const localVarQueryParameter = {} as any;
116
-
117
- // authentication bearer required
118
- // http bearer authentication required
119
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
120
-
121
- // Only Authorization falls back to the configured token; an empty value is never sent.
122
- const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
123
- if (authorizationValue) {
124
- localVarHeaderParameter['Authorization'] = String(authorizationValue);
125
- }
126
-
127
-
128
-
129
- localVarHeaderParameter['Content-Type'] = 'application/json';
130
-
131
- setSearchParams(localVarUrlObj, localVarQueryParameter);
132
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
133
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
134
- localVarRequestOptions.data = serializeDataIfNeeded(catchUpEmailSubscriptionsRequestDto, localVarRequestOptions, configuration)
135
-
136
- return {
137
- url: toPathString(localVarUrlObj),
138
- options: localVarRequestOptions,
139
- };
140
- },
141
- /**
142
- * Retrieves the email subscription with the given id. **Required Permissions** \"tenant-management.settings.view\"
143
- * @summary Retrieve the email subscription
144
- * @param {number} id
145
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
146
- * @param {*} [options] Override http request option.
147
- * @throws {RequiredError}
148
- */
149
- getEmailSubscription: async (id: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
150
- // verify required parameter 'id' is not null or undefined
151
- assertParamExists('getEmailSubscription', 'id', id)
152
- const localVarPath = `/notificationservice/v1/email-subscriptions/{id}`
153
- .replace(`{${"id"}}`, encodeURIComponent(String(id)));
154
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
155
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
156
- let baseOptions;
157
- let baseAccessToken;
158
- if (configuration) {
159
- baseOptions = configuration.baseOptions;
160
- baseAccessToken = configuration.accessToken;
161
- }
162
-
163
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
164
- const localVarHeaderParameter = {} as any;
165
- const localVarQueryParameter = {} as any;
166
-
167
- // authentication bearer required
168
- // http bearer authentication required
169
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
170
-
171
- // Only Authorization falls back to the configured token; an empty value is never sent.
172
- const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
173
- if (authorizationValue) {
174
- localVarHeaderParameter['Authorization'] = String(authorizationValue);
175
- }
176
-
177
-
178
-
179
- setSearchParams(localVarUrlObj, localVarQueryParameter);
180
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
181
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
182
-
183
- return {
184
- url: toPathString(localVarUrlObj),
185
- options: localVarRequestOptions,
186
- };
187
- },
188
- /**
189
- * Returns the Microsoft Graph mail subscriptions of the tenant, one per mailbox and folder of the email channel, with their status, expiry and last error. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
190
- * @summary List email subscriptions
191
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
192
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
193
- * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
194
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt&lt;/i&gt;
195
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, mailbox, folder, status, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
198
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt&lt;/i&gt;
199
- * @param {*} [options] Override http request option.
200
- * @throws {RequiredError}
201
- */
202
- listEmailSubscriptions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
203
- const localVarPath = `/notificationservice/v1/email-subscriptions`;
204
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
205
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
206
- let baseOptions;
207
- let baseAccessToken;
208
- if (configuration) {
209
- baseOptions = configuration.baseOptions;
210
- baseAccessToken = configuration.accessToken;
211
- }
212
-
213
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
214
- const localVarHeaderParameter = {} as any;
215
- const localVarQueryParameter = {} as any;
216
-
217
- // authentication bearer required
218
- // http bearer authentication required
219
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
220
-
221
- if (pageSize !== undefined) {
222
- localVarQueryParameter['pageSize'] = pageSize;
223
- }
224
-
225
- if (pageToken !== undefined) {
226
- localVarQueryParameter['pageToken'] = pageToken;
227
- }
228
-
229
- if (filter !== undefined) {
230
- localVarQueryParameter['filter'] = filter;
231
- }
232
-
233
- if (search !== undefined) {
234
- localVarQueryParameter['search'] = search;
235
- }
236
-
237
- if (order !== undefined) {
238
- localVarQueryParameter['order'] = order;
239
- }
240
-
241
- if (expand !== undefined) {
242
- localVarQueryParameter['expand'] = expand;
243
- }
244
-
245
- if (filters !== undefined) {
246
- localVarQueryParameter['filters'] = filters;
247
- }
248
-
249
- // Only Authorization falls back to the configured token; an empty value is never sent.
250
- const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
251
- if (authorizationValue) {
252
- localVarHeaderParameter['Authorization'] = String(authorizationValue);
253
- }
254
-
255
-
256
-
257
- setSearchParams(localVarUrlObj, localVarQueryParameter);
258
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
259
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
260
-
261
- return {
262
- url: toPathString(localVarUrlObj),
263
- options: localVarRequestOptions,
264
- };
265
- },
266
- /**
267
- * Brings the subscriptions in line with the mailboxes and folders of the email channel: creates the missing ones, deletes the ones no longer configured and recreates expired or failed ones. Returns how many subscriptions each step touched. **Required Permissions** \"tenant-management.settings.update\"
268
- * @summary Reconcile the email subscriptions
269
- * @param {ReconcileEmailSubscriptionsRequestDto} reconcileEmailSubscriptionsRequestDto
270
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
271
- * @param {*} [options] Override http request option.
272
- * @throws {RequiredError}
273
- */
274
- reconcileEmailSubscriptions: async (reconcileEmailSubscriptionsRequestDto: ReconcileEmailSubscriptionsRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
275
- // verify required parameter 'reconcileEmailSubscriptionsRequestDto' is not null or undefined
276
- assertParamExists('reconcileEmailSubscriptions', 'reconcileEmailSubscriptionsRequestDto', reconcileEmailSubscriptionsRequestDto)
277
- const localVarPath = `/notificationservice/v1/email-subscriptions/reconcile`;
278
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
279
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
280
- let baseOptions;
281
- let baseAccessToken;
282
- if (configuration) {
283
- baseOptions = configuration.baseOptions;
284
- baseAccessToken = configuration.accessToken;
285
- }
286
-
287
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
288
- const localVarHeaderParameter = {} as any;
289
- const localVarQueryParameter = {} as any;
290
-
291
- // authentication bearer required
292
- // http bearer authentication required
293
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
294
-
295
- // Only Authorization falls back to the configured token; an empty value is never sent.
296
- const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
297
- if (authorizationValue) {
298
- localVarHeaderParameter['Authorization'] = String(authorizationValue);
299
- }
300
-
301
-
302
-
303
- localVarHeaderParameter['Content-Type'] = 'application/json';
304
-
305
- setSearchParams(localVarUrlObj, localVarQueryParameter);
306
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
307
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
308
- localVarRequestOptions.data = serializeDataIfNeeded(reconcileEmailSubscriptionsRequestDto, localVarRequestOptions, configuration)
309
-
310
- return {
311
- url: toPathString(localVarUrlObj),
312
- options: localVarRequestOptions,
313
- };
314
- },
315
- /**
316
- * Renews the subscription in Microsoft Graph right away and returns it with its new expiry. A pending or failed subscription, or one Graph no longer knows, is created again. Fails with 503 when Graph rejects the call; the error is kept on the subscription. **Required Permissions** \"tenant-management.settings.update\"
317
- * @summary Renew the email subscription
318
- * @param {number} id
319
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
320
- * @param {*} [options] Override http request option.
321
- * @throws {RequiredError}
322
- */
323
- renewEmailSubscription: async (id: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
324
- // verify required parameter 'id' is not null or undefined
325
- assertParamExists('renewEmailSubscription', 'id', id)
326
- const localVarPath = `/notificationservice/v1/email-subscriptions/{id}/renew`
327
- .replace(`{${"id"}}`, encodeURIComponent(String(id)));
328
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
329
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
330
- let baseOptions;
331
- let baseAccessToken;
332
- if (configuration) {
333
- baseOptions = configuration.baseOptions;
334
- baseAccessToken = configuration.accessToken;
335
- }
336
-
337
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
338
- const localVarHeaderParameter = {} as any;
339
- const localVarQueryParameter = {} as any;
340
-
341
- // authentication bearer required
342
- // http bearer authentication required
343
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
344
-
345
- // Only Authorization falls back to the configured token; an empty value is never sent.
346
- const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
347
- if (authorizationValue) {
348
- localVarHeaderParameter['Authorization'] = String(authorizationValue);
349
- }
350
-
351
-
352
-
353
- setSearchParams(localVarUrlObj, localVarQueryParameter);
354
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
355
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
356
-
357
- return {
358
- url: toPathString(localVarUrlObj),
359
- options: localVarRequestOptions,
360
- };
361
- },
362
- }
363
- };
364
-
365
- /**
366
- * EmailSubscriptionsApi - functional programming interface
367
- * @export
368
- */
369
- export const EmailSubscriptionsApiFp = function(configuration?: Configuration) {
370
- const localVarAxiosParamCreator = EmailSubscriptionsApiAxiosParamCreator(configuration)
371
- return {
372
- /**
373
- * Queues a catch-up for this subscription: Microsoft Graph is asked for every change to the folder since the last catch-up, and mail that never arrived through a notification is ingested. Returns straight away; queued is false when the subscription is being deleted. **Required Permissions** \"tenant-management.settings.update\"
374
- * @summary Catch up missed mail for the email subscription
375
- * @param {number} id
376
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
377
- * @param {*} [options] Override http request option.
378
- * @throws {RequiredError}
379
- */
380
- async catchUpEmailSubscription(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CatchUpEmailSubscriptionResponseClass>> {
381
- const localVarAxiosArgs = await localVarAxiosParamCreator.catchUpEmailSubscription(id, authorization, options);
382
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
383
- },
384
- /**
385
- * Queues a catch-up for every subscription of the email channel: Microsoft Graph is asked for every change since the last catch-up, and mail that never arrived through a notification is ingested. Returns straight away with how many catch-ups were queued. **Required Permissions** \"tenant-management.settings.update\"
386
- * @summary Catch up missed mail for all email subscriptions
387
- * @param {CatchUpEmailSubscriptionsRequestDto} catchUpEmailSubscriptionsRequestDto
388
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
389
- * @param {*} [options] Override http request option.
390
- * @throws {RequiredError}
391
- */
392
- async catchUpEmailSubscriptions(catchUpEmailSubscriptionsRequestDto: CatchUpEmailSubscriptionsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CatchUpEmailSubscriptionsResponseClass>> {
393
- const localVarAxiosArgs = await localVarAxiosParamCreator.catchUpEmailSubscriptions(catchUpEmailSubscriptionsRequestDto, authorization, options);
394
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
395
- },
396
- /**
397
- * Retrieves the email subscription with the given id. **Required Permissions** \"tenant-management.settings.view\"
398
- * @summary Retrieve the email subscription
399
- * @param {number} id
400
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
401
- * @param {*} [options] Override http request option.
402
- * @throws {RequiredError}
403
- */
404
- async getEmailSubscription(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailSubscriptionResponseClass>> {
405
- const localVarAxiosArgs = await localVarAxiosParamCreator.getEmailSubscription(id, authorization, options);
406
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
407
- },
408
- /**
409
- * Returns the Microsoft Graph mail subscriptions of the tenant, one per mailbox and folder of the email channel, with their status, expiry and last error. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
410
- * @summary List email subscriptions
411
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
412
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
413
- * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
414
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt&lt;/i&gt;
415
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
416
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, mailbox, folder, status, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt&lt;/i&gt;
417
- * @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.&lt;br/&gt; &lt;br/&gt;
418
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt&lt;/i&gt;
419
- * @param {*} [options] Override http request option.
420
- * @throws {RequiredError}
421
- */
422
- async listEmailSubscriptions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailSubscriptionsResponseClass>> {
423
- const localVarAxiosArgs = await localVarAxiosParamCreator.listEmailSubscriptions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
424
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
425
- },
426
- /**
427
- * Brings the subscriptions in line with the mailboxes and folders of the email channel: creates the missing ones, deletes the ones no longer configured and recreates expired or failed ones. Returns how many subscriptions each step touched. **Required Permissions** \"tenant-management.settings.update\"
428
- * @summary Reconcile the email subscriptions
429
- * @param {ReconcileEmailSubscriptionsRequestDto} reconcileEmailSubscriptionsRequestDto
430
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
431
- * @param {*} [options] Override http request option.
432
- * @throws {RequiredError}
433
- */
434
- async reconcileEmailSubscriptions(reconcileEmailSubscriptionsRequestDto: ReconcileEmailSubscriptionsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReconcileEmailSubscriptionsResponseClass>> {
435
- const localVarAxiosArgs = await localVarAxiosParamCreator.reconcileEmailSubscriptions(reconcileEmailSubscriptionsRequestDto, authorization, options);
436
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
437
- },
438
- /**
439
- * Renews the subscription in Microsoft Graph right away and returns it with its new expiry. A pending or failed subscription, or one Graph no longer knows, is created again. Fails with 503 when Graph rejects the call; the error is kept on the subscription. **Required Permissions** \"tenant-management.settings.update\"
440
- * @summary Renew the email subscription
441
- * @param {number} id
442
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
443
- * @param {*} [options] Override http request option.
444
- * @throws {RequiredError}
445
- */
446
- async renewEmailSubscription(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RenewEmailSubscriptionResponseClass>> {
447
- const localVarAxiosArgs = await localVarAxiosParamCreator.renewEmailSubscription(id, authorization, options);
448
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
449
- },
450
- }
451
- };
452
-
453
- /**
454
- * EmailSubscriptionsApi - factory interface
455
- * @export
456
- */
457
- export const EmailSubscriptionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
458
- const localVarFp = EmailSubscriptionsApiFp(configuration)
459
- return {
460
- /**
461
- * Queues a catch-up for this subscription: Microsoft Graph is asked for every change to the folder since the last catch-up, and mail that never arrived through a notification is ingested. Returns straight away; queued is false when the subscription is being deleted. **Required Permissions** \"tenant-management.settings.update\"
462
- * @summary Catch up missed mail for the email subscription
463
- * @param {number} id
464
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
465
- * @param {*} [options] Override http request option.
466
- * @throws {RequiredError}
467
- */
468
- catchUpEmailSubscription(id: number, authorization?: string, options?: any): AxiosPromise<CatchUpEmailSubscriptionResponseClass> {
469
- return localVarFp.catchUpEmailSubscription(id, authorization, options).then((request) => request(axios, basePath));
470
- },
471
- /**
472
- * Queues a catch-up for every subscription of the email channel: Microsoft Graph is asked for every change since the last catch-up, and mail that never arrived through a notification is ingested. Returns straight away with how many catch-ups were queued. **Required Permissions** \"tenant-management.settings.update\"
473
- * @summary Catch up missed mail for all email subscriptions
474
- * @param {CatchUpEmailSubscriptionsRequestDto} catchUpEmailSubscriptionsRequestDto
475
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
476
- * @param {*} [options] Override http request option.
477
- * @throws {RequiredError}
478
- */
479
- catchUpEmailSubscriptions(catchUpEmailSubscriptionsRequestDto: CatchUpEmailSubscriptionsRequestDto, authorization?: string, options?: any): AxiosPromise<CatchUpEmailSubscriptionsResponseClass> {
480
- return localVarFp.catchUpEmailSubscriptions(catchUpEmailSubscriptionsRequestDto, authorization, options).then((request) => request(axios, basePath));
481
- },
482
- /**
483
- * Retrieves the email subscription with the given id. **Required Permissions** \"tenant-management.settings.view\"
484
- * @summary Retrieve the email subscription
485
- * @param {number} id
486
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
487
- * @param {*} [options] Override http request option.
488
- * @throws {RequiredError}
489
- */
490
- getEmailSubscription(id: number, authorization?: string, options?: any): AxiosPromise<GetEmailSubscriptionResponseClass> {
491
- return localVarFp.getEmailSubscription(id, authorization, options).then((request) => request(axios, basePath));
492
- },
493
- /**
494
- * Returns the Microsoft Graph mail subscriptions of the tenant, one per mailbox and folder of the email channel, with their status, expiry and last error. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
495
- * @summary List email subscriptions
496
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
497
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
498
- * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
499
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt&lt;/i&gt;
500
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
501
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, mailbox, folder, status, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt&lt;/i&gt;
502
- * @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.&lt;br/&gt; &lt;br/&gt;
503
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt&lt;/i&gt;
504
- * @param {*} [options] Override http request option.
505
- * @throws {RequiredError}
506
- */
507
- listEmailSubscriptions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailSubscriptionsResponseClass> {
508
- return localVarFp.listEmailSubscriptions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
509
- },
510
- /**
511
- * Brings the subscriptions in line with the mailboxes and folders of the email channel: creates the missing ones, deletes the ones no longer configured and recreates expired or failed ones. Returns how many subscriptions each step touched. **Required Permissions** \"tenant-management.settings.update\"
512
- * @summary Reconcile the email subscriptions
513
- * @param {ReconcileEmailSubscriptionsRequestDto} reconcileEmailSubscriptionsRequestDto
514
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
515
- * @param {*} [options] Override http request option.
516
- * @throws {RequiredError}
517
- */
518
- reconcileEmailSubscriptions(reconcileEmailSubscriptionsRequestDto: ReconcileEmailSubscriptionsRequestDto, authorization?: string, options?: any): AxiosPromise<ReconcileEmailSubscriptionsResponseClass> {
519
- return localVarFp.reconcileEmailSubscriptions(reconcileEmailSubscriptionsRequestDto, authorization, options).then((request) => request(axios, basePath));
520
- },
521
- /**
522
- * Renews the subscription in Microsoft Graph right away and returns it with its new expiry. A pending or failed subscription, or one Graph no longer knows, is created again. Fails with 503 when Graph rejects the call; the error is kept on the subscription. **Required Permissions** \"tenant-management.settings.update\"
523
- * @summary Renew the email subscription
524
- * @param {number} id
525
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
526
- * @param {*} [options] Override http request option.
527
- * @throws {RequiredError}
528
- */
529
- renewEmailSubscription(id: number, authorization?: string, options?: any): AxiosPromise<RenewEmailSubscriptionResponseClass> {
530
- return localVarFp.renewEmailSubscription(id, authorization, options).then((request) => request(axios, basePath));
531
- },
532
- };
533
- };
534
-
535
- /**
536
- * Request parameters for catchUpEmailSubscription operation in EmailSubscriptionsApi.
537
- * @export
538
- * @interface EmailSubscriptionsApiCatchUpEmailSubscriptionRequest
539
- */
540
- export interface EmailSubscriptionsApiCatchUpEmailSubscriptionRequest {
541
- /**
542
- *
543
- * @type {number}
544
- * @memberof EmailSubscriptionsApiCatchUpEmailSubscription
545
- */
546
- readonly id: number
547
-
548
- /**
549
- * Bearer Token: provided by the login endpoint under the name accessToken.
550
- * @type {string}
551
- * @memberof EmailSubscriptionsApiCatchUpEmailSubscription
552
- */
553
- readonly authorization?: string
554
- }
555
-
556
- /**
557
- * Request parameters for catchUpEmailSubscriptions operation in EmailSubscriptionsApi.
558
- * @export
559
- * @interface EmailSubscriptionsApiCatchUpEmailSubscriptionsRequest
560
- */
561
- export interface EmailSubscriptionsApiCatchUpEmailSubscriptionsRequest {
562
- /**
563
- *
564
- * @type {CatchUpEmailSubscriptionsRequestDto}
565
- * @memberof EmailSubscriptionsApiCatchUpEmailSubscriptions
566
- */
567
- readonly catchUpEmailSubscriptionsRequestDto: CatchUpEmailSubscriptionsRequestDto
568
-
569
- /**
570
- * Bearer Token: provided by the login endpoint under the name accessToken.
571
- * @type {string}
572
- * @memberof EmailSubscriptionsApiCatchUpEmailSubscriptions
573
- */
574
- readonly authorization?: string
575
- }
576
-
577
- /**
578
- * Request parameters for getEmailSubscription operation in EmailSubscriptionsApi.
579
- * @export
580
- * @interface EmailSubscriptionsApiGetEmailSubscriptionRequest
581
- */
582
- export interface EmailSubscriptionsApiGetEmailSubscriptionRequest {
583
- /**
584
- *
585
- * @type {number}
586
- * @memberof EmailSubscriptionsApiGetEmailSubscription
587
- */
588
- readonly id: number
589
-
590
- /**
591
- * Bearer Token: provided by the login endpoint under the name accessToken.
592
- * @type {string}
593
- * @memberof EmailSubscriptionsApiGetEmailSubscription
594
- */
595
- readonly authorization?: string
596
- }
597
-
598
- /**
599
- * Request parameters for listEmailSubscriptions operation in EmailSubscriptionsApi.
600
- * @export
601
- * @interface EmailSubscriptionsApiListEmailSubscriptionsRequest
602
- */
603
- export interface EmailSubscriptionsApiListEmailSubscriptionsRequest {
604
- /**
605
- * Bearer Token: provided by the login endpoint under the name accessToken.
606
- * @type {string}
607
- * @memberof EmailSubscriptionsApiListEmailSubscriptions
608
- */
609
- readonly authorization?: string
610
-
611
- /**
612
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
613
- * @type {number}
614
- * @memberof EmailSubscriptionsApiListEmailSubscriptions
615
- */
616
- readonly pageSize?: number
617
-
618
- /**
619
- * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
620
- * @type {string}
621
- * @memberof EmailSubscriptionsApiListEmailSubscriptions
622
- */
623
- readonly pageToken?: string
624
-
625
- /**
626
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt&lt;/i&gt;
627
- * @type {string}
628
- * @memberof EmailSubscriptionsApiListEmailSubscriptions
629
- */
630
- readonly filter?: string
631
-
632
- /**
633
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
634
- * @type {string}
635
- * @memberof EmailSubscriptionsApiListEmailSubscriptions
636
- */
637
- readonly search?: string
638
-
639
- /**
640
- * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, mailbox, folder, status, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt&lt;/i&gt;
641
- * @type {string}
642
- * @memberof EmailSubscriptionsApiListEmailSubscriptions
643
- */
644
- readonly order?: string
645
-
646
- /**
647
- * 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.&lt;br/&gt; &lt;br/&gt;
648
- * @type {string}
649
- * @memberof EmailSubscriptionsApiListEmailSubscriptions
650
- */
651
- readonly expand?: string
652
-
653
- /**
654
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt&lt;/i&gt;
655
- * @type {string}
656
- * @memberof EmailSubscriptionsApiListEmailSubscriptions
657
- */
658
- readonly filters?: string
659
- }
660
-
661
- /**
662
- * Request parameters for reconcileEmailSubscriptions operation in EmailSubscriptionsApi.
663
- * @export
664
- * @interface EmailSubscriptionsApiReconcileEmailSubscriptionsRequest
665
- */
666
- export interface EmailSubscriptionsApiReconcileEmailSubscriptionsRequest {
667
- /**
668
- *
669
- * @type {ReconcileEmailSubscriptionsRequestDto}
670
- * @memberof EmailSubscriptionsApiReconcileEmailSubscriptions
671
- */
672
- readonly reconcileEmailSubscriptionsRequestDto: ReconcileEmailSubscriptionsRequestDto
673
-
674
- /**
675
- * Bearer Token: provided by the login endpoint under the name accessToken.
676
- * @type {string}
677
- * @memberof EmailSubscriptionsApiReconcileEmailSubscriptions
678
- */
679
- readonly authorization?: string
680
- }
681
-
682
- /**
683
- * Request parameters for renewEmailSubscription operation in EmailSubscriptionsApi.
684
- * @export
685
- * @interface EmailSubscriptionsApiRenewEmailSubscriptionRequest
686
- */
687
- export interface EmailSubscriptionsApiRenewEmailSubscriptionRequest {
688
- /**
689
- *
690
- * @type {number}
691
- * @memberof EmailSubscriptionsApiRenewEmailSubscription
692
- */
693
- readonly id: number
694
-
695
- /**
696
- * Bearer Token: provided by the login endpoint under the name accessToken.
697
- * @type {string}
698
- * @memberof EmailSubscriptionsApiRenewEmailSubscription
699
- */
700
- readonly authorization?: string
701
- }
702
-
703
- /**
704
- * EmailSubscriptionsApi - object-oriented interface
705
- * @export
706
- * @class EmailSubscriptionsApi
707
- * @extends {BaseAPI}
708
- */
709
- export class EmailSubscriptionsApi extends BaseAPI {
710
- /**
711
- * Queues a catch-up for this subscription: Microsoft Graph is asked for every change to the folder since the last catch-up, and mail that never arrived through a notification is ingested. Returns straight away; queued is false when the subscription is being deleted. **Required Permissions** \"tenant-management.settings.update\"
712
- * @summary Catch up missed mail for the email subscription
713
- * @param {EmailSubscriptionsApiCatchUpEmailSubscriptionRequest} requestParameters Request parameters.
714
- * @param {*} [options] Override http request option.
715
- * @throws {RequiredError}
716
- * @memberof EmailSubscriptionsApi
717
- */
718
- public catchUpEmailSubscription(requestParameters: EmailSubscriptionsApiCatchUpEmailSubscriptionRequest, options?: AxiosRequestConfig) {
719
- return EmailSubscriptionsApiFp(this.configuration).catchUpEmailSubscription(requestParameters.id, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
720
- }
721
-
722
- /**
723
- * Queues a catch-up for every subscription of the email channel: Microsoft Graph is asked for every change since the last catch-up, and mail that never arrived through a notification is ingested. Returns straight away with how many catch-ups were queued. **Required Permissions** \"tenant-management.settings.update\"
724
- * @summary Catch up missed mail for all email subscriptions
725
- * @param {EmailSubscriptionsApiCatchUpEmailSubscriptionsRequest} requestParameters Request parameters.
726
- * @param {*} [options] Override http request option.
727
- * @throws {RequiredError}
728
- * @memberof EmailSubscriptionsApi
729
- */
730
- public catchUpEmailSubscriptions(requestParameters: EmailSubscriptionsApiCatchUpEmailSubscriptionsRequest, options?: AxiosRequestConfig) {
731
- return EmailSubscriptionsApiFp(this.configuration).catchUpEmailSubscriptions(requestParameters.catchUpEmailSubscriptionsRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
732
- }
733
-
734
- /**
735
- * Retrieves the email subscription with the given id. **Required Permissions** \"tenant-management.settings.view\"
736
- * @summary Retrieve the email subscription
737
- * @param {EmailSubscriptionsApiGetEmailSubscriptionRequest} requestParameters Request parameters.
738
- * @param {*} [options] Override http request option.
739
- * @throws {RequiredError}
740
- * @memberof EmailSubscriptionsApi
741
- */
742
- public getEmailSubscription(requestParameters: EmailSubscriptionsApiGetEmailSubscriptionRequest, options?: AxiosRequestConfig) {
743
- return EmailSubscriptionsApiFp(this.configuration).getEmailSubscription(requestParameters.id, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
744
- }
745
-
746
- /**
747
- * Returns the Microsoft Graph mail subscriptions of the tenant, one per mailbox and folder of the email channel, with their status, expiry and last error. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
748
- * @summary List email subscriptions
749
- * @param {EmailSubscriptionsApiListEmailSubscriptionsRequest} requestParameters Request parameters.
750
- * @param {*} [options] Override http request option.
751
- * @throws {RequiredError}
752
- * @memberof EmailSubscriptionsApi
753
- */
754
- public listEmailSubscriptions(requestParameters: EmailSubscriptionsApiListEmailSubscriptionsRequest = {}, options?: AxiosRequestConfig) {
755
- return EmailSubscriptionsApiFp(this.configuration).listEmailSubscriptions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
756
- }
757
-
758
- /**
759
- * Brings the subscriptions in line with the mailboxes and folders of the email channel: creates the missing ones, deletes the ones no longer configured and recreates expired or failed ones. Returns how many subscriptions each step touched. **Required Permissions** \"tenant-management.settings.update\"
760
- * @summary Reconcile the email subscriptions
761
- * @param {EmailSubscriptionsApiReconcileEmailSubscriptionsRequest} requestParameters Request parameters.
762
- * @param {*} [options] Override http request option.
763
- * @throws {RequiredError}
764
- * @memberof EmailSubscriptionsApi
765
- */
766
- public reconcileEmailSubscriptions(requestParameters: EmailSubscriptionsApiReconcileEmailSubscriptionsRequest, options?: AxiosRequestConfig) {
767
- return EmailSubscriptionsApiFp(this.configuration).reconcileEmailSubscriptions(requestParameters.reconcileEmailSubscriptionsRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
768
- }
769
-
770
- /**
771
- * Renews the subscription in Microsoft Graph right away and returns it with its new expiry. A pending or failed subscription, or one Graph no longer knows, is created again. Fails with 503 when Graph rejects the call; the error is kept on the subscription. **Required Permissions** \"tenant-management.settings.update\"
772
- * @summary Renew the email subscription
773
- * @param {EmailSubscriptionsApiRenewEmailSubscriptionRequest} requestParameters Request parameters.
774
- * @param {*} [options] Override http request option.
775
- * @throws {RequiredError}
776
- * @memberof EmailSubscriptionsApi
777
- */
778
- public renewEmailSubscription(requestParameters: EmailSubscriptionsApiRenewEmailSubscriptionRequest, options?: AxiosRequestConfig) {
779
- return EmailSubscriptionsApiFp(this.configuration).renewEmailSubscription(requestParameters.id, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
780
- }
781
- }