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

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 +23 -0
  2. package/README.md +2 -2
  3. package/api/email-mailboxes-api.ts +148 -0
  4. package/api/email-messages-api.ts +40 -28
  5. package/api/email-subscriptions-api.ts +769 -0
  6. package/api/email-tracking-api.ts +271 -40
  7. package/api/email-verifications-api.ts +16 -8
  8. package/api/layouts-api.ts +56 -36
  9. package/api/msgraph-webhooks-api.ts +278 -0
  10. package/api/notification-templates-api.ts +56 -36
  11. package/api/notifications-api.ts +115 -4
  12. package/api.ts +6 -0
  13. package/dist/api/email-mailboxes-api.d.ts +87 -0
  14. package/dist/api/email-mailboxes-api.js +218 -0
  15. package/dist/api/email-messages-api.d.ts +40 -28
  16. package/dist/api/email-messages-api.js +37 -25
  17. package/dist/api/email-subscriptions-api.d.ts +432 -0
  18. package/dist/api/email-subscriptions-api.js +722 -0
  19. package/dist/api/email-tracking-api.d.ts +170 -40
  20. package/dist/api/email-tracking-api.js +233 -34
  21. package/dist/api/email-verifications-api.d.ts +16 -8
  22. package/dist/api/email-verifications-api.js +16 -8
  23. package/dist/api/layouts-api.d.ts +56 -36
  24. package/dist/api/layouts-api.js +52 -32
  25. package/dist/api/msgraph-webhooks-api.d.ts +168 -0
  26. package/dist/api/msgraph-webhooks-api.js +305 -0
  27. package/dist/api/notification-templates-api.d.ts +56 -36
  28. package/dist/api/notification-templates-api.js +52 -32
  29. package/dist/api/notifications-api.d.ts +65 -4
  30. package/dist/api/notifications-api.js +101 -4
  31. package/dist/api.d.ts +3 -0
  32. package/dist/api.js +3 -0
  33. package/dist/models/assign-email-thread-entity-body-dto.d.ts +43 -0
  34. package/dist/models/assign-email-thread-entity-body-dto.js +22 -0
  35. package/dist/models/assign-email-thread-entity-response-class.d.ts +25 -0
  36. package/dist/models/assign-email-thread-entity-response-class.js +15 -0
  37. package/dist/models/catch-up-email-subscription-response-class.d.ts +24 -0
  38. package/dist/models/catch-up-email-subscription-response-class.js +15 -0
  39. package/dist/models/catch-up-email-subscriptions-request-dto.d.ts +24 -0
  40. package/dist/models/catch-up-email-subscriptions-request-dto.js +15 -0
  41. package/dist/models/catch-up-email-subscriptions-response-class.d.ts +30 -0
  42. package/dist/models/catch-up-email-subscriptions-response-class.js +15 -0
  43. package/dist/models/email-mailbox-class.d.ts +47 -0
  44. package/dist/models/email-mailbox-class.js +20 -0
  45. package/dist/models/email-message-class.d.ts +73 -7
  46. package/dist/models/email-message-class.js +22 -3
  47. package/dist/models/email-message-summary-class.d.ts +98 -0
  48. package/dist/models/email-message-summary-class.js +33 -0
  49. package/dist/models/email-subscription-class.d.ts +110 -0
  50. package/dist/models/email-subscription-class.js +23 -0
  51. package/dist/models/email-thread-class.d.ts +37 -5
  52. package/dist/models/entity-ref-class.d.ts +37 -0
  53. package/dist/models/entity-ref-class.js +22 -0
  54. package/dist/models/get-email-subscription-response-class.d.ts +25 -0
  55. package/dist/models/get-email-subscription-response-class.js +15 -0
  56. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  57. package/dist/models/grpc-send-email-request-dto.js +22 -0
  58. package/dist/models/index.d.ts +20 -0
  59. package/dist/models/index.js +20 -0
  60. package/dist/models/inline-attachment-dto.d.ts +36 -0
  61. package/dist/models/inline-attachment-dto.js +15 -0
  62. package/dist/models/list-email-mailboxes-response-class.d.ts +43 -0
  63. package/dist/models/list-email-mailboxes-response-class.js +15 -0
  64. package/dist/models/list-email-subscriptions-response-class.d.ts +43 -0
  65. package/dist/models/list-email-subscriptions-response-class.js +15 -0
  66. package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +24 -0
  67. package/dist/models/reconcile-email-subscriptions-request-dto.js +15 -0
  68. package/dist/models/reconcile-email-subscriptions-response-class.d.ts +48 -0
  69. package/dist/models/reconcile-email-subscriptions-response-class.js +15 -0
  70. package/dist/models/renew-email-subscription-response-class.d.ts +25 -0
  71. package/dist/models/renew-email-subscription-response-class.js +15 -0
  72. package/dist/models/send-email-request-dto.d.ts +131 -0
  73. package/dist/models/send-email-request-dto.js +22 -0
  74. package/dist/models/send-email-response-class.d.ts +24 -0
  75. package/dist/models/send-email-response-class.js +15 -0
  76. package/dist/models/send-notification-request-dto.d.ts +10 -1
  77. package/dist/models/send-notification-request-dto.js +2 -1
  78. package/dist/models/unassign-email-thread-entity-response-class.d.ts +25 -0
  79. package/dist/models/unassign-email-thread-entity-response-class.js +15 -0
  80. package/models/assign-email-thread-entity-body-dto.ts +52 -0
  81. package/models/assign-email-thread-entity-response-class.ts +31 -0
  82. package/models/catch-up-email-subscription-response-class.ts +30 -0
  83. package/models/catch-up-email-subscriptions-request-dto.ts +30 -0
  84. package/models/catch-up-email-subscriptions-response-class.ts +36 -0
  85. package/models/email-mailbox-class.ts +56 -0
  86. package/models/email-message-class.ts +78 -8
  87. package/models/email-message-summary-class.ts +109 -0
  88. package/models/email-subscription-class.ts +119 -0
  89. package/models/email-thread-class.ts +37 -5
  90. package/models/entity-ref-class.ts +46 -0
  91. package/models/get-email-subscription-response-class.ts +31 -0
  92. package/models/grpc-send-email-request-dto.ts +144 -0
  93. package/models/index.ts +20 -0
  94. package/models/inline-attachment-dto.ts +42 -0
  95. package/models/list-email-mailboxes-response-class.ts +49 -0
  96. package/models/list-email-subscriptions-response-class.ts +49 -0
  97. package/models/reconcile-email-subscriptions-request-dto.ts +30 -0
  98. package/models/reconcile-email-subscriptions-response-class.ts +54 -0
  99. package/models/renew-email-subscription-response-class.ts +31 -0
  100. package/models/send-email-request-dto.ts +138 -0
  101. package/models/send-email-response-class.ts +30 -0
  102. package/models/send-notification-request-dto.ts +9 -2
  103. package/models/unassign-email-thread-entity-response-class.ts +31 -0
  104. package/package.json +1 -1
