@epilot/email-settings-client 2.0.0 → 2.0.1
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/dist/definition.js +1 -1
- package/dist/openapi.d.ts +150 -0
- package/package.json +2 -2
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={438(e,s
|
|
1
|
+
(()=>{"use strict";var e={438(e,o,s){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(o,"__esModule",{value:!0});var n=t(s(466));o.default=n.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/email-settings/email-addresses/epilot:provision":{"put":{"operationId":"provisionEpilotEmailAddress","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/email-addresses/primary":{"post":{"operationId":"setEmailAddressPrimary","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/email-addresses/{id}":{"get":{"operationId":"getEmailAddress","parameters":[{"$ref":"#/components/parameters/EmailAddressId"}],"responses":{}},"delete":{"operationId":"deleteEmailAddress","parameters":[{"$ref":"#/components/parameters/EmailAddressId"}],"responses":{}},"put":{"operationId":"updateEmailAddress","parameters":[{"$ref":"#/components/parameters/EmailAddressId"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/email-addresses":{"get":{"operationId":"listEmailAddresses","responses":{}},"post":{"operationId":"addEmailAddress","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/shared-inboxes/{id}":{"get":{"operationId":"getSharedInbox","parameters":[{"$ref":"#/components/parameters/SharedInboxId"}],"responses":{}},"delete":{"operationId":"deleteSharedInbox","parameters":[{"$ref":"#/components/parameters/SharedInboxId"},{"name":"successorInboxId","in":"query","required":false}],"responses":{}},"put":{"operationId":"updateSharedInbox","parameters":[{"$ref":"#/components/parameters/SharedInboxId"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/shared-inboxes":{"get":{"operationId":"listSharedInboxes","responses":{}},"post":{"operationId":"addSharedInbox","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/inbox-buckets":{"get":{"operationId":"listInboxBuckets","responses":{}}},"/v2/outlook/connect":{"post":{"operationId":"connectOutlook","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/outlook/connection/status":{"get":{"operationId":"getOutlookConnectionStatus","responses":{}}},"/v2/outlook/calendar/me":{"get":{"operationId":"getMyCalendarConnection","responses":{}},"delete":{"operationId":"disconnectMyCalendar","responses":{}}},"/v2/outlook/connection/disconnect":{"post":{"operationId":"disconnectOutlook","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/channels/msteams/connect":{"post":{"operationId":"connectMsTeams","responses":{}}},"/v2/channels/msteams/disconnect":{"post":{"operationId":"disconnectMsTeams","responses":{}}},"/v2/channels/msteams/status":{"get":{"operationId":"getMsTeamsStatus","responses":{}}},"/v2/outlook/mailbox/connect":{"post":{"operationId":"connectOutlookMailbox","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/outlook/mailbox/{email}/disconnect":{"post":{"operationId":"disconnectOutlookMailbox","parameters":[{"name":"email","in":"path","required":true}],"responses":{}}},"/v2/outlook/mailbox/{email}/sync":{"post":{"operationId":"startMailboxSync","parameters":[{"name":"email","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/outlook/mailbox/{email}/sync/status":{"get":{"operationId":"getMailboxSyncStatus","parameters":[{"name":"email","in":"path","required":true}],"responses":{}}},"/v2/outlook/mailbox/{email}/sync/retry":{"post":{"operationId":"retryMailboxSync","parameters":[{"name":"email","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/outlook/mailbox/mappings":{"get":{"operationId":"getConnectedOutlookEmails","responses":{}}},"/v2/outlook/oauth/callback":{"get":{"operationId":"outlookOAuthCallback","parameters":[{"name":"code","in":"query","required":false},{"name":"state","in":"query","required":true},{"name":"session_state","in":"query","required":false},{"name":"error","in":"query","required":false},{"name":"error_description","in":"query","required":false},{"name":"error_subcode","in":"query","required":false},{"name":"client_info","in":"query","required":false},{"name":"error_uri","in":"query","required":false},{"name":"admin_consent","in":"query","required":false},{"name":"tenant","in":"query","required":false},{"name":"clientdata","in":"query","required":false}],"responses":{}}},"/v1/email-settings":{"get":{"operationId":"getSettings","parameters":[{"name":"type","in":"query","required":true},{"name":"id","in":"query"}],"responses":{}},"post":{"operationId":"addSetting","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSetting","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/{id}":{"post":{"operationId":"updateSetting","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/domain":{"post":{"operationId":"addDomain","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteDomain","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getDomains","responses":{}}},"/v1/email-settings/domain/name-servers:verify":{"post":{"operationId":"verifyNameServers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/domain/dns-records:verify":{"post":{"operationId":"verifyDnsRecords","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/domain:verify":{"post":{"operationId":"verifyDomain","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"ListInboxBucketsSuccessResponse":{"content":{"application/json":{}}},"ProvisionEpilotEmailAddressSuccessResponse":{"content":{"application/json":{}}},"SetEmailAddressPrimarySuccessResponse":{"content":{"application/json":{}}},"CreateEmailAddressSuccessResponse":{"content":{"application/json":{}}},"UpdateEmailAddressSuccessResponse":{"content":{"application/json":{}}},"GetEmailAddressSuccessResponse":{"content":{"application/json":{}}},"ListEmailAddressesSuccessResponse":{"content":{"application/json":{}}},"NoContent":{},"CreateSharedInboxSuccessResponse":{"content":{"application/json":{}}},"UpdateSharedInboxSuccessResponse":{"content":{"application/json":{}}},"GetSharedInboxSuccessResponse":{"content":{"application/json":{}}},"ListSharedInboxesSuccessResponse":{"content":{"application/json":{}}},"BadRequest":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"Conflict":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"OutlookErrorResponse":{"content":{"application/json":{}}}},"parameters":{"EmailAddressId":{"name":"id","in":"path","required":true},"SharedInboxId":{"name":"id","in":"path","required":true}}},"servers":[]}')}},o={},s=function s(t){var n=o[t];if(void 0!==n)return n.exports;var r=o[t]={exports:{}};return e[t].call(r.exports,r,r.exports,s),r.exports}(438),t=exports;for(var n in s)t[n]=s[n];s.__esModule&&Object.defineProperty(t,"__esModule",{value:!0})})();
|
package/dist/openapi.d.ts
CHANGED
|
@@ -37,6 +37,29 @@ declare namespace Components {
|
|
|
37
37
|
export type UpdateSharedInboxSuccessResponse = /* Shared inbox configuration with all associated metadata. */ Schemas.SharedInboxResponse;
|
|
38
38
|
}
|
|
39
39
|
namespace Schemas {
|
|
40
|
+
export interface CalendarConnectionInfo {
|
|
41
|
+
/**
|
|
42
|
+
* Azure AD Object ID of the connected user
|
|
43
|
+
*/
|
|
44
|
+
user_id: string;
|
|
45
|
+
/**
|
|
46
|
+
* Microsoft Azure AD tenant ID
|
|
47
|
+
*/
|
|
48
|
+
tenant_id: string;
|
|
49
|
+
/**
|
|
50
|
+
* Token health for this calendar connection
|
|
51
|
+
*/
|
|
52
|
+
status: "connected" | "expired";
|
|
53
|
+
/**
|
|
54
|
+
* Granted permission scopes on the user's token
|
|
55
|
+
*/
|
|
56
|
+
scopes?: string[];
|
|
57
|
+
connected_by_display_name?: string;
|
|
58
|
+
connected_by_email?: string; // email
|
|
59
|
+
connected_at?: string; // date-time
|
|
60
|
+
updated_at?: string; // date-time
|
|
61
|
+
expires_at?: string; // date-time
|
|
62
|
+
}
|
|
40
63
|
/**
|
|
41
64
|
* Feature flags selecting which Microsoft Graph scopes to request.
|
|
42
65
|
* At least one flag must be true. Passing a superset of previously
|
|
@@ -52,6 +75,13 @@ declare namespace Components {
|
|
|
52
75
|
* Request 'calendar' specific scopes.
|
|
53
76
|
*/
|
|
54
77
|
calendar?: boolean;
|
|
78
|
+
/**
|
|
79
|
+
* Optional same-origin frontend path to redirect to after the OAuth
|
|
80
|
+
* round-trip. Must start with a single "/" — protocol-relative
|
|
81
|
+
* and absolute URLs are rejected.
|
|
82
|
+
*
|
|
83
|
+
*/
|
|
84
|
+
return_to?: string; // ^/[^/\\].*$
|
|
55
85
|
}
|
|
56
86
|
/**
|
|
57
87
|
* Mapping between an Outlook email and its Outlook Connection.
|
|
@@ -334,6 +364,36 @@ declare namespace Components {
|
|
|
334
364
|
}
|
|
335
365
|
export type MailboxSyncStatuses = "RUNNING" | "COMPLETED" | "COMPLETED_WITH_ERRORS" | "FAILED" | "CANCELLED";
|
|
336
366
|
export type MailboxSyncTimeframePeriods = "5m" | "1w" | "2w" | "1m";
|
|
367
|
+
/**
|
|
368
|
+
* Per-user calendar connection metadata, or null when the caller has
|
|
369
|
+
* not connected their personal calendar yet.
|
|
370
|
+
*
|
|
371
|
+
*/
|
|
372
|
+
export interface MyCalendarConnectionResponse {
|
|
373
|
+
connection?: {
|
|
374
|
+
/**
|
|
375
|
+
* Azure AD Object ID of the connected user
|
|
376
|
+
*/
|
|
377
|
+
user_id: string;
|
|
378
|
+
/**
|
|
379
|
+
* Microsoft Azure AD tenant ID
|
|
380
|
+
*/
|
|
381
|
+
tenant_id: string;
|
|
382
|
+
/**
|
|
383
|
+
* Token health for this calendar connection
|
|
384
|
+
*/
|
|
385
|
+
status: "connected" | "expired";
|
|
386
|
+
/**
|
|
387
|
+
* Granted permission scopes on the user's token
|
|
388
|
+
*/
|
|
389
|
+
scopes?: string[];
|
|
390
|
+
connected_by_display_name?: string;
|
|
391
|
+
connected_by_email?: string; // email
|
|
392
|
+
connected_at?: string; // date-time
|
|
393
|
+
updated_at?: string; // date-time
|
|
394
|
+
expires_at?: string; // date-time
|
|
395
|
+
} | null;
|
|
396
|
+
}
|
|
337
397
|
export interface OutlookConnectionError {
|
|
338
398
|
/**
|
|
339
399
|
* Error code or message from the OAuth flow.
|
|
@@ -841,6 +901,12 @@ declare namespace Paths {
|
|
|
841
901
|
* Shared inbox ID to associate with the mailbox. Defaults to the default shared inbox.
|
|
842
902
|
*/
|
|
843
903
|
shared_inbox_id?: string;
|
|
904
|
+
/**
|
|
905
|
+
* ID of the signature to use by default when sending from this address
|
|
906
|
+
* example:
|
|
907
|
+
* sig-abc
|
|
908
|
+
*/
|
|
909
|
+
default_signature_id?: string;
|
|
844
910
|
/**
|
|
845
911
|
* Optional timeframe for initial mailbox sync. When provided, triggers an automatic
|
|
846
912
|
* mailbox sync after connecting the mailbox, syncing emails from the specified period.
|
|
@@ -950,6 +1016,16 @@ declare namespace Paths {
|
|
|
950
1016
|
}
|
|
951
1017
|
}
|
|
952
1018
|
}
|
|
1019
|
+
namespace DisconnectMyCalendar {
|
|
1020
|
+
namespace Responses {
|
|
1021
|
+
export interface $204 {
|
|
1022
|
+
}
|
|
1023
|
+
export interface $404 {
|
|
1024
|
+
}
|
|
1025
|
+
export interface $500 {
|
|
1026
|
+
}
|
|
1027
|
+
}
|
|
1028
|
+
}
|
|
953
1029
|
namespace DisconnectOutlook {
|
|
954
1030
|
export interface RequestBody {
|
|
955
1031
|
/**
|
|
@@ -1072,6 +1148,20 @@ declare namespace Paths {
|
|
|
1072
1148
|
}
|
|
1073
1149
|
}
|
|
1074
1150
|
}
|
|
1151
|
+
namespace GetMyCalendarConnection {
|
|
1152
|
+
namespace Responses {
|
|
1153
|
+
export type $200 = /**
|
|
1154
|
+
* Per-user calendar connection metadata, or null when the caller has
|
|
1155
|
+
* not connected their personal calendar yet.
|
|
1156
|
+
*
|
|
1157
|
+
*/
|
|
1158
|
+
Components.Schemas.MyCalendarConnectionResponse;
|
|
1159
|
+
export interface $401 {
|
|
1160
|
+
}
|
|
1161
|
+
export interface $500 {
|
|
1162
|
+
}
|
|
1163
|
+
}
|
|
1164
|
+
}
|
|
1075
1165
|
namespace GetOutlookConnectionStatus {
|
|
1076
1166
|
namespace Responses {
|
|
1077
1167
|
export interface $200 {
|
|
@@ -1148,6 +1238,7 @@ declare namespace Paths {
|
|
|
1148
1238
|
namespace Parameters {
|
|
1149
1239
|
export type AdminConsent = string;
|
|
1150
1240
|
export type ClientInfo = string;
|
|
1241
|
+
export type Clientdata = string;
|
|
1151
1242
|
export type Code = string;
|
|
1152
1243
|
export type Error = string;
|
|
1153
1244
|
export type ErrorDescription = string;
|
|
@@ -1168,6 +1259,7 @@ declare namespace Paths {
|
|
|
1168
1259
|
error_uri?: Parameters.ErrorUri;
|
|
1169
1260
|
admin_consent?: Parameters.AdminConsent;
|
|
1170
1261
|
tenant?: Parameters.Tenant;
|
|
1262
|
+
clientdata?: Parameters.Clientdata;
|
|
1171
1263
|
}
|
|
1172
1264
|
namespace Responses {
|
|
1173
1265
|
export interface $200 {
|
|
@@ -1604,6 +1696,33 @@ export interface OperationMethods {
|
|
|
1604
1696
|
data?: any,
|
|
1605
1697
|
config?: AxiosRequestConfig
|
|
1606
1698
|
): OperationResponse<Paths.GetOutlookConnectionStatus.Responses.$200>
|
|
1699
|
+
/**
|
|
1700
|
+
* getMyCalendarConnection - getMyCalendarConnection
|
|
1701
|
+
*
|
|
1702
|
+
* Returns the calling user's personal Outlook calendar connection,
|
|
1703
|
+
* or null when the user hasn't connected yet.
|
|
1704
|
+
*
|
|
1705
|
+
* Per-user calendar connections are distinct from the org-level
|
|
1706
|
+
* shared-mailbox connection (`/v2/outlook/connection/status`): each
|
|
1707
|
+
* user connects their own delegated token because reading user A's
|
|
1708
|
+
* calendar requires user A's consent.
|
|
1709
|
+
*
|
|
1710
|
+
*/
|
|
1711
|
+
'getMyCalendarConnection'(
|
|
1712
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1713
|
+
data?: any,
|
|
1714
|
+
config?: AxiosRequestConfig
|
|
1715
|
+
): OperationResponse<Paths.GetMyCalendarConnection.Responses.$200>
|
|
1716
|
+
/**
|
|
1717
|
+
* disconnectMyCalendar - disconnectMyCalendar
|
|
1718
|
+
*
|
|
1719
|
+
* Removes the calling user's personal calendar connection.
|
|
1720
|
+
*/
|
|
1721
|
+
'disconnectMyCalendar'(
|
|
1722
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1723
|
+
data?: any,
|
|
1724
|
+
config?: AxiosRequestConfig
|
|
1725
|
+
): OperationResponse<Paths.DisconnectMyCalendar.Responses.$204>
|
|
1607
1726
|
/**
|
|
1608
1727
|
* disconnectOutlook - disconnectOutlook
|
|
1609
1728
|
*
|
|
@@ -2150,6 +2269,35 @@ export interface PathsDictionary {
|
|
|
2150
2269
|
config?: AxiosRequestConfig
|
|
2151
2270
|
): OperationResponse<Paths.GetOutlookConnectionStatus.Responses.$200>
|
|
2152
2271
|
}
|
|
2272
|
+
['/v2/outlook/calendar/me']: {
|
|
2273
|
+
/**
|
|
2274
|
+
* getMyCalendarConnection - getMyCalendarConnection
|
|
2275
|
+
*
|
|
2276
|
+
* Returns the calling user's personal Outlook calendar connection,
|
|
2277
|
+
* or null when the user hasn't connected yet.
|
|
2278
|
+
*
|
|
2279
|
+
* Per-user calendar connections are distinct from the org-level
|
|
2280
|
+
* shared-mailbox connection (`/v2/outlook/connection/status`): each
|
|
2281
|
+
* user connects their own delegated token because reading user A's
|
|
2282
|
+
* calendar requires user A's consent.
|
|
2283
|
+
*
|
|
2284
|
+
*/
|
|
2285
|
+
'get'(
|
|
2286
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2287
|
+
data?: any,
|
|
2288
|
+
config?: AxiosRequestConfig
|
|
2289
|
+
): OperationResponse<Paths.GetMyCalendarConnection.Responses.$200>
|
|
2290
|
+
/**
|
|
2291
|
+
* disconnectMyCalendar - disconnectMyCalendar
|
|
2292
|
+
*
|
|
2293
|
+
* Removes the calling user's personal calendar connection.
|
|
2294
|
+
*/
|
|
2295
|
+
'delete'(
|
|
2296
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2297
|
+
data?: any,
|
|
2298
|
+
config?: AxiosRequestConfig
|
|
2299
|
+
): OperationResponse<Paths.DisconnectMyCalendar.Responses.$204>
|
|
2300
|
+
}
|
|
2153
2301
|
['/v2/outlook/connection/disconnect']: {
|
|
2154
2302
|
/**
|
|
2155
2303
|
* disconnectOutlook - disconnectOutlook
|
|
@@ -2487,6 +2635,7 @@ export interface PathsDictionary {
|
|
|
2487
2635
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
2488
2636
|
|
|
2489
2637
|
|
|
2638
|
+
export type CalendarConnectionInfo = Components.Schemas.CalendarConnectionInfo;
|
|
2490
2639
|
export type ConnectOutlookRequest = Components.Schemas.ConnectOutlookRequest;
|
|
2491
2640
|
export type ConnectedOutlookEmail = Components.Schemas.ConnectedOutlookEmail;
|
|
2492
2641
|
export type CreateEmailAddressPayload = Components.Schemas.CreateEmailAddressPayload;
|
|
@@ -2501,6 +2650,7 @@ export type MailboxSyncFolderStatuses = Components.Schemas.MailboxSyncFolderStat
|
|
|
2501
2650
|
export type MailboxSyncStatus = Components.Schemas.MailboxSyncStatus;
|
|
2502
2651
|
export type MailboxSyncStatuses = Components.Schemas.MailboxSyncStatuses;
|
|
2503
2652
|
export type MailboxSyncTimeframePeriods = Components.Schemas.MailboxSyncTimeframePeriods;
|
|
2653
|
+
export type MyCalendarConnectionResponse = Components.Schemas.MyCalendarConnectionResponse;
|
|
2504
2654
|
export type OutlookConnectionError = Components.Schemas.OutlookConnectionError;
|
|
2505
2655
|
export type OutlookConnectionStatus = Components.Schemas.OutlookConnectionStatus;
|
|
2506
2656
|
export type ProvisionEpilotEmailAddressPayload = Components.Schemas.ProvisionEpilotEmailAddressPayload;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/email-settings-client",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"description": "API Client for epilot Email Settings API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -69,4 +69,4 @@
|
|
|
69
69
|
"webpack-cli": "^4.10.0"
|
|
70
70
|
},
|
|
71
71
|
"gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
|
|
72
|
-
}
|
|
72
|
+
}
|