@epilot/email-settings-client 1.4.0 → 1.5.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/client.d.ts +1 -1
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +144 -4
- package/package.json +4 -7
package/dist/client.d.ts
CHANGED
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={
|
|
1
|
+
(()=>{"use strict";var e={914:function(e,s,o){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(s,"__esModule",{value:!0});var n=t(o(240));s.default=n.default},240: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":{"get":{"operationId":"connectOutlook","responses":{}}},"/v2/outlook/connection/status":{"get":{"operationId":"getOutlookConnectionStatus","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}],"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: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":[{"url":"https://email-settings.sls.epilot.io"}]}')}},s={},o=function o(t){var n=s[t];if(void 0!==n)return n.exports;var r=s[t]={exports:{}};return e[t].call(r.exports,r,r.exports,o),r.exports}(914),t=exports;for(var n in o)t[n]=o[n];o.__esModule&&Object.defineProperty(t,"__esModule",{value:!0})})();
|
package/dist/openapi.d.ts
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
/* eslint-disable */
|
|
2
|
-
|
|
3
1
|
import type {
|
|
4
2
|
OpenAPIClient,
|
|
5
3
|
Parameters,
|
|
@@ -779,6 +777,18 @@ declare namespace Paths {
|
|
|
779
777
|
export type $500 = Components.Responses.InternalServerError;
|
|
780
778
|
}
|
|
781
779
|
}
|
|
780
|
+
namespace ConnectMsTeams {
|
|
781
|
+
namespace Responses {
|
|
782
|
+
export interface $200 {
|
|
783
|
+
connected?: boolean;
|
|
784
|
+
connected_at?: string; // date-time
|
|
785
|
+
}
|
|
786
|
+
export interface $400 {
|
|
787
|
+
error?: string;
|
|
788
|
+
message?: string;
|
|
789
|
+
}
|
|
790
|
+
}
|
|
791
|
+
}
|
|
782
792
|
namespace ConnectOutlook {
|
|
783
793
|
namespace Responses {
|
|
784
794
|
export interface $200 {
|
|
@@ -899,6 +909,13 @@ declare namespace Paths {
|
|
|
899
909
|
export type $500 = Components.Responses.InternalServerError;
|
|
900
910
|
}
|
|
901
911
|
}
|
|
912
|
+
namespace DisconnectMsTeams {
|
|
913
|
+
namespace Responses {
|
|
914
|
+
export interface $200 {
|
|
915
|
+
connected?: boolean;
|
|
916
|
+
}
|
|
917
|
+
}
|
|
918
|
+
}
|
|
902
919
|
namespace DisconnectOutlook {
|
|
903
920
|
export interface RequestBody {
|
|
904
921
|
/**
|
|
@@ -967,6 +984,13 @@ declare namespace Paths {
|
|
|
967
984
|
}
|
|
968
985
|
}
|
|
969
986
|
}
|
|
987
|
+
namespace GetDomains {
|
|
988
|
+
namespace Responses {
|
|
989
|
+
export type $200 = string[];
|
|
990
|
+
export type $403 = Components.Responses.Forbidden;
|
|
991
|
+
export type $404 = Components.Responses.NotFound;
|
|
992
|
+
}
|
|
993
|
+
}
|
|
970
994
|
namespace GetEmailAddress {
|
|
971
995
|
namespace Parameters {
|
|
972
996
|
export type Id = string;
|
|
@@ -996,6 +1020,24 @@ declare namespace Paths {
|
|
|
996
1020
|
}
|
|
997
1021
|
}
|
|
998
1022
|
}
|
|
1023
|
+
namespace GetMsTeamsStatus {
|
|
1024
|
+
namespace Responses {
|
|
1025
|
+
export interface $200 {
|
|
1026
|
+
/**
|
|
1027
|
+
* Whether the Teams channel is connected
|
|
1028
|
+
*/
|
|
1029
|
+
connected?: boolean;
|
|
1030
|
+
/**
|
|
1031
|
+
* When the Teams channel was connected
|
|
1032
|
+
*/
|
|
1033
|
+
connected_at?: string; // date-time
|
|
1034
|
+
/**
|
|
1035
|
+
* User ID who connected the Teams channel
|
|
1036
|
+
*/
|
|
1037
|
+
connected_by_user_id?: string;
|
|
1038
|
+
}
|
|
1039
|
+
}
|
|
1040
|
+
}
|
|
999
1041
|
namespace GetOutlookConnectionStatus {
|
|
1000
1042
|
namespace Responses {
|
|
1001
1043
|
export interface $200 {
|
|
@@ -1007,6 +1049,10 @@ declare namespace Paths {
|
|
|
1007
1049
|
* Whether any connections exist
|
|
1008
1050
|
*/
|
|
1009
1051
|
has_connections: boolean;
|
|
1052
|
+
/**
|
|
1053
|
+
* Whether Microsoft Teams features are enabled for this organization
|
|
1054
|
+
*/
|
|
1055
|
+
teams_enabled?: boolean;
|
|
1010
1056
|
}
|
|
1011
1057
|
export interface $400 {
|
|
1012
1058
|
}
|
|
@@ -1287,7 +1333,6 @@ declare namespace Paths {
|
|
|
1287
1333
|
}
|
|
1288
1334
|
}
|
|
1289
1335
|
|
|
1290
|
-
|
|
1291
1336
|
export interface OperationMethods {
|
|
1292
1337
|
/**
|
|
1293
1338
|
* provisionEpilotEmailAddress - provisionEpilotEmailAddress
|
|
@@ -1521,6 +1566,40 @@ export interface OperationMethods {
|
|
|
1521
1566
|
data?: Paths.DisconnectOutlook.RequestBody,
|
|
1522
1567
|
config?: AxiosRequestConfig
|
|
1523
1568
|
): OperationResponse<Paths.DisconnectOutlook.Responses.$200>
|
|
1569
|
+
/**
|
|
1570
|
+
* connectMsTeams - connectMsTeams
|
|
1571
|
+
*
|
|
1572
|
+
* Connects Microsoft Teams channel (click-to-call deep links, meetings) for the organization.
|
|
1573
|
+
* Requires an active Microsoft 365 / Outlook connection.
|
|
1574
|
+
*
|
|
1575
|
+
*/
|
|
1576
|
+
'connectMsTeams'(
|
|
1577
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1578
|
+
data?: any,
|
|
1579
|
+
config?: AxiosRequestConfig
|
|
1580
|
+
): OperationResponse<Paths.ConnectMsTeams.Responses.$200>
|
|
1581
|
+
/**
|
|
1582
|
+
* disconnectMsTeams - disconnectMsTeams
|
|
1583
|
+
*
|
|
1584
|
+
* Disconnects Microsoft Teams channel for the organization.
|
|
1585
|
+
*
|
|
1586
|
+
*/
|
|
1587
|
+
'disconnectMsTeams'(
|
|
1588
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1589
|
+
data?: any,
|
|
1590
|
+
config?: AxiosRequestConfig
|
|
1591
|
+
): OperationResponse<Paths.DisconnectMsTeams.Responses.$200>
|
|
1592
|
+
/**
|
|
1593
|
+
* getMsTeamsStatus - getMsTeamsStatus
|
|
1594
|
+
*
|
|
1595
|
+
* Returns the connection status of the Microsoft Teams channel for the organization.
|
|
1596
|
+
*
|
|
1597
|
+
*/
|
|
1598
|
+
'getMsTeamsStatus'(
|
|
1599
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1600
|
+
data?: any,
|
|
1601
|
+
config?: AxiosRequestConfig
|
|
1602
|
+
): OperationResponse<Paths.GetMsTeamsStatus.Responses.$200>
|
|
1524
1603
|
/**
|
|
1525
1604
|
* connectOutlookMailbox - connectOutlookMailbox
|
|
1526
1605
|
*
|
|
@@ -1676,6 +1755,17 @@ export interface OperationMethods {
|
|
|
1676
1755
|
data?: Paths.UpdateSetting.RequestBody,
|
|
1677
1756
|
config?: AxiosRequestConfig
|
|
1678
1757
|
): OperationResponse<Paths.UpdateSetting.Responses.$200>
|
|
1758
|
+
/**
|
|
1759
|
+
* getDomains - getDomains
|
|
1760
|
+
*
|
|
1761
|
+
* Retrieves all custom email domains for the organization.
|
|
1762
|
+
*
|
|
1763
|
+
*/
|
|
1764
|
+
'getDomains'(
|
|
1765
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1766
|
+
data?: any,
|
|
1767
|
+
config?: AxiosRequestConfig
|
|
1768
|
+
): OperationResponse<Paths.GetDomains.Responses.$200>
|
|
1679
1769
|
/**
|
|
1680
1770
|
* addDomain - addDomain
|
|
1681
1771
|
*
|
|
@@ -1998,6 +2088,46 @@ export interface PathsDictionary {
|
|
|
1998
2088
|
config?: AxiosRequestConfig
|
|
1999
2089
|
): OperationResponse<Paths.DisconnectOutlook.Responses.$200>
|
|
2000
2090
|
}
|
|
2091
|
+
['/v2/channels/msteams/connect']: {
|
|
2092
|
+
/**
|
|
2093
|
+
* connectMsTeams - connectMsTeams
|
|
2094
|
+
*
|
|
2095
|
+
* Connects Microsoft Teams channel (click-to-call deep links, meetings) for the organization.
|
|
2096
|
+
* Requires an active Microsoft 365 / Outlook connection.
|
|
2097
|
+
*
|
|
2098
|
+
*/
|
|
2099
|
+
'post'(
|
|
2100
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2101
|
+
data?: any,
|
|
2102
|
+
config?: AxiosRequestConfig
|
|
2103
|
+
): OperationResponse<Paths.ConnectMsTeams.Responses.$200>
|
|
2104
|
+
}
|
|
2105
|
+
['/v2/channels/msteams/disconnect']: {
|
|
2106
|
+
/**
|
|
2107
|
+
* disconnectMsTeams - disconnectMsTeams
|
|
2108
|
+
*
|
|
2109
|
+
* Disconnects Microsoft Teams channel for the organization.
|
|
2110
|
+
*
|
|
2111
|
+
*/
|
|
2112
|
+
'post'(
|
|
2113
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2114
|
+
data?: any,
|
|
2115
|
+
config?: AxiosRequestConfig
|
|
2116
|
+
): OperationResponse<Paths.DisconnectMsTeams.Responses.$200>
|
|
2117
|
+
}
|
|
2118
|
+
['/v2/channels/msteams/status']: {
|
|
2119
|
+
/**
|
|
2120
|
+
* getMsTeamsStatus - getMsTeamsStatus
|
|
2121
|
+
*
|
|
2122
|
+
* Returns the connection status of the Microsoft Teams channel for the organization.
|
|
2123
|
+
*
|
|
2124
|
+
*/
|
|
2125
|
+
'get'(
|
|
2126
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2127
|
+
data?: any,
|
|
2128
|
+
config?: AxiosRequestConfig
|
|
2129
|
+
): OperationResponse<Paths.GetMsTeamsStatus.Responses.$200>
|
|
2130
|
+
}
|
|
2001
2131
|
['/v2/outlook/mailbox/connect']: {
|
|
2002
2132
|
/**
|
|
2003
2133
|
* connectOutlookMailbox - connectOutlookMailbox
|
|
@@ -2204,6 +2334,17 @@ export interface PathsDictionary {
|
|
|
2204
2334
|
data?: Paths.DeleteDomain.RequestBody,
|
|
2205
2335
|
config?: AxiosRequestConfig
|
|
2206
2336
|
): OperationResponse<Paths.DeleteDomain.Responses.$204>
|
|
2337
|
+
/**
|
|
2338
|
+
* getDomains - getDomains
|
|
2339
|
+
*
|
|
2340
|
+
* Retrieves all custom email domains for the organization.
|
|
2341
|
+
*
|
|
2342
|
+
*/
|
|
2343
|
+
'get'(
|
|
2344
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2345
|
+
data?: any,
|
|
2346
|
+
config?: AxiosRequestConfig
|
|
2347
|
+
): OperationResponse<Paths.GetDomains.Responses.$200>
|
|
2207
2348
|
}
|
|
2208
2349
|
['/v1/email-settings/domain/name-servers:verify']: {
|
|
2209
2350
|
/**
|
|
@@ -2248,7 +2389,6 @@ export interface PathsDictionary {
|
|
|
2248
2389
|
|
|
2249
2390
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
2250
2391
|
|
|
2251
|
-
|
|
2252
2392
|
export type ConnectedOutlookEmail = Components.Schemas.ConnectedOutlookEmail;
|
|
2253
2393
|
export type CreateEmailAddressPayload = Components.Schemas.CreateEmailAddressPayload;
|
|
2254
2394
|
export type CreateSharedInboxPayload = Components.Schemas.CreateSharedInboxPayload;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/email-settings-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.5.1",
|
|
4
4
|
"description": "API Client for epilot Email Settings API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -19,17 +19,17 @@
|
|
|
19
19
|
"email-settings"
|
|
20
20
|
],
|
|
21
21
|
"scripts": {
|
|
22
|
-
"test": "
|
|
22
|
+
"test": "vitest",
|
|
23
23
|
"typescript": "tsc",
|
|
24
24
|
"bundle-definition": "webpack",
|
|
25
25
|
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/email-settings.yaml",
|
|
26
26
|
"openapi:local": "node ../../scripts/update-openapi.js /Users/manikandansubramanian/Workspace/email-settings/lambda/ApiHandlerFunction/openapi.yml",
|
|
27
|
-
"typegen": "openapi typegen src/openapi.json --client
|
|
27
|
+
"typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
|
|
28
28
|
"build": "tsc && npm run build:patch && npm run bundle-definition",
|
|
29
29
|
"build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
|
|
30
30
|
"build:watch": "npm run build && tsc -w",
|
|
31
31
|
"prepublishOnly": "npm run typegen && npm run build",
|
|
32
|
-
"lint": "
|
|
32
|
+
"lint": "biome check src"
|
|
33
33
|
},
|
|
34
34
|
"files": [
|
|
35
35
|
"*.js",
|
|
@@ -58,13 +58,10 @@
|
|
|
58
58
|
"util": "^0.12.3"
|
|
59
59
|
},
|
|
60
60
|
"devDependencies": {
|
|
61
|
-
"@types/jest": "^26.0.20",
|
|
62
61
|
"axios": "^1.11.0",
|
|
63
62
|
"copy-webpack-plugin": "^7.0.0",
|
|
64
|
-
"jest": "^29.6.2",
|
|
65
63
|
"json-loader": "^0.5.7",
|
|
66
64
|
"openapicmd": "^2.7.0",
|
|
67
|
-
"ts-jest": "^29.4.1",
|
|
68
65
|
"ts-loader": "^8.0.14",
|
|
69
66
|
"ts-node": "^10.9.1",
|
|
70
67
|
"typescript": "^4.1.3",
|