@@ -0,0 +1,432 @@
1
+ /**
2
+ * EMIL NotificationService
3
+ * The EMIL NotificationService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CatchUpEmailSubscriptionResponseClass } from '../models';
16
+ import { CatchUpEmailSubscriptionsRequestDto } from '../models';
17
+ import { CatchUpEmailSubscriptionsResponseClass } from '../models';
18
+ import { GetEmailSubscriptionResponseClass } from '../models';
19
+ import { ListEmailSubscriptionsResponseClass } from '../models';
20
+ import { ReconcileEmailSubscriptionsRequestDto } from '../models';
21
+ import { ReconcileEmailSubscriptionsResponseClass } from '../models';
22
+ import { RenewEmailSubscriptionResponseClass } from '../models';
23
+ /**
24
+ * EmailSubscriptionsApi - axios parameter creator
25
+ * @export
26
+ */
27
+ export declare const EmailSubscriptionsApiAxiosParamCreator: (configuration?: Configuration) => {
28
+ /**
29
+ * 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\"
30
+ * @summary Catch up missed mail for the email subscription
31
+ * @param {number} id
32
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
33
+ * @param {*} [options] Override http request option.
34
+ * @throws {RequiredError}
35
+ */
36
+ catchUpEmailSubscription: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
+ /**
38
+ * 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\"
39
+ * @summary Catch up missed mail for all email subscriptions
40
+ * @param {CatchUpEmailSubscriptionsRequestDto} catchUpEmailSubscriptionsRequestDto
41
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ catchUpEmailSubscriptions: (catchUpEmailSubscriptionsRequestDto: CatchUpEmailSubscriptionsRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
+ /**
47
+ * Retrieves the email subscription with the given id. **Required Permissions** \"tenant-management.settings.view\"
48
+ * @summary Retrieve the email subscription
49
+ * @param {number} id
50
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
51
+ * @param {*} [options] Override http request option.
52
+ * @throws {RequiredError}
53
+ */
54
+ getEmailSubscription: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
55
+ /**
56
+ * 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\"
57
+ * @summary List email subscriptions
58
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
59
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
60
+ * @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.
61
+ * @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;
62
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
63
+ * @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;
64
+ * @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;
65
+ * @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;
66
+ * @param {*} [options] Override http request option.
67
+ * @throws {RequiredError}
68
+ */
69
+ listEmailSubscriptions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
70
+ /**
71
+ * 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\"
72
+ * @summary Reconcile the email subscriptions
73
+ * @param {ReconcileEmailSubscriptionsRequestDto} reconcileEmailSubscriptionsRequestDto
74
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
75
+ * @param {*} [options] Override http request option.
76
+ * @throws {RequiredError}
77
+ */
78
+ reconcileEmailSubscriptions: (reconcileEmailSubscriptionsRequestDto: ReconcileEmailSubscriptionsRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
79
+ /**
80
+ * 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\"
81
+ * @summary Renew the email subscription
82
+ * @param {number} id
83
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
84
+ * @param {*} [options] Override http request option.
85
+ * @throws {RequiredError}
86
+ */
87
+ renewEmailSubscription: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
88
+ };
89
+ /**
90
+ * EmailSubscriptionsApi - functional programming interface
91
+ * @export
92
+ */
93
+ export declare const EmailSubscriptionsApiFp: (configuration?: Configuration) => {
94
+ /**
95
+ * 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\"
96
+ * @summary Catch up missed mail for the email subscription
97
+ * @param {number} id
98
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ catchUpEmailSubscription(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CatchUpEmailSubscriptionResponseClass>>;
103
+ /**
104
+ * 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\"
105
+ * @summary Catch up missed mail for all email subscriptions
106
+ * @param {CatchUpEmailSubscriptionsRequestDto} catchUpEmailSubscriptionsRequestDto
107
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
108
+ * @param {*} [options] Override http request option.
109
+ * @throws {RequiredError}
110
+ */
111
+ catchUpEmailSubscriptions(catchUpEmailSubscriptionsRequestDto: CatchUpEmailSubscriptionsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CatchUpEmailSubscriptionsResponseClass>>;
112
+ /**
113
+ * Retrieves the email subscription with the given id. **Required Permissions** \"tenant-management.settings.view\"
114
+ * @summary Retrieve the email subscription
115
+ * @param {number} id
116
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
117
+ * @param {*} [options] Override http request option.
118
+ * @throws {RequiredError}
119
+ */
120
+ getEmailSubscription(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailSubscriptionResponseClass>>;
121
+ /**
122
+ * 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\"
123
+ * @summary List email subscriptions
124
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
125
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
126
+ * @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.
127
+ * @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;
128
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
129
+ * @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;
130
+ * @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;
131
+ * @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;
132
+ * @param {*} [options] Override http request option.
133
+ * @throws {RequiredError}
134
+ */
135
+ 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>>;
136
+ /**
137
+ * 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\"
138
+ * @summary Reconcile the email subscriptions
139
+ * @param {ReconcileEmailSubscriptionsRequestDto} reconcileEmailSubscriptionsRequestDto
140
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
141
+ * @param {*} [options] Override http request option.
142
+ * @throws {RequiredError}
143
+ */
144
+ reconcileEmailSubscriptions(reconcileEmailSubscriptionsRequestDto: ReconcileEmailSubscriptionsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReconcileEmailSubscriptionsResponseClass>>;
145
+ /**
146
+ * 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\"
147
+ * @summary Renew the email subscription
148
+ * @param {number} id
149
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
150
+ * @param {*} [options] Override http request option.
151
+ * @throws {RequiredError}
152
+ */
153
+ renewEmailSubscription(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RenewEmailSubscriptionResponseClass>>;
154
+ };
155
+ /**
156
+ * EmailSubscriptionsApi - factory interface
157
+ * @export
158
+ */
159
+ export declare const EmailSubscriptionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
160
+ /**
161
+ * 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\"
162
+ * @summary Catch up missed mail for the email subscription
163
+ * @param {number} id
164
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
165
+ * @param {*} [options] Override http request option.
166
+ * @throws {RequiredError}
167
+ */
168
+ catchUpEmailSubscription(id: number, authorization?: string, options?: any): AxiosPromise<CatchUpEmailSubscriptionResponseClass>;
169
+ /**
170
+ * 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\"
171
+ * @summary Catch up missed mail for all email subscriptions
172
+ * @param {CatchUpEmailSubscriptionsRequestDto} catchUpEmailSubscriptionsRequestDto
173
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
174
+ * @param {*} [options] Override http request option.
175
+ * @throws {RequiredError}
176
+ */
177
+ catchUpEmailSubscriptions(catchUpEmailSubscriptionsRequestDto: CatchUpEmailSubscriptionsRequestDto, authorization?: string, options?: any): AxiosPromise<CatchUpEmailSubscriptionsResponseClass>;
178
+ /**
179
+ * Retrieves the email subscription with the given id. **Required Permissions** \"tenant-management.settings.view\"
180
+ * @summary Retrieve the email subscription
181
+ * @param {number} id
182
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
183
+ * @param {*} [options] Override http request option.
184
+ * @throws {RequiredError}
185
+ */
186
+ getEmailSubscription(id: number, authorization?: string, options?: any): AxiosPromise<GetEmailSubscriptionResponseClass>;
187
+ /**
188
+ * 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\"
189
+ * @summary List email subscriptions
190
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
191
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
192
+ * @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.
193
+ * @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;
194
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
195
+ * @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;
196
+ * @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;
197
+ * @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;
198
+ * @param {*} [options] Override http request option.
199
+ * @throws {RequiredError}
200
+ */
201
+ listEmailSubscriptions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailSubscriptionsResponseClass>;
202
+ /**
203
+ * 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\"
204
+ * @summary Reconcile the email subscriptions
205
+ * @param {ReconcileEmailSubscriptionsRequestDto} reconcileEmailSubscriptionsRequestDto
206
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
207
+ * @param {*} [options] Override http request option.
208
+ * @throws {RequiredError}
209
+ */
210
+ reconcileEmailSubscriptions(reconcileEmailSubscriptionsRequestDto: ReconcileEmailSubscriptionsRequestDto, authorization?: string, options?: any): AxiosPromise<ReconcileEmailSubscriptionsResponseClass>;
211
+ /**
212
+ * 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\"
213
+ * @summary Renew the email subscription
214
+ * @param {number} id
215
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
216
+ * @param {*} [options] Override http request option.
217
+ * @throws {RequiredError}
218
+ */
219
+ renewEmailSubscription(id: number, authorization?: string, options?: any): AxiosPromise<RenewEmailSubscriptionResponseClass>;
220
+ };
221
+ /**
222
+ * Request parameters for catchUpEmailSubscription operation in EmailSubscriptionsApi.
223
+ * @export
224
+ * @interface EmailSubscriptionsApiCatchUpEmailSubscriptionRequest
225
+ */
226
+ export interface EmailSubscriptionsApiCatchUpEmailSubscriptionRequest {
227
+ /**
228
+ *
229
+ * @type {number}
230
+ * @memberof EmailSubscriptionsApiCatchUpEmailSubscription
231
+ */
232
+ readonly id: number;
233
+ /**
234
+ * Bearer Token: provided by the login endpoint under the name accessToken.
235
+ * @type {string}
236
+ * @memberof EmailSubscriptionsApiCatchUpEmailSubscription
237
+ */
238
+ readonly authorization?: string;
239
+ }
240
+ /**
241
+ * Request parameters for catchUpEmailSubscriptions operation in EmailSubscriptionsApi.
242
+ * @export
243
+ * @interface EmailSubscriptionsApiCatchUpEmailSubscriptionsRequest
244
+ */
245
+ export interface EmailSubscriptionsApiCatchUpEmailSubscriptionsRequest {
246
+ /**
247
+ *
248
+ * @type {CatchUpEmailSubscriptionsRequestDto}
249
+ * @memberof EmailSubscriptionsApiCatchUpEmailSubscriptions
250
+ */
251
+ readonly catchUpEmailSubscriptionsRequestDto: CatchUpEmailSubscriptionsRequestDto;
252
+ /**
253
+ * Bearer Token: provided by the login endpoint under the name accessToken.
254
+ * @type {string}
255
+ * @memberof EmailSubscriptionsApiCatchUpEmailSubscriptions
256
+ */
257
+ readonly authorization?: string;
258
+ }
259
+ /**
260
+ * Request parameters for getEmailSubscription operation in EmailSubscriptionsApi.
261
+ * @export
262
+ * @interface EmailSubscriptionsApiGetEmailSubscriptionRequest
263
+ */
264
+ export interface EmailSubscriptionsApiGetEmailSubscriptionRequest {
265
+ /**
266
+ *
267
+ * @type {number}
268
+ * @memberof EmailSubscriptionsApiGetEmailSubscription
269
+ */
270
+ readonly id: number;
271
+ /**
272
+ * Bearer Token: provided by the login endpoint under the name accessToken.
273
+ * @type {string}
274
+ * @memberof EmailSubscriptionsApiGetEmailSubscription
275
+ */
276
+ readonly authorization?: string;
277
+ }
278
+ /**
279
+ * Request parameters for listEmailSubscriptions operation in EmailSubscriptionsApi.
280
+ * @export
281
+ * @interface EmailSubscriptionsApiListEmailSubscriptionsRequest
282
+ */
283
+ export interface EmailSubscriptionsApiListEmailSubscriptionsRequest {
284
+ /**
285
+ * Bearer Token: provided by the login endpoint under the name accessToken.
286
+ * @type {string}
287
+ * @memberof EmailSubscriptionsApiListEmailSubscriptions
288
+ */
289
+ readonly authorization?: string;
290
+ /**
291
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
292
+ * @type {number}
293
+ * @memberof EmailSubscriptionsApiListEmailSubscriptions
294
+ */
295
+ readonly pageSize?: number;
296
+ /**
297
+ * 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.
298
+ * @type {string}
299
+ * @memberof EmailSubscriptionsApiListEmailSubscriptions
300
+ */
301
+ readonly pageToken?: string;
302
+ /**
303
+ * 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;
304
+ * @type {string}
305
+ * @memberof EmailSubscriptionsApiListEmailSubscriptions
306
+ */
307
+ readonly filter?: string;
308
+ /**
309
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
310
+ * @type {string}
311
+ * @memberof EmailSubscriptionsApiListEmailSubscriptions
312
+ */
313
+ readonly search?: string;
314
+ /**
315
+ * 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;
316
+ * @type {string}
317
+ * @memberof EmailSubscriptionsApiListEmailSubscriptions
318
+ */
319
+ readonly order?: string;
320
+ /**
321
+ * 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;
322
+ * @type {string}
323
+ * @memberof EmailSubscriptionsApiListEmailSubscriptions
324
+ */
325
+ readonly expand?: string;
326
+ /**
327
+ * 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;
328
+ * @type {string}
329
+ * @memberof EmailSubscriptionsApiListEmailSubscriptions
330
+ */
331
+ readonly filters?: string;
332
+ }
333
+ /**
334
+ * Request parameters for reconcileEmailSubscriptions operation in EmailSubscriptionsApi.
335
+ * @export
336
+ * @interface EmailSubscriptionsApiReconcileEmailSubscriptionsRequest
337
+ */
338
+ export interface EmailSubscriptionsApiReconcileEmailSubscriptionsRequest {
339
+ /**
340
+ *
341
+ * @type {ReconcileEmailSubscriptionsRequestDto}
342
+ * @memberof EmailSubscriptionsApiReconcileEmailSubscriptions
343
+ */
344
+ readonly reconcileEmailSubscriptionsRequestDto: ReconcileEmailSubscriptionsRequestDto;
345
+ /**
346
+ * Bearer Token: provided by the login endpoint under the name accessToken.
347
+ * @type {string}
348
+ * @memberof EmailSubscriptionsApiReconcileEmailSubscriptions
349
+ */
350
+ readonly authorization?: string;
351
+ }
352
+ /**
353
+ * Request parameters for renewEmailSubscription operation in EmailSubscriptionsApi.
354
+ * @export
355
+ * @interface EmailSubscriptionsApiRenewEmailSubscriptionRequest
356
+ */
357
+ export interface EmailSubscriptionsApiRenewEmailSubscriptionRequest {
358
+ /**
359
+ *
360
+ * @type {number}
361
+ * @memberof EmailSubscriptionsApiRenewEmailSubscription
362
+ */
363
+ readonly id: number;
364
+ /**
365
+ * Bearer Token: provided by the login endpoint under the name accessToken.
366
+ * @type {string}
367
+ * @memberof EmailSubscriptionsApiRenewEmailSubscription
368
+ */
369
+ readonly authorization?: string;
370
+ }
371
+ /**
372
+ * EmailSubscriptionsApi - object-oriented interface
373
+ * @export
374
+ * @class EmailSubscriptionsApi
375
+ * @extends {BaseAPI}
376
+ */
377
+ export declare class EmailSubscriptionsApi extends BaseAPI {
378
+ /**
379
+ * 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\"
380
+ * @summary Catch up missed mail for the email subscription
381
+ * @param {EmailSubscriptionsApiCatchUpEmailSubscriptionRequest} requestParameters Request parameters.
382
+ * @param {*} [options] Override http request option.
383
+ * @throws {RequiredError}
384
+ * @memberof EmailSubscriptionsApi
385
+ */
386
+ catchUpEmailSubscription(requestParameters: EmailSubscriptionsApiCatchUpEmailSubscriptionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CatchUpEmailSubscriptionResponseClass, any, {}>>;
387
+ /**
388
+ * 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\"
389
+ * @summary Catch up missed mail for all email subscriptions
390
+ * @param {EmailSubscriptionsApiCatchUpEmailSubscriptionsRequest} requestParameters Request parameters.
391
+ * @param {*} [options] Override http request option.
392
+ * @throws {RequiredError}
393
+ * @memberof EmailSubscriptionsApi
394
+ */
395
+ catchUpEmailSubscriptions(requestParameters: EmailSubscriptionsApiCatchUpEmailSubscriptionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CatchUpEmailSubscriptionsResponseClass, any, {}>>;
396
+ /**
397
+ * Retrieves the email subscription with the given id. **Required Permissions** \"tenant-management.settings.view\"
398
+ * @summary Retrieve the email subscription
399
+ * @param {EmailSubscriptionsApiGetEmailSubscriptionRequest} requestParameters Request parameters.
400
+ * @param {*} [options] Override http request option.
401
+ * @throws {RequiredError}
402
+ * @memberof EmailSubscriptionsApi
403
+ */
404
+ getEmailSubscription(requestParameters: EmailSubscriptionsApiGetEmailSubscriptionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailSubscriptionResponseClass, any, {}>>;
405
+ /**
406
+ * 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\"
407
+ * @summary List email subscriptions
408
+ * @param {EmailSubscriptionsApiListEmailSubscriptionsRequest} requestParameters Request parameters.
409
+ * @param {*} [options] Override http request option.
410
+ * @throws {RequiredError}
411
+ * @memberof EmailSubscriptionsApi
412
+ */
413
+ listEmailSubscriptions(requestParameters?: EmailSubscriptionsApiListEmailSubscriptionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailSubscriptionsResponseClass, any, {}>>;
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 {EmailSubscriptionsApiReconcileEmailSubscriptionsRequest} requestParameters Request parameters.
418
+ * @param {*} [options] Override http request option.
419
+ * @throws {RequiredError}
420
+ * @memberof EmailSubscriptionsApi
421
+ */
422
+ reconcileEmailSubscriptions(requestParameters: EmailSubscriptionsApiReconcileEmailSubscriptionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReconcileEmailSubscriptionsResponseClass, any, {}>>;
423
+ /**
424
+ * 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\"
425
+ * @summary Renew the email subscription
426
+ * @param {EmailSubscriptionsApiRenewEmailSubscriptionRequest} requestParameters Request parameters.
427
+ * @param {*} [options] Override http request option.
428
+ * @throws {RequiredError}
429
+ * @memberof EmailSubscriptionsApi
430
+ */
431
+ renewEmailSubscription(requestParameters: EmailSubscriptionsApiRenewEmailSubscriptionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RenewEmailSubscriptionResponseClass, any, {}>>;
432
+ }