@terminal3/t3n-sdk 2.11.0 → 2.13.0

package/dist/index.d.ts

@@ -554,6 +554,8 @@ interface UserInputProfile {
     phone_number?: string;
     birthdate?: string;
     nationality?: string;
+    campaign_code?: string;
+    role?: string;
     [key: string]: unknown;
 }
 /**
@@ -573,6 +575,41 @@ interface SubmitUserInputArgs {
      * Most callers should leave this `undefined`.
      */
     requireExistingUser?: boolean;
+    /**
+     * MAT-1618 testnet self-admit. When `true`, the contract additionally
+     * runs the self-admit side-effect after the profile commit: writes
+     * the caller's DID into `idx:_tenants` + `idx:_tenant_quotas` and
+     * mints any operator-configured welcome credits. Inspect the
+     * `tenantAdmit` field on the response for the outcome.
+     *
+     * Testnet-only. Production clusters return
+     * `tenantAdmit.status = "refused"` with
+     * `reason = "not_testnet" | "self_admit_disabled" | "not_eth_derived"`.
+     * The profile commit always succeeds regardless of the inner outcome.
+     *
+     * Most callers should leave this `undefined`.
+     */
+    becomeDevTenant?: boolean;
+}
+/**
+ * MAT-1618 self-admit projection from `user-upsert`. Present only
+ * when the caller set `becomeDevTenant: true` on the request.
+ *
+ * - `status: "admitted"` — first call for this DID; tenant record
+ *   committed and (if configured) welcome credits minted into
+ *   `grantedCredits`.
+ * - `status: "already-admitted"` — replay; idempotent no-op.
+ * - `status: "refused"` — the cluster declined the self-admit;
+ *   `reason` is the machine-readable cause (`not_testnet`,
+ *   `self_admit_disabled`, `not_eth_derived`), `detail` is a
+ *   human-readable string.
+ */
+type TenantAdmitStatus = "admitted" | "already-admitted" | "refused";
+interface TenantAdmitProjection {
+    status: TenantAdmitStatus;
+    grantedCredits?: string;
+    reason?: string;
+    detail?: string;
 }
 /**
  * Response shape returned by the slim `user-upsert`. Carries the
@@ -585,6 +622,11 @@ interface SubmitUserInputResult {
     refusedFields?: string[];
     mergeSuggestion?: OtpMergeSuggestion;
     userFound?: boolean;
+    /**
+     * MAT-1618 self-admit projection. Present only when the caller
+     * set `becomeDevTenant: true` on the request.
+     */
+    tenantAdmit?: TenantAdmitProjection;
 }
 /**
  * Discriminator for {@link UserUpsertError}. Mirrors the
@@ -1679,6 +1721,12 @@ declare class T3nClient {
         organisationDid?: string;
         attestations?: unknown;
         keys?: Record<string, unknown>;
+        /**
+         * MAT-1618 testnet self-admit, propagated to the inner
+         * {@link submitUserInput} call. Inspect `result.tenantAdmit` for
+         * the outcome.
+         */
+        becomeDevTenant?: boolean;
         getOtpCode: (contact: string, channel: OtpChannel) => Promise<string> | string;
     }): Promise<SubmitUserInputResult>;
     /**
@@ -2722,4 +2770,4 @@ declare function clearKeyCache(): void;
 declare function loadConfig(baseUrl?: string): SdkConfig;
 
 export { AGENT_PUBKEY_LEN, AuthMethod, AuthenticationError, ContractResponseError, DEFAULT_INDIVIDUAL_THRESHOLD_CENTS, DEFAULT_KYC_POLL_CADENCE, DELEGATION_CREDENTIAL_DOMAIN, DELEGATION_INVOCATION_DOMAIN, DelegationCustodialClient, ETH_SIG_LEN, HandshakeError, HttpTransport, KycStatusTimeoutError, LogLevel, MockTransport, NODE_URLS, NONCE_LEN, OrgDataClient, REQUEST_HASH_LEN, RpcError, SessionExpiredError, SessionOrgDataClient, SessionStateError, SessionStatus, T3nClient, T3nError, TERMINAL_KYC_STATUSES, UserUpsertError, VC_ID_LEN, WasmError, _b64uEncode, assertShape, b64uDecodeStrict, b64uEncodeBytes, buildDelegationCredential, buildInvocationPreimage, buildPayrollDirectInvocation, buildPayrollInvocation, bytesToString, canonicaliseCredential, canonicaliseRequest, clearKeyCache, compactDidFromBytes, createDefaultHandlers, createEthAuthInput, createLogger, createMlKemPublicKeyHandler, createOidcAuthInput, createOrgDataClientFromSession, createRandomHandler, decodeWasmErrorMessage, eip191Digest, ethRecoverEip191, eth_get_address, extractWasmError, fetchDkgAttestation, fetchMlKemPublicKey, generateRandomString, generateUUID, getEnvironment, getEnvironmentName, getGlobalLogLevel, getLogger, getNodeUrl, getScriptVersion, isDataGetResponse, isDataListResponse, isMutationResponse, isObject, isOrgContractGrants, isOrgPolicyMeta, isOrgWriters, loadConfig, loadWasmComponent, metamask_get_address, metamask_sign, parseContractResponse, redactSecrets, redactSecretsFromJson, requestHash, setEnvironment, setGlobalLogLevel, setNodeUrl, signAgentInvocation, signCredential, stringToBytes, validateConfig, validateCredentialBody, verifyDkgAttestation, verifyTdxQuote };
-export type { AgeBand, AuthInput, BuildDelegationCredentialOpts, BuildPayrollDirectInvocationOpts, BuildPayrollInvocationOpts, ClientAuth, ClientHandshake, ConfigValidationResult, ContractResponseSchema, CreatePolicyInput, DataGetInput, DataGetResponse, DataListInput, DataListResponse, DelegationCredential, DelegationCustodialClientOpts, DelegationEnvelope, DeleteDataInput, DeleteGrantsInput, DeleteScopeInput, Did, DkgAttestation, DkgVerifyResult, EmployeeRecord, EmploymentStatus, Environment, EthAuthInput, ExecuteOrgDataActionOptions, ExpenseClaim, GrantsGetInput, GuestToHostHandler, GuestToHostHandlers, HandshakeResult, JsonRpcRequest, JsonRpcResponse, KycPollCadence, KycPollOptions, KycStatus, KycStatusKind, Logger, MutationResponse, OidcAuthInput, OidcCredentials, OrgContractGrants, OrgDataActionWire, OrgDataClientOptions, OrgPolicyMeta, OrgWriters, OtpChannel, OtpMergeSuggestion, OtpRequestInput, OtpRequestResult, OtpVerifyInput, OtpVerifyResult, PayrollInvocation, PayrollInvocationDelegated, PayrollInvocationDirect, PayrollRunRequest, PeerQuoteResult, PolicyGetInput, QuoteVerifyResult, ResidencyCategory, SdkConfig, SessionCrypto, SessionId, SetGrantsInput, SetWritersInput, SignCustodialResult, SignDelegationResponse, SubmitUserInputArgs, SubmitUserInputResult, T3nClientConfig, Transport, UpdateMetaInput, UserGrant, UserInputProfile, UserUpsertErrorKind, WasmComponent, WasmNextResult, WriteDataInput, WritersGetInput };
+export type { AgeBand, AuthInput, BuildDelegationCredentialOpts, BuildPayrollDirectInvocationOpts, BuildPayrollInvocationOpts, ClientAuth, ClientHandshake, ConfigValidationResult, ContractResponseSchema, CreatePolicyInput, DataGetInput, DataGetResponse, DataListInput, DataListResponse, DelegationCredential, DelegationCustodialClientOpts, DelegationEnvelope, DeleteDataInput, DeleteGrantsInput, DeleteScopeInput, Did, DkgAttestation, DkgVerifyResult, EmployeeRecord, EmploymentStatus, Environment, EthAuthInput, ExecuteOrgDataActionOptions, ExpenseClaim, GrantsGetInput, GuestToHostHandler, GuestToHostHandlers, HandshakeResult, JsonRpcRequest, JsonRpcResponse, KycPollCadence, KycPollOptions, KycStatus, KycStatusKind, Logger, MutationResponse, OidcAuthInput, OidcCredentials, OrgContractGrants, OrgDataActionWire, OrgDataClientOptions, OrgPolicyMeta, OrgWriters, OtpChannel, OtpMergeSuggestion, OtpRequestInput, OtpRequestResult, OtpVerifyInput, OtpVerifyResult, PayrollInvocation, PayrollInvocationDelegated, PayrollInvocationDirect, PayrollRunRequest, PeerQuoteResult, PolicyGetInput, QuoteVerifyResult, ResidencyCategory, SdkConfig, SessionCrypto, SessionId, SetGrantsInput, SetWritersInput, SignCustodialResult, SignDelegationResponse, SubmitUserInputArgs, SubmitUserInputResult, T3nClientConfig, TenantAdmitProjection, TenantAdmitStatus, Transport, UpdateMetaInput, UserGrant, UserInputProfile, UserUpsertErrorKind, WasmComponent, WasmNextResult, WriteDataInput, WritersGetInput };