@epilot/email-settings-client 1.5.1 → 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 +257 -8
- package/package.json +3 -3
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={
|
|
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,52 @@ 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
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Feature flags selecting which Microsoft Graph scopes to request.
|
|
65
|
+
* At least one flag must be true. Passing a superset of previously
|
|
66
|
+
* granted features triggers incremental consent for the delta only.
|
|
67
|
+
*
|
|
68
|
+
*/
|
|
69
|
+
export interface ConnectOutlookRequest {
|
|
70
|
+
/**
|
|
71
|
+
* Request 'mail' specific scopes.
|
|
72
|
+
*/
|
|
73
|
+
mail?: boolean;
|
|
74
|
+
/**
|
|
75
|
+
* Request 'calendar' specific scopes.
|
|
76
|
+
*/
|
|
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; // ^/[^/\\].*$
|
|
85
|
+
}
|
|
40
86
|
/**
|
|
41
87
|
* Mapping between an Outlook email and its Outlook Connection.
|
|
42
88
|
* This tracks which provider/tenant provisions each Outlook email.
|
|
@@ -318,6 +364,36 @@ declare namespace Components {
|
|
|
318
364
|
}
|
|
319
365
|
export type MailboxSyncStatuses = "RUNNING" | "COMPLETED" | "COMPLETED_WITH_ERRORS" | "FAILED" | "CANCELLED";
|
|
320
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
|
+
}
|
|
321
397
|
export interface OutlookConnectionError {
|
|
322
398
|
/**
|
|
323
399
|
* Error code or message from the OAuth flow.
|
|
@@ -343,14 +419,24 @@ declare namespace Components {
|
|
|
343
419
|
*/
|
|
344
420
|
status: "connected" | "expired" | "pending_auth" | "not_connected";
|
|
345
421
|
/**
|
|
346
|
-
* Action for UI to take (all call
|
|
422
|
+
* Action for UI to take (all call POST /outlook/connect):
|
|
347
423
|
* - connect: No connection, initiate OAuth
|
|
348
424
|
* - authorize: Admin consent done, complete OAuth
|
|
349
|
-
* - reconnect: Re-authenticate expired session
|
|
425
|
+
* - reconnect: Re-authenticate expired session or approve updated permissions
|
|
350
426
|
* - none: Fully connected, no action needed
|
|
351
427
|
*
|
|
352
428
|
*/
|
|
353
429
|
action: "connect" | "authorize" | "reconnect" | "none";
|
|
430
|
+
/**
|
|
431
|
+
* Discriminates the cause when `action` is `reconnect`:
|
|
432
|
+
* - expired: Stored tokens are no longer valid; user must re-authenticate
|
|
433
|
+
* - permission_update: Token is valid, but the granted scopes do not cover the
|
|
434
|
+
* scopes required by the configured Outlook integrations (currently `mail`).
|
|
435
|
+
* The user must reconnect to grant the additional permissions; Microsoft's
|
|
436
|
+
* incremental-consent flow will only prompt for the delta.
|
|
437
|
+
*
|
|
438
|
+
*/
|
|
439
|
+
action_reason?: "expired" | "permission_update";
|
|
354
440
|
/**
|
|
355
441
|
* Display name of user who connected
|
|
356
442
|
*/
|
|
@@ -790,10 +876,18 @@ declare namespace Paths {
|
|
|
790
876
|
}
|
|
791
877
|
}
|
|
792
878
|
namespace ConnectOutlook {
|
|
879
|
+
export type RequestBody = /**
|
|
880
|
+
* Feature flags selecting which Microsoft Graph scopes to request.
|
|
881
|
+
* At least one flag must be true. Passing a superset of previously
|
|
882
|
+
* granted features triggers incremental consent for the delta only.
|
|
883
|
+
*
|
|
884
|
+
*/
|
|
885
|
+
Components.Schemas.ConnectOutlookRequest;
|
|
793
886
|
namespace Responses {
|
|
794
887
|
export interface $200 {
|
|
795
|
-
authorization_url
|
|
888
|
+
authorization_url: string;
|
|
796
889
|
}
|
|
890
|
+
export type $400 = Components.Responses.OutlookErrorResponse;
|
|
797
891
|
export type $403 = Components.Responses.OutlookErrorResponse;
|
|
798
892
|
}
|
|
799
893
|
}
|
|
@@ -807,6 +901,12 @@ declare namespace Paths {
|
|
|
807
901
|
* Shared inbox ID to associate with the mailbox. Defaults to the default shared inbox.
|
|
808
902
|
*/
|
|
809
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;
|
|
810
910
|
/**
|
|
811
911
|
* Optional timeframe for initial mailbox sync. When provided, triggers an automatic
|
|
812
912
|
* mailbox sync after connecting the mailbox, syncing emails from the specified period.
|
|
@@ -916,6 +1016,16 @@ declare namespace Paths {
|
|
|
916
1016
|
}
|
|
917
1017
|
}
|
|
918
1018
|
}
|
|
1019
|
+
namespace DisconnectMyCalendar {
|
|
1020
|
+
namespace Responses {
|
|
1021
|
+
export interface $204 {
|
|
1022
|
+
}
|
|
1023
|
+
export interface $404 {
|
|
1024
|
+
}
|
|
1025
|
+
export interface $500 {
|
|
1026
|
+
}
|
|
1027
|
+
}
|
|
1028
|
+
}
|
|
919
1029
|
namespace DisconnectOutlook {
|
|
920
1030
|
export interface RequestBody {
|
|
921
1031
|
/**
|
|
@@ -1038,6 +1148,20 @@ declare namespace Paths {
|
|
|
1038
1148
|
}
|
|
1039
1149
|
}
|
|
1040
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
|
+
}
|
|
1041
1165
|
namespace GetOutlookConnectionStatus {
|
|
1042
1166
|
namespace Responses {
|
|
1043
1167
|
export interface $200 {
|
|
@@ -1114,6 +1238,7 @@ declare namespace Paths {
|
|
|
1114
1238
|
namespace Parameters {
|
|
1115
1239
|
export type AdminConsent = string;
|
|
1116
1240
|
export type ClientInfo = string;
|
|
1241
|
+
export type Clientdata = string;
|
|
1117
1242
|
export type Code = string;
|
|
1118
1243
|
export type Error = string;
|
|
1119
1244
|
export type ErrorDescription = string;
|
|
@@ -1134,6 +1259,7 @@ declare namespace Paths {
|
|
|
1134
1259
|
error_uri?: Parameters.ErrorUri;
|
|
1135
1260
|
admin_consent?: Parameters.AdminConsent;
|
|
1136
1261
|
tenant?: Parameters.Tenant;
|
|
1262
|
+
clientdata?: Parameters.Clientdata;
|
|
1137
1263
|
}
|
|
1138
1264
|
namespace Responses {
|
|
1139
1265
|
export interface $200 {
|
|
@@ -1315,6 +1441,14 @@ declare namespace Paths {
|
|
|
1315
1441
|
export type $500 = Components.Responses.InternalServerError;
|
|
1316
1442
|
}
|
|
1317
1443
|
}
|
|
1444
|
+
namespace VerifyDnsRecords {
|
|
1445
|
+
export type RequestBody = /* Custom email domain configuration. */ Components.Schemas.Domain;
|
|
1446
|
+
namespace Responses {
|
|
1447
|
+
export type $200 = Components.Schemas.SettingsResponse;
|
|
1448
|
+
export type $403 = Components.Responses.Forbidden;
|
|
1449
|
+
export type $404 = Components.Responses.NotFound;
|
|
1450
|
+
}
|
|
1451
|
+
}
|
|
1318
1452
|
namespace VerifyDomain {
|
|
1319
1453
|
export type RequestBody = /* Custom email domain configuration. */ Components.Schemas.Domain;
|
|
1320
1454
|
namespace Responses {
|
|
@@ -1333,6 +1467,7 @@ declare namespace Paths {
|
|
|
1333
1467
|
}
|
|
1334
1468
|
}
|
|
1335
1469
|
|
|
1470
|
+
|
|
1336
1471
|
export interface OperationMethods {
|
|
1337
1472
|
/**
|
|
1338
1473
|
* provisionEpilotEmailAddress - provisionEpilotEmailAddress
|
|
@@ -1532,11 +1667,18 @@ export interface OperationMethods {
|
|
|
1532
1667
|
/**
|
|
1533
1668
|
* connectOutlook - connectOutlook
|
|
1534
1669
|
*
|
|
1535
|
-
* Returns Microsoft authorization URL for Outlook OAuth.
|
|
1670
|
+
* Returns the Microsoft authorization URL for Outlook OAuth.
|
|
1671
|
+
*
|
|
1672
|
+
* The request body selects which features to request scopes for. Feature
|
|
1673
|
+
* flags are additive; Microsoft OAuth scopes are cumulative. Calling this
|
|
1674
|
+
* endpoint again with a superset of features (e.g. `mail` already connected,
|
|
1675
|
+
* and `calendar` added) triggers Microsoft's incremental-consent flow —
|
|
1676
|
+
* the user only sees a consent prompt for the new scopes.
|
|
1677
|
+
*
|
|
1536
1678
|
*/
|
|
1537
1679
|
'connectOutlook'(
|
|
1538
1680
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1539
|
-
data?:
|
|
1681
|
+
data?: Paths.ConnectOutlook.RequestBody,
|
|
1540
1682
|
config?: AxiosRequestConfig
|
|
1541
1683
|
): OperationResponse<Paths.ConnectOutlook.Responses.$200>
|
|
1542
1684
|
/**
|
|
@@ -1554,6 +1696,33 @@ export interface OperationMethods {
|
|
|
1554
1696
|
data?: any,
|
|
1555
1697
|
config?: AxiosRequestConfig
|
|
1556
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>
|
|
1557
1726
|
/**
|
|
1558
1727
|
* disconnectOutlook - disconnectOutlook
|
|
1559
1728
|
*
|
|
@@ -1808,12 +1977,31 @@ export interface OperationMethods {
|
|
|
1808
1977
|
*
|
|
1809
1978
|
* Run this verification after configuring NS records in your DNS provider.
|
|
1810
1979
|
*
|
|
1980
|
+
* **Deprecated**: Use `/domain/dns-records:verify` for new integrations.
|
|
1981
|
+
*
|
|
1811
1982
|
*/
|
|
1812
1983
|
'verifyNameServers'(
|
|
1813
1984
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1814
1985
|
data?: Paths.VerifyNameServers.RequestBody,
|
|
1815
1986
|
config?: AxiosRequestConfig
|
|
1816
1987
|
): OperationResponse<Paths.VerifyNameServers.Responses.$200>
|
|
1988
|
+
/**
|
|
1989
|
+
* verifyDnsRecords - verifyDnsRecords
|
|
1990
|
+
*
|
|
1991
|
+
* Verifies that the domain's DNS records (MX, TXT, CNAME) are correctly configured
|
|
1992
|
+
* in the customer's DNS provider.
|
|
1993
|
+
*
|
|
1994
|
+
* This check performs DNS lookups to confirm each required record is present
|
|
1995
|
+
* before proceeding with full domain identity verification.
|
|
1996
|
+
*
|
|
1997
|
+
* Run this verification after configuring all DNS records in your DNS provider.
|
|
1998
|
+
*
|
|
1999
|
+
*/
|
|
2000
|
+
'verifyDnsRecords'(
|
|
2001
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2002
|
+
data?: Paths.VerifyDnsRecords.RequestBody,
|
|
2003
|
+
config?: AxiosRequestConfig
|
|
2004
|
+
): OperationResponse<Paths.VerifyDnsRecords.Responses.$200>
|
|
1817
2005
|
/**
|
|
1818
2006
|
* verifyDomain - verifyDomain
|
|
1819
2007
|
*
|
|
@@ -2049,11 +2237,18 @@ export interface PathsDictionary {
|
|
|
2049
2237
|
/**
|
|
2050
2238
|
* connectOutlook - connectOutlook
|
|
2051
2239
|
*
|
|
2052
|
-
* Returns Microsoft authorization URL for Outlook OAuth.
|
|
2240
|
+
* Returns the Microsoft authorization URL for Outlook OAuth.
|
|
2241
|
+
*
|
|
2242
|
+
* The request body selects which features to request scopes for. Feature
|
|
2243
|
+
* flags are additive; Microsoft OAuth scopes are cumulative. Calling this
|
|
2244
|
+
* endpoint again with a superset of features (e.g. `mail` already connected,
|
|
2245
|
+
* and `calendar` added) triggers Microsoft's incremental-consent flow —
|
|
2246
|
+
* the user only sees a consent prompt for the new scopes.
|
|
2247
|
+
*
|
|
2053
2248
|
*/
|
|
2054
|
-
'
|
|
2249
|
+
'post'(
|
|
2055
2250
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2056
|
-
data?:
|
|
2251
|
+
data?: Paths.ConnectOutlook.RequestBody,
|
|
2057
2252
|
config?: AxiosRequestConfig
|
|
2058
2253
|
): OperationResponse<Paths.ConnectOutlook.Responses.$200>
|
|
2059
2254
|
}
|
|
@@ -2074,6 +2269,35 @@ export interface PathsDictionary {
|
|
|
2074
2269
|
config?: AxiosRequestConfig
|
|
2075
2270
|
): OperationResponse<Paths.GetOutlookConnectionStatus.Responses.$200>
|
|
2076
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
|
+
}
|
|
2077
2301
|
['/v2/outlook/connection/disconnect']: {
|
|
2078
2302
|
/**
|
|
2079
2303
|
* disconnectOutlook - disconnectOutlook
|
|
@@ -2357,6 +2581,8 @@ export interface PathsDictionary {
|
|
|
2357
2581
|
*
|
|
2358
2582
|
* Run this verification after configuring NS records in your DNS provider.
|
|
2359
2583
|
*
|
|
2584
|
+
* **Deprecated**: Use `/domain/dns-records:verify` for new integrations.
|
|
2585
|
+
*
|
|
2360
2586
|
*/
|
|
2361
2587
|
'post'(
|
|
2362
2588
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -2364,6 +2590,25 @@ export interface PathsDictionary {
|
|
|
2364
2590
|
config?: AxiosRequestConfig
|
|
2365
2591
|
): OperationResponse<Paths.VerifyNameServers.Responses.$200>
|
|
2366
2592
|
}
|
|
2593
|
+
['/v1/email-settings/domain/dns-records:verify']: {
|
|
2594
|
+
/**
|
|
2595
|
+
* verifyDnsRecords - verifyDnsRecords
|
|
2596
|
+
*
|
|
2597
|
+
* Verifies that the domain's DNS records (MX, TXT, CNAME) are correctly configured
|
|
2598
|
+
* in the customer's DNS provider.
|
|
2599
|
+
*
|
|
2600
|
+
* This check performs DNS lookups to confirm each required record is present
|
|
2601
|
+
* before proceeding with full domain identity verification.
|
|
2602
|
+
*
|
|
2603
|
+
* Run this verification after configuring all DNS records in your DNS provider.
|
|
2604
|
+
*
|
|
2605
|
+
*/
|
|
2606
|
+
'post'(
|
|
2607
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2608
|
+
data?: Paths.VerifyDnsRecords.RequestBody,
|
|
2609
|
+
config?: AxiosRequestConfig
|
|
2610
|
+
): OperationResponse<Paths.VerifyDnsRecords.Responses.$200>
|
|
2611
|
+
}
|
|
2367
2612
|
['/v1/email-settings/domain:verify']: {
|
|
2368
2613
|
/**
|
|
2369
2614
|
* verifyDomain - verifyDomain
|
|
@@ -2389,6 +2634,9 @@ export interface PathsDictionary {
|
|
|
2389
2634
|
|
|
2390
2635
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
2391
2636
|
|
|
2637
|
+
|
|
2638
|
+
export type CalendarConnectionInfo = Components.Schemas.CalendarConnectionInfo;
|
|
2639
|
+
export type ConnectOutlookRequest = Components.Schemas.ConnectOutlookRequest;
|
|
2392
2640
|
export type ConnectedOutlookEmail = Components.Schemas.ConnectedOutlookEmail;
|
|
2393
2641
|
export type CreateEmailAddressPayload = Components.Schemas.CreateEmailAddressPayload;
|
|
2394
2642
|
export type CreateSharedInboxPayload = Components.Schemas.CreateSharedInboxPayload;
|
|
@@ -2402,6 +2650,7 @@ export type MailboxSyncFolderStatuses = Components.Schemas.MailboxSyncFolderStat
|
|
|
2402
2650
|
export type MailboxSyncStatus = Components.Schemas.MailboxSyncStatus;
|
|
2403
2651
|
export type MailboxSyncStatuses = Components.Schemas.MailboxSyncStatuses;
|
|
2404
2652
|
export type MailboxSyncTimeframePeriods = Components.Schemas.MailboxSyncTimeframePeriods;
|
|
2653
|
+
export type MyCalendarConnectionResponse = Components.Schemas.MyCalendarConnectionResponse;
|
|
2405
2654
|
export type OutlookConnectionError = Components.Schemas.OutlookConnectionError;
|
|
2406
2655
|
export type OutlookConnectionStatus = Components.Schemas.OutlookConnectionStatus;
|
|
2407
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": "
|
|
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",
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
"axios": "^1.11.0",
|
|
62
62
|
"copy-webpack-plugin": "^7.0.0",
|
|
63
63
|
"json-loader": "^0.5.7",
|
|
64
|
-
"openapicmd": "^2.
|
|
64
|
+
"openapicmd": "^2.9.2",
|
|
65
65
|
"ts-loader": "^8.0.14",
|
|
66
66
|
"ts-node": "^10.9.1",
|
|
67
67
|
"typescript": "^4.1.3",
|
|
@@ -69,4 +69,4 @@
|
|
|
69
69
|
"webpack-cli": "^4.10.0"
|
|
70
70
|
},
|
|
71
71
|
"gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
|
|
72
|
-
}
|
|
72
|
+
}
|