agentmail 0.5.24 → 0.5.26
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/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/apiKeys/client/Client.d.ts +37 -167
- package/dist/cjs/api/resources/apiKeys/client/Client.js +65 -627
- package/dist/cjs/api/resources/apiKeys/client/requests/ListApiKeysRequest.d.ts +2 -0
- package/dist/cjs/api/resources/apiKeys/client/requests/index.d.ts +0 -5
- package/dist/cjs/api/resources/apiKeys/types/AcceptDisclosure.d.ts +6 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKey.d.ts +6 -13
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyCreator.d.ts +7 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyMutableFields.d.ts +8 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyPermissions.d.ts +10 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyType.d.ts +5 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyType.js +8 -0
- package/dist/cjs/api/resources/apiKeys/types/AuthToken.d.ts +4 -0
- package/dist/cjs/api/resources/apiKeys/types/BearerApiKey.d.ts +17 -0
- package/dist/cjs/api/resources/apiKeys/types/CreateApiKeyRequest.d.ts +5 -4
- package/dist/cjs/api/resources/apiKeys/types/CreateApiKeyResponse.d.ts +2 -4
- package/dist/cjs/api/resources/apiKeys/types/CreateApiKeyResult.d.ts +5 -0
- package/dist/cjs/api/resources/apiKeys/types/CreateBearerApiKeyRequest.d.ts +3 -0
- package/dist/cjs/api/resources/apiKeys/types/CreatePublicKeyRequest.d.ts +10 -15
- package/dist/cjs/api/resources/apiKeys/types/ExpiresAt.d.ts +4 -0
- package/dist/cjs/api/resources/apiKeys/types/InboxScopeId.d.ts +4 -0
- package/dist/cjs/api/resources/apiKeys/types/ListApiKeysResponse.d.ts +4 -1
- package/dist/cjs/api/resources/apiKeys/types/PodScopeId.d.ts +4 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicKeyClientId.d.ts +7 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicKeyCredential.d.ts +18 -15
- package/dist/cjs/api/resources/apiKeys/types/PublicKeyStatus.d.ts +10 -0
- package/dist/cjs/api/resources/apiKeys/types/PublicKeyStatus.js +13 -0
- package/dist/cjs/api/resources/apiKeys/types/UpdateApiKeyRequest.d.ts +7 -0
- package/dist/cjs/api/resources/apiKeys/types/UpdatedAt.d.ts +4 -0
- package/dist/cjs/api/resources/apiKeys/types/UsedAt.d.ts +4 -0
- package/dist/cjs/api/resources/apiKeys/types/index.d.ts +16 -25
- package/dist/cjs/api/resources/apiKeys/types/index.js +16 -25
- package/dist/cjs/api/resources/domains/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/domains/client/Client.js +9 -0
- package/dist/cjs/api/resources/domains/types/CreateDomainRequest.d.ts +8 -0
- package/dist/cjs/api/resources/inboxes/client/Client.d.ts +19 -3
- package/dist/cjs/api/resources/inboxes/client/Client.js +98 -19
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/Client.d.ts +20 -1
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/Client.js +85 -1
- package/dist/cjs/api/resources/inboxes/resources/index.d.ts +0 -1
- package/dist/cjs/api/resources/inboxes/resources/index.js +1 -2
- package/dist/cjs/api/resources/inboxes/types/AuthorizeInboxRequest.d.ts +10 -0
- package/dist/cjs/api/resources/inboxes/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/types/index.js +1 -0
- package/dist/cjs/api/resources/pods/resources/apiKeys/client/Client.d.ts +19 -0
- package/dist/cjs/api/resources/pods/resources/apiKeys/client/Client.js +84 -0
- package/dist/cjs/api/resources/pods/resources/domains/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/pods/resources/domains/client/Client.js +9 -0
- package/dist/cjs/api/resources/providers/client/Client.d.ts +7 -9
- package/dist/cjs/api/resources/providers/client/Client.js +7 -15
- package/dist/cjs/api/resources/providers/types/ConnectAccepted.d.ts +9 -0
- package/dist/cjs/api/resources/providers/types/ConnectInboxId.d.ts +5 -0
- package/dist/cjs/api/resources/providers/types/ConnectProviderBody.d.ts +2 -4
- package/dist/cjs/api/resources/providers/types/MagicUrl.d.ts +4 -0
- package/dist/cjs/api/resources/providers/types/Provider.d.ts +2 -0
- package/dist/cjs/api/resources/providers/types/index.d.ts +3 -1
- package/dist/cjs/api/resources/providers/types/index.js +3 -1
- package/dist/cjs/serialization/resources/apiKeys/types/AcceptDisclosure.d.ts +7 -0
- package/dist/cjs/serialization/resources/apiKeys/types/{OrganizationPublicKeyScope.js → AcceptDisclosure.js} +2 -2
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKey.d.ts +4 -16
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKey.js +3 -15
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyCreator.d.ts +10 -0
- package/dist/cjs/serialization/resources/apiKeys/types/{InboxPublicKeyScope.js → ApiKeyCreator.js} +4 -3
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyMutableFields.d.ts +12 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyMutableFields.js +44 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyPermissions.d.ts +2 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyPermissions.js +2 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyType.d.ts +7 -0
- package/dist/cjs/serialization/resources/apiKeys/types/{BrowserAuthorizationListLimit.js → ApiKeyType.js} +2 -2
- package/dist/cjs/serialization/resources/apiKeys/types/AuthToken.d.ts +7 -0
- package/dist/cjs/serialization/resources/apiKeys/types/{BrowserEnrollmentTransactionJti.js → AuthToken.js} +2 -2
- package/dist/cjs/serialization/resources/apiKeys/types/BearerApiKey.d.ts +29 -0
- package/dist/cjs/serialization/resources/apiKeys/types/{ListBrowserCredentialsResponse.js → BearerApiKey.js} +23 -10
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyRequest.d.ts +4 -7
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyRequest.js +3 -6
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyResponse.d.ts +4 -2
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyResponse.js +4 -2
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyResult.d.ts +9 -0
- package/dist/cjs/serialization/resources/apiKeys/types/{BrowserCredentialCreator.js → CreateApiKeyResult.js} +4 -6
- package/dist/cjs/serialization/resources/apiKeys/types/CreateBearerApiKeyRequest.d.ts +9 -0
- package/dist/cjs/serialization/resources/apiKeys/types/CreateBearerApiKeyRequest.js +40 -0
- package/dist/cjs/serialization/resources/apiKeys/types/CreatePublicKeyRequest.d.ts +8 -4
- package/dist/cjs/serialization/resources/apiKeys/types/CreatePublicKeyRequest.js +8 -4
- package/dist/cjs/serialization/resources/apiKeys/types/ExpiresAt.d.ts +7 -0
- package/dist/cjs/serialization/resources/apiKeys/types/{PodPublicKeyScope.js → ExpiresAt.js} +2 -4
- package/dist/cjs/serialization/resources/apiKeys/types/InboxScopeId.d.ts +7 -0
- package/dist/cjs/serialization/resources/apiKeys/types/InboxScopeId.js +39 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PodScopeId.d.ts +7 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PodScopeId.js +39 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyClientId.d.ts +7 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyClientId.js +39 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyCredential.d.ts +23 -8
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyCredential.js +23 -8
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyStatus.d.ts +7 -0
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyStatus.js +39 -0
- package/dist/cjs/serialization/resources/apiKeys/types/UpdateApiKeyRequest.d.ts +9 -0
- package/dist/cjs/serialization/resources/apiKeys/types/{BrowserLifecycleApiKeyActor.js → UpdateApiKeyRequest.js} +3 -4
- package/dist/cjs/serialization/resources/apiKeys/types/UpdatedAt.d.ts +7 -0
- package/dist/cjs/serialization/resources/apiKeys/types/UpdatedAt.js +39 -0
- package/dist/cjs/serialization/resources/apiKeys/types/UsedAt.d.ts +7 -0
- package/dist/cjs/serialization/resources/apiKeys/types/UsedAt.js +39 -0
- package/dist/cjs/serialization/resources/apiKeys/types/index.d.ts +16 -25
- package/dist/cjs/serialization/resources/apiKeys/types/index.js +16 -25
- package/dist/cjs/serialization/resources/domains/types/CreateDomainRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/domains/types/CreateDomainRequest.js +1 -0
- package/dist/cjs/serialization/resources/inboxes/types/AuthorizeInboxRequest.d.ts +12 -0
- package/dist/cjs/serialization/resources/{apiKeys/types/BrowserLifecycleCredentialActor.js → inboxes/types/AuthorizeInboxRequest.js} +6 -4
- package/dist/cjs/serialization/resources/inboxes/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/inboxes/types/index.js +1 -0
- package/dist/cjs/serialization/resources/providers/types/ConnectAccepted.d.ts +14 -0
- package/dist/cjs/serialization/resources/{apiKeys/types/BrowserEnrollmentAccepted.js → providers/types/ConnectAccepted.js} +8 -5
- package/dist/cjs/serialization/resources/providers/types/ConnectInboxId.d.ts +8 -0
- package/dist/cjs/serialization/resources/providers/types/ConnectInboxId.js +6 -0
- package/dist/cjs/serialization/resources/providers/types/ConnectProviderBody.d.ts +4 -3
- package/dist/cjs/serialization/resources/providers/types/ConnectProviderBody.js +4 -3
- package/dist/cjs/serialization/resources/providers/types/MagicUrl.d.ts +7 -0
- package/dist/cjs/serialization/resources/providers/types/MagicUrl.js +39 -0
- package/dist/cjs/serialization/resources/providers/types/Provider.d.ts +1 -0
- package/dist/cjs/serialization/resources/providers/types/Provider.js +1 -0
- package/dist/cjs/serialization/resources/providers/types/index.d.ts +3 -1
- package/dist/cjs/serialization/resources/providers/types/index.js +3 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/apiKeys/client/Client.d.mts +37 -167
- package/dist/esm/api/resources/apiKeys/client/Client.mjs +66 -628
- package/dist/esm/api/resources/apiKeys/client/requests/ListApiKeysRequest.d.mts +2 -0
- package/dist/esm/api/resources/apiKeys/client/requests/index.d.mts +0 -5
- package/dist/esm/api/resources/apiKeys/types/AcceptDisclosure.d.mts +6 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKey.d.mts +6 -13
- package/dist/esm/api/resources/apiKeys/types/ApiKeyCreator.d.mts +7 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeyMutableFields.d.mts +8 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeyPermissions.d.mts +10 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeyType.d.mts +5 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeyType.mjs +5 -0
- package/dist/esm/api/resources/apiKeys/types/AuthToken.d.mts +4 -0
- package/dist/esm/api/resources/apiKeys/types/BearerApiKey.d.mts +17 -0
- package/dist/esm/api/resources/apiKeys/types/CreateApiKeyRequest.d.mts +5 -4
- package/dist/esm/api/resources/apiKeys/types/CreateApiKeyResponse.d.mts +2 -4
- package/dist/esm/api/resources/apiKeys/types/CreateApiKeyResult.d.mts +5 -0
- package/dist/esm/api/resources/apiKeys/types/CreateBearerApiKeyRequest.d.mts +3 -0
- package/dist/esm/api/resources/apiKeys/types/CreatePublicKeyRequest.d.mts +10 -15
- package/dist/esm/api/resources/apiKeys/types/ExpiresAt.d.mts +4 -0
- package/dist/esm/api/resources/apiKeys/types/InboxScopeId.d.mts +4 -0
- package/dist/esm/api/resources/apiKeys/types/ListApiKeysResponse.d.mts +4 -1
- package/dist/esm/api/resources/apiKeys/types/PodScopeId.d.mts +4 -0
- package/dist/esm/api/resources/apiKeys/types/PublicKeyClientId.d.mts +7 -0
- package/dist/esm/api/resources/apiKeys/types/PublicKeyCredential.d.mts +18 -15
- package/dist/esm/api/resources/apiKeys/types/PublicKeyStatus.d.mts +10 -0
- package/dist/esm/api/resources/apiKeys/types/PublicKeyStatus.mjs +10 -0
- package/dist/esm/api/resources/apiKeys/types/UpdateApiKeyRequest.d.mts +7 -0
- package/dist/esm/api/resources/apiKeys/types/UpdatedAt.d.mts +4 -0
- package/dist/esm/api/resources/apiKeys/types/UsedAt.d.mts +4 -0
- package/dist/esm/api/resources/apiKeys/types/index.d.mts +16 -25
- package/dist/esm/api/resources/apiKeys/types/index.mjs +16 -25
- package/dist/esm/api/resources/domains/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/domains/client/Client.mjs +9 -0
- package/dist/esm/api/resources/domains/types/CreateDomainRequest.d.mts +8 -0
- package/dist/esm/api/resources/inboxes/client/Client.d.mts +19 -3
- package/dist/esm/api/resources/inboxes/client/Client.mjs +84 -5
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/Client.d.mts +20 -1
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/Client.mjs +85 -1
- package/dist/esm/api/resources/inboxes/resources/index.d.mts +0 -1
- package/dist/esm/api/resources/inboxes/resources/index.mjs +0 -1
- package/dist/esm/api/resources/inboxes/types/AuthorizeInboxRequest.d.mts +10 -0
- package/dist/esm/api/resources/inboxes/types/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/types/index.mjs +1 -0
- package/dist/esm/api/resources/pods/resources/apiKeys/client/Client.d.mts +19 -0
- package/dist/esm/api/resources/pods/resources/apiKeys/client/Client.mjs +84 -0
- package/dist/esm/api/resources/pods/resources/domains/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/pods/resources/domains/client/Client.mjs +9 -0
- package/dist/esm/api/resources/providers/client/Client.d.mts +7 -9
- package/dist/esm/api/resources/providers/client/Client.mjs +8 -16
- package/dist/esm/api/resources/providers/types/ConnectAccepted.d.mts +9 -0
- package/dist/esm/api/resources/providers/types/ConnectInboxId.d.mts +5 -0
- package/dist/esm/api/resources/providers/types/ConnectProviderBody.d.mts +2 -4
- package/dist/esm/api/resources/providers/types/MagicUrl.d.mts +4 -0
- package/dist/esm/api/resources/providers/types/Provider.d.mts +2 -0
- package/dist/esm/api/resources/providers/types/index.d.mts +3 -1
- package/dist/esm/api/resources/providers/types/index.mjs +3 -1
- package/dist/esm/serialization/resources/apiKeys/types/AcceptDisclosure.d.mts +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/{OrganizationPublicKeyScope.mjs → AcceptDisclosure.mjs} +1 -1
- package/dist/esm/serialization/resources/apiKeys/types/ApiKey.d.mts +4 -16
- package/dist/esm/serialization/resources/apiKeys/types/ApiKey.mjs +3 -15
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyCreator.d.mts +10 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyCreator.mjs +6 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyMutableFields.d.mts +12 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyMutableFields.mjs +8 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyPermissions.d.mts +2 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyPermissions.mjs +2 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyType.d.mts +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/{PodPublicKeyScope.mjs → ApiKeyType.mjs} +1 -3
- package/dist/esm/serialization/resources/apiKeys/types/AuthToken.d.mts +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/{BrowserAuthorizationListLimit.mjs → AuthToken.mjs} +1 -1
- package/dist/esm/serialization/resources/apiKeys/types/BearerApiKey.d.mts +29 -0
- package/dist/esm/serialization/resources/apiKeys/types/BearerApiKey.mjs +25 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyRequest.d.mts +4 -7
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyRequest.mjs +3 -6
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyResponse.d.mts +4 -2
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyResponse.mjs +4 -2
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyResult.d.mts +9 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyResult.mjs +5 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreateBearerApiKeyRequest.d.mts +9 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreateBearerApiKeyRequest.mjs +4 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreatePublicKeyRequest.d.mts +8 -4
- package/dist/esm/serialization/resources/apiKeys/types/CreatePublicKeyRequest.mjs +8 -4
- package/dist/esm/serialization/resources/apiKeys/types/ExpiresAt.d.mts +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/{BrowserEnrollmentTransactionJti.mjs → ExpiresAt.mjs} +1 -1
- package/dist/esm/serialization/resources/apiKeys/types/InboxScopeId.d.mts +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/InboxScopeId.mjs +3 -0
- package/dist/esm/serialization/resources/apiKeys/types/PodScopeId.d.mts +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/PodScopeId.mjs +3 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyClientId.d.mts +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyClientId.mjs +3 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyCredential.d.mts +23 -8
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyCredential.mjs +23 -8
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyStatus.d.mts +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyStatus.mjs +3 -0
- package/dist/esm/serialization/resources/apiKeys/types/UpdateApiKeyRequest.d.mts +9 -0
- package/dist/esm/serialization/resources/apiKeys/types/UpdateApiKeyRequest.mjs +4 -0
- package/dist/esm/serialization/resources/apiKeys/types/UpdatedAt.d.mts +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/UpdatedAt.mjs +3 -0
- package/dist/esm/serialization/resources/apiKeys/types/UsedAt.d.mts +7 -0
- package/dist/esm/serialization/resources/apiKeys/types/UsedAt.mjs +3 -0
- package/dist/esm/serialization/resources/apiKeys/types/index.d.mts +16 -25
- package/dist/esm/serialization/resources/apiKeys/types/index.mjs +16 -25
- package/dist/esm/serialization/resources/domains/types/CreateDomainRequest.d.mts +1 -0
- package/dist/esm/serialization/resources/domains/types/CreateDomainRequest.mjs +1 -0
- package/dist/esm/serialization/resources/inboxes/types/AuthorizeInboxRequest.d.mts +12 -0
- package/dist/esm/serialization/resources/inboxes/types/AuthorizeInboxRequest.mjs +8 -0
- package/dist/esm/serialization/resources/inboxes/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/inboxes/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/providers/types/ConnectAccepted.d.mts +14 -0
- package/dist/esm/serialization/resources/providers/types/ConnectAccepted.mjs +10 -0
- package/dist/esm/serialization/resources/providers/types/ConnectInboxId.d.mts +8 -0
- package/dist/esm/serialization/resources/providers/types/ConnectInboxId.mjs +3 -0
- package/dist/esm/serialization/resources/providers/types/ConnectProviderBody.d.mts +4 -3
- package/dist/esm/serialization/resources/providers/types/ConnectProviderBody.mjs +4 -3
- package/dist/esm/serialization/resources/providers/types/MagicUrl.d.mts +7 -0
- package/dist/esm/serialization/resources/providers/types/MagicUrl.mjs +3 -0
- package/dist/esm/serialization/resources/providers/types/Provider.d.mts +1 -0
- package/dist/esm/serialization/resources/providers/types/Provider.mjs +1 -0
- package/dist/esm/serialization/resources/providers/types/index.d.mts +3 -1
- package/dist/esm/serialization/resources/providers/types/index.mjs +3 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms-full.txt +0 -1
- package/dist/llms.txt +7 -14
- package/package.json +1 -12
- package/reference.md +288 -729
- package/dist/cjs/api/resources/apiKeys/client/requests/ListBrowserConsentsRequest.d.ts +0 -12
- package/dist/cjs/api/resources/apiKeys/client/requests/ListBrowserCredentialEventsRequest.d.ts +0 -9
- package/dist/cjs/api/resources/apiKeys/client/requests/ListBrowserCredentialsRequest.d.ts +0 -9
- package/dist/cjs/api/resources/apiKeys/client/requests/ListPublicKeysRequest.d.ts +0 -10
- package/dist/cjs/api/resources/apiKeys/client/requests/RevokeAllAgentIdSignInKeysRequest.d.ts +0 -10
- package/dist/cjs/api/resources/apiKeys/types/BrowserAuthorizationListLimit.d.ts +0 -1
- package/dist/cjs/api/resources/apiKeys/types/BrowserConsent.d.ts +0 -16
- package/dist/cjs/api/resources/apiKeys/types/BrowserConsentLifecycleEvent.d.ts +0 -13
- package/dist/cjs/api/resources/apiKeys/types/BrowserConsentLifecycleEventType.d.ts +0 -7
- package/dist/cjs/api/resources/apiKeys/types/BrowserConsentLifecycleEventType.js +0 -10
- package/dist/cjs/api/resources/apiKeys/types/BrowserCredential.d.ts +0 -14
- package/dist/cjs/api/resources/apiKeys/types/BrowserCredentialCreator.d.ts +0 -7
- package/dist/cjs/api/resources/apiKeys/types/BrowserEnrollmentAccepted.d.ts +0 -11
- package/dist/cjs/api/resources/apiKeys/types/BrowserEnrollmentLifecycleEvent.d.ts +0 -12
- package/dist/cjs/api/resources/apiKeys/types/BrowserEnrollmentLifecycleEventType.d.ts +0 -7
- package/dist/cjs/api/resources/apiKeys/types/BrowserEnrollmentLifecycleEventType.js +0 -10
- package/dist/cjs/api/resources/apiKeys/types/BrowserEnrollmentTransactionJti.d.ts +0 -4
- package/dist/cjs/api/resources/apiKeys/types/BrowserLifecycleActor.d.ts +0 -10
- package/dist/cjs/api/resources/apiKeys/types/BrowserLifecycleApiKeyActor.d.ts +0 -3
- package/dist/cjs/api/resources/apiKeys/types/BrowserLifecycleCredentialActor.d.ts +0 -4
- package/dist/cjs/api/resources/apiKeys/types/BrowserLifecycleEvent.d.ts +0 -2
- package/dist/cjs/api/resources/apiKeys/types/CreateBrowserEnrollmentRequest.d.ts +0 -9
- package/dist/cjs/api/resources/apiKeys/types/InboxPublicKeyScope.d.ts +0 -7
- package/dist/cjs/api/resources/apiKeys/types/InboxPublicKeyScope.js +0 -3
- package/dist/cjs/api/resources/apiKeys/types/ListBrowserConsentsResponse.d.ts +0 -7
- package/dist/cjs/api/resources/apiKeys/types/ListBrowserConsentsResponse.js +0 -3
- package/dist/cjs/api/resources/apiKeys/types/ListBrowserCredentialsResponse.d.ts +0 -7
- package/dist/cjs/api/resources/apiKeys/types/ListBrowserCredentialsResponse.js +0 -3
- package/dist/cjs/api/resources/apiKeys/types/ListBrowserLifecycleEventsResponse.d.ts +0 -7
- package/dist/cjs/api/resources/apiKeys/types/ListBrowserLifecycleEventsResponse.js +0 -3
- package/dist/cjs/api/resources/apiKeys/types/ListPublicKeysResponse.d.ts +0 -7
- package/dist/cjs/api/resources/apiKeys/types/ListPublicKeysResponse.js +0 -3
- package/dist/cjs/api/resources/apiKeys/types/OrganizationPublicKeyScope.d.ts +0 -4
- package/dist/cjs/api/resources/apiKeys/types/OrganizationPublicKeyScope.js +0 -3
- package/dist/cjs/api/resources/apiKeys/types/PodPublicKeyScope.d.ts +0 -7
- package/dist/cjs/api/resources/apiKeys/types/PodPublicKeyScope.js +0 -3
- package/dist/cjs/api/resources/apiKeys/types/PublicKeyScope.d.ts +0 -16
- package/dist/cjs/api/resources/apiKeys/types/PublicKeyScope.js +0 -3
- package/dist/cjs/api/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.d.ts +0 -8
- package/dist/cjs/api/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.js +0 -3
- package/dist/cjs/api/resources/apiKeys/types/UpdatePublicKeyNameRequest.d.ts +0 -7
- package/dist/cjs/api/resources/apiKeys/types/UpdatePublicKeyNameRequest.js +0 -3
- package/dist/cjs/api/resources/inboxes/resources/browserCredentials/client/Client.d.ts +0 -55
- package/dist/cjs/api/resources/inboxes/resources/browserCredentials/client/Client.js +0 -175
- package/dist/cjs/api/resources/inboxes/resources/browserCredentials/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/inboxes/resources/browserCredentials/client/index.js +0 -2
- package/dist/cjs/api/resources/inboxes/resources/browserCredentials/exports.d.ts +0 -2
- package/dist/cjs/api/resources/inboxes/resources/browserCredentials/exports.js +0 -21
- package/dist/cjs/api/resources/inboxes/resources/browserCredentials/index.d.ts +0 -1
- package/dist/cjs/api/resources/inboxes/resources/browserCredentials/index.js +0 -17
- package/dist/cjs/api/resources/providers/types/ConnectProviderAccepted.d.ts +0 -8
- package/dist/cjs/api/resources/providers/types/ConnectProviderAccepted.js +0 -3
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserAuthorizationListLimit.d.ts +0 -7
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserConsent.d.ts +0 -17
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserConsent.js +0 -49
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserConsentLifecycleEvent.d.ts +0 -20
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserConsentLifecycleEvent.js +0 -52
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserConsentLifecycleEventType.d.ts +0 -7
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserConsentLifecycleEventType.js +0 -44
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserCredential.d.ts +0 -17
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserCredential.js +0 -49
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserCredentialCreator.d.ts +0 -11
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserEnrollmentAccepted.d.ts +0 -11
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserEnrollmentLifecycleEvent.d.ts +0 -19
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserEnrollmentLifecycleEvent.js +0 -51
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserEnrollmentLifecycleEventType.d.ts +0 -7
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserEnrollmentLifecycleEventType.js +0 -44
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserEnrollmentTransactionJti.d.ts +0 -7
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserLifecycleActor.d.ts +0 -15
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserLifecycleActor.js +0 -49
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserLifecycleApiKeyActor.d.ts +0 -9
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserLifecycleCredentialActor.d.ts +0 -10
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserLifecycleEvent.d.ts +0 -9
- package/dist/cjs/serialization/resources/apiKeys/types/BrowserLifecycleEvent.js +0 -41
- package/dist/cjs/serialization/resources/apiKeys/types/CreateBrowserEnrollmentRequest.d.ts +0 -10
- package/dist/cjs/serialization/resources/apiKeys/types/CreateBrowserEnrollmentRequest.js +0 -42
- package/dist/cjs/serialization/resources/apiKeys/types/InboxPublicKeyScope.d.ts +0 -9
- package/dist/cjs/serialization/resources/apiKeys/types/ListBrowserConsentsResponse.d.ts +0 -16
- package/dist/cjs/serialization/resources/apiKeys/types/ListBrowserConsentsResponse.js +0 -48
- package/dist/cjs/serialization/resources/apiKeys/types/ListBrowserCredentialsResponse.d.ts +0 -16
- package/dist/cjs/serialization/resources/apiKeys/types/ListBrowserLifecycleEventsResponse.d.ts +0 -16
- package/dist/cjs/serialization/resources/apiKeys/types/ListBrowserLifecycleEventsResponse.js +0 -48
- package/dist/cjs/serialization/resources/apiKeys/types/ListPublicKeysResponse.d.ts +0 -14
- package/dist/cjs/serialization/resources/apiKeys/types/ListPublicKeysResponse.js +0 -46
- package/dist/cjs/serialization/resources/apiKeys/types/OrganizationPublicKeyScope.d.ts +0 -7
- package/dist/cjs/serialization/resources/apiKeys/types/PodPublicKeyScope.d.ts +0 -9
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyScope.d.ts +0 -19
- package/dist/cjs/serialization/resources/apiKeys/types/PublicKeyScope.js +0 -51
- package/dist/cjs/serialization/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.d.ts +0 -11
- package/dist/cjs/serialization/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.js +0 -43
- package/dist/cjs/serialization/resources/apiKeys/types/UpdatePublicKeyNameRequest.d.ts +0 -9
- package/dist/cjs/serialization/resources/apiKeys/types/UpdatePublicKeyNameRequest.js +0 -41
- package/dist/cjs/serialization/resources/providers/types/ConnectProviderAccepted.d.ts +0 -11
- package/dist/cjs/serialization/resources/providers/types/ConnectProviderAccepted.js +0 -43
- package/dist/esm/api/resources/apiKeys/client/requests/ListBrowserConsentsRequest.d.mts +0 -12
- package/dist/esm/api/resources/apiKeys/client/requests/ListBrowserCredentialEventsRequest.d.mts +0 -9
- package/dist/esm/api/resources/apiKeys/client/requests/ListBrowserCredentialsRequest.d.mts +0 -9
- package/dist/esm/api/resources/apiKeys/client/requests/ListPublicKeysRequest.d.mts +0 -10
- package/dist/esm/api/resources/apiKeys/client/requests/RevokeAllAgentIdSignInKeysRequest.d.mts +0 -10
- package/dist/esm/api/resources/apiKeys/types/BrowserAuthorizationListLimit.d.mts +0 -1
- package/dist/esm/api/resources/apiKeys/types/BrowserConsent.d.mts +0 -16
- package/dist/esm/api/resources/apiKeys/types/BrowserConsentLifecycleEvent.d.mts +0 -13
- package/dist/esm/api/resources/apiKeys/types/BrowserConsentLifecycleEventType.d.mts +0 -7
- package/dist/esm/api/resources/apiKeys/types/BrowserConsentLifecycleEventType.mjs +0 -7
- package/dist/esm/api/resources/apiKeys/types/BrowserCredential.d.mts +0 -14
- package/dist/esm/api/resources/apiKeys/types/BrowserCredentialCreator.d.mts +0 -7
- package/dist/esm/api/resources/apiKeys/types/BrowserEnrollmentAccepted.d.mts +0 -11
- package/dist/esm/api/resources/apiKeys/types/BrowserEnrollmentLifecycleEvent.d.mts +0 -12
- package/dist/esm/api/resources/apiKeys/types/BrowserEnrollmentLifecycleEventType.d.mts +0 -7
- package/dist/esm/api/resources/apiKeys/types/BrowserEnrollmentLifecycleEventType.mjs +0 -7
- package/dist/esm/api/resources/apiKeys/types/BrowserEnrollmentTransactionJti.d.mts +0 -4
- package/dist/esm/api/resources/apiKeys/types/BrowserLifecycleActor.d.mts +0 -10
- package/dist/esm/api/resources/apiKeys/types/BrowserLifecycleApiKeyActor.d.mts +0 -3
- package/dist/esm/api/resources/apiKeys/types/BrowserLifecycleCredentialActor.d.mts +0 -4
- package/dist/esm/api/resources/apiKeys/types/BrowserLifecycleEvent.d.mts +0 -2
- package/dist/esm/api/resources/apiKeys/types/CreateBrowserEnrollmentRequest.d.mts +0 -9
- package/dist/esm/api/resources/apiKeys/types/InboxPublicKeyScope.d.mts +0 -7
- package/dist/esm/api/resources/apiKeys/types/InboxPublicKeyScope.mjs +0 -2
- package/dist/esm/api/resources/apiKeys/types/ListBrowserConsentsResponse.d.mts +0 -7
- package/dist/esm/api/resources/apiKeys/types/ListBrowserConsentsResponse.mjs +0 -2
- package/dist/esm/api/resources/apiKeys/types/ListBrowserCredentialsResponse.d.mts +0 -7
- package/dist/esm/api/resources/apiKeys/types/ListBrowserCredentialsResponse.mjs +0 -2
- package/dist/esm/api/resources/apiKeys/types/ListBrowserLifecycleEventsResponse.d.mts +0 -7
- package/dist/esm/api/resources/apiKeys/types/ListBrowserLifecycleEventsResponse.mjs +0 -2
- package/dist/esm/api/resources/apiKeys/types/ListPublicKeysResponse.d.mts +0 -7
- package/dist/esm/api/resources/apiKeys/types/ListPublicKeysResponse.mjs +0 -2
- package/dist/esm/api/resources/apiKeys/types/OrganizationPublicKeyScope.d.mts +0 -4
- package/dist/esm/api/resources/apiKeys/types/OrganizationPublicKeyScope.mjs +0 -2
- package/dist/esm/api/resources/apiKeys/types/PodPublicKeyScope.d.mts +0 -7
- package/dist/esm/api/resources/apiKeys/types/PodPublicKeyScope.mjs +0 -2
- package/dist/esm/api/resources/apiKeys/types/PublicKeyScope.d.mts +0 -16
- package/dist/esm/api/resources/apiKeys/types/PublicKeyScope.mjs +0 -2
- package/dist/esm/api/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.d.mts +0 -8
- package/dist/esm/api/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.mjs +0 -2
- package/dist/esm/api/resources/apiKeys/types/UpdatePublicKeyNameRequest.d.mts +0 -7
- package/dist/esm/api/resources/apiKeys/types/UpdatePublicKeyNameRequest.mjs +0 -2
- package/dist/esm/api/resources/inboxes/resources/browserCredentials/client/Client.d.mts +0 -55
- package/dist/esm/api/resources/inboxes/resources/browserCredentials/client/Client.mjs +0 -138
- package/dist/esm/api/resources/inboxes/resources/browserCredentials/client/index.d.mts +0 -1
- package/dist/esm/api/resources/inboxes/resources/browserCredentials/client/index.mjs +0 -1
- package/dist/esm/api/resources/inboxes/resources/browserCredentials/exports.d.mts +0 -2
- package/dist/esm/api/resources/inboxes/resources/browserCredentials/exports.mjs +0 -3
- package/dist/esm/api/resources/inboxes/resources/browserCredentials/index.d.mts +0 -1
- package/dist/esm/api/resources/inboxes/resources/browserCredentials/index.mjs +0 -1
- package/dist/esm/api/resources/providers/types/ConnectProviderAccepted.d.mts +0 -8
- package/dist/esm/api/resources/providers/types/ConnectProviderAccepted.mjs +0 -2
- package/dist/esm/serialization/resources/apiKeys/types/BrowserAuthorizationListLimit.d.mts +0 -7
- package/dist/esm/serialization/resources/apiKeys/types/BrowserConsent.d.mts +0 -17
- package/dist/esm/serialization/resources/apiKeys/types/BrowserConsent.mjs +0 -13
- package/dist/esm/serialization/resources/apiKeys/types/BrowserConsentLifecycleEvent.d.mts +0 -20
- package/dist/esm/serialization/resources/apiKeys/types/BrowserConsentLifecycleEvent.mjs +0 -16
- package/dist/esm/serialization/resources/apiKeys/types/BrowserConsentLifecycleEventType.d.mts +0 -7
- package/dist/esm/serialization/resources/apiKeys/types/BrowserConsentLifecycleEventType.mjs +0 -8
- package/dist/esm/serialization/resources/apiKeys/types/BrowserCredential.d.mts +0 -17
- package/dist/esm/serialization/resources/apiKeys/types/BrowserCredential.mjs +0 -13
- package/dist/esm/serialization/resources/apiKeys/types/BrowserCredentialCreator.d.mts +0 -11
- package/dist/esm/serialization/resources/apiKeys/types/BrowserCredentialCreator.mjs +0 -7
- package/dist/esm/serialization/resources/apiKeys/types/BrowserEnrollmentAccepted.d.mts +0 -11
- package/dist/esm/serialization/resources/apiKeys/types/BrowserEnrollmentAccepted.mjs +0 -7
- package/dist/esm/serialization/resources/apiKeys/types/BrowserEnrollmentLifecycleEvent.d.mts +0 -19
- package/dist/esm/serialization/resources/apiKeys/types/BrowserEnrollmentLifecycleEvent.mjs +0 -15
- package/dist/esm/serialization/resources/apiKeys/types/BrowserEnrollmentLifecycleEventType.d.mts +0 -7
- package/dist/esm/serialization/resources/apiKeys/types/BrowserEnrollmentLifecycleEventType.mjs +0 -8
- package/dist/esm/serialization/resources/apiKeys/types/BrowserEnrollmentTransactionJti.d.mts +0 -7
- package/dist/esm/serialization/resources/apiKeys/types/BrowserLifecycleActor.d.mts +0 -15
- package/dist/esm/serialization/resources/apiKeys/types/BrowserLifecycleActor.mjs +0 -13
- package/dist/esm/serialization/resources/apiKeys/types/BrowserLifecycleApiKeyActor.d.mts +0 -9
- package/dist/esm/serialization/resources/apiKeys/types/BrowserLifecycleApiKeyActor.mjs +0 -5
- package/dist/esm/serialization/resources/apiKeys/types/BrowserLifecycleCredentialActor.d.mts +0 -10
- package/dist/esm/serialization/resources/apiKeys/types/BrowserLifecycleCredentialActor.mjs +0 -6
- package/dist/esm/serialization/resources/apiKeys/types/BrowserLifecycleEvent.d.mts +0 -9
- package/dist/esm/serialization/resources/apiKeys/types/BrowserLifecycleEvent.mjs +0 -5
- package/dist/esm/serialization/resources/apiKeys/types/CreateBrowserEnrollmentRequest.d.mts +0 -10
- package/dist/esm/serialization/resources/apiKeys/types/CreateBrowserEnrollmentRequest.mjs +0 -6
- package/dist/esm/serialization/resources/apiKeys/types/InboxPublicKeyScope.d.mts +0 -9
- package/dist/esm/serialization/resources/apiKeys/types/InboxPublicKeyScope.mjs +0 -5
- package/dist/esm/serialization/resources/apiKeys/types/ListBrowserConsentsResponse.d.mts +0 -16
- package/dist/esm/serialization/resources/apiKeys/types/ListBrowserConsentsResponse.mjs +0 -12
- package/dist/esm/serialization/resources/apiKeys/types/ListBrowserCredentialsResponse.d.mts +0 -16
- package/dist/esm/serialization/resources/apiKeys/types/ListBrowserCredentialsResponse.mjs +0 -12
- package/dist/esm/serialization/resources/apiKeys/types/ListBrowserLifecycleEventsResponse.d.mts +0 -16
- package/dist/esm/serialization/resources/apiKeys/types/ListBrowserLifecycleEventsResponse.mjs +0 -12
- package/dist/esm/serialization/resources/apiKeys/types/ListPublicKeysResponse.d.mts +0 -14
- package/dist/esm/serialization/resources/apiKeys/types/ListPublicKeysResponse.mjs +0 -10
- package/dist/esm/serialization/resources/apiKeys/types/OrganizationPublicKeyScope.d.mts +0 -7
- package/dist/esm/serialization/resources/apiKeys/types/PodPublicKeyScope.d.mts +0 -9
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyScope.d.mts +0 -19
- package/dist/esm/serialization/resources/apiKeys/types/PublicKeyScope.mjs +0 -15
- package/dist/esm/serialization/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.d.mts +0 -11
- package/dist/esm/serialization/resources/apiKeys/types/RevokeAllAgentIdSignInKeysResponse.mjs +0 -7
- package/dist/esm/serialization/resources/apiKeys/types/UpdatePublicKeyNameRequest.d.mts +0 -9
- package/dist/esm/serialization/resources/apiKeys/types/UpdatePublicKeyNameRequest.mjs +0 -5
- package/dist/esm/serialization/resources/providers/types/ConnectProviderAccepted.d.mts +0 -11
- package/dist/esm/serialization/resources/providers/types/ConnectProviderAccepted.mjs +0 -7
- /package/dist/cjs/api/resources/apiKeys/{client/requests/ListBrowserConsentsRequest.js → types/AcceptDisclosure.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/{client/requests/ListBrowserCredentialEventsRequest.js → types/ApiKeyCreator.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/{client/requests/ListBrowserCredentialsRequest.js → types/ApiKeyMutableFields.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/{client/requests/ListPublicKeysRequest.js → types/AuthToken.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/{client/requests/RevokeAllAgentIdSignInKeysRequest.js → types/BearerApiKey.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/types/{BrowserAuthorizationListLimit.js → CreateApiKeyResult.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/types/{BrowserConsent.js → CreateBearerApiKeyRequest.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/types/{BrowserConsentLifecycleEvent.js → ExpiresAt.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/types/{BrowserCredential.js → InboxScopeId.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/types/{BrowserCredentialCreator.js → PodScopeId.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/types/{BrowserEnrollmentAccepted.js → PublicKeyClientId.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/types/{BrowserEnrollmentLifecycleEvent.js → UpdateApiKeyRequest.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/types/{BrowserEnrollmentTransactionJti.js → UpdatedAt.js} +0 -0
- /package/dist/cjs/api/resources/apiKeys/types/{BrowserLifecycleActor.js → UsedAt.js} +0 -0
- /package/dist/cjs/api/resources/{apiKeys/types/BrowserLifecycleApiKeyActor.js → inboxes/types/AuthorizeInboxRequest.js} +0 -0
- /package/dist/cjs/api/resources/{apiKeys/types/BrowserLifecycleCredentialActor.js → providers/types/ConnectAccepted.js} +0 -0
- /package/dist/cjs/api/resources/{apiKeys/types/BrowserLifecycleEvent.js → providers/types/ConnectInboxId.js} +0 -0
- /package/dist/cjs/api/resources/{apiKeys/types/CreateBrowserEnrollmentRequest.js → providers/types/MagicUrl.js} +0 -0
- /package/dist/esm/api/resources/apiKeys/{client/requests/ListBrowserConsentsRequest.mjs → types/AcceptDisclosure.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/{client/requests/ListBrowserCredentialEventsRequest.mjs → types/ApiKeyCreator.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/{client/requests/ListBrowserCredentialsRequest.mjs → types/ApiKeyMutableFields.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/{client/requests/ListPublicKeysRequest.mjs → types/AuthToken.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/{client/requests/RevokeAllAgentIdSignInKeysRequest.mjs → types/BearerApiKey.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/types/{BrowserAuthorizationListLimit.mjs → CreateApiKeyResult.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/types/{BrowserConsent.mjs → CreateBearerApiKeyRequest.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/types/{BrowserConsentLifecycleEvent.mjs → ExpiresAt.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/types/{BrowserCredential.mjs → InboxScopeId.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/types/{BrowserCredentialCreator.mjs → PodScopeId.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/types/{BrowserEnrollmentAccepted.mjs → PublicKeyClientId.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/types/{BrowserEnrollmentLifecycleEvent.mjs → UpdateApiKeyRequest.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/types/{BrowserEnrollmentTransactionJti.mjs → UpdatedAt.mjs} +0 -0
- /package/dist/esm/api/resources/apiKeys/types/{BrowserLifecycleActor.mjs → UsedAt.mjs} +0 -0
- /package/dist/esm/api/resources/{apiKeys/types/BrowserLifecycleApiKeyActor.mjs → inboxes/types/AuthorizeInboxRequest.mjs} +0 -0
- /package/dist/esm/api/resources/{apiKeys/types/BrowserLifecycleCredentialActor.mjs → providers/types/ConnectAccepted.mjs} +0 -0
- /package/dist/esm/api/resources/{apiKeys/types/BrowserLifecycleEvent.mjs → providers/types/ConnectInboxId.mjs} +0 -0
- /package/dist/esm/api/resources/{apiKeys/types/CreateBrowserEnrollmentRequest.mjs → providers/types/MagicUrl.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -408,8 +408,7 @@ await client.inboxes.delete("inbox_id");
|
|
|
408
408
|
</dl>
|
|
409
409
|
</details>
|
|
410
410
|
|
|
411
|
-
|
|
412
|
-
<details><summary><code>client.pods.<a href="/src/api/resources/pods/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListPodsResponse</code></summary>
|
|
411
|
+
<details><summary><code>client.inboxes.<a href="/src/api/resources/inboxes/client/Client.ts">authorize</a>(inbox_id, { ...params }) -> AgentMail.PublicKeyCredential</code></summary>
|
|
413
412
|
<dl>
|
|
414
413
|
<dd>
|
|
415
414
|
|
|
@@ -421,10 +420,9 @@ await client.inboxes.delete("inbox_id");
|
|
|
421
420
|
<dl>
|
|
422
421
|
<dd>
|
|
423
422
|
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
```
|
|
423
|
+
Authorizes the AgentID sign-in a client is already waiting in, for the
|
|
424
|
+
inbox in the path, and returns the pending public key it will activate. A
|
|
425
|
+
repeat for the same token, inbox, and bearer returns the same key.
|
|
428
426
|
</dd>
|
|
429
427
|
</dl>
|
|
430
428
|
</dd>
|
|
@@ -439,7 +437,9 @@ agentmail pods list
|
|
|
439
437
|
<dd>
|
|
440
438
|
|
|
441
439
|
```typescript
|
|
442
|
-
await client.
|
|
440
|
+
await client.inboxes.authorize("inbox_id", {
|
|
441
|
+
authToken: "blackcurrant.........."
|
|
442
|
+
});
|
|
443
443
|
|
|
444
444
|
```
|
|
445
445
|
</dd>
|
|
@@ -455,73 +455,15 @@ await client.pods.list();
|
|
|
455
455
|
<dl>
|
|
456
456
|
<dd>
|
|
457
457
|
|
|
458
|
-
**
|
|
459
|
-
|
|
460
|
-
</dd>
|
|
461
|
-
</dl>
|
|
462
|
-
|
|
463
|
-
<dl>
|
|
464
|
-
<dd>
|
|
465
|
-
|
|
466
|
-
**requestOptions:** `PodsClient.RequestOptions`
|
|
458
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
467
459
|
|
|
468
460
|
</dd>
|
|
469
461
|
</dl>
|
|
470
|
-
</dd>
|
|
471
|
-
</dl>
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
</dd>
|
|
475
|
-
</dl>
|
|
476
|
-
</details>
|
|
477
|
-
|
|
478
|
-
<details><summary><code>client.pods.<a href="/src/api/resources/pods/client/Client.ts">get</a>(pod_id) -> AgentMail.Pod</code></summary>
|
|
479
|
-
<dl>
|
|
480
|
-
<dd>
|
|
481
|
-
|
|
482
|
-
#### 📝 Description
|
|
483
|
-
|
|
484
|
-
<dl>
|
|
485
|
-
<dd>
|
|
486
|
-
|
|
487
|
-
<dl>
|
|
488
|
-
<dd>
|
|
489
|
-
|
|
490
|
-
**CLI:**
|
|
491
|
-
```bash
|
|
492
|
-
agentmail pods get --pod-id <pod_id>
|
|
493
|
-
```
|
|
494
|
-
</dd>
|
|
495
|
-
</dl>
|
|
496
|
-
</dd>
|
|
497
|
-
</dl>
|
|
498
|
-
|
|
499
|
-
#### 🔌 Usage
|
|
500
|
-
|
|
501
|
-
<dl>
|
|
502
|
-
<dd>
|
|
503
|
-
|
|
504
|
-
<dl>
|
|
505
|
-
<dd>
|
|
506
|
-
|
|
507
|
-
```typescript
|
|
508
|
-
await client.pods.get("pod_id");
|
|
509
|
-
|
|
510
|
-
```
|
|
511
|
-
</dd>
|
|
512
|
-
</dl>
|
|
513
|
-
</dd>
|
|
514
|
-
</dl>
|
|
515
|
-
|
|
516
|
-
#### ⚙️ Parameters
|
|
517
|
-
|
|
518
|
-
<dl>
|
|
519
|
-
<dd>
|
|
520
462
|
|
|
521
463
|
<dl>
|
|
522
464
|
<dd>
|
|
523
465
|
|
|
524
|
-
**
|
|
466
|
+
**request:** `AgentMail.AuthorizeInboxRequest`
|
|
525
467
|
|
|
526
468
|
</dd>
|
|
527
469
|
</dl>
|
|
@@ -529,7 +471,7 @@ await client.pods.get("pod_id");
|
|
|
529
471
|
<dl>
|
|
530
472
|
<dd>
|
|
531
473
|
|
|
532
|
-
**requestOptions:** `
|
|
474
|
+
**requestOptions:** `InboxesClient.RequestOptions`
|
|
533
475
|
|
|
534
476
|
</dd>
|
|
535
477
|
</dl>
|
|
@@ -541,7 +483,8 @@ await client.pods.get("pod_id");
|
|
|
541
483
|
</dl>
|
|
542
484
|
</details>
|
|
543
485
|
|
|
544
|
-
|
|
486
|
+
## Pods
|
|
487
|
+
<details><summary><code>client.pods.<a href="/src/api/resources/pods/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListPodsResponse</code></summary>
|
|
545
488
|
<dl>
|
|
546
489
|
<dd>
|
|
547
490
|
|
|
@@ -555,7 +498,7 @@ await client.pods.get("pod_id");
|
|
|
555
498
|
|
|
556
499
|
**CLI:**
|
|
557
500
|
```bash
|
|
558
|
-
agentmail pods
|
|
501
|
+
agentmail pods list
|
|
559
502
|
```
|
|
560
503
|
</dd>
|
|
561
504
|
</dl>
|
|
@@ -571,7 +514,7 @@ agentmail pods create --client-id my-pod
|
|
|
571
514
|
<dd>
|
|
572
515
|
|
|
573
516
|
```typescript
|
|
574
|
-
await client.pods.
|
|
517
|
+
await client.pods.list();
|
|
575
518
|
|
|
576
519
|
```
|
|
577
520
|
</dd>
|
|
@@ -587,7 +530,7 @@ await client.pods.create({});
|
|
|
587
530
|
<dl>
|
|
588
531
|
<dd>
|
|
589
532
|
|
|
590
|
-
**request:** `AgentMail.
|
|
533
|
+
**request:** `AgentMail.pods.ListPodsRequest`
|
|
591
534
|
|
|
592
535
|
</dd>
|
|
593
536
|
</dl>
|
|
@@ -607,7 +550,7 @@ await client.pods.create({});
|
|
|
607
550
|
</dl>
|
|
608
551
|
</details>
|
|
609
552
|
|
|
610
|
-
<details><summary><code>client.pods.<a href="/src/api/resources/pods/client/Client.ts">
|
|
553
|
+
<details><summary><code>client.pods.<a href="/src/api/resources/pods/client/Client.ts">get</a>(pod_id) -> AgentMail.Pod</code></summary>
|
|
611
554
|
<dl>
|
|
612
555
|
<dd>
|
|
613
556
|
|
|
@@ -621,7 +564,7 @@ await client.pods.create({});
|
|
|
621
564
|
|
|
622
565
|
**CLI:**
|
|
623
566
|
```bash
|
|
624
|
-
agentmail pods
|
|
567
|
+
agentmail pods get --pod-id <pod_id>
|
|
625
568
|
```
|
|
626
569
|
</dd>
|
|
627
570
|
</dl>
|
|
@@ -637,7 +580,7 @@ agentmail pods delete --pod-id <pod_id>
|
|
|
637
580
|
<dd>
|
|
638
581
|
|
|
639
582
|
```typescript
|
|
640
|
-
await client.pods.
|
|
583
|
+
await client.pods.get("pod_id");
|
|
641
584
|
|
|
642
585
|
```
|
|
643
586
|
</dd>
|
|
@@ -673,8 +616,7 @@ await client.pods.delete("pod_id");
|
|
|
673
616
|
</dl>
|
|
674
617
|
</details>
|
|
675
618
|
|
|
676
|
-
|
|
677
|
-
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListWebhooksResponse</code></summary>
|
|
619
|
+
<details><summary><code>client.pods.<a href="/src/api/resources/pods/client/Client.ts">create</a>({ ...params }) -> AgentMail.Pod</code></summary>
|
|
678
620
|
<dl>
|
|
679
621
|
<dd>
|
|
680
622
|
|
|
@@ -688,7 +630,7 @@ await client.pods.delete("pod_id");
|
|
|
688
630
|
|
|
689
631
|
**CLI:**
|
|
690
632
|
```bash
|
|
691
|
-
agentmail
|
|
633
|
+
agentmail pods create --client-id my-pod
|
|
692
634
|
```
|
|
693
635
|
</dd>
|
|
694
636
|
</dl>
|
|
@@ -704,7 +646,7 @@ agentmail webhooks list
|
|
|
704
646
|
<dd>
|
|
705
647
|
|
|
706
648
|
```typescript
|
|
707
|
-
await client.
|
|
649
|
+
await client.pods.create({});
|
|
708
650
|
|
|
709
651
|
```
|
|
710
652
|
</dd>
|
|
@@ -720,7 +662,7 @@ await client.webhooks.list();
|
|
|
720
662
|
<dl>
|
|
721
663
|
<dd>
|
|
722
664
|
|
|
723
|
-
**request:** `AgentMail.
|
|
665
|
+
**request:** `AgentMail.CreatePodRequest`
|
|
724
666
|
|
|
725
667
|
</dd>
|
|
726
668
|
</dl>
|
|
@@ -728,7 +670,7 @@ await client.webhooks.list();
|
|
|
728
670
|
<dl>
|
|
729
671
|
<dd>
|
|
730
672
|
|
|
731
|
-
**requestOptions:** `
|
|
673
|
+
**requestOptions:** `PodsClient.RequestOptions`
|
|
732
674
|
|
|
733
675
|
</dd>
|
|
734
676
|
</dl>
|
|
@@ -740,7 +682,7 @@ await client.webhooks.list();
|
|
|
740
682
|
</dl>
|
|
741
683
|
</details>
|
|
742
684
|
|
|
743
|
-
<details><summary><code>client.
|
|
685
|
+
<details><summary><code>client.pods.<a href="/src/api/resources/pods/client/Client.ts">delete</a>(pod_id) -> void</code></summary>
|
|
744
686
|
<dl>
|
|
745
687
|
<dd>
|
|
746
688
|
|
|
@@ -754,77 +696,13 @@ await client.webhooks.list();
|
|
|
754
696
|
|
|
755
697
|
**CLI:**
|
|
756
698
|
```bash
|
|
757
|
-
agentmail
|
|
758
|
-
```
|
|
759
|
-
</dd>
|
|
760
|
-
</dl>
|
|
761
|
-
</dd>
|
|
762
|
-
</dl>
|
|
763
|
-
|
|
764
|
-
#### 🔌 Usage
|
|
765
|
-
|
|
766
|
-
<dl>
|
|
767
|
-
<dd>
|
|
768
|
-
|
|
769
|
-
<dl>
|
|
770
|
-
<dd>
|
|
771
|
-
|
|
772
|
-
```typescript
|
|
773
|
-
await client.webhooks.get("webhook_id");
|
|
774
|
-
|
|
699
|
+
agentmail pods delete --pod-id <pod_id>
|
|
775
700
|
```
|
|
776
701
|
</dd>
|
|
777
702
|
</dl>
|
|
778
703
|
</dd>
|
|
779
704
|
</dl>
|
|
780
705
|
|
|
781
|
-
#### ⚙️ Parameters
|
|
782
|
-
|
|
783
|
-
<dl>
|
|
784
|
-
<dd>
|
|
785
|
-
|
|
786
|
-
<dl>
|
|
787
|
-
<dd>
|
|
788
|
-
|
|
789
|
-
**webhook_id:** `AgentMail.WebhookId`
|
|
790
|
-
|
|
791
|
-
</dd>
|
|
792
|
-
</dl>
|
|
793
|
-
|
|
794
|
-
<dl>
|
|
795
|
-
<dd>
|
|
796
|
-
|
|
797
|
-
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
798
|
-
|
|
799
|
-
</dd>
|
|
800
|
-
</dl>
|
|
801
|
-
</dd>
|
|
802
|
-
</dl>
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
</dd>
|
|
806
|
-
</dl>
|
|
807
|
-
</details>
|
|
808
|
-
|
|
809
|
-
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getHeaders</a>(webhook_id) -> AgentMail.WebhookHeaderNamesResponse</code></summary>
|
|
810
|
-
<dl>
|
|
811
|
-
<dd>
|
|
812
|
-
|
|
813
|
-
#### 📝 Description
|
|
814
|
-
|
|
815
|
-
<dl>
|
|
816
|
-
<dd>
|
|
817
|
-
|
|
818
|
-
<dl>
|
|
819
|
-
<dd>
|
|
820
|
-
|
|
821
|
-
List the names of custom HTTP headers included with deliveries to this webhook. Header values are
|
|
822
|
-
write-only and are never returned.
|
|
823
|
-
</dd>
|
|
824
|
-
</dl>
|
|
825
|
-
</dd>
|
|
826
|
-
</dl>
|
|
827
|
-
|
|
828
706
|
#### 🔌 Usage
|
|
829
707
|
|
|
830
708
|
<dl>
|
|
@@ -834,7 +712,7 @@ write-only and are never returned.
|
|
|
834
712
|
<dd>
|
|
835
713
|
|
|
836
714
|
```typescript
|
|
837
|
-
await client.
|
|
715
|
+
await client.pods.delete("pod_id");
|
|
838
716
|
|
|
839
717
|
```
|
|
840
718
|
</dd>
|
|
@@ -850,7 +728,7 @@ await client.webhooks.getHeaders("webhook_id");
|
|
|
850
728
|
<dl>
|
|
851
729
|
<dd>
|
|
852
730
|
|
|
853
|
-
**
|
|
731
|
+
**pod_id:** `AgentMail.PodId`
|
|
854
732
|
|
|
855
733
|
</dd>
|
|
856
734
|
</dl>
|
|
@@ -858,7 +736,7 @@ await client.webhooks.getHeaders("webhook_id");
|
|
|
858
736
|
<dl>
|
|
859
737
|
<dd>
|
|
860
738
|
|
|
861
|
-
**requestOptions:** `
|
|
739
|
+
**requestOptions:** `PodsClient.RequestOptions`
|
|
862
740
|
|
|
863
741
|
</dd>
|
|
864
742
|
</dl>
|
|
@@ -870,7 +748,8 @@ await client.webhooks.getHeaders("webhook_id");
|
|
|
870
748
|
</dl>
|
|
871
749
|
</details>
|
|
872
750
|
|
|
873
|
-
|
|
751
|
+
## Webhooks
|
|
752
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListWebhooksResponse</code></summary>
|
|
874
753
|
<dl>
|
|
875
754
|
<dd>
|
|
876
755
|
|
|
@@ -884,7 +763,7 @@ await client.webhooks.getHeaders("webhook_id");
|
|
|
884
763
|
|
|
885
764
|
**CLI:**
|
|
886
765
|
```bash
|
|
887
|
-
agentmail webhooks
|
|
766
|
+
agentmail webhooks list
|
|
888
767
|
```
|
|
889
768
|
</dd>
|
|
890
769
|
</dl>
|
|
@@ -900,10 +779,7 @@ agentmail webhooks create --url https://example.com/webhook --event-types messag
|
|
|
900
779
|
<dd>
|
|
901
780
|
|
|
902
781
|
```typescript
|
|
903
|
-
await client.webhooks.
|
|
904
|
-
url: "url",
|
|
905
|
-
eventTypes: ["message.received", "message.received"]
|
|
906
|
-
});
|
|
782
|
+
await client.webhooks.list();
|
|
907
783
|
|
|
908
784
|
```
|
|
909
785
|
</dd>
|
|
@@ -919,7 +795,7 @@ await client.webhooks.create({
|
|
|
919
795
|
<dl>
|
|
920
796
|
<dd>
|
|
921
797
|
|
|
922
|
-
**request:** `AgentMail.
|
|
798
|
+
**request:** `AgentMail.webhooks.ListWebhooksRequest`
|
|
923
799
|
|
|
924
800
|
</dd>
|
|
925
801
|
</dl>
|
|
@@ -939,7 +815,7 @@ await client.webhooks.create({
|
|
|
939
815
|
</dl>
|
|
940
816
|
</details>
|
|
941
817
|
|
|
942
|
-
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">
|
|
818
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">get</a>(webhook_id) -> AgentMail.Webhook</code></summary>
|
|
943
819
|
<dl>
|
|
944
820
|
<dd>
|
|
945
821
|
|
|
@@ -951,12 +827,9 @@ await client.webhooks.create({
|
|
|
951
827
|
<dl>
|
|
952
828
|
<dd>
|
|
953
829
|
|
|
954
|
-
Update inbox or pod subscriptions, or replace the webhook's `event_types` in full when you pass a
|
|
955
|
-
non-empty `event_types` array (see request field docs). Inbox and pod changes use add/remove lists.
|
|
956
|
-
|
|
957
830
|
**CLI:**
|
|
958
831
|
```bash
|
|
959
|
-
agentmail webhooks
|
|
832
|
+
agentmail webhooks get --webhook-id <webhook_id>
|
|
960
833
|
```
|
|
961
834
|
</dd>
|
|
962
835
|
</dl>
|
|
@@ -972,7 +845,7 @@ agentmail webhooks update --webhook-id <webhook_id> --add-inbox-ids <inbox_id>
|
|
|
972
845
|
<dd>
|
|
973
846
|
|
|
974
847
|
```typescript
|
|
975
|
-
await client.webhooks.
|
|
848
|
+
await client.webhooks.get("webhook_id");
|
|
976
849
|
|
|
977
850
|
```
|
|
978
851
|
</dd>
|
|
@@ -996,14 +869,6 @@ await client.webhooks.update("webhook_id", {});
|
|
|
996
869
|
<dl>
|
|
997
870
|
<dd>
|
|
998
871
|
|
|
999
|
-
**request:** `AgentMail.UpdateWebhookRequest`
|
|
1000
|
-
|
|
1001
|
-
</dd>
|
|
1002
|
-
</dl>
|
|
1003
|
-
|
|
1004
|
-
<dl>
|
|
1005
|
-
<dd>
|
|
1006
|
-
|
|
1007
872
|
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1008
873
|
|
|
1009
874
|
</dd>
|
|
@@ -1016,7 +881,7 @@ await client.webhooks.update("webhook_id", {});
|
|
|
1016
881
|
</dl>
|
|
1017
882
|
</details>
|
|
1018
883
|
|
|
1019
|
-
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">
|
|
884
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getHeaders</a>(webhook_id) -> AgentMail.WebhookHeaderNamesResponse</code></summary>
|
|
1020
885
|
<dl>
|
|
1021
886
|
<dd>
|
|
1022
887
|
|
|
@@ -1028,8 +893,8 @@ await client.webhooks.update("webhook_id", {});
|
|
|
1028
893
|
<dl>
|
|
1029
894
|
<dd>
|
|
1030
895
|
|
|
1031
|
-
|
|
1032
|
-
|
|
896
|
+
List the names of custom HTTP headers included with deliveries to this webhook. Header values are
|
|
897
|
+
write-only and are never returned.
|
|
1033
898
|
</dd>
|
|
1034
899
|
</dl>
|
|
1035
900
|
</dd>
|
|
@@ -1044,7 +909,7 @@ Header values remain write-only.
|
|
|
1044
909
|
<dd>
|
|
1045
910
|
|
|
1046
911
|
```typescript
|
|
1047
|
-
await client.webhooks.
|
|
912
|
+
await client.webhooks.getHeaders("webhook_id");
|
|
1048
913
|
|
|
1049
914
|
```
|
|
1050
915
|
</dd>
|
|
@@ -1068,14 +933,6 @@ await client.webhooks.updateHeaders("webhook_id", {});
|
|
|
1068
933
|
<dl>
|
|
1069
934
|
<dd>
|
|
1070
935
|
|
|
1071
|
-
**request:** `AgentMail.UpdateWebhookHeadersRequest`
|
|
1072
|
-
|
|
1073
|
-
</dd>
|
|
1074
|
-
</dl>
|
|
1075
|
-
|
|
1076
|
-
<dl>
|
|
1077
|
-
<dd>
|
|
1078
|
-
|
|
1079
936
|
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1080
937
|
|
|
1081
938
|
</dd>
|
|
@@ -1088,7 +945,7 @@ await client.webhooks.updateHeaders("webhook_id", {});
|
|
|
1088
945
|
</dl>
|
|
1089
946
|
</details>
|
|
1090
947
|
|
|
1091
|
-
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">
|
|
948
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">create</a>({ ...params }) -> AgentMail.Webhook</code></summary>
|
|
1092
949
|
<dl>
|
|
1093
950
|
<dd>
|
|
1094
951
|
|
|
@@ -1102,7 +959,7 @@ await client.webhooks.updateHeaders("webhook_id", {});
|
|
|
1102
959
|
|
|
1103
960
|
**CLI:**
|
|
1104
961
|
```bash
|
|
1105
|
-
agentmail webhooks
|
|
962
|
+
agentmail webhooks create --url https://example.com/webhook --event-types message.received
|
|
1106
963
|
```
|
|
1107
964
|
</dd>
|
|
1108
965
|
</dl>
|
|
@@ -1118,271 +975,9 @@ agentmail webhooks delete --webhook-id <webhook_id>
|
|
|
1118
975
|
<dd>
|
|
1119
976
|
|
|
1120
977
|
```typescript
|
|
1121
|
-
await client.webhooks.
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
</dd>
|
|
1125
|
-
</dl>
|
|
1126
|
-
</dd>
|
|
1127
|
-
</dl>
|
|
1128
|
-
|
|
1129
|
-
#### ⚙️ Parameters
|
|
1130
|
-
|
|
1131
|
-
<dl>
|
|
1132
|
-
<dd>
|
|
1133
|
-
|
|
1134
|
-
<dl>
|
|
1135
|
-
<dd>
|
|
1136
|
-
|
|
1137
|
-
**webhook_id:** `AgentMail.WebhookId`
|
|
1138
|
-
|
|
1139
|
-
</dd>
|
|
1140
|
-
</dl>
|
|
1141
|
-
|
|
1142
|
-
<dl>
|
|
1143
|
-
<dd>
|
|
1144
|
-
|
|
1145
|
-
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1146
|
-
|
|
1147
|
-
</dd>
|
|
1148
|
-
</dl>
|
|
1149
|
-
</dd>
|
|
1150
|
-
</dl>
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
</dd>
|
|
1154
|
-
</dl>
|
|
1155
|
-
</details>
|
|
1156
|
-
|
|
1157
|
-
## Accounts
|
|
1158
|
-
<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListAccountsResponse</code></summary>
|
|
1159
|
-
<dl>
|
|
1160
|
-
<dd>
|
|
1161
|
-
|
|
1162
|
-
#### 📝 Description
|
|
1163
|
-
|
|
1164
|
-
<dl>
|
|
1165
|
-
<dd>
|
|
1166
|
-
|
|
1167
|
-
<dl>
|
|
1168
|
-
<dd>
|
|
1169
|
-
|
|
1170
|
-
Lists accounts across all providers.
|
|
1171
|
-
</dd>
|
|
1172
|
-
</dl>
|
|
1173
|
-
</dd>
|
|
1174
|
-
</dl>
|
|
1175
|
-
|
|
1176
|
-
#### 🔌 Usage
|
|
1177
|
-
|
|
1178
|
-
<dl>
|
|
1179
|
-
<dd>
|
|
1180
|
-
|
|
1181
|
-
<dl>
|
|
1182
|
-
<dd>
|
|
1183
|
-
|
|
1184
|
-
```typescript
|
|
1185
|
-
await client.accounts.list();
|
|
1186
|
-
|
|
1187
|
-
```
|
|
1188
|
-
</dd>
|
|
1189
|
-
</dl>
|
|
1190
|
-
</dd>
|
|
1191
|
-
</dl>
|
|
1192
|
-
|
|
1193
|
-
#### ⚙️ Parameters
|
|
1194
|
-
|
|
1195
|
-
<dl>
|
|
1196
|
-
<dd>
|
|
1197
|
-
|
|
1198
|
-
<dl>
|
|
1199
|
-
<dd>
|
|
1200
|
-
|
|
1201
|
-
**request:** `AgentMail.ListAccountsRequest`
|
|
1202
|
-
|
|
1203
|
-
</dd>
|
|
1204
|
-
</dl>
|
|
1205
|
-
|
|
1206
|
-
<dl>
|
|
1207
|
-
<dd>
|
|
1208
|
-
|
|
1209
|
-
**requestOptions:** `AccountsClient.RequestOptions`
|
|
1210
|
-
|
|
1211
|
-
</dd>
|
|
1212
|
-
</dl>
|
|
1213
|
-
</dd>
|
|
1214
|
-
</dl>
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
</dd>
|
|
1218
|
-
</dl>
|
|
1219
|
-
</details>
|
|
1220
|
-
|
|
1221
|
-
<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">get</a>(account_id) -> AgentMail.Account</code></summary>
|
|
1222
|
-
<dl>
|
|
1223
|
-
<dd>
|
|
1224
|
-
|
|
1225
|
-
#### 🔌 Usage
|
|
1226
|
-
|
|
1227
|
-
<dl>
|
|
1228
|
-
<dd>
|
|
1229
|
-
|
|
1230
|
-
<dl>
|
|
1231
|
-
<dd>
|
|
1232
|
-
|
|
1233
|
-
```typescript
|
|
1234
|
-
await client.accounts.get("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
1235
|
-
|
|
1236
|
-
```
|
|
1237
|
-
</dd>
|
|
1238
|
-
</dl>
|
|
1239
|
-
</dd>
|
|
1240
|
-
</dl>
|
|
1241
|
-
|
|
1242
|
-
#### ⚙️ Parameters
|
|
1243
|
-
|
|
1244
|
-
<dl>
|
|
1245
|
-
<dd>
|
|
1246
|
-
|
|
1247
|
-
<dl>
|
|
1248
|
-
<dd>
|
|
1249
|
-
|
|
1250
|
-
**account_id:** `AgentMail.AccountId`
|
|
1251
|
-
|
|
1252
|
-
</dd>
|
|
1253
|
-
</dl>
|
|
1254
|
-
|
|
1255
|
-
<dl>
|
|
1256
|
-
<dd>
|
|
1257
|
-
|
|
1258
|
-
**requestOptions:** `AccountsClient.RequestOptions`
|
|
1259
|
-
|
|
1260
|
-
</dd>
|
|
1261
|
-
</dl>
|
|
1262
|
-
</dd>
|
|
1263
|
-
</dl>
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
</dd>
|
|
1267
|
-
</dl>
|
|
1268
|
-
</details>
|
|
1269
|
-
|
|
1270
|
-
## Agent
|
|
1271
|
-
<details><summary><code>client.agent.<a href="/src/api/resources/agent/client/Client.ts">signUp</a>({ ...params }) -> AgentMail.AgentSignupResponse</code></summary>
|
|
1272
|
-
<dl>
|
|
1273
|
-
<dd>
|
|
1274
|
-
|
|
1275
|
-
#### 📝 Description
|
|
1276
|
-
|
|
1277
|
-
<dl>
|
|
1278
|
-
<dd>
|
|
1279
|
-
|
|
1280
|
-
<dl>
|
|
1281
|
-
<dd>
|
|
1282
|
-
|
|
1283
|
-
Create a new agent organization with an inbox and API key. This endpoint is for signing up for the first time. If you've already signed up, you're all set — just use your existing API key.
|
|
1284
|
-
|
|
1285
|
-
A 6-digit OTP is sent to the human's email for verification.
|
|
1286
|
-
|
|
1287
|
-
This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
|
|
1288
|
-
|
|
1289
|
-
The returned API key has limited permissions until the organization is verified via the verify endpoint.
|
|
1290
|
-
|
|
1291
|
-
**CLI:**
|
|
1292
|
-
```bash
|
|
1293
|
-
agentmail agent sign-up --human-email user@example.com --username my-agent
|
|
1294
|
-
```
|
|
1295
|
-
</dd>
|
|
1296
|
-
</dl>
|
|
1297
|
-
</dd>
|
|
1298
|
-
</dl>
|
|
1299
|
-
|
|
1300
|
-
#### 🔌 Usage
|
|
1301
|
-
|
|
1302
|
-
<dl>
|
|
1303
|
-
<dd>
|
|
1304
|
-
|
|
1305
|
-
<dl>
|
|
1306
|
-
<dd>
|
|
1307
|
-
|
|
1308
|
-
```typescript
|
|
1309
|
-
await client.agent.signUp({
|
|
1310
|
-
humanEmail: "human_email",
|
|
1311
|
-
username: "username"
|
|
1312
|
-
});
|
|
1313
|
-
|
|
1314
|
-
```
|
|
1315
|
-
</dd>
|
|
1316
|
-
</dl>
|
|
1317
|
-
</dd>
|
|
1318
|
-
</dl>
|
|
1319
|
-
|
|
1320
|
-
#### ⚙️ Parameters
|
|
1321
|
-
|
|
1322
|
-
<dl>
|
|
1323
|
-
<dd>
|
|
1324
|
-
|
|
1325
|
-
<dl>
|
|
1326
|
-
<dd>
|
|
1327
|
-
|
|
1328
|
-
**request:** `AgentMail.AgentSignupRequest`
|
|
1329
|
-
|
|
1330
|
-
</dd>
|
|
1331
|
-
</dl>
|
|
1332
|
-
|
|
1333
|
-
<dl>
|
|
1334
|
-
<dd>
|
|
1335
|
-
|
|
1336
|
-
**requestOptions:** `AgentClient.RequestOptions`
|
|
1337
|
-
|
|
1338
|
-
</dd>
|
|
1339
|
-
</dl>
|
|
1340
|
-
</dd>
|
|
1341
|
-
</dl>
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
</dd>
|
|
1345
|
-
</dl>
|
|
1346
|
-
</details>
|
|
1347
|
-
|
|
1348
|
-
<details><summary><code>client.agent.<a href="/src/api/resources/agent/client/Client.ts">verify</a>({ ...params }) -> AgentMail.AgentVerifyResponse</code></summary>
|
|
1349
|
-
<dl>
|
|
1350
|
-
<dd>
|
|
1351
|
-
|
|
1352
|
-
#### 📝 Description
|
|
1353
|
-
|
|
1354
|
-
<dl>
|
|
1355
|
-
<dd>
|
|
1356
|
-
|
|
1357
|
-
<dl>
|
|
1358
|
-
<dd>
|
|
1359
|
-
|
|
1360
|
-
Verify an agent organization using the 6-digit OTP sent to the human's email during sign-up.
|
|
1361
|
-
|
|
1362
|
-
On success, the organization is upgraded from `agent_unverified` to `agent_verified`, the send allowlist is removed, and free plan entitlements are applied.
|
|
1363
|
-
|
|
1364
|
-
The OTP expires after 24 hours and allows a maximum of 10 attempts. If you run into any difficulties receiving the OTP code, you can also create an account on [console.agentmail.to](https://console.agentmail.to) using the human email address you provided to verify your account.
|
|
1365
|
-
|
|
1366
|
-
**CLI:**
|
|
1367
|
-
```bash
|
|
1368
|
-
agentmail agent verify --otp-code 123456
|
|
1369
|
-
```
|
|
1370
|
-
</dd>
|
|
1371
|
-
</dl>
|
|
1372
|
-
</dd>
|
|
1373
|
-
</dl>
|
|
1374
|
-
|
|
1375
|
-
#### 🔌 Usage
|
|
1376
|
-
|
|
1377
|
-
<dl>
|
|
1378
|
-
<dd>
|
|
1379
|
-
|
|
1380
|
-
<dl>
|
|
1381
|
-
<dd>
|
|
1382
|
-
|
|
1383
|
-
```typescript
|
|
1384
|
-
await client.agent.verify({
|
|
1385
|
-
otpCode: "otp_code"
|
|
978
|
+
await client.webhooks.create({
|
|
979
|
+
url: "url",
|
|
980
|
+
eventTypes: ["message.received", "message.received"]
|
|
1386
981
|
});
|
|
1387
982
|
|
|
1388
983
|
```
|
|
@@ -1399,140 +994,7 @@ await client.agent.verify({
|
|
|
1399
994
|
<dl>
|
|
1400
995
|
<dd>
|
|
1401
996
|
|
|
1402
|
-
**request:** `AgentMail.
|
|
1403
|
-
|
|
1404
|
-
</dd>
|
|
1405
|
-
</dl>
|
|
1406
|
-
|
|
1407
|
-
<dl>
|
|
1408
|
-
<dd>
|
|
1409
|
-
|
|
1410
|
-
**requestOptions:** `AgentClient.RequestOptions`
|
|
1411
|
-
|
|
1412
|
-
</dd>
|
|
1413
|
-
</dl>
|
|
1414
|
-
</dd>
|
|
1415
|
-
</dl>
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
</dd>
|
|
1419
|
-
</dl>
|
|
1420
|
-
</details>
|
|
1421
|
-
|
|
1422
|
-
## ApiKeys
|
|
1423
|
-
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListApiKeysResponse</code></summary>
|
|
1424
|
-
<dl>
|
|
1425
|
-
<dd>
|
|
1426
|
-
|
|
1427
|
-
#### 📝 Description
|
|
1428
|
-
|
|
1429
|
-
<dl>
|
|
1430
|
-
<dd>
|
|
1431
|
-
|
|
1432
|
-
<dl>
|
|
1433
|
-
<dd>
|
|
1434
|
-
|
|
1435
|
-
**CLI:**
|
|
1436
|
-
```bash
|
|
1437
|
-
agentmail api-keys list
|
|
1438
|
-
```
|
|
1439
|
-
</dd>
|
|
1440
|
-
</dl>
|
|
1441
|
-
</dd>
|
|
1442
|
-
</dl>
|
|
1443
|
-
|
|
1444
|
-
#### 🔌 Usage
|
|
1445
|
-
|
|
1446
|
-
<dl>
|
|
1447
|
-
<dd>
|
|
1448
|
-
|
|
1449
|
-
<dl>
|
|
1450
|
-
<dd>
|
|
1451
|
-
|
|
1452
|
-
```typescript
|
|
1453
|
-
await client.apiKeys.list();
|
|
1454
|
-
|
|
1455
|
-
```
|
|
1456
|
-
</dd>
|
|
1457
|
-
</dl>
|
|
1458
|
-
</dd>
|
|
1459
|
-
</dl>
|
|
1460
|
-
|
|
1461
|
-
#### ⚙️ Parameters
|
|
1462
|
-
|
|
1463
|
-
<dl>
|
|
1464
|
-
<dd>
|
|
1465
|
-
|
|
1466
|
-
<dl>
|
|
1467
|
-
<dd>
|
|
1468
|
-
|
|
1469
|
-
**request:** `AgentMail.ListApiKeysRequest`
|
|
1470
|
-
|
|
1471
|
-
</dd>
|
|
1472
|
-
</dl>
|
|
1473
|
-
|
|
1474
|
-
<dl>
|
|
1475
|
-
<dd>
|
|
1476
|
-
|
|
1477
|
-
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
1478
|
-
|
|
1479
|
-
</dd>
|
|
1480
|
-
</dl>
|
|
1481
|
-
</dd>
|
|
1482
|
-
</dl>
|
|
1483
|
-
|
|
1484
|
-
|
|
1485
|
-
</dd>
|
|
1486
|
-
</dl>
|
|
1487
|
-
</details>
|
|
1488
|
-
|
|
1489
|
-
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">create</a>({ ...params }) -> AgentMail.CreateApiKeyResponse</code></summary>
|
|
1490
|
-
<dl>
|
|
1491
|
-
<dd>
|
|
1492
|
-
|
|
1493
|
-
#### 📝 Description
|
|
1494
|
-
|
|
1495
|
-
<dl>
|
|
1496
|
-
<dd>
|
|
1497
|
-
|
|
1498
|
-
<dl>
|
|
1499
|
-
<dd>
|
|
1500
|
-
|
|
1501
|
-
**CLI:**
|
|
1502
|
-
```bash
|
|
1503
|
-
agentmail api-keys create --name "My Key"
|
|
1504
|
-
```
|
|
1505
|
-
</dd>
|
|
1506
|
-
</dl>
|
|
1507
|
-
</dd>
|
|
1508
|
-
</dl>
|
|
1509
|
-
|
|
1510
|
-
#### 🔌 Usage
|
|
1511
|
-
|
|
1512
|
-
<dl>
|
|
1513
|
-
<dd>
|
|
1514
|
-
|
|
1515
|
-
<dl>
|
|
1516
|
-
<dd>
|
|
1517
|
-
|
|
1518
|
-
```typescript
|
|
1519
|
-
await client.apiKeys.create({});
|
|
1520
|
-
|
|
1521
|
-
```
|
|
1522
|
-
</dd>
|
|
1523
|
-
</dl>
|
|
1524
|
-
</dd>
|
|
1525
|
-
</dl>
|
|
1526
|
-
|
|
1527
|
-
#### ⚙️ Parameters
|
|
1528
|
-
|
|
1529
|
-
<dl>
|
|
1530
|
-
<dd>
|
|
1531
|
-
|
|
1532
|
-
<dl>
|
|
1533
|
-
<dd>
|
|
1534
|
-
|
|
1535
|
-
**request:** `AgentMail.CreateApiKeyRequest`
|
|
997
|
+
**request:** `AgentMail.CreateWebhookRequest`
|
|
1536
998
|
|
|
1537
999
|
</dd>
|
|
1538
1000
|
</dl>
|
|
@@ -1540,7 +1002,7 @@ await client.apiKeys.create({});
|
|
|
1540
1002
|
<dl>
|
|
1541
1003
|
<dd>
|
|
1542
1004
|
|
|
1543
|
-
**requestOptions:** `
|
|
1005
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1544
1006
|
|
|
1545
1007
|
</dd>
|
|
1546
1008
|
</dl>
|
|
@@ -1552,7 +1014,7 @@ await client.apiKeys.create({});
|
|
|
1552
1014
|
</dl>
|
|
1553
1015
|
</details>
|
|
1554
1016
|
|
|
1555
|
-
<details><summary><code>client.
|
|
1017
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">update</a>(webhook_id, { ...params }) -> AgentMail.Webhook</code></summary>
|
|
1556
1018
|
<dl>
|
|
1557
1019
|
<dd>
|
|
1558
1020
|
|
|
@@ -1564,9 +1026,12 @@ await client.apiKeys.create({});
|
|
|
1564
1026
|
<dl>
|
|
1565
1027
|
<dd>
|
|
1566
1028
|
|
|
1029
|
+
Update inbox or pod subscriptions, or replace the webhook's `event_types` in full when you pass a
|
|
1030
|
+
non-empty `event_types` array (see request field docs). Inbox and pod changes use add/remove lists.
|
|
1031
|
+
|
|
1567
1032
|
**CLI:**
|
|
1568
1033
|
```bash
|
|
1569
|
-
agentmail
|
|
1034
|
+
agentmail webhooks update --webhook-id <webhook_id> --add-inbox-ids <inbox_id>
|
|
1570
1035
|
```
|
|
1571
1036
|
</dd>
|
|
1572
1037
|
</dl>
|
|
@@ -1582,7 +1047,7 @@ agentmail api-keys delete --api-key-id <api_key_id>
|
|
|
1582
1047
|
<dd>
|
|
1583
1048
|
|
|
1584
1049
|
```typescript
|
|
1585
|
-
await client.
|
|
1050
|
+
await client.webhooks.update("webhook_id", {});
|
|
1586
1051
|
|
|
1587
1052
|
```
|
|
1588
1053
|
</dd>
|
|
@@ -1598,7 +1063,7 @@ await client.apiKeys.delete("api_key_id");
|
|
|
1598
1063
|
<dl>
|
|
1599
1064
|
<dd>
|
|
1600
1065
|
|
|
1601
|
-
**
|
|
1066
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
1602
1067
|
|
|
1603
1068
|
</dd>
|
|
1604
1069
|
</dl>
|
|
@@ -1606,7 +1071,15 @@ await client.apiKeys.delete("api_key_id");
|
|
|
1606
1071
|
<dl>
|
|
1607
1072
|
<dd>
|
|
1608
1073
|
|
|
1609
|
-
**
|
|
1074
|
+
**request:** `AgentMail.UpdateWebhookRequest`
|
|
1075
|
+
|
|
1076
|
+
</dd>
|
|
1077
|
+
</dl>
|
|
1078
|
+
|
|
1079
|
+
<dl>
|
|
1080
|
+
<dd>
|
|
1081
|
+
|
|
1082
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1610
1083
|
|
|
1611
1084
|
</dd>
|
|
1612
1085
|
</dl>
|
|
@@ -1618,7 +1091,7 @@ await client.apiKeys.delete("api_key_id");
|
|
|
1618
1091
|
</dl>
|
|
1619
1092
|
</details>
|
|
1620
1093
|
|
|
1621
|
-
<details><summary><code>client.
|
|
1094
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">updateHeaders</a>(webhook_id, { ...params }) -> void</code></summary>
|
|
1622
1095
|
<dl>
|
|
1623
1096
|
<dd>
|
|
1624
1097
|
|
|
@@ -1630,9 +1103,8 @@ await client.apiKeys.delete("api_key_id");
|
|
|
1630
1103
|
<dl>
|
|
1631
1104
|
<dd>
|
|
1632
1105
|
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
share storage and pagination indexes. Requires `api_key_read`.
|
|
1106
|
+
Atomically set, replace, or remove custom HTTP headers included with deliveries to this webhook.
|
|
1107
|
+
Header values remain write-only.
|
|
1636
1108
|
</dd>
|
|
1637
1109
|
</dl>
|
|
1638
1110
|
</dd>
|
|
@@ -1647,7 +1119,7 @@ share storage and pagination indexes. Requires `api_key_read`.
|
|
|
1647
1119
|
<dd>
|
|
1648
1120
|
|
|
1649
1121
|
```typescript
|
|
1650
|
-
await client.
|
|
1122
|
+
await client.webhooks.updateHeaders("webhook_id", {});
|
|
1651
1123
|
|
|
1652
1124
|
```
|
|
1653
1125
|
</dd>
|
|
@@ -1663,7 +1135,7 @@ await client.apiKeys.listPublicKeys();
|
|
|
1663
1135
|
<dl>
|
|
1664
1136
|
<dd>
|
|
1665
1137
|
|
|
1666
|
-
**
|
|
1138
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
1667
1139
|
|
|
1668
1140
|
</dd>
|
|
1669
1141
|
</dl>
|
|
@@ -1671,7 +1143,15 @@ await client.apiKeys.listPublicKeys();
|
|
|
1671
1143
|
<dl>
|
|
1672
1144
|
<dd>
|
|
1673
1145
|
|
|
1674
|
-
**
|
|
1146
|
+
**request:** `AgentMail.UpdateWebhookHeadersRequest`
|
|
1147
|
+
|
|
1148
|
+
</dd>
|
|
1149
|
+
</dl>
|
|
1150
|
+
|
|
1151
|
+
<dl>
|
|
1152
|
+
<dd>
|
|
1153
|
+
|
|
1154
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1675
1155
|
|
|
1676
1156
|
</dd>
|
|
1677
1157
|
</dl>
|
|
@@ -1683,7 +1163,7 @@ await client.apiKeys.listPublicKeys();
|
|
|
1683
1163
|
</dl>
|
|
1684
1164
|
</details>
|
|
1685
1165
|
|
|
1686
|
-
<details><summary><code>client.
|
|
1166
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">delete</a>(webhook_id) -> void</code></summary>
|
|
1687
1167
|
<dl>
|
|
1688
1168
|
<dd>
|
|
1689
1169
|
|
|
@@ -1695,10 +1175,10 @@ await client.apiKeys.listPublicKeys();
|
|
|
1695
1175
|
<dl>
|
|
1696
1176
|
<dd>
|
|
1697
1177
|
|
|
1698
|
-
|
|
1699
|
-
|
|
1700
|
-
|
|
1701
|
-
|
|
1178
|
+
**CLI:**
|
|
1179
|
+
```bash
|
|
1180
|
+
agentmail webhooks delete --webhook-id <webhook_id>
|
|
1181
|
+
```
|
|
1702
1182
|
</dd>
|
|
1703
1183
|
</dl>
|
|
1704
1184
|
</dd>
|
|
@@ -1713,14 +1193,7 @@ The private key must never be sent to AgentMail.
|
|
|
1713
1193
|
<dd>
|
|
1714
1194
|
|
|
1715
1195
|
```typescript
|
|
1716
|
-
await client.
|
|
1717
|
-
publicKey: {
|
|
1718
|
-
kty: "EC",
|
|
1719
|
-
crv: "P-256",
|
|
1720
|
-
x: "blackcurrant...............................",
|
|
1721
|
-
y: "blackcurrant..............................."
|
|
1722
|
-
}
|
|
1723
|
-
});
|
|
1196
|
+
await client.webhooks.delete("webhook_id");
|
|
1724
1197
|
|
|
1725
1198
|
```
|
|
1726
1199
|
</dd>
|
|
@@ -1736,7 +1209,7 @@ await client.apiKeys.createPublicKey({
|
|
|
1736
1209
|
<dl>
|
|
1737
1210
|
<dd>
|
|
1738
1211
|
|
|
1739
|
-
**
|
|
1212
|
+
**webhook_id:** `AgentMail.WebhookId`
|
|
1740
1213
|
|
|
1741
1214
|
</dd>
|
|
1742
1215
|
</dl>
|
|
@@ -1744,7 +1217,7 @@ await client.apiKeys.createPublicKey({
|
|
|
1744
1217
|
<dl>
|
|
1745
1218
|
<dd>
|
|
1746
1219
|
|
|
1747
|
-
**requestOptions:** `
|
|
1220
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1748
1221
|
|
|
1749
1222
|
</dd>
|
|
1750
1223
|
</dl>
|
|
@@ -1756,7 +1229,8 @@ await client.apiKeys.createPublicKey({
|
|
|
1756
1229
|
</dl>
|
|
1757
1230
|
</details>
|
|
1758
1231
|
|
|
1759
|
-
|
|
1232
|
+
## Accounts
|
|
1233
|
+
<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListAccountsResponse</code></summary>
|
|
1760
1234
|
<dl>
|
|
1761
1235
|
<dd>
|
|
1762
1236
|
|
|
@@ -1768,8 +1242,7 @@ await client.apiKeys.createPublicKey({
|
|
|
1768
1242
|
<dl>
|
|
1769
1243
|
<dd>
|
|
1770
1244
|
|
|
1771
|
-
|
|
1772
|
-
Requires `api_key_update`.
|
|
1245
|
+
Lists accounts across all providers.
|
|
1773
1246
|
</dd>
|
|
1774
1247
|
</dl>
|
|
1775
1248
|
</dd>
|
|
@@ -1784,9 +1257,7 @@ Requires `api_key_update`.
|
|
|
1784
1257
|
<dd>
|
|
1785
1258
|
|
|
1786
1259
|
```typescript
|
|
1787
|
-
await client.
|
|
1788
|
-
name: "x"
|
|
1789
|
-
});
|
|
1260
|
+
await client.accounts.list();
|
|
1790
1261
|
|
|
1791
1262
|
```
|
|
1792
1263
|
</dd>
|
|
@@ -1802,15 +1273,7 @@ await client.apiKeys.updatePublicKeyName("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
|
|
|
1802
1273
|
<dl>
|
|
1803
1274
|
<dd>
|
|
1804
1275
|
|
|
1805
|
-
**
|
|
1806
|
-
|
|
1807
|
-
</dd>
|
|
1808
|
-
</dl>
|
|
1809
|
-
|
|
1810
|
-
<dl>
|
|
1811
|
-
<dd>
|
|
1812
|
-
|
|
1813
|
-
**request:** `AgentMail.UpdatePublicKeyNameRequest`
|
|
1276
|
+
**request:** `AgentMail.ListAccountsRequest`
|
|
1814
1277
|
|
|
1815
1278
|
</dd>
|
|
1816
1279
|
</dl>
|
|
@@ -1818,7 +1281,7 @@ await client.apiKeys.updatePublicKeyName("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
|
|
|
1818
1281
|
<dl>
|
|
1819
1282
|
<dd>
|
|
1820
1283
|
|
|
1821
|
-
**requestOptions:** `
|
|
1284
|
+
**requestOptions:** `AccountsClient.RequestOptions`
|
|
1822
1285
|
|
|
1823
1286
|
</dd>
|
|
1824
1287
|
</dl>
|
|
@@ -1830,26 +1293,10 @@ await client.apiKeys.updatePublicKeyName("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
|
|
|
1830
1293
|
</dl>
|
|
1831
1294
|
</details>
|
|
1832
1295
|
|
|
1833
|
-
<details><summary><code>client.
|
|
1834
|
-
<dl>
|
|
1835
|
-
<dd>
|
|
1836
|
-
|
|
1837
|
-
#### 📝 Description
|
|
1838
|
-
|
|
1839
|
-
<dl>
|
|
1840
|
-
<dd>
|
|
1841
|
-
|
|
1296
|
+
<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">get</a>(account_id) -> AgentMail.Account</code></summary>
|
|
1842
1297
|
<dl>
|
|
1843
1298
|
<dd>
|
|
1844
1299
|
|
|
1845
|
-
Permanently revoke one public-key credential. This hard-deletes the
|
|
1846
|
-
credential; repeating the request returns not found. Requires
|
|
1847
|
-
`api_key_delete`.
|
|
1848
|
-
</dd>
|
|
1849
|
-
</dl>
|
|
1850
|
-
</dd>
|
|
1851
|
-
</dl>
|
|
1852
|
-
|
|
1853
1300
|
#### 🔌 Usage
|
|
1854
1301
|
|
|
1855
1302
|
<dl>
|
|
@@ -1859,7 +1306,7 @@ credential; repeating the request returns not found. Requires
|
|
|
1859
1306
|
<dd>
|
|
1860
1307
|
|
|
1861
1308
|
```typescript
|
|
1862
|
-
await client.
|
|
1309
|
+
await client.accounts.get("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
1863
1310
|
|
|
1864
1311
|
```
|
|
1865
1312
|
</dd>
|
|
@@ -1875,7 +1322,7 @@ await client.apiKeys.revokePublicKey("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
|
1875
1322
|
<dl>
|
|
1876
1323
|
<dd>
|
|
1877
1324
|
|
|
1878
|
-
**
|
|
1325
|
+
**account_id:** `AgentMail.AccountId`
|
|
1879
1326
|
|
|
1880
1327
|
</dd>
|
|
1881
1328
|
</dl>
|
|
@@ -1883,7 +1330,7 @@ await client.apiKeys.revokePublicKey("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
|
1883
1330
|
<dl>
|
|
1884
1331
|
<dd>
|
|
1885
1332
|
|
|
1886
|
-
**requestOptions:** `
|
|
1333
|
+
**requestOptions:** `AccountsClient.RequestOptions`
|
|
1887
1334
|
|
|
1888
1335
|
</dd>
|
|
1889
1336
|
</dl>
|
|
@@ -1895,7 +1342,8 @@ await client.apiKeys.revokePublicKey("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
|
1895
1342
|
</dl>
|
|
1896
1343
|
</details>
|
|
1897
1344
|
|
|
1898
|
-
|
|
1345
|
+
## Agent
|
|
1346
|
+
<details><summary><code>client.agent.<a href="/src/api/resources/agent/client/Client.ts">signUp</a>({ ...params }) -> AgentMail.AgentSignupResponse</code></summary>
|
|
1899
1347
|
<dl>
|
|
1900
1348
|
<dd>
|
|
1901
1349
|
|
|
@@ -1907,15 +1355,18 @@ await client.apiKeys.revokePublicKey("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
|
1907
1355
|
<dl>
|
|
1908
1356
|
<dd>
|
|
1909
1357
|
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
1358
|
+
Create a new agent organization with an inbox and API key. This endpoint is for signing up for the first time. If you've already signed up, you're all set — just use your existing API key.
|
|
1359
|
+
|
|
1360
|
+
A 6-digit OTP is sent to the human's email for verification.
|
|
1361
|
+
|
|
1362
|
+
This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
|
|
1363
|
+
|
|
1364
|
+
The returned API key has limited permissions until the organization is verified via the verify endpoint.
|
|
1915
1365
|
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
|
|
1366
|
+
**CLI:**
|
|
1367
|
+
```bash
|
|
1368
|
+
agentmail agent sign-up --human-email user@example.com --username my-agent
|
|
1369
|
+
```
|
|
1919
1370
|
</dd>
|
|
1920
1371
|
</dl>
|
|
1921
1372
|
</dd>
|
|
@@ -1930,8 +1381,9 @@ again. A new UUID performs a new generation advance.
|
|
|
1930
1381
|
<dd>
|
|
1931
1382
|
|
|
1932
1383
|
```typescript
|
|
1933
|
-
await client.
|
|
1934
|
-
|
|
1384
|
+
await client.agent.signUp({
|
|
1385
|
+
humanEmail: "human_email",
|
|
1386
|
+
username: "username"
|
|
1935
1387
|
});
|
|
1936
1388
|
|
|
1937
1389
|
```
|
|
@@ -1948,7 +1400,7 @@ await client.apiKeys.revokeAllAgentIdSignInKeys({
|
|
|
1948
1400
|
<dl>
|
|
1949
1401
|
<dd>
|
|
1950
1402
|
|
|
1951
|
-
**request:** `AgentMail.
|
|
1403
|
+
**request:** `AgentMail.AgentSignupRequest`
|
|
1952
1404
|
|
|
1953
1405
|
</dd>
|
|
1954
1406
|
</dl>
|
|
@@ -1956,7 +1408,7 @@ await client.apiKeys.revokeAllAgentIdSignInKeys({
|
|
|
1956
1408
|
<dl>
|
|
1957
1409
|
<dd>
|
|
1958
1410
|
|
|
1959
|
-
**requestOptions:** `
|
|
1411
|
+
**requestOptions:** `AgentClient.RequestOptions`
|
|
1960
1412
|
|
|
1961
1413
|
</dd>
|
|
1962
1414
|
</dl>
|
|
@@ -1968,7 +1420,7 @@ await client.apiKeys.revokeAllAgentIdSignInKeys({
|
|
|
1968
1420
|
</dl>
|
|
1969
1421
|
</details>
|
|
1970
1422
|
|
|
1971
|
-
<details><summary><code>client.
|
|
1423
|
+
<details><summary><code>client.agent.<a href="/src/api/resources/agent/client/Client.ts">verify</a>({ ...params }) -> AgentMail.AgentVerifyResponse</code></summary>
|
|
1972
1424
|
<dl>
|
|
1973
1425
|
<dd>
|
|
1974
1426
|
|
|
@@ -1980,7 +1432,16 @@ await client.apiKeys.revokeAllAgentIdSignInKeys({
|
|
|
1980
1432
|
<dl>
|
|
1981
1433
|
<dd>
|
|
1982
1434
|
|
|
1983
|
-
|
|
1435
|
+
Verify an agent organization using the 6-digit OTP sent to the human's email during sign-up.
|
|
1436
|
+
|
|
1437
|
+
On success, the organization is upgraded from `agent_unverified` to `agent_verified`, the send allowlist is removed, and free plan entitlements are applied.
|
|
1438
|
+
|
|
1439
|
+
The OTP expires after 24 hours and allows a maximum of 10 attempts. If you run into any difficulties receiving the OTP code, you can also create an account on [console.agentmail.to](https://console.agentmail.to) using the human email address you provided to verify your account.
|
|
1440
|
+
|
|
1441
|
+
**CLI:**
|
|
1442
|
+
```bash
|
|
1443
|
+
agentmail agent verify --otp-code 123456
|
|
1444
|
+
```
|
|
1984
1445
|
</dd>
|
|
1985
1446
|
</dl>
|
|
1986
1447
|
</dd>
|
|
@@ -1995,7 +1456,9 @@ List active browser credentials visible to the caller's scope. Requires `api_key
|
|
|
1995
1456
|
<dd>
|
|
1996
1457
|
|
|
1997
1458
|
```typescript
|
|
1998
|
-
await client.
|
|
1459
|
+
await client.agent.verify({
|
|
1460
|
+
otpCode: "otp_code"
|
|
1461
|
+
});
|
|
1999
1462
|
|
|
2000
1463
|
```
|
|
2001
1464
|
</dd>
|
|
@@ -2011,7 +1474,7 @@ await client.apiKeys.listBrowserCredentials();
|
|
|
2011
1474
|
<dl>
|
|
2012
1475
|
<dd>
|
|
2013
1476
|
|
|
2014
|
-
**request:** `AgentMail.
|
|
1477
|
+
**request:** `AgentMail.AgentVerifyRequest`
|
|
2015
1478
|
|
|
2016
1479
|
</dd>
|
|
2017
1480
|
</dl>
|
|
@@ -2019,7 +1482,7 @@ await client.apiKeys.listBrowserCredentials();
|
|
|
2019
1482
|
<dl>
|
|
2020
1483
|
<dd>
|
|
2021
1484
|
|
|
2022
|
-
**requestOptions:** `
|
|
1485
|
+
**requestOptions:** `AgentClient.RequestOptions`
|
|
2023
1486
|
|
|
2024
1487
|
</dd>
|
|
2025
1488
|
</dl>
|
|
@@ -2031,7 +1494,8 @@ await client.apiKeys.listBrowserCredentials();
|
|
|
2031
1494
|
</dl>
|
|
2032
1495
|
</details>
|
|
2033
1496
|
|
|
2034
|
-
|
|
1497
|
+
## ApiKeys
|
|
1498
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">list</a>({ ...params }) -> AgentMail.ListApiKeysResponse</code></summary>
|
|
2035
1499
|
<dl>
|
|
2036
1500
|
<dd>
|
|
2037
1501
|
|
|
@@ -2043,7 +1507,14 @@ await client.apiKeys.listBrowserCredentials();
|
|
|
2043
1507
|
<dl>
|
|
2044
1508
|
<dd>
|
|
2045
1509
|
|
|
2046
|
-
|
|
1510
|
+
Lists every credential, newest first. Filter one family with `type`.
|
|
1511
|
+
Page to token exhaustion: a page can be empty and still carry a
|
|
1512
|
+
`next_page_token`.
|
|
1513
|
+
|
|
1514
|
+
**CLI:**
|
|
1515
|
+
```bash
|
|
1516
|
+
agentmail api-keys list
|
|
1517
|
+
```
|
|
2047
1518
|
</dd>
|
|
2048
1519
|
</dl>
|
|
2049
1520
|
</dd>
|
|
@@ -2058,7 +1529,7 @@ List owner-facing browser credential and consent lifecycle events. Requires `api
|
|
|
2058
1529
|
<dd>
|
|
2059
1530
|
|
|
2060
1531
|
```typescript
|
|
2061
|
-
await client.apiKeys.
|
|
1532
|
+
await client.apiKeys.list();
|
|
2062
1533
|
|
|
2063
1534
|
```
|
|
2064
1535
|
</dd>
|
|
@@ -2074,7 +1545,7 @@ await client.apiKeys.listBrowserCredentialEvents();
|
|
|
2074
1545
|
<dl>
|
|
2075
1546
|
<dd>
|
|
2076
1547
|
|
|
2077
|
-
**request:** `AgentMail.
|
|
1548
|
+
**request:** `AgentMail.ListApiKeysRequest`
|
|
2078
1549
|
|
|
2079
1550
|
</dd>
|
|
2080
1551
|
</dl>
|
|
@@ -2094,7 +1565,7 @@ await client.apiKeys.listBrowserCredentialEvents();
|
|
|
2094
1565
|
</dl>
|
|
2095
1566
|
</details>
|
|
2096
1567
|
|
|
2097
|
-
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">
|
|
1568
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">get</a>(api_key_id) -> AgentMail.ApiKey</code></summary>
|
|
2098
1569
|
<dl>
|
|
2099
1570
|
<dd>
|
|
2100
1571
|
|
|
@@ -2106,7 +1577,8 @@ await client.apiKeys.listBrowserCredentialEvents();
|
|
|
2106
1577
|
<dl>
|
|
2107
1578
|
<dd>
|
|
2108
1579
|
|
|
2109
|
-
|
|
1580
|
+
Returns one credential of any family. Public keys also resolve by
|
|
1581
|
+
`client_id`. Poll a sign-in key until `status` is `active`.
|
|
2110
1582
|
</dd>
|
|
2111
1583
|
</dl>
|
|
2112
1584
|
</dd>
|
|
@@ -2121,7 +1593,7 @@ Permanently revoke one active browser credential. Requires `api_key_delete`.
|
|
|
2121
1593
|
<dd>
|
|
2122
1594
|
|
|
2123
1595
|
```typescript
|
|
2124
|
-
await client.apiKeys.
|
|
1596
|
+
await client.apiKeys.get("api_key_id");
|
|
2125
1597
|
|
|
2126
1598
|
```
|
|
2127
1599
|
</dd>
|
|
@@ -2137,7 +1609,7 @@ await client.apiKeys.deleteBrowserCredential("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc
|
|
|
2137
1609
|
<dl>
|
|
2138
1610
|
<dd>
|
|
2139
1611
|
|
|
2140
|
-
**
|
|
1612
|
+
**api_key_id:** `AgentMail.ApiKeyId`
|
|
2141
1613
|
|
|
2142
1614
|
</dd>
|
|
2143
1615
|
</dl>
|
|
@@ -2157,7 +1629,7 @@ await client.apiKeys.deleteBrowserCredential("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc
|
|
|
2157
1629
|
</dl>
|
|
2158
1630
|
</details>
|
|
2159
1631
|
|
|
2160
|
-
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">
|
|
1632
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">create</a>({ ...params }) -> AgentMail.CreateApiKeyResult</code></summary>
|
|
2161
1633
|
<dl>
|
|
2162
1634
|
<dd>
|
|
2163
1635
|
|
|
@@ -2169,7 +1641,13 @@ await client.apiKeys.deleteBrowserCredential("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc
|
|
|
2169
1641
|
<dl>
|
|
2170
1642
|
<dd>
|
|
2171
1643
|
|
|
2172
|
-
|
|
1644
|
+
Creates a bearer key, or registers a public key when the body carries
|
|
1645
|
+
`public_key`. The route selects the scope. Bearer secrets are returned once.
|
|
1646
|
+
|
|
1647
|
+
**CLI:**
|
|
1648
|
+
```bash
|
|
1649
|
+
agentmail api-keys create --name "My Key"
|
|
1650
|
+
```
|
|
2173
1651
|
</dd>
|
|
2174
1652
|
</dl>
|
|
2175
1653
|
</dd>
|
|
@@ -2184,7 +1662,7 @@ Cancel one pending, unexpired browser enrollment intent. Requires `api_key_delet
|
|
|
2184
1662
|
<dd>
|
|
2185
1663
|
|
|
2186
1664
|
```typescript
|
|
2187
|
-
await client.apiKeys.
|
|
1665
|
+
await client.apiKeys.create({});
|
|
2188
1666
|
|
|
2189
1667
|
```
|
|
2190
1668
|
</dd>
|
|
@@ -2200,7 +1678,7 @@ await client.apiKeys.cancelBrowserEnrollment("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc
|
|
|
2200
1678
|
<dl>
|
|
2201
1679
|
<dd>
|
|
2202
1680
|
|
|
2203
|
-
**
|
|
1681
|
+
**request:** `AgentMail.CreateApiKeyRequest`
|
|
2204
1682
|
|
|
2205
1683
|
</dd>
|
|
2206
1684
|
</dl>
|
|
@@ -2220,7 +1698,7 @@ await client.apiKeys.cancelBrowserEnrollment("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc
|
|
|
2220
1698
|
</dl>
|
|
2221
1699
|
</details>
|
|
2222
1700
|
|
|
2223
|
-
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">
|
|
1701
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">update</a>(api_key_id, { ...params }) -> AgentMail.ApiKey</code></summary>
|
|
2224
1702
|
<dl>
|
|
2225
1703
|
<dd>
|
|
2226
1704
|
|
|
@@ -2232,7 +1710,9 @@ await client.apiKeys.cancelBrowserEnrollment("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc
|
|
|
2232
1710
|
<dl>
|
|
2233
1711
|
<dd>
|
|
2234
1712
|
|
|
2235
|
-
|
|
1713
|
+
Renames a credential or changes its permissions. Public keys also resolve
|
|
1714
|
+
by `client_id`; a sign-in key accepts only `provider_connect` and
|
|
1715
|
+
`provider_share_owner`.
|
|
2236
1716
|
</dd>
|
|
2237
1717
|
</dl>
|
|
2238
1718
|
</dd>
|
|
@@ -2247,9 +1727,7 @@ List remembered AgentID client approvals for one live inbox. Requires `api_key_r
|
|
|
2247
1727
|
<dd>
|
|
2248
1728
|
|
|
2249
1729
|
```typescript
|
|
2250
|
-
await client.apiKeys.
|
|
2251
|
-
inboxId: "inbox_id"
|
|
2252
|
-
});
|
|
1730
|
+
await client.apiKeys.update("api_key_id", {});
|
|
2253
1731
|
|
|
2254
1732
|
```
|
|
2255
1733
|
</dd>
|
|
@@ -2265,7 +1743,15 @@ await client.apiKeys.listBrowserConsents({
|
|
|
2265
1743
|
<dl>
|
|
2266
1744
|
<dd>
|
|
2267
1745
|
|
|
2268
|
-
**
|
|
1746
|
+
**api_key_id:** `AgentMail.ApiKeyId`
|
|
1747
|
+
|
|
1748
|
+
</dd>
|
|
1749
|
+
</dl>
|
|
1750
|
+
|
|
1751
|
+
<dl>
|
|
1752
|
+
<dd>
|
|
1753
|
+
|
|
1754
|
+
**request:** `AgentMail.UpdateApiKeyRequest`
|
|
2269
1755
|
|
|
2270
1756
|
</dd>
|
|
2271
1757
|
</dl>
|
|
@@ -2285,7 +1771,7 @@ await client.apiKeys.listBrowserConsents({
|
|
|
2285
1771
|
</dl>
|
|
2286
1772
|
</details>
|
|
2287
1773
|
|
|
2288
|
-
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">
|
|
1774
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">delete</a>(api_key_id) -> void</code></summary>
|
|
2289
1775
|
<dl>
|
|
2290
1776
|
<dd>
|
|
2291
1777
|
|
|
@@ -2297,7 +1783,13 @@ await client.apiKeys.listBrowserConsents({
|
|
|
2297
1783
|
<dl>
|
|
2298
1784
|
<dd>
|
|
2299
1785
|
|
|
2300
|
-
|
|
1786
|
+
Deletes one credential of any family. A pending sign-in key is
|
|
1787
|
+
cancelled; an active one is revoked. Public keys also resolve by `client_id`.
|
|
1788
|
+
|
|
1789
|
+
**CLI:**
|
|
1790
|
+
```bash
|
|
1791
|
+
agentmail api-keys delete --api-key-id <api_key_id>
|
|
1792
|
+
```
|
|
2301
1793
|
</dd>
|
|
2302
1794
|
</dl>
|
|
2303
1795
|
</dd>
|
|
@@ -2312,7 +1804,7 @@ Revoke one remembered AgentID client approval. Requires `api_key_delete`.
|
|
|
2312
1804
|
<dd>
|
|
2313
1805
|
|
|
2314
1806
|
```typescript
|
|
2315
|
-
await client.apiKeys.
|
|
1807
|
+
await client.apiKeys.delete("api_key_id");
|
|
2316
1808
|
|
|
2317
1809
|
```
|
|
2318
1810
|
</dd>
|
|
@@ -2328,7 +1820,7 @@ await client.apiKeys.deleteBrowserConsent("consent_id");
|
|
|
2328
1820
|
<dl>
|
|
2329
1821
|
<dd>
|
|
2330
1822
|
|
|
2331
|
-
**
|
|
1823
|
+
**api_key_id:** `AgentMail.ApiKeyId`
|
|
2332
1824
|
|
|
2333
1825
|
</dd>
|
|
2334
1826
|
</dl>
|
|
@@ -3227,7 +2719,7 @@ await client.inboxes.apiKeys.list("inbox_id");
|
|
|
3227
2719
|
</dl>
|
|
3228
2720
|
</details>
|
|
3229
2721
|
|
|
3230
|
-
<details><summary><code>client.inboxes.apiKeys.<a href="/src/api/resources/inboxes/resources/apiKeys/client/Client.ts">create</a>(inbox_id, { ...params }) -> AgentMail.
|
|
2722
|
+
<details><summary><code>client.inboxes.apiKeys.<a href="/src/api/resources/inboxes/resources/apiKeys/client/Client.ts">create</a>(inbox_id, { ...params }) -> AgentMail.CreateApiKeyResult</code></summary>
|
|
3231
2723
|
<dl>
|
|
3232
2724
|
<dd>
|
|
3233
2725
|
|
|
@@ -3301,7 +2793,7 @@ await client.inboxes.apiKeys.create("inbox_id", {});
|
|
|
3301
2793
|
</dl>
|
|
3302
2794
|
</details>
|
|
3303
2795
|
|
|
3304
|
-
<details><summary><code>client.inboxes.apiKeys.<a href="/src/api/resources/inboxes/resources/apiKeys/client/Client.ts">
|
|
2796
|
+
<details><summary><code>client.inboxes.apiKeys.<a href="/src/api/resources/inboxes/resources/apiKeys/client/Client.ts">update</a>(inbox_id, api_key_id, { ...params }) -> AgentMail.ApiKey</code></summary>
|
|
3305
2797
|
<dl>
|
|
3306
2798
|
<dd>
|
|
3307
2799
|
|
|
@@ -3315,7 +2807,7 @@ await client.inboxes.apiKeys.create("inbox_id", {});
|
|
|
3315
2807
|
|
|
3316
2808
|
**CLI:**
|
|
3317
2809
|
```bash
|
|
3318
|
-
agentmail inboxes api-keys
|
|
2810
|
+
agentmail inboxes api-keys update --inbox-id <inbox_id> --api-key-id <api_key_id> --name "Renamed"
|
|
3319
2811
|
```
|
|
3320
2812
|
</dd>
|
|
3321
2813
|
</dl>
|
|
@@ -3331,7 +2823,7 @@ agentmail inboxes api-keys delete --inbox-id <inbox_id> --api-key-id <api_key_id
|
|
|
3331
2823
|
<dd>
|
|
3332
2824
|
|
|
3333
2825
|
```typescript
|
|
3334
|
-
await client.inboxes.apiKeys.
|
|
2826
|
+
await client.inboxes.apiKeys.update("inbox_id", "api_key_id", {});
|
|
3335
2827
|
|
|
3336
2828
|
```
|
|
3337
2829
|
</dd>
|
|
@@ -3363,6 +2855,14 @@ await client.inboxes.apiKeys.delete("inbox_id", "api_key_id");
|
|
|
3363
2855
|
<dl>
|
|
3364
2856
|
<dd>
|
|
3365
2857
|
|
|
2858
|
+
**request:** `AgentMail.UpdateApiKeyRequest`
|
|
2859
|
+
|
|
2860
|
+
</dd>
|
|
2861
|
+
</dl>
|
|
2862
|
+
|
|
2863
|
+
<dl>
|
|
2864
|
+
<dd>
|
|
2865
|
+
|
|
3366
2866
|
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
3367
2867
|
|
|
3368
2868
|
</dd>
|
|
@@ -3375,8 +2875,7 @@ await client.inboxes.apiKeys.delete("inbox_id", "api_key_id");
|
|
|
3375
2875
|
</dl>
|
|
3376
2876
|
</details>
|
|
3377
2877
|
|
|
3378
|
-
|
|
3379
|
-
<details><summary><code>client.inboxes.browserCredentials.<a href="/src/api/resources/inboxes/resources/browserCredentials/client/Client.ts">createEnrollment</a>(inbox_id, { ...params }) -> AgentMail.BrowserEnrollmentAccepted</code></summary>
|
|
2878
|
+
<details><summary><code>client.inboxes.apiKeys.<a href="/src/api/resources/inboxes/resources/apiKeys/client/Client.ts">delete</a>(inbox_id, api_key_id) -> void</code></summary>
|
|
3380
2879
|
<dl>
|
|
3381
2880
|
<dd>
|
|
3382
2881
|
|
|
@@ -3388,31 +2887,10 @@ await client.inboxes.apiKeys.delete("inbox_id", "api_key_id");
|
|
|
3388
2887
|
<dl>
|
|
3389
2888
|
<dd>
|
|
3390
2889
|
|
|
3391
|
-
|
|
3392
|
-
|
|
3393
|
-
|
|
3394
|
-
|
|
3395
|
-
|
|
3396
|
-
This endpoint is available to every organization using US production.
|
|
3397
|
-
It is not available in EU production.
|
|
3398
|
-
|
|
3399
|
-
Select `inbox_id` from trusted AgentMail configuration. An AgentID
|
|
3400
|
-
`login_hint` is not authoritative for selecting the inbox; when the
|
|
3401
|
-
transaction includes one, it must match the path inbox.
|
|
3402
|
-
|
|
3403
|
-
**AgentMail API keys are sent only to `https://api.agentmail.to`; AgentID never requests them.**
|
|
3404
|
-
|
|
3405
|
-
A new intent returns `202`; an idempotent retry for the same pending
|
|
3406
|
-
transaction, inbox, and bearer key returns `200` with the same receipt.
|
|
3407
|
-
An intent lasts at most five minutes. An activated credential lasts at
|
|
3408
|
-
most 30 days and cannot outlive its authorizing bearer API key.
|
|
3409
|
-
|
|
3410
|
-
Creation is limited to 20 intents per bearer API key per hour, 100 per
|
|
3411
|
-
organization per hour, and five live unused intents per bearer API key.
|
|
3412
|
-
Browser activation is separately limited to 20 activations per
|
|
3413
|
-
authorizing bearer API key per UTC day. Either kind of limit can return
|
|
3414
|
-
`429`; honor the `Retry-After` header. Cancelling an enrollment releases
|
|
3415
|
-
its live-intent slot but does not reset the daily activation counter.
|
|
2890
|
+
**CLI:**
|
|
2891
|
+
```bash
|
|
2892
|
+
agentmail inboxes api-keys delete --inbox-id <inbox_id> --api-key-id <api_key_id>
|
|
2893
|
+
```
|
|
3416
2894
|
</dd>
|
|
3417
2895
|
</dl>
|
|
3418
2896
|
</dd>
|
|
@@ -3427,9 +2905,7 @@ its live-intent slot but does not reset the daily activation counter.
|
|
|
3427
2905
|
<dd>
|
|
3428
2906
|
|
|
3429
2907
|
```typescript
|
|
3430
|
-
await client.inboxes.
|
|
3431
|
-
transactionJti: "blackcurrant.........."
|
|
3432
|
-
});
|
|
2908
|
+
await client.inboxes.apiKeys.delete("inbox_id", "api_key_id");
|
|
3433
2909
|
|
|
3434
2910
|
```
|
|
3435
2911
|
</dd>
|
|
@@ -3453,7 +2929,7 @@ await client.inboxes.browserCredentials.createEnrollment("inbox_id", {
|
|
|
3453
2929
|
<dl>
|
|
3454
2930
|
<dd>
|
|
3455
2931
|
|
|
3456
|
-
**
|
|
2932
|
+
**api_key_id:** `AgentMail.ApiKeyId`
|
|
3457
2933
|
|
|
3458
2934
|
</dd>
|
|
3459
2935
|
</dl>
|
|
@@ -3461,7 +2937,7 @@ await client.inboxes.browserCredentials.createEnrollment("inbox_id", {
|
|
|
3461
2937
|
<dl>
|
|
3462
2938
|
<dd>
|
|
3463
2939
|
|
|
3464
|
-
**requestOptions:** `
|
|
2940
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
3465
2941
|
|
|
3466
2942
|
</dd>
|
|
3467
2943
|
</dl>
|
|
@@ -7340,6 +6816,88 @@ await client.pods.apiKeys.create("pod_id", {});
|
|
|
7340
6816
|
</dl>
|
|
7341
6817
|
|
|
7342
6818
|
|
|
6819
|
+
</dd>
|
|
6820
|
+
</dl>
|
|
6821
|
+
</details>
|
|
6822
|
+
|
|
6823
|
+
<details><summary><code>client.pods.apiKeys.<a href="/src/api/resources/pods/resources/apiKeys/client/Client.ts">update</a>(pod_id, api_key_id, { ...params }) -> AgentMail.ApiKey</code></summary>
|
|
6824
|
+
<dl>
|
|
6825
|
+
<dd>
|
|
6826
|
+
|
|
6827
|
+
#### 📝 Description
|
|
6828
|
+
|
|
6829
|
+
<dl>
|
|
6830
|
+
<dd>
|
|
6831
|
+
|
|
6832
|
+
<dl>
|
|
6833
|
+
<dd>
|
|
6834
|
+
|
|
6835
|
+
**CLI:**
|
|
6836
|
+
```bash
|
|
6837
|
+
agentmail pods api-keys update --pod-id <pod_id> --api-key-id <api_key_id> --name "Renamed"
|
|
6838
|
+
```
|
|
6839
|
+
</dd>
|
|
6840
|
+
</dl>
|
|
6841
|
+
</dd>
|
|
6842
|
+
</dl>
|
|
6843
|
+
|
|
6844
|
+
#### 🔌 Usage
|
|
6845
|
+
|
|
6846
|
+
<dl>
|
|
6847
|
+
<dd>
|
|
6848
|
+
|
|
6849
|
+
<dl>
|
|
6850
|
+
<dd>
|
|
6851
|
+
|
|
6852
|
+
```typescript
|
|
6853
|
+
await client.pods.apiKeys.update("pod_id", "api_key_id", {});
|
|
6854
|
+
|
|
6855
|
+
```
|
|
6856
|
+
</dd>
|
|
6857
|
+
</dl>
|
|
6858
|
+
</dd>
|
|
6859
|
+
</dl>
|
|
6860
|
+
|
|
6861
|
+
#### ⚙️ Parameters
|
|
6862
|
+
|
|
6863
|
+
<dl>
|
|
6864
|
+
<dd>
|
|
6865
|
+
|
|
6866
|
+
<dl>
|
|
6867
|
+
<dd>
|
|
6868
|
+
|
|
6869
|
+
**pod_id:** `AgentMail.PodId`
|
|
6870
|
+
|
|
6871
|
+
</dd>
|
|
6872
|
+
</dl>
|
|
6873
|
+
|
|
6874
|
+
<dl>
|
|
6875
|
+
<dd>
|
|
6876
|
+
|
|
6877
|
+
**api_key_id:** `AgentMail.ApiKeyId`
|
|
6878
|
+
|
|
6879
|
+
</dd>
|
|
6880
|
+
</dl>
|
|
6881
|
+
|
|
6882
|
+
<dl>
|
|
6883
|
+
<dd>
|
|
6884
|
+
|
|
6885
|
+
**request:** `AgentMail.UpdateApiKeyRequest`
|
|
6886
|
+
|
|
6887
|
+
</dd>
|
|
6888
|
+
</dl>
|
|
6889
|
+
|
|
6890
|
+
<dl>
|
|
6891
|
+
<dd>
|
|
6892
|
+
|
|
6893
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
6894
|
+
|
|
6895
|
+
</dd>
|
|
6896
|
+
</dl>
|
|
6897
|
+
</dd>
|
|
6898
|
+
</dl>
|
|
6899
|
+
|
|
6900
|
+
|
|
7343
6901
|
</dd>
|
|
7344
6902
|
</dl>
|
|
7345
6903
|
</details>
|
|
@@ -10416,7 +9974,7 @@ await client.providers.listAccounts("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
|
10416
9974
|
</dl>
|
|
10417
9975
|
</details>
|
|
10418
9976
|
|
|
10419
|
-
<details><summary><code>client.providers.<a href="/src/api/resources/providers/client/Client.ts">connect</a>(provider_id, { ...params }) -> AgentMail.
|
|
9977
|
+
<details><summary><code>client.providers.<a href="/src/api/resources/providers/client/Client.ts">connect</a>(provider_id, { ...params }) -> AgentMail.ConnectAccepted</code></summary>
|
|
10420
9978
|
<dl>
|
|
10421
9979
|
<dd>
|
|
10422
9980
|
|
|
@@ -10428,9 +9986,10 @@ await client.providers.listAccounts("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
|
|
|
10428
9986
|
<dl>
|
|
10429
9987
|
<dd>
|
|
10430
9988
|
|
|
10431
|
-
Starts signing an inbox in to a provider. Returns a `magic_url
|
|
10432
|
-
for five minutes
|
|
10433
|
-
|
|
9989
|
+
Starts signing an inbox in to a provider. Returns a single-use `magic_url`,
|
|
9990
|
+
valid for five minutes, to open in the client that will hold the sign-in;
|
|
9991
|
+
the client enrolls as the inbox and continues to the provider. Poll
|
|
9992
|
+
[Get API Key](/api-reference/api-keys/get) with `api_key_id` for `status`.
|
|
10434
9993
|
</dd>
|
|
10435
9994
|
</dl>
|
|
10436
9995
|
</dd>
|
|
@@ -10477,7 +10036,7 @@ await client.providers.connect("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", undefined
|
|
|
10477
10036
|
<dl>
|
|
10478
10037
|
<dd>
|
|
10479
10038
|
|
|
10480
|
-
**requestOptions:** `ProvidersClient.
|
|
10039
|
+
**requestOptions:** `ProvidersClient.RequestOptions`
|
|
10481
10040
|
|
|
10482
10041
|
</dd>
|
|
10483
10042
|
</dl>
|