@terminal3/t3n-sdk 4.35.1 → 4.37.0

package/dist/index.d.ts

@@ -3310,6 +3310,30 @@ interface RoleGetResponse {
 }
 /** Shallow runtime guard for {@link RoleGetResponse}. */
 declare function isRoleGetResponse(value: unknown): value is RoleGetResponse;
+/**
+ * One org-owned agent's outbound host allow-list for a single contract.
+ *
+ * Egress only — it carries no data scopes by construction, so it can never be
+ * a second path to org data (that stays with `org-policy-set-grants`).
+ */
+interface AgentEgressEntry {
+    contract_id: string;
+    /** Bare lowercase hostnames, matched exactly by the node. */
+    allowed_hosts: string[];
+    /** WIT functions covered; `["*"]` means all of them. */
+    functions: string[];
+    /** Present only when the allow-list is pinned to a version range. */
+    version_req?: string;
+}
+/**
+ * Response for `org-agent-egress-get`; `egress` is `null` when the agent holds
+ * no egress entry for the requested contract.
+ */
+interface AgentEgressGetResponse {
+    egress: AgentEgressEntry | null;
+}
+/** Runtime guard for {@link AgentEgressGetResponse}. */
+declare function isAgentEgressGetResponse(value: unknown): value is AgentEgressGetResponse;
 /** Response for `org-role-assignments-get`. */
 interface RoleAssignmentsResponse {
     /** Echoed back so callers don't need to track which request this answers. */
@@ -3582,6 +3606,38 @@ interface DeleteGrantsInput {
     orgDid: string;
     contractId: string;
 }
+/**
+ * Grant or replace the outbound host allow-list an org-owned agent may use
+ * while executing one of the org's contracts (org-admin only).
+ *
+ * Egress ONLY — this confers no data authority. An agent needs BOTH this and a
+ * {@link OrgDataClient.setGrants} entry naming its own DID to do useful work:
+ * `setGrants` authorises the org data it may read, this authorises the hosts it
+ * may dial. No human `agent_auth` row is involved in either.
+ *
+ * Hosts are matched EXACTLY (lowercased). A scheme, port, path, or `*` wildcard
+ * is rejected rather than stored as an entry that could never match.
+ */
+interface SetAgentEgressInput {
+    orgDid: string;
+    /** The org-owned agent the allow-list applies to. */
+    agentDid: string;
+    contractId: string;
+    /** Bare hostnames, e.g. `["api.airwallex.com"]`. Must be non-empty — use
+     * {@link OrgDataClient.deleteAgentEgress} to revoke. */
+    allowedHosts: string[];
+    /** WIT functions the allow-list covers. Defaults to all functions. Narrowing
+     * this means a call to an uncovered function gets deny-all egress. */
+    functions?: string[];
+    /** SemVer requirement on the target contract version; omit to cover all. */
+    versionReq?: string;
+}
+/** Addresses one `(agent, contract)` egress entry. */
+interface AgentEgressRefInput {
+    orgDid: string;
+    agentDid: string;
+    contractId: string;
+}
 /**
  * Create or replace a secret and its three ACLs (org-admin only). `value` is
  * optional on a replace — omitting it preserves the stored bytes so an admin
@@ -3847,6 +3903,27 @@ declare class OrgDataClient {
      * Delete the grant entry for a contract entirely.
      */
     deleteGrants(input: DeleteGrantsInput): Promise<MutationResponse>;
+    /**
+     * Grant or replace the outbound host allow-list an org-owned agent may use
+     * while executing one of the org's contracts (org-admin only).
+     *
+     * Full replacement for the `(agent, contract)` pair. Other contracts' egress
+     * entries are untouched. See {@link SetAgentEgressInput} on why this is
+     * needed alongside {@link setGrants}.
+     */
+    setAgentEgress(input: SetAgentEgressInput): Promise<MutationResponse>;
+    /**
+     * The egress entry in force for one `(agent, contract)` pair (org-admin
+     * only). `egress` is `null` when the agent holds none — which means
+     * deny-all outbound HTTP for that contract.
+     */
+    getAgentEgress(input: AgentEgressRefInput): Promise<AgentEgressGetResponse>;
+    /**
+     * Revoke an org-owned agent's egress for one contract (org-admin only).
+     * Effective on the agent's next call. `deleted` is `false` when no entry was
+     * in force.
+     */
+    deleteAgentEgress(input: AgentEgressRefInput): Promise<MutationResponse>;
     /** Upsert a role definition (org-admin only). */
     setRole(input: SetRoleInput): Promise<MutationResponse>;
     /** Delete a role definition (org-admin only). */
@@ -4047,6 +4124,27 @@ declare class SessionOrgDataClient {
     setGrants(input: SetGrantsInput): Promise<MutationResponse>;
     /** Mirrors {@link OrgDataClient.deleteGrants}. */
     deleteGrants(input: DeleteGrantsInput): Promise<MutationResponse>;
+    /**
+     * Grant or replace the outbound host allow-list an org-owned agent may use
+     * while executing one of the org's contracts (org-admin only).
+     *
+     * Full replacement for the `(agent, contract)` pair. Other contracts' egress
+     * entries are untouched. See {@link SetAgentEgressInput} on why this is
+     * needed alongside {@link setGrants}.
+     */
+    setAgentEgress(input: SetAgentEgressInput): Promise<MutationResponse>;
+    /**
+     * The egress entry in force for one `(agent, contract)` pair (org-admin
+     * only). `egress` is `null` when the agent holds none — which means
+     * deny-all outbound HTTP for that contract.
+     */
+    getAgentEgress(input: AgentEgressRefInput): Promise<AgentEgressGetResponse>;
+    /**
+     * Revoke an org-owned agent's egress for one contract (org-admin only).
+     * Effective on the agent's next call. `deleted` is `false` when no entry was
+     * in force.
+     */
+    deleteAgentEgress(input: AgentEgressRefInput): Promise<MutationResponse>;
     /** Upsert a role definition (org-admin only). */
     setRole(input: SetRoleInput): Promise<MutationResponse>;
     /** Delete a role definition (org-admin only). */
@@ -5130,5 +5228,5 @@ declare function tenantDidHex(tenantDid: string): string;
 declare function validateTail(tail: string): string;
 declare function canonicalTenantName(tenantDid: string, tail: string): string;
 
-export { AGENT_CARDS_SCOPE, AuthMethod, AuthenticationError, BASE_UNITS_PER_TOKEN, ContractResponseError, DEFAULT_ENVIRONMENT, DEFAULT_INDIVIDUAL_THRESHOLD_CENTS, DEFAULT_KYC_POLL_CADENCE, HandshakeError, HttpTransport, InvokeError, KycStatusTimeoutError, LogLevel, MockTransport, NODE_URLS, OrgDataClient, OtpRateLimitedError, RpcError, SessionExpiredError, SessionOrgDataClient, SessionStateError, SessionStatus, SessionUsageReportClient, T3nClient, T3nConfigError, T3nError, TERMINAL_KYC_STATUSES, TOKEN_DECIMALS, TenantClient, TenantContractsNamespace, TenantMapsNamespace, TenantNamespace, TenantSdkValidationError, TenantTokenNamespace, UnsupportedTenantSdkOperationError, UserUpsertError, WasmError, WireEncodingError, Z_PAYROLL_AUDIT_READ_FUNCTIONS, Z_PAYROLL_RUN_FUNCTIONS, _b64uEncode, assertShape, b64uDecodeStrict, b64uEncodeBytes, buildSecretWriteArgs, bytesToString, canonicalTenantName, clearKeyCache, clearManifestVersionFloor, compactDidFromBytes, createDefaultHandlers, createEmailOtpAuthInput, createEthAuthInput, createLogger, createMlKemPublicKeyHandler, createOidcAuthInput, createOrgDataClientFromSession, createRandomHandler, createUsageReportClientFromSession, createWorkloadAuthInput, decodeWasmErrorMessage, deriveAgentCardEntryId, eth_get_address, extractWasmError, fetchDkgAttestation, fetchMlKemPublicKey, fetchTrustedManifest, formatTokens, generateRandomString, generateUUID, getEnvironment, getEnvironmentName, getGlobalLogLevel, getLogger, getNodeUrl, getScriptVersion, invoke, isAgentCardResponse, isDataGetResponse, isDataListResponse, isListAgentsResponse, isListHumanMembersResponse, isMutationResponse, isObject, isOrgAdminStatus, isOrgContractGrants, isOrgPolicyMeta, isOrgPolicyView, isOrgUsageReport, isOrgWriters, isRoleAssignmentsResponse, isRoleGetResponse, isSecretListResponse, isSecretRecord, isSecretView, isUnsafeTrustServer, loadConfig, loadWasmComponent, manifestToTrustAnchor, maskKeyMaterial, mergeAgentAuthEntries, mergeDiscoverDids, metamask_get_address, metamask_sign, parseAgentAuthGet, parseAgentAuthPolicy, parseContractResponse, redactSecrets, redactSecretsFromJson, requestToWire, setEnvironment, setGlobalLogLevel, setNodeUrl, stringToBytes, tenantDidHex, toAgentAuthUpdateWire, toBaseUnits, validateConfig, validateTail, verifyDkgAttestation, verifyManifestSignature, verifyTdxQuote };
-export type { ActivityCallerType, ActivityEntry, ActivityOutcome, ActivityReport, AdmitForOrgOptions, AgentAuthEntry, AgentAuthMergeResult, AgentAuthPolicy, AgentAuthScriptGrant, AgentAuthUpdateInput, AgentCardRefInput, AgentCardResponse, AgentCardSetInput, AgentSummary, AssignRolesInput, AuthInput, BalanceRow, ChargeReason, ClientAuth, ClientHandshake, ConfigValidationResult, ContractDescriptorFacets, ContractExecuteInput, ContractKind, ContractLifecycleStatus, ContractListDetailedOptions, ContractListDetailedPage, ContractPublishInput, ContractRegisterResult, ContractResponseSchema, ContractSetDescriptorInput, CreatePolicyInput, DataGetInput, DataGetResponse, DataListInput, DataListResponse, DelegationGrantKind, DelegationGrantRef, DeleteDataInput, DeleteGrantsInput, DeleteScopeInput, DetailedContract, Did, Direction, DkgAttestation, DkgVerifyResult, EmailOtpAuthInput, EmailOtpCredentials, Environment, EthAuthInput, ExecuteBusinessContractOptions, ExecuteOrgDataActionOptions, FetchTrustedManifestOptions, GetActivityLogOptions, GetUsageOptions, GrantCheckParams, GrantCheckResult, GranteeInput, GrantsGetInput, GuestToHostHandler, GuestToHostHandlers, HandshakeResult, HumanMember, InvokeOptions, InvokeRequest, JsonRpcRequest, JsonRpcResponse, KycPollCadence, KycPollOptions, KycStatus, KycStatusKind, ListAgentsInput, ListAgentsResponse, ListContractsParams, ListContractsResult, ListContractsScope, ListHumanMembersInput, ListHumanMembersResponse, ListedContract, Logger, MapCreateInput, MapLifecycleStatus, MapResponse, MapUpdateInput, MapVisibility, MemberRole, MutationResponse, OidcAuthInput, OidcCredentials, OrgAdminStatus, OrgContractGrants, OrgDataActionWire, OrgDataClientOptions, OrgPolicyMeta, OrgPolicyView, OrgUsageReport, OrgUsageReportInput, OrgWriters, OtpChannel, OtpMergeSuggestion, OtpRequestInput, OtpRequestResult, OtpVerifyInput, OtpVerifyResult, PayrollRunRequest, PeerQuoteResult, PolicyGetInput, PurgeOrgInput, QuoteVerifyResult, ReaderSet, RemoveMemberGrantsInput, RoleAssignments, RoleAssignmentsResponse, RoleDefinition, RoleGetResponse, RoleGrant, RoleIdInput, SdkConfig, SecretKind, SecretListInput, SecretListResponse, SecretNameInput, SecretRecord, SecretSetValueInput, SecretView, SecretWriteInput, SessionCrypto, SessionId, SetGrantsInput, SetRoleInput, SetWritersInput, SignedTrustManifest, StringEncoding, SubmitUserInputArgs, SubmitUserInputResult, T3nClientConfig, TenantAdmitProjection, TenantAdmitStatus, TenantBaseClient, TenantClientConfig, TenantContractExecuteInput, TenantContractPublishInput, TenantContractSetDescriptorInput, TenantExecutionSession, TenantMapCreateInput, TenantMapUpdatePatch, TenantMeResponse, TenantSdkEnvironment, TenantSelfAdmitResult, TenantStatus, TenantTargetOptions, TokenTxKind, Transport, TrustAnchor, TrustAnchorOrUnsafe, TrustAnchorSource, TrustManifestPayload, UnassignRolesInput, UnsafeTrustServer, UpdateMetaInput, UsageEntry, UsagePage, UsageReportSignature, UserGrant, UserInputProfile, UserUpsertErrorKind, WasmComponent, WasmNextResult, WireBlock, WorkloadAuthInput, WriteDataInput, WriterSet, WritersGetInput };
+export { AGENT_CARDS_SCOPE, AuthMethod, AuthenticationError, BASE_UNITS_PER_TOKEN, ContractResponseError, DEFAULT_ENVIRONMENT, DEFAULT_INDIVIDUAL_THRESHOLD_CENTS, DEFAULT_KYC_POLL_CADENCE, HandshakeError, HttpTransport, InvokeError, KycStatusTimeoutError, LogLevel, MockTransport, NODE_URLS, OrgDataClient, OtpRateLimitedError, RpcError, SessionExpiredError, SessionOrgDataClient, SessionStateError, SessionStatus, SessionUsageReportClient, T3nClient, T3nConfigError, T3nError, TERMINAL_KYC_STATUSES, TOKEN_DECIMALS, TenantClient, TenantContractsNamespace, TenantMapsNamespace, TenantNamespace, TenantSdkValidationError, TenantTokenNamespace, UnsupportedTenantSdkOperationError, UserUpsertError, WasmError, WireEncodingError, Z_PAYROLL_AUDIT_READ_FUNCTIONS, Z_PAYROLL_RUN_FUNCTIONS, _b64uEncode, assertShape, b64uDecodeStrict, b64uEncodeBytes, buildSecretWriteArgs, bytesToString, canonicalTenantName, clearKeyCache, clearManifestVersionFloor, compactDidFromBytes, createDefaultHandlers, createEmailOtpAuthInput, createEthAuthInput, createLogger, createMlKemPublicKeyHandler, createOidcAuthInput, createOrgDataClientFromSession, createRandomHandler, createUsageReportClientFromSession, createWorkloadAuthInput, decodeWasmErrorMessage, deriveAgentCardEntryId, eth_get_address, extractWasmError, fetchDkgAttestation, fetchMlKemPublicKey, fetchTrustedManifest, formatTokens, generateRandomString, generateUUID, getEnvironment, getEnvironmentName, getGlobalLogLevel, getLogger, getNodeUrl, getScriptVersion, invoke, isAgentCardResponse, isAgentEgressGetResponse, isDataGetResponse, isDataListResponse, isListAgentsResponse, isListHumanMembersResponse, isMutationResponse, isObject, isOrgAdminStatus, isOrgContractGrants, isOrgPolicyMeta, isOrgPolicyView, isOrgUsageReport, isOrgWriters, isRoleAssignmentsResponse, isRoleGetResponse, isSecretListResponse, isSecretRecord, isSecretView, isUnsafeTrustServer, loadConfig, loadWasmComponent, manifestToTrustAnchor, maskKeyMaterial, mergeAgentAuthEntries, mergeDiscoverDids, metamask_get_address, metamask_sign, parseAgentAuthGet, parseAgentAuthPolicy, parseContractResponse, redactSecrets, redactSecretsFromJson, requestToWire, setEnvironment, setGlobalLogLevel, setNodeUrl, stringToBytes, tenantDidHex, toAgentAuthUpdateWire, toBaseUnits, validateConfig, validateTail, verifyDkgAttestation, verifyManifestSignature, verifyTdxQuote };
+export type { ActivityCallerType, ActivityEntry, ActivityOutcome, ActivityReport, AdmitForOrgOptions, AgentAuthEntry, AgentAuthMergeResult, AgentAuthPolicy, AgentAuthScriptGrant, AgentAuthUpdateInput, AgentCardRefInput, AgentCardResponse, AgentCardSetInput, AgentEgressEntry, AgentEgressGetResponse, AgentEgressRefInput, AgentSummary, AssignRolesInput, AuthInput, BalanceRow, ChargeReason, ClientAuth, ClientHandshake, ConfigValidationResult, ContractDescriptorFacets, ContractExecuteInput, ContractKind, ContractLifecycleStatus, ContractListDetailedOptions, ContractListDetailedPage, ContractPublishInput, ContractRegisterResult, ContractResponseSchema, ContractSetDescriptorInput, CreatePolicyInput, DataGetInput, DataGetResponse, DataListInput, DataListResponse, DelegationGrantKind, DelegationGrantRef, DeleteDataInput, DeleteGrantsInput, DeleteScopeInput, DetailedContract, Did, Direction, DkgAttestation, DkgVerifyResult, EmailOtpAuthInput, EmailOtpCredentials, Environment, EthAuthInput, ExecuteBusinessContractOptions, ExecuteOrgDataActionOptions, FetchTrustedManifestOptions, GetActivityLogOptions, GetUsageOptions, GrantCheckParams, GrantCheckResult, GranteeInput, GrantsGetInput, GuestToHostHandler, GuestToHostHandlers, HandshakeResult, HumanMember, InvokeOptions, InvokeRequest, JsonRpcRequest, JsonRpcResponse, KycPollCadence, KycPollOptions, KycStatus, KycStatusKind, ListAgentsInput, ListAgentsResponse, ListContractsParams, ListContractsResult, ListContractsScope, ListHumanMembersInput, ListHumanMembersResponse, ListedContract, Logger, MapCreateInput, MapLifecycleStatus, MapResponse, MapUpdateInput, MapVisibility, MemberRole, MutationResponse, OidcAuthInput, OidcCredentials, OrgAdminStatus, OrgContractGrants, OrgDataActionWire, OrgDataClientOptions, OrgPolicyMeta, OrgPolicyView, OrgUsageReport, OrgUsageReportInput, OrgWriters, OtpChannel, OtpMergeSuggestion, OtpRequestInput, OtpRequestResult, OtpVerifyInput, OtpVerifyResult, PayrollRunRequest, PeerQuoteResult, PolicyGetInput, PurgeOrgInput, QuoteVerifyResult, ReaderSet, RemoveMemberGrantsInput, RoleAssignments, RoleAssignmentsResponse, RoleDefinition, RoleGetResponse, RoleGrant, RoleIdInput, SdkConfig, SecretKind, SecretListInput, SecretListResponse, SecretNameInput, SecretRecord, SecretSetValueInput, SecretView, SecretWriteInput, SessionCrypto, SessionId, SetAgentEgressInput, SetGrantsInput, SetRoleInput, SetWritersInput, SignedTrustManifest, StringEncoding, SubmitUserInputArgs, SubmitUserInputResult, T3nClientConfig, TenantAdmitProjection, TenantAdmitStatus, TenantBaseClient, TenantClientConfig, TenantContractExecuteInput, TenantContractPublishInput, TenantContractSetDescriptorInput, TenantExecutionSession, TenantMapCreateInput, TenantMapUpdatePatch, TenantMeResponse, TenantSdkEnvironment, TenantSelfAdmitResult, TenantStatus, TenantTargetOptions, TokenTxKind, Transport, TrustAnchor, TrustAnchorOrUnsafe, TrustAnchorSource, TrustManifestPayload, UnassignRolesInput, UnsafeTrustServer, UpdateMetaInput, UsageEntry, UsagePage, UsageReportSignature, UserGrant, UserInputProfile, UserUpsertErrorKind, WasmComponent, WasmNextResult, WireBlock, WorkloadAuthInput, WriteDataInput, WriterSet, WritersGetInput };