@emilgroup/notification-sdk 0.8.1-beta.40 → 0.8.1-beta.42
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.
- package/.openapi-generator/FILES +8 -0
- package/README.md +2 -2
- package/api/email-subscriptions-api.ts +559 -0
- package/api/email-tracking-api.ts +16 -16
- package/api.ts +2 -0
- package/base.ts +36 -15
- package/configuration.ts +11 -0
- package/dist/api/email-subscriptions-api.d.ts +319 -0
- package/dist/api/email-subscriptions-api.js +537 -0
- package/dist/api/email-tracking-api.d.ts +16 -16
- package/dist/api/email-tracking-api.js +13 -13
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.d.ts +1 -0
- package/dist/base.js +36 -16
- package/dist/configuration.d.ts +9 -0
- package/dist/configuration.js +1 -0
- package/dist/models/email-message-class.d.ts +7 -2
- package/dist/models/email-message-class.js +0 -1
- package/dist/models/email-message-summary-class.d.ts +85 -0
- package/dist/models/email-message-summary-class.js +27 -0
- package/dist/models/email-subscription-class.d.ts +104 -0
- package/dist/models/email-subscription-class.js +23 -0
- package/dist/models/email-thread-class.d.ts +25 -0
- package/dist/models/get-email-subscription-response-class.d.ts +25 -0
- package/dist/models/get-email-subscription-response-class.js +15 -0
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/models/list-email-subscriptions-response-class.d.ts +43 -0
- package/dist/models/list-email-subscriptions-response-class.js +15 -0
- package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +24 -0
- package/dist/models/reconcile-email-subscriptions-request-dto.js +15 -0
- package/dist/models/reconcile-email-subscriptions-response-class.d.ts +48 -0
- package/dist/models/reconcile-email-subscriptions-response-class.js +15 -0
- package/dist/models/renew-email-subscription-response-class.d.ts +25 -0
- package/dist/models/renew-email-subscription-response-class.js +15 -0
- package/models/email-message-class.ts +7 -2
- package/models/email-message-summary-class.ts +95 -0
- package/models/email-subscription-class.ts +113 -0
- package/models/email-thread-class.ts +25 -0
- package/models/get-email-subscription-response-class.ts +31 -0
- package/models/index.ts +7 -0
- package/models/list-email-subscriptions-response-class.ts +49 -0
- package/models/reconcile-email-subscriptions-request-dto.ts +30 -0
- package/models/reconcile-email-subscriptions-response-class.ts +54 -0
- package/models/renew-email-subscription-response-class.ts +31 -0
- package/package.json +1 -1
|
@@ -245,16 +245,16 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
245
245
|
};
|
|
246
246
|
},
|
|
247
247
|
/**
|
|
248
|
-
* Returns a list of email threads. A thread groups an email
|
|
248
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
249
249
|
* @summary List email threads
|
|
250
250
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
251
251
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
252
252
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
253
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
253
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
254
254
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
255
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
255
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
256
256
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: messages<i>
|
|
257
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
257
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
258
258
|
* @param {*} [options] Override http request option.
|
|
259
259
|
* @throws {RequiredError}
|
|
260
260
|
*/
|
|
@@ -429,16 +429,16 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
429
429
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
430
430
|
},
|
|
431
431
|
/**
|
|
432
|
-
* Returns a list of email threads. A thread groups an email
|
|
432
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
433
433
|
* @summary List email threads
|
|
434
434
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
435
435
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
436
436
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
437
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
437
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
438
438
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
439
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
439
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
440
440
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: messages<i>
|
|
441
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
441
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
442
442
|
* @param {*} [options] Override http request option.
|
|
443
443
|
* @throws {RequiredError}
|
|
444
444
|
*/
|
|
@@ -518,16 +518,16 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
518
518
|
return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
|
|
519
519
|
},
|
|
520
520
|
/**
|
|
521
|
-
* Returns a list of email threads. A thread groups an email
|
|
521
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
522
522
|
* @summary List email threads
|
|
523
523
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
524
524
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
525
525
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
526
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
526
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
527
527
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
528
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
528
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
529
529
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: messages<i>
|
|
530
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
530
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
531
531
|
* @param {*} [options] Override http request option.
|
|
532
532
|
* @throws {RequiredError}
|
|
533
533
|
*/
|
|
@@ -695,7 +695,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
695
695
|
readonly pageToken?: string
|
|
696
696
|
|
|
697
697
|
/**
|
|
698
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
698
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
699
699
|
* @type {string}
|
|
700
700
|
* @memberof EmailTrackingApiListThreads
|
|
701
701
|
*/
|
|
@@ -709,7 +709,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
709
709
|
readonly search?: string
|
|
710
710
|
|
|
711
711
|
/**
|
|
712
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
712
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
713
713
|
* @type {string}
|
|
714
714
|
* @memberof EmailTrackingApiListThreads
|
|
715
715
|
*/
|
|
@@ -723,7 +723,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
723
723
|
readonly expand?: string
|
|
724
724
|
|
|
725
725
|
/**
|
|
726
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
726
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
727
727
|
* @type {string}
|
|
728
728
|
* @memberof EmailTrackingApiListThreads
|
|
729
729
|
*/
|
|
@@ -807,7 +807,7 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
807
807
|
}
|
|
808
808
|
|
|
809
809
|
/**
|
|
810
|
-
* Returns a list of email threads. A thread groups an email
|
|
810
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
811
811
|
* @summary List email threads
|
|
812
812
|
* @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
|
|
813
813
|
* @param {*} [options] Override http request option.
|
package/api.ts
CHANGED
|
@@ -21,6 +21,7 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
|
|
23
23
|
import { EmailMessagesApi } from './api';
|
|
24
|
+
import { EmailSubscriptionsApi } from './api';
|
|
24
25
|
import { EmailTrackingApi } from './api';
|
|
25
26
|
import { EmailVerificationsApi } from './api';
|
|
26
27
|
import { HealthApi } from './api';
|
|
@@ -31,6 +32,7 @@ import { NotificationsApi } from './api';
|
|
|
31
32
|
|
|
32
33
|
|
|
33
34
|
export * from './api/email-messages-api';
|
|
35
|
+
export * from './api/email-subscriptions-api';
|
|
34
36
|
export * from './api/email-tracking-api';
|
|
35
37
|
export * from './api/email-verifications-api';
|
|
36
38
|
export * from './api/health-api';
|
package/base.ts
CHANGED
|
@@ -102,10 +102,14 @@ export class BaseAPI {
|
|
|
102
102
|
this.configuration = configuration;
|
|
103
103
|
this.basePath = configuration.basePath || this.basePath;
|
|
104
104
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
105
|
+
if (configuration.cookieAuth) {
|
|
106
|
+
this.useCookieAuth();
|
|
107
|
+
} else {
|
|
108
|
+
// Use config token if provided, otherwise use tokenData token
|
|
109
|
+
const configToken = this.configuration.accessToken;
|
|
110
|
+
const storedToken = accessToken ? `Bearer ${accessToken}` : '';
|
|
111
|
+
this.configuration.accessToken = configToken || storedToken;
|
|
112
|
+
}
|
|
109
113
|
} else {
|
|
110
114
|
const { accessToken, username } = this.tokenData;
|
|
111
115
|
|
|
@@ -119,6 +123,12 @@ export class BaseAPI {
|
|
|
119
123
|
this.attachInterceptor(axios);
|
|
120
124
|
}
|
|
121
125
|
|
|
126
|
+
// Cookie mode: the browser sends the HttpOnly access cookie, so no token is read from storage.
|
|
127
|
+
private useCookieAuth() {
|
|
128
|
+
this.configuration.username = this.configuration.username || this.tokenData.username;
|
|
129
|
+
this.configuration.baseOptions = { ...this.configuration.baseOptions, withCredentials: true };
|
|
130
|
+
}
|
|
131
|
+
|
|
122
132
|
selectEnvironment(env: Environment) {
|
|
123
133
|
this.selectBasePath(env);
|
|
124
134
|
}
|
|
@@ -152,10 +162,12 @@ export class BaseAPI {
|
|
|
152
162
|
const { data: { accessToken, permissions } } = response;
|
|
153
163
|
|
|
154
164
|
this.configuration.username = username;
|
|
155
|
-
this.configuration.accessToken = `Bearer ${accessToken}`;
|
|
156
165
|
this.tokenData.username = username;
|
|
157
|
-
this.tokenData.accessToken = accessToken;
|
|
158
166
|
this.tokenData.permissions = permissions;
|
|
167
|
+
if (!this.configuration.cookieAuth) {
|
|
168
|
+
this.configuration.accessToken = `Bearer ${accessToken}`;
|
|
169
|
+
this.tokenData.accessToken = accessToken;
|
|
170
|
+
}
|
|
159
171
|
|
|
160
172
|
// Switch workspace if provided
|
|
161
173
|
if (targetWorkspace) {
|
|
@@ -178,7 +190,7 @@ export class BaseAPI {
|
|
|
178
190
|
url: `${this.configuration.basePath}/authservice/v1/workspaces/switch`,
|
|
179
191
|
headers: {
|
|
180
192
|
'Content-Type': 'application/json',
|
|
181
|
-
'Authorization': `Bearer ${this.configuration.accessToken}
|
|
193
|
+
...(this.configuration.cookieAuth ? {} : { 'Authorization': `Bearer ${this.configuration.accessToken}` }),
|
|
182
194
|
},
|
|
183
195
|
data: {
|
|
184
196
|
username: this.configuration.username,
|
|
@@ -190,10 +202,12 @@ export class BaseAPI {
|
|
|
190
202
|
const response = await globalAxios.request<SwitchWorkspaceResponseClass>(options);
|
|
191
203
|
|
|
192
204
|
const { data: { accessToken, permissions } } = response;
|
|
193
|
-
|
|
194
|
-
this.configuration.accessToken = `Bearer ${accessToken}`;
|
|
195
|
-
this.tokenData.accessToken = accessToken;
|
|
205
|
+
|
|
196
206
|
this.tokenData.permissions = permissions;
|
|
207
|
+
if (!this.configuration.cookieAuth) {
|
|
208
|
+
this.configuration.accessToken = `Bearer ${accessToken}`;
|
|
209
|
+
this.tokenData.accessToken = accessToken;
|
|
210
|
+
}
|
|
197
211
|
|
|
198
212
|
this.storeTokenData({
|
|
199
213
|
...this.tokenData
|
|
@@ -233,6 +247,11 @@ export class BaseAPI {
|
|
|
233
247
|
|
|
234
248
|
private storeTokenData(tokenData?: TokenData) {
|
|
235
249
|
if (typeof window !== 'undefined') {
|
|
250
|
+
if (tokenData && this.configuration?.cookieAuth) {
|
|
251
|
+
// Cookie mode saves who is logged in, never the token; a token saved by apps not yet migrated stays.
|
|
252
|
+
const { username, permissions } = tokenData;
|
|
253
|
+
tokenData = { ...(defaultStorage().get<TokenData>(TOKEN_DATA) || {}), username, permissions };
|
|
254
|
+
}
|
|
236
255
|
defaultStorage().set<TokenData>(TOKEN_DATA, tokenData);
|
|
237
256
|
}
|
|
238
257
|
}
|
|
@@ -263,15 +282,17 @@ export class BaseAPI {
|
|
|
263
282
|
originalConfig._retry = true;
|
|
264
283
|
try {
|
|
265
284
|
const { accessToken: tokenString, permissions } = await this.refreshTokenInternal();
|
|
266
|
-
const accessToken = `Bearer ${tokenString}`;
|
|
267
285
|
this.tokenData.permissions = permissions;
|
|
268
286
|
|
|
269
287
|
delete originalConfig.headers['Authorization']
|
|
270
288
|
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
289
|
+
// In cookie mode the refresh reply renewed the access cookie, so retry without a header.
|
|
290
|
+
if (!this.configuration.cookieAuth) {
|
|
291
|
+
const accessToken = `Bearer ${tokenString}`;
|
|
292
|
+
originalConfig.headers['Authorization'] = accessToken;
|
|
293
|
+
this.configuration.accessToken = accessToken;
|
|
294
|
+
this.tokenData.accessToken = tokenString;
|
|
295
|
+
}
|
|
275
296
|
|
|
276
297
|
this.storeTokenData(this.tokenData);
|
|
277
298
|
|
package/configuration.ts
CHANGED
|
@@ -21,6 +21,7 @@ export interface ConfigurationParameters {
|
|
|
21
21
|
basePath?: string;
|
|
22
22
|
baseOptions?: any;
|
|
23
23
|
formDataCtor?: new () => any;
|
|
24
|
+
cookieAuth?: boolean;
|
|
24
25
|
}
|
|
25
26
|
|
|
26
27
|
export class Configuration {
|
|
@@ -74,6 +75,15 @@ export class Configuration {
|
|
|
74
75
|
*/
|
|
75
76
|
formDataCtor?: new () => any;
|
|
76
77
|
|
|
78
|
+
/**
|
|
79
|
+
* Authenticate with the HttpOnly access cookie instead of a stored token: every call sends credentials.
|
|
80
|
+
* The browser holds one cookie, so use it with one logged-in account; log out through the auth service.
|
|
81
|
+
*
|
|
82
|
+
* @type {boolean}
|
|
83
|
+
* @memberof Configuration
|
|
84
|
+
*/
|
|
85
|
+
cookieAuth?: boolean;
|
|
86
|
+
|
|
77
87
|
constructor(param: ConfigurationParameters = {}) {
|
|
78
88
|
this.apiKey = param.apiKey;
|
|
79
89
|
this.username = param.username;
|
|
@@ -82,6 +92,7 @@ export class Configuration {
|
|
|
82
92
|
this.basePath = param.basePath;
|
|
83
93
|
this.baseOptions = param.baseOptions;
|
|
84
94
|
this.formDataCtor = param.formDataCtor;
|
|
95
|
+
this.cookieAuth = param.cookieAuth;
|
|
85
96
|
}
|
|
86
97
|
|
|
87
98
|
/**
|
|
@@ -0,0 +1,319 @@
|
|
|
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 { GetEmailSubscriptionResponseClass } from '../models';
|
|
16
|
+
import { ListEmailSubscriptionsResponseClass } from '../models';
|
|
17
|
+
import { ReconcileEmailSubscriptionsRequestDto } from '../models';
|
|
18
|
+
import { ReconcileEmailSubscriptionsResponseClass } from '../models';
|
|
19
|
+
import { RenewEmailSubscriptionResponseClass } from '../models';
|
|
20
|
+
/**
|
|
21
|
+
* EmailSubscriptionsApi - axios parameter creator
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export declare const EmailSubscriptionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
|
+
/**
|
|
26
|
+
* Retrieves the email subscription with the given id. **Required Permissions** \"tenant-management.settings.view\"
|
|
27
|
+
* @summary Retrieve the email subscription
|
|
28
|
+
* @param {number} id
|
|
29
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
30
|
+
* @param {*} [options] Override http request option.
|
|
31
|
+
* @throws {RequiredError}
|
|
32
|
+
*/
|
|
33
|
+
getEmailSubscription: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
|
+
/**
|
|
35
|
+
* 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\"
|
|
36
|
+
* @summary List email subscriptions
|
|
37
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
38
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
39
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
40
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt</i>
|
|
41
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
42
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, mailbox, folder, status, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt</i>
|
|
43
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
44
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt</i>
|
|
45
|
+
* @param {*} [options] Override http request option.
|
|
46
|
+
* @throws {RequiredError}
|
|
47
|
+
*/
|
|
48
|
+
listEmailSubscriptions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
|
+
/**
|
|
50
|
+
* 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\"
|
|
51
|
+
* @summary Reconcile the email subscriptions
|
|
52
|
+
* @param {ReconcileEmailSubscriptionsRequestDto} reconcileEmailSubscriptionsRequestDto
|
|
53
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
*/
|
|
57
|
+
reconcileEmailSubscriptions: (reconcileEmailSubscriptionsRequestDto: ReconcileEmailSubscriptionsRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
|
+
/**
|
|
59
|
+
* 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\"
|
|
60
|
+
* @summary Renew the email subscription
|
|
61
|
+
* @param {number} id
|
|
62
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
63
|
+
* @param {*} [options] Override http request option.
|
|
64
|
+
* @throws {RequiredError}
|
|
65
|
+
*/
|
|
66
|
+
renewEmailSubscription: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
|
+
};
|
|
68
|
+
/**
|
|
69
|
+
* EmailSubscriptionsApi - functional programming interface
|
|
70
|
+
* @export
|
|
71
|
+
*/
|
|
72
|
+
export declare const EmailSubscriptionsApiFp: (configuration?: Configuration) => {
|
|
73
|
+
/**
|
|
74
|
+
* Retrieves the email subscription with the given id. **Required Permissions** \"tenant-management.settings.view\"
|
|
75
|
+
* @summary Retrieve the email subscription
|
|
76
|
+
* @param {number} id
|
|
77
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
78
|
+
* @param {*} [options] Override http request option.
|
|
79
|
+
* @throws {RequiredError}
|
|
80
|
+
*/
|
|
81
|
+
getEmailSubscription(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailSubscriptionResponseClass>>;
|
|
82
|
+
/**
|
|
83
|
+
* 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\"
|
|
84
|
+
* @summary List email subscriptions
|
|
85
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
86
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
87
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
88
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt</i>
|
|
89
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
90
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, mailbox, folder, status, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt</i>
|
|
91
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
92
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt</i>
|
|
93
|
+
* @param {*} [options] Override http request option.
|
|
94
|
+
* @throws {RequiredError}
|
|
95
|
+
*/
|
|
96
|
+
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>>;
|
|
97
|
+
/**
|
|
98
|
+
* 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\"
|
|
99
|
+
* @summary Reconcile the email subscriptions
|
|
100
|
+
* @param {ReconcileEmailSubscriptionsRequestDto} reconcileEmailSubscriptionsRequestDto
|
|
101
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
102
|
+
* @param {*} [options] Override http request option.
|
|
103
|
+
* @throws {RequiredError}
|
|
104
|
+
*/
|
|
105
|
+
reconcileEmailSubscriptions(reconcileEmailSubscriptionsRequestDto: ReconcileEmailSubscriptionsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReconcileEmailSubscriptionsResponseClass>>;
|
|
106
|
+
/**
|
|
107
|
+
* 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\"
|
|
108
|
+
* @summary Renew the email subscription
|
|
109
|
+
* @param {number} id
|
|
110
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
111
|
+
* @param {*} [options] Override http request option.
|
|
112
|
+
* @throws {RequiredError}
|
|
113
|
+
*/
|
|
114
|
+
renewEmailSubscription(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RenewEmailSubscriptionResponseClass>>;
|
|
115
|
+
};
|
|
116
|
+
/**
|
|
117
|
+
* EmailSubscriptionsApi - factory interface
|
|
118
|
+
* @export
|
|
119
|
+
*/
|
|
120
|
+
export declare const EmailSubscriptionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
121
|
+
/**
|
|
122
|
+
* Retrieves the email subscription with the given id. **Required Permissions** \"tenant-management.settings.view\"
|
|
123
|
+
* @summary Retrieve the email subscription
|
|
124
|
+
* @param {number} id
|
|
125
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
126
|
+
* @param {*} [options] Override http request option.
|
|
127
|
+
* @throws {RequiredError}
|
|
128
|
+
*/
|
|
129
|
+
getEmailSubscription(id: number, authorization?: string, options?: any): AxiosPromise<GetEmailSubscriptionResponseClass>;
|
|
130
|
+
/**
|
|
131
|
+
* 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\"
|
|
132
|
+
* @summary List email subscriptions
|
|
133
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
134
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
135
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
136
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt</i>
|
|
137
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
138
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, mailbox, folder, status, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt</i>
|
|
139
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
140
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt</i>
|
|
141
|
+
* @param {*} [options] Override http request option.
|
|
142
|
+
* @throws {RequiredError}
|
|
143
|
+
*/
|
|
144
|
+
listEmailSubscriptions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailSubscriptionsResponseClass>;
|
|
145
|
+
/**
|
|
146
|
+
* 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\"
|
|
147
|
+
* @summary Reconcile the email subscriptions
|
|
148
|
+
* @param {ReconcileEmailSubscriptionsRequestDto} reconcileEmailSubscriptionsRequestDto
|
|
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
|
+
reconcileEmailSubscriptions(reconcileEmailSubscriptionsRequestDto: ReconcileEmailSubscriptionsRequestDto, authorization?: string, options?: any): AxiosPromise<ReconcileEmailSubscriptionsResponseClass>;
|
|
154
|
+
/**
|
|
155
|
+
* 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\"
|
|
156
|
+
* @summary Renew the email subscription
|
|
157
|
+
* @param {number} id
|
|
158
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
*/
|
|
162
|
+
renewEmailSubscription(id: number, authorization?: string, options?: any): AxiosPromise<RenewEmailSubscriptionResponseClass>;
|
|
163
|
+
};
|
|
164
|
+
/**
|
|
165
|
+
* Request parameters for getEmailSubscription operation in EmailSubscriptionsApi.
|
|
166
|
+
* @export
|
|
167
|
+
* @interface EmailSubscriptionsApiGetEmailSubscriptionRequest
|
|
168
|
+
*/
|
|
169
|
+
export interface EmailSubscriptionsApiGetEmailSubscriptionRequest {
|
|
170
|
+
/**
|
|
171
|
+
*
|
|
172
|
+
* @type {number}
|
|
173
|
+
* @memberof EmailSubscriptionsApiGetEmailSubscription
|
|
174
|
+
*/
|
|
175
|
+
readonly id: number;
|
|
176
|
+
/**
|
|
177
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
178
|
+
* @type {string}
|
|
179
|
+
* @memberof EmailSubscriptionsApiGetEmailSubscription
|
|
180
|
+
*/
|
|
181
|
+
readonly authorization?: string;
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* Request parameters for listEmailSubscriptions operation in EmailSubscriptionsApi.
|
|
185
|
+
* @export
|
|
186
|
+
* @interface EmailSubscriptionsApiListEmailSubscriptionsRequest
|
|
187
|
+
*/
|
|
188
|
+
export interface EmailSubscriptionsApiListEmailSubscriptionsRequest {
|
|
189
|
+
/**
|
|
190
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
191
|
+
* @type {string}
|
|
192
|
+
* @memberof EmailSubscriptionsApiListEmailSubscriptions
|
|
193
|
+
*/
|
|
194
|
+
readonly authorization?: string;
|
|
195
|
+
/**
|
|
196
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
197
|
+
* @type {number}
|
|
198
|
+
* @memberof EmailSubscriptionsApiListEmailSubscriptions
|
|
199
|
+
*/
|
|
200
|
+
readonly pageSize?: number;
|
|
201
|
+
/**
|
|
202
|
+
* 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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
203
|
+
* @type {string}
|
|
204
|
+
* @memberof EmailSubscriptionsApiListEmailSubscriptions
|
|
205
|
+
*/
|
|
206
|
+
readonly pageToken?: string;
|
|
207
|
+
/**
|
|
208
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt</i>
|
|
209
|
+
* @type {string}
|
|
210
|
+
* @memberof EmailSubscriptionsApiListEmailSubscriptions
|
|
211
|
+
*/
|
|
212
|
+
readonly filter?: string;
|
|
213
|
+
/**
|
|
214
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
215
|
+
* @type {string}
|
|
216
|
+
* @memberof EmailSubscriptionsApiListEmailSubscriptions
|
|
217
|
+
*/
|
|
218
|
+
readonly search?: string;
|
|
219
|
+
/**
|
|
220
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, mailbox, folder, status, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt</i>
|
|
221
|
+
* @type {string}
|
|
222
|
+
* @memberof EmailSubscriptionsApiListEmailSubscriptions
|
|
223
|
+
*/
|
|
224
|
+
readonly order?: string;
|
|
225
|
+
/**
|
|
226
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
227
|
+
* @type {string}
|
|
228
|
+
* @memberof EmailSubscriptionsApiListEmailSubscriptions
|
|
229
|
+
*/
|
|
230
|
+
readonly expand?: string;
|
|
231
|
+
/**
|
|
232
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, productSlug, mailbox, folder, status, subscriptionId, expiresAt, lastRenewedAt, lastNotificationAt, createdAt, updatedAt</i>
|
|
233
|
+
* @type {string}
|
|
234
|
+
* @memberof EmailSubscriptionsApiListEmailSubscriptions
|
|
235
|
+
*/
|
|
236
|
+
readonly filters?: string;
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* Request parameters for reconcileEmailSubscriptions operation in EmailSubscriptionsApi.
|
|
240
|
+
* @export
|
|
241
|
+
* @interface EmailSubscriptionsApiReconcileEmailSubscriptionsRequest
|
|
242
|
+
*/
|
|
243
|
+
export interface EmailSubscriptionsApiReconcileEmailSubscriptionsRequest {
|
|
244
|
+
/**
|
|
245
|
+
*
|
|
246
|
+
* @type {ReconcileEmailSubscriptionsRequestDto}
|
|
247
|
+
* @memberof EmailSubscriptionsApiReconcileEmailSubscriptions
|
|
248
|
+
*/
|
|
249
|
+
readonly reconcileEmailSubscriptionsRequestDto: ReconcileEmailSubscriptionsRequestDto;
|
|
250
|
+
/**
|
|
251
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
252
|
+
* @type {string}
|
|
253
|
+
* @memberof EmailSubscriptionsApiReconcileEmailSubscriptions
|
|
254
|
+
*/
|
|
255
|
+
readonly authorization?: string;
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* Request parameters for renewEmailSubscription operation in EmailSubscriptionsApi.
|
|
259
|
+
* @export
|
|
260
|
+
* @interface EmailSubscriptionsApiRenewEmailSubscriptionRequest
|
|
261
|
+
*/
|
|
262
|
+
export interface EmailSubscriptionsApiRenewEmailSubscriptionRequest {
|
|
263
|
+
/**
|
|
264
|
+
*
|
|
265
|
+
* @type {number}
|
|
266
|
+
* @memberof EmailSubscriptionsApiRenewEmailSubscription
|
|
267
|
+
*/
|
|
268
|
+
readonly id: number;
|
|
269
|
+
/**
|
|
270
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
271
|
+
* @type {string}
|
|
272
|
+
* @memberof EmailSubscriptionsApiRenewEmailSubscription
|
|
273
|
+
*/
|
|
274
|
+
readonly authorization?: string;
|
|
275
|
+
}
|
|
276
|
+
/**
|
|
277
|
+
* EmailSubscriptionsApi - object-oriented interface
|
|
278
|
+
* @export
|
|
279
|
+
* @class EmailSubscriptionsApi
|
|
280
|
+
* @extends {BaseAPI}
|
|
281
|
+
*/
|
|
282
|
+
export declare class EmailSubscriptionsApi extends BaseAPI {
|
|
283
|
+
/**
|
|
284
|
+
* Retrieves the email subscription with the given id. **Required Permissions** \"tenant-management.settings.view\"
|
|
285
|
+
* @summary Retrieve the email subscription
|
|
286
|
+
* @param {EmailSubscriptionsApiGetEmailSubscriptionRequest} requestParameters Request parameters.
|
|
287
|
+
* @param {*} [options] Override http request option.
|
|
288
|
+
* @throws {RequiredError}
|
|
289
|
+
* @memberof EmailSubscriptionsApi
|
|
290
|
+
*/
|
|
291
|
+
getEmailSubscription(requestParameters: EmailSubscriptionsApiGetEmailSubscriptionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailSubscriptionResponseClass, any, {}>>;
|
|
292
|
+
/**
|
|
293
|
+
* 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\"
|
|
294
|
+
* @summary List email subscriptions
|
|
295
|
+
* @param {EmailSubscriptionsApiListEmailSubscriptionsRequest} requestParameters Request parameters.
|
|
296
|
+
* @param {*} [options] Override http request option.
|
|
297
|
+
* @throws {RequiredError}
|
|
298
|
+
* @memberof EmailSubscriptionsApi
|
|
299
|
+
*/
|
|
300
|
+
listEmailSubscriptions(requestParameters?: EmailSubscriptionsApiListEmailSubscriptionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailSubscriptionsResponseClass, any, {}>>;
|
|
301
|
+
/**
|
|
302
|
+
* 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\"
|
|
303
|
+
* @summary Reconcile the email subscriptions
|
|
304
|
+
* @param {EmailSubscriptionsApiReconcileEmailSubscriptionsRequest} requestParameters Request parameters.
|
|
305
|
+
* @param {*} [options] Override http request option.
|
|
306
|
+
* @throws {RequiredError}
|
|
307
|
+
* @memberof EmailSubscriptionsApi
|
|
308
|
+
*/
|
|
309
|
+
reconcileEmailSubscriptions(requestParameters: EmailSubscriptionsApiReconcileEmailSubscriptionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReconcileEmailSubscriptionsResponseClass, any, {}>>;
|
|
310
|
+
/**
|
|
311
|
+
* 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\"
|
|
312
|
+
* @summary Renew the email subscription
|
|
313
|
+
* @param {EmailSubscriptionsApiRenewEmailSubscriptionRequest} requestParameters Request parameters.
|
|
314
|
+
* @param {*} [options] Override http request option.
|
|
315
|
+
* @throws {RequiredError}
|
|
316
|
+
* @memberof EmailSubscriptionsApi
|
|
317
|
+
*/
|
|
318
|
+
renewEmailSubscription(requestParameters: EmailSubscriptionsApiRenewEmailSubscriptionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RenewEmailSubscriptionResponseClass, any, {}>>;
|
|
319
|
+
}
|