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