infra-sdk-typescript 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -354,44 +354,59 @@ type TokenType = "ASSET" | "YIELD_BEARING";
 type TokenStatus = LooseUnion<"PENDING" | "ACTIVE" | "PAUSED" | "RETIRED">;
 type TokenTransactionType = LooseUnion<"MINT" | "BURN" | "TRANSFER" | "DEPLOY" | "REDEEM" | "SNAPSHOT">;
 type TokenTransactionStatus = LooseUnion<"PENDING" | "CONFIRMED" | "FAILED">;
+/**
+ * Chain id a token is deployed on, e.g. `84532` (Base Sepolia). The API accepts it as a number
+ * or a numeric string; responses always return it as a string.
+ */
+type TokenChainId = string | number;
+type AssetClass = LooseUnion<"FIXED_INCOME" | "MONEY_MARKET" | "REAL_ESTATE" | "COMMODITY" | "EQUITY" | "LOYALTY_VOUCHER">;
+/** Day-count convention used to accrue yield. */
+type YieldDayCount = LooseUnion<"ACT_365" | "ACT_360" | "THIRTY_360">;
+/** Stablecoin a yield payout is made in. Omit to pay out in the token's own settlement asset. */
+type YieldPayoutToken = LooseUnion<"CNGN">;
 interface YieldParams {
-    /** Annual yield rate as a percentage, e.g. `5.5` for 5.5%. */
+    /**
+     * Annual yield rate as a percentage, e.g. `5.5` for 5.5%. Must be greater than `0`, at most
+     * `100`, and have no more than 2 decimal places.
+     */
     annualRate: number;
-    /** Maturity date, `YYYY-MM-DD`. */
+    /** Maturity date, `YYYY-MM-DD`. Must be in the future. */
     maturityDate: string;
-    /** First coupon date, `YYYY-MM-DD`. */
+    /** First coupon date, `YYYY-MM-DD`. Must be in the future and before `maturityDate`. */
     firstCouponDate: string;
-    /** Coupon interval, in days. */
+    /** Coupon interval, in days. Must be at least `1`. */
     couponInterval: number;
-    /** Day-count convention, e.g. `"ACT_365"`. */
-    dayCount: string;
-    /** Face value per token, in fiat major units. */
+    dayCount: YieldDayCount;
+    /** Face value per token, in fiat major units. Must be at least `1`. */
     faceValuePerToken: number;
     /** Grace period, in seconds. */
-    gracePeriod?: number;
-    callable?: boolean;
-    /** Call date, `YYYY-MM-DD`. Only meaningful when `callable` is `true`. */
+    gracePeriod: number;
+    callable: boolean;
+    /**
+     * Call date, `YYYY-MM-DD`. Only meaningful when `callable` is `true`. Must be in the future
+     * and before `maturityDate`.
+     */
     callDate?: string;
     /** Early redemption fee, in basis points. */
     earlyRedemptionFee?: number;
 }
 interface CreateTokenParams {
-    /** Short token symbol, e.g. `"ACMB3"`. */
+    /** Short token symbol, e.g. `"ACMB3"`. At most 10 characters. */
     ticker: string;
     name: string;
-    /** Issue price per token, in fiat major units. */
-    price?: number;
-    chainId: string;
-    decimals: number;
-    /** Asset class, e.g. `"MONEY_MARKET"`. */
-    assetClass: string;
+    /** Issue price per token, in fiat major units. Must be at least `1`. */
+    price: number;
+    chainId: TokenChainId;
+    /** Between `1` and `18`. */
+    decimals?: number;
+    assetClass: AssetClass;
     tokenType: TokenType;
     /** Maximum holders; `0` for unlimited. */
-    maxShareholders?: number;
+    maxShareholders: number;
     /** Per-investor cap; `0` for unlimited. */
-    maxTokensPerInvestor?: number;
+    maxTokensPerInvestor: number;
     /** Lock-up duration, in seconds; `0` for none. */
-    lockUpDuration?: number;
+    lockUpDuration: number;
     /** Required when `tokenType` is `"YIELD_BEARING"`. */
     yieldParams?: YieldParams;
 }
@@ -457,7 +472,7 @@ interface ListTokensParams {
 }
 interface BurnTokenParams {
     tokenId: string;
-    chainId: string;
+    chainId: TokenChainId;
     /** Holder address to burn from. */
     fromAddress: string;
     /** Amount to burn, in token units. */
@@ -467,7 +482,7 @@ interface BurnTokenParams {
 }
 interface MintTokenParams {
     tokenId: string;
-    chainId: string;
+    chainId: TokenChainId;
     /** Recipient wallet address. */
     toAddress: string;
     /** Amount to mint, in token units. */
@@ -476,8 +491,8 @@ interface MintTokenParams {
 }
 interface TransferTokenParams {
     tokenId: string;
-    chainId: string;
-    /** HD address index of the sending holder wallet. */
+    chainId: TokenChainId;
+    /** HD address index of the sending holder wallet. Must be greater than `0`. */
     fromAddressIndex: number;
     toAddress: string;
     /** Amount to transfer, in token units. */
@@ -486,9 +501,10 @@ interface TransferTokenParams {
 }
 interface ForcedTransferTokenParams {
     tokenId: string;
-    chainId: string;
-    /** Holder address to move tokens out of. */
+    chainId: TokenChainId;
+    /** Holder address to move tokens out of. Must be a valid EVM address. */
     fromAddress: string;
+    /** Must be a valid EVM address. */
     toAddress: string;
     /** Amount to transfer, in token units. */
     amount: number;
@@ -517,7 +533,7 @@ interface TokenTransferResult {
 }
 interface RegisterTokenWalletParams {
     tokenId: string;
-    chainId: string;
+    chainId: TokenChainId;
     walletAddress: string;
 }
 interface RegisterTokenWalletResult {
@@ -527,7 +543,7 @@ interface RegisterTokenWalletResult {
 }
 interface GetTokenHoldersParams {
     tokenId: string;
-    chainId?: string;
+    chainId?: TokenChainId;
     page?: number;
     pageSize?: number;
 }
@@ -538,7 +554,7 @@ interface TokenHolder {
 }
 interface GetWalletBalanceParams {
     tokenId: string;
-    chainId: string;
+    chainId: TokenChainId;
     walletAddress: string;
 }
 /** A single wallet's balance of a token, returned by {@link TokenizationResource.getWalletBalance}. */
@@ -553,7 +569,7 @@ interface TokenWalletBalance {
 }
 interface ListTokenTransactionsParams {
     tokenId?: string;
-    chainId?: string;
+    chainId?: TokenChainId;
     page?: number;
     pageSize?: number;
     type?: TokenTransactionType;
@@ -584,62 +600,100 @@ interface TokenTransactionRecord {
     memo?: string;
     createdAt?: string;
     confirmedAt?: string;
+    /** Distribution snapshot id, set on `SNAPSHOT` transactions. */
+    snapshotId?: number;
 }
 interface UpdateTokenYieldParams {
     /** Yield-bearing token id. */
     tokenId: string;
-    chainId: string;
-    /** New annual yield rate, as a percentage. */
+    chainId: TokenChainId;
+    /** New annual yield rate, as a percentage. Same limits as {@link YieldParams.annualRate}. */
     annualRate: number;
 }
+/** Result of {@link TokenizationResource.updateYield}. */
+interface UpdateYieldResult {
+    /** Annual rate before the update, as a percentage. */
+    currentRate: number;
+    /** Annual rate after the update, as a percentage. */
+    newRate: number;
+    txHash: string;
+}
 interface DistributeYieldParams {
     tokenId: string;
-    chainId: string;
-    /** Amount to fund the distribution, in fiat major units. */
+    chainId: TokenChainId;
+    /** Amount to fund the distribution, in fiat major units. A whole number, at least `1`. */
     fundAmount: number;
-    payoutToken?: string;
-    /** Seconds after which unclaimed funds may be reclaimed. */
-    reclaimAfter?: number;
-    memo?: string;
+    payoutToken?: YieldPayoutToken;
+    /** Seconds after which unclaimed funds may be reclaimed. A whole number, at least `1`. */
+    reclaimAfter: number;
+    /** Push the payout to investors instead of letting them claim it. */
+    pushYield?: boolean;
+    /** Note recorded with the distribution. */
+    memo: string;
 }
 interface PayCouponParams {
     tokenId: string;
-    chainId: string;
-    payoutToken?: string;
+    chainId: TokenChainId;
+    payoutToken?: YieldPayoutToken;
     /** Push the coupon to investors instead of letting them claim it. */
-    pushYield?: boolean;
-    reclaimAfter?: number;
-    memo?: string;
+    pushYield: boolean;
+    /** Seconds after which unclaimed funds may be reclaimed. At least `1`. */
+    reclaimAfter: number;
+    /** Note recorded with the coupon payment. */
+    memo: string;
 }
 interface ClaimYieldParams {
     tokenId: string;
-    chainId: string;
-    /** HD address index of the claiming investor. */
+    chainId: TokenChainId;
+    /** HD address index of the claiming investor. At least `1`. */
     investorAddressIndex: number;
-    /** Distribution snapshot to claim against. */
+    /** Distribution snapshot to claim against. At least `1`. */
     snapshotId: number;
 }
 interface RedeemPrincipalParams {
     tokenId: string;
-    chainId: string;
-    /** Push redeemed funds to investors instead of letting them claim. */
-    pushYield?: boolean;
+    chainId: TokenChainId;
+}
+/** Result of {@link TokenizationResource.redeemPrincipal} — one transaction per redemption payout. */
+interface RedeemPrincipalResult {
+    tokenId: string;
+    operationRef: string;
+    transactionIds: string[];
+    txHashes: string[];
+}
+interface ReclaimUnclaimedYieldParams {
+    tokenId: string;
+    chainId: TokenChainId;
+    /** Distribution snapshot to reclaim unclaimed funds from. A whole number, at least `1`. */
+    snapshotId: number;
+}
+/** Result of {@link TokenizationResource.reclaimUnclaimedYield}. */
+interface ReclaimUnclaimedYieldResult {
+    tokenId: string;
+    /** Snapshot id, as a numeric string. */
+    snapshotId: string;
+    /** Amount reclaimed, as a decimal string. */
+    reclaimed: string;
+    operationRef: string;
+    txHash: string;
 }
-/** Result of a yield operation that only returns a transaction hash. */
+/** Result of {@link TokenizationResource.claimYield}. */
 interface YieldTxResult {
     txHash: string;
 }
-/** Result of a yield operation that also returns an operation reference (distribute, pay-coupon). */
+/** Result of {@link TokenizationResource.distributeYield} / {@link TokenizationResource.payCoupon}. */
 interface YieldOperationResult {
+    tokenId: string;
     operationRef: string;
+    transactionId: string;
     txHash: string;
 }
 
 /**
  * The Tokenization service — issues and manages tokenized real-world assets: deployment,
  * mint/burn/transfer, wallet whitelisting, holder balances, and the yield lifecycle
- * (rate updates, coupon payments, claims, and principal redemption) for `YIELD_BEARING`
- * tokens.
+ * (rate updates, coupon payments, claims, principal redemption, and reclaiming unclaimed
+ * payouts) for `YIELD_BEARING` tokens.
  */
 declare class TokenizationResource extends APIResource {
     /**
@@ -683,15 +737,20 @@ declare class TokenizationResource extends APIResource {
     /** Returns token transactions, optionally filtered by token. */
     listTokenTransactions(params?: ListTokenTransactionsParams, overrides?: RequestOverrides): Promise<Page<TokenTransactionRecord>>;
     /** Updates the annual yield rate for a yield-bearing token. */
-    updateYield(params: UpdateTokenYieldParams, overrides?: RequestOverrides): Promise<YieldTxResult>;
+    updateYield(params: UpdateTokenYieldParams, overrides?: RequestOverrides): Promise<UpdateYieldResult>;
     /** Funds and distributes a yield payout to holders. Unclaimed funds may be reclaimed after `reclaimAfter`. */
     distributeYield(params: DistributeYieldParams, overrides?: IdempotentRequestOverrides): Promise<YieldOperationResult>;
     /** Pays the scheduled coupon for a yield-bearing token. Set `pushYield` to push funds rather than let investors claim. */
     payCoupon(params: PayCouponParams, overrides?: IdempotentRequestOverrides): Promise<YieldOperationResult>;
     /** Claims an investor's yield for a given distribution snapshot. */
     claimYield(params: ClaimYieldParams, overrides?: IdempotentRequestOverrides): Promise<YieldTxResult>;
-    /** Redeems principal to holders at maturity. Set `pushYield` to push funds rather than let investors claim. */
-    redeemPrincipal(params: RedeemPrincipalParams, overrides?: IdempotentRequestOverrides): Promise<YieldTxResult>;
+    /** Redeems principal to holders at maturity. */
+    redeemPrincipal(params: RedeemPrincipalParams, overrides?: IdempotentRequestOverrides): Promise<RedeemPrincipalResult>;
+    /**
+     * Returns a snapshot's unclaimed yield to the issuer once its `reclaimAfter` window has
+     * passed. An `Idempotency-Key` is generated per call unless you pass your own.
+     */
+    reclaimUnclaimedYield(params: ReclaimUnclaimedYieldParams, overrides?: IdempotentRequestOverrides): Promise<ReclaimUnclaimedYieldResult>;
 }
 
 type SubscriptionStatus = LooseUnion<"active" | "paused" | "deleted">;
@@ -946,4 +1005,4 @@ declare function verifyIndexerWebhookSignature(options: VerifyIndexerWebhookOpti
 /** Generates a UUIDv4 suitable for use as an `Idempotency-Key` header value. */
 declare function generateIdempotencyKey(): string;
 
-export { AuthenticationError, BadRequestError, type BurnTokenParams, type Chain, type ChainType, type ClaimYieldParams, ConflictError, type CreateSubscriptionParams, type CreateTokenParams, type DeactivateWalletParams, type DistributeYieldParams, type EventCatalogEntry, type EventFamily, type EventKind, type FlatPaginatedResponse, type GenerateWalletsParams, type GeneratedWallet, type GetTokenHoldersParams, type GetTransactionHistoryParams, type GetWalletByAddressIndexParams, type GetWalletByAddressParams, type GetWalletCountParams, type HdEnabledStatus, type HttpMethod, type IdempotentRequestOverrides, IndexerResource, type IndexerSubscription, type IndexerSubscriptionWithSecret, InfraAPIError, InfraAuthTokenError, InfraClient, type InfraClientOptions, InfraConnectionError, InfraConnectionTimeoutError, InfraError, type InitiateTransferParams, InternalServerError, type ListEventCatalogParams, type ListSubscriptionsParams, type ListTokenTransactionsParams, type ListTokensParams, type ListWalletsParams, type LooseUnion, type MetaPaginatedResponse, type MintTokenParams, type Network, NotFoundError, type OffsetPaginatedResponse, Page, type PayCouponParams, PaymentRequiredError, PermissionDeniedError, type QueryValue, RateLimitError, type RedeemPrincipalParams, type RegisterTokenWalletParams, type RegisterTokenWalletResult, type RequestOptions, type RequestOverrides, ServiceUnavailableError, type SignTransactionParams, type SignTransactionRequest, type SignedTransactionResult, type SubscriptionStatus, type SupportedChain, type TokenChainDeployment, type TokenDeploymentResult, type TokenDetail, type TokenHolder, type TokenOperationResult, type TokenStatus, type TokenSummary, type TokenTransactionRecord, type TokenTransactionStatus, type TokenTransactionType, type TokenTransferResult, type TokenType, TokenizationResource, type TransactionStatus, type TransferTokenParams, UnknownAPIError, UnprocessableEntityError, type UpdateSubscriptionParams, type UpdateTokenYieldParams, type VerifyIndexerWebhookOptions, type VerifyWalletWebhookOptions, type Wallet, type WalletBalance, type WalletCount, WalletResource, type WalletTransaction, WebhookSignatureVerificationError, type YieldOperationResult, type YieldParams, type YieldTxResult, generateIdempotencyKey, verifyIndexerWebhookSignature, verifyWalletWebhookSignature };
+export { type AssetClass, AuthenticationError, BadRequestError, type BurnTokenParams, type Chain, type ChainType, type ClaimYieldParams, ConflictError, type CreateSubscriptionParams, type CreateTokenParams, type DeactivateWalletParams, type DistributeYieldParams, type EventCatalogEntry, type EventFamily, type EventKind, type FlatPaginatedResponse, type ForcedTransferTokenParams, type GenerateWalletsParams, type GeneratedWallet, type GetTokenHoldersParams, type GetTransactionHistoryParams, type GetWalletBalanceParams, type GetWalletByAddressIndexParams, type GetWalletByAddressParams, type GetWalletCountParams, type HdEnabledStatus, type HttpMethod, type IdempotentRequestOverrides, IndexerResource, type IndexerSubscription, type IndexerSubscriptionWithSecret, InfraAPIError, InfraAuthTokenError, InfraClient, type InfraClientOptions, InfraConnectionError, InfraConnectionTimeoutError, InfraError, type InitiateTransferParams, InternalServerError, type ListEventCatalogParams, type ListSubscriptionsParams, type ListTokenTransactionsParams, type ListTokensParams, type ListWalletsParams, type LooseUnion, type MetaPaginatedResponse, type MintTokenParams, type Network, NotFoundError, type OffsetPaginatedResponse, Page, type PayCouponParams, PaymentRequiredError, PermissionDeniedError, type QueryValue, RateLimitError, type ReclaimUnclaimedYieldParams, type ReclaimUnclaimedYieldResult, type RedeemPrincipalParams, type RedeemPrincipalResult, type RegisterTokenWalletParams, type RegisterTokenWalletResult, type RequestOptions, type RequestOverrides, ServiceUnavailableError, type SignTransactionParams, type SignTransactionRequest, type SignedTransactionResult, type SubscriptionStatus, type SupportedChain, type TokenChainDeployment, type TokenChainId, type TokenDeploymentResult, type TokenDetail, type TokenHolder, type TokenOperationResult, type TokenStatus, type TokenSummary, type TokenTransactionRecord, type TokenTransactionStatus, type TokenTransactionType, type TokenTransferResult, type TokenType, type TokenWalletBalance, TokenizationResource, type TransactionStatus, type TransferTokenParams, UnknownAPIError, UnprocessableEntityError, type UpdateSubscriptionParams, type UpdateTokenYieldParams, type UpdateYieldResult, type VerifyIndexerWebhookOptions, type VerifyWalletWebhookOptions, type Wallet, type WalletBalance, type WalletCount, WalletResource, type WalletTransaction, WebhookSignatureVerificationError, type YieldDayCount, type YieldOperationResult, type YieldParams, type YieldPayoutToken, type YieldTxResult, generateIdempotencyKey, verifyIndexerWebhookSignature, verifyWalletWebhookSignature };

package/dist/index.d.ts

@@ -354,44 +354,59 @@ type TokenType = "ASSET" | "YIELD_BEARING";
 type TokenStatus = LooseUnion<"PENDING" | "ACTIVE" | "PAUSED" | "RETIRED">;
 type TokenTransactionType = LooseUnion<"MINT" | "BURN" | "TRANSFER" | "DEPLOY" | "REDEEM" | "SNAPSHOT">;
 type TokenTransactionStatus = LooseUnion<"PENDING" | "CONFIRMED" | "FAILED">;
+/**
+ * Chain id a token is deployed on, e.g. `84532` (Base Sepolia). The API accepts it as a number
+ * or a numeric string; responses always return it as a string.
+ */
+type TokenChainId = string | number;
+type AssetClass = LooseUnion<"FIXED_INCOME" | "MONEY_MARKET" | "REAL_ESTATE" | "COMMODITY" | "EQUITY" | "LOYALTY_VOUCHER">;
+/** Day-count convention used to accrue yield. */
+type YieldDayCount = LooseUnion<"ACT_365" | "ACT_360" | "THIRTY_360">;
+/** Stablecoin a yield payout is made in. Omit to pay out in the token's own settlement asset. */
+type YieldPayoutToken = LooseUnion<"CNGN">;
 interface YieldParams {
-    /** Annual yield rate as a percentage, e.g. `5.5` for 5.5%. */
+    /**
+     * Annual yield rate as a percentage, e.g. `5.5` for 5.5%. Must be greater than `0`, at most
+     * `100`, and have no more than 2 decimal places.
+     */
     annualRate: number;
-    /** Maturity date, `YYYY-MM-DD`. */
+    /** Maturity date, `YYYY-MM-DD`. Must be in the future. */
     maturityDate: string;
-    /** First coupon date, `YYYY-MM-DD`. */
+    /** First coupon date, `YYYY-MM-DD`. Must be in the future and before `maturityDate`. */
     firstCouponDate: string;
-    /** Coupon interval, in days. */
+    /** Coupon interval, in days. Must be at least `1`. */
     couponInterval: number;
-    /** Day-count convention, e.g. `"ACT_365"`. */
-    dayCount: string;
-    /** Face value per token, in fiat major units. */
+    dayCount: YieldDayCount;
+    /** Face value per token, in fiat major units. Must be at least `1`. */
     faceValuePerToken: number;
     /** Grace period, in seconds. */
-    gracePeriod?: number;
-    callable?: boolean;
-    /** Call date, `YYYY-MM-DD`. Only meaningful when `callable` is `true`. */
+    gracePeriod: number;
+    callable: boolean;
+    /**
+     * Call date, `YYYY-MM-DD`. Only meaningful when `callable` is `true`. Must be in the future
+     * and before `maturityDate`.
+     */
     callDate?: string;
     /** Early redemption fee, in basis points. */
     earlyRedemptionFee?: number;
 }
 interface CreateTokenParams {
-    /** Short token symbol, e.g. `"ACMB3"`. */
+    /** Short token symbol, e.g. `"ACMB3"`. At most 10 characters. */
     ticker: string;
     name: string;
-    /** Issue price per token, in fiat major units. */
-    price?: number;
-    chainId: string;
-    decimals: number;
-    /** Asset class, e.g. `"MONEY_MARKET"`. */
-    assetClass: string;
+    /** Issue price per token, in fiat major units. Must be at least `1`. */
+    price: number;
+    chainId: TokenChainId;
+    /** Between `1` and `18`. */
+    decimals?: number;
+    assetClass: AssetClass;
     tokenType: TokenType;
     /** Maximum holders; `0` for unlimited. */
-    maxShareholders?: number;
+    maxShareholders: number;
     /** Per-investor cap; `0` for unlimited. */
-    maxTokensPerInvestor?: number;
+    maxTokensPerInvestor: number;
     /** Lock-up duration, in seconds; `0` for none. */
-    lockUpDuration?: number;
+    lockUpDuration: number;
     /** Required when `tokenType` is `"YIELD_BEARING"`. */
     yieldParams?: YieldParams;
 }
@@ -457,7 +472,7 @@ interface ListTokensParams {
 }
 interface BurnTokenParams {
     tokenId: string;
-    chainId: string;
+    chainId: TokenChainId;
     /** Holder address to burn from. */
     fromAddress: string;
     /** Amount to burn, in token units. */
@@ -467,7 +482,7 @@ interface BurnTokenParams {
 }
 interface MintTokenParams {
     tokenId: string;
-    chainId: string;
+    chainId: TokenChainId;
     /** Recipient wallet address. */
     toAddress: string;
     /** Amount to mint, in token units. */
@@ -476,8 +491,8 @@ interface MintTokenParams {
 }
 interface TransferTokenParams {
     tokenId: string;
-    chainId: string;
-    /** HD address index of the sending holder wallet. */
+    chainId: TokenChainId;
+    /** HD address index of the sending holder wallet. Must be greater than `0`. */
     fromAddressIndex: number;
     toAddress: string;
     /** Amount to transfer, in token units. */
@@ -486,9 +501,10 @@ interface TransferTokenParams {
 }
 interface ForcedTransferTokenParams {
     tokenId: string;
-    chainId: string;
-    /** Holder address to move tokens out of. */
+    chainId: TokenChainId;
+    /** Holder address to move tokens out of. Must be a valid EVM address. */
     fromAddress: string;
+    /** Must be a valid EVM address. */
     toAddress: string;
     /** Amount to transfer, in token units. */
     amount: number;
@@ -517,7 +533,7 @@ interface TokenTransferResult {
 }
 interface RegisterTokenWalletParams {
     tokenId: string;
-    chainId: string;
+    chainId: TokenChainId;
     walletAddress: string;
 }
 interface RegisterTokenWalletResult {
@@ -527,7 +543,7 @@ interface RegisterTokenWalletResult {
 }
 interface GetTokenHoldersParams {
     tokenId: string;
-    chainId?: string;
+    chainId?: TokenChainId;
     page?: number;
     pageSize?: number;
 }
@@ -538,7 +554,7 @@ interface TokenHolder {
 }
 interface GetWalletBalanceParams {
     tokenId: string;
-    chainId: string;
+    chainId: TokenChainId;
     walletAddress: string;
 }
 /** A single wallet's balance of a token, returned by {@link TokenizationResource.getWalletBalance}. */
@@ -553,7 +569,7 @@ interface TokenWalletBalance {
 }
 interface ListTokenTransactionsParams {
     tokenId?: string;
-    chainId?: string;
+    chainId?: TokenChainId;
     page?: number;
     pageSize?: number;
     type?: TokenTransactionType;
@@ -584,62 +600,100 @@ interface TokenTransactionRecord {
     memo?: string;
     createdAt?: string;
     confirmedAt?: string;
+    /** Distribution snapshot id, set on `SNAPSHOT` transactions. */
+    snapshotId?: number;
 }
 interface UpdateTokenYieldParams {
     /** Yield-bearing token id. */
     tokenId: string;
-    chainId: string;
-    /** New annual yield rate, as a percentage. */
+    chainId: TokenChainId;
+    /** New annual yield rate, as a percentage. Same limits as {@link YieldParams.annualRate}. */
     annualRate: number;
 }
+/** Result of {@link TokenizationResource.updateYield}. */
+interface UpdateYieldResult {
+    /** Annual rate before the update, as a percentage. */
+    currentRate: number;
+    /** Annual rate after the update, as a percentage. */
+    newRate: number;
+    txHash: string;
+}
 interface DistributeYieldParams {
     tokenId: string;
-    chainId: string;
-    /** Amount to fund the distribution, in fiat major units. */
+    chainId: TokenChainId;
+    /** Amount to fund the distribution, in fiat major units. A whole number, at least `1`. */
     fundAmount: number;
-    payoutToken?: string;
-    /** Seconds after which unclaimed funds may be reclaimed. */
-    reclaimAfter?: number;
-    memo?: string;
+    payoutToken?: YieldPayoutToken;
+    /** Seconds after which unclaimed funds may be reclaimed. A whole number, at least `1`. */
+    reclaimAfter: number;
+    /** Push the payout to investors instead of letting them claim it. */
+    pushYield?: boolean;
+    /** Note recorded with the distribution. */
+    memo: string;
 }
 interface PayCouponParams {
     tokenId: string;
-    chainId: string;
-    payoutToken?: string;
+    chainId: TokenChainId;
+    payoutToken?: YieldPayoutToken;
     /** Push the coupon to investors instead of letting them claim it. */
-    pushYield?: boolean;
-    reclaimAfter?: number;
-    memo?: string;
+    pushYield: boolean;
+    /** Seconds after which unclaimed funds may be reclaimed. At least `1`. */
+    reclaimAfter: number;
+    /** Note recorded with the coupon payment. */
+    memo: string;
 }
 interface ClaimYieldParams {
     tokenId: string;
-    chainId: string;
-    /** HD address index of the claiming investor. */
+    chainId: TokenChainId;
+    /** HD address index of the claiming investor. At least `1`. */
     investorAddressIndex: number;
-    /** Distribution snapshot to claim against. */
+    /** Distribution snapshot to claim against. At least `1`. */
     snapshotId: number;
 }
 interface RedeemPrincipalParams {
     tokenId: string;
-    chainId: string;
-    /** Push redeemed funds to investors instead of letting them claim. */
-    pushYield?: boolean;
+    chainId: TokenChainId;
+}
+/** Result of {@link TokenizationResource.redeemPrincipal} — one transaction per redemption payout. */
+interface RedeemPrincipalResult {
+    tokenId: string;
+    operationRef: string;
+    transactionIds: string[];
+    txHashes: string[];
+}
+interface ReclaimUnclaimedYieldParams {
+    tokenId: string;
+    chainId: TokenChainId;
+    /** Distribution snapshot to reclaim unclaimed funds from. A whole number, at least `1`. */
+    snapshotId: number;
+}
+/** Result of {@link TokenizationResource.reclaimUnclaimedYield}. */
+interface ReclaimUnclaimedYieldResult {
+    tokenId: string;
+    /** Snapshot id, as a numeric string. */
+    snapshotId: string;
+    /** Amount reclaimed, as a decimal string. */
+    reclaimed: string;
+    operationRef: string;
+    txHash: string;
 }
-/** Result of a yield operation that only returns a transaction hash. */
+/** Result of {@link TokenizationResource.claimYield}. */
 interface YieldTxResult {
     txHash: string;
 }
-/** Result of a yield operation that also returns an operation reference (distribute, pay-coupon). */
+/** Result of {@link TokenizationResource.distributeYield} / {@link TokenizationResource.payCoupon}. */
 interface YieldOperationResult {
+    tokenId: string;
     operationRef: string;
+    transactionId: string;
     txHash: string;
 }
 
 /**
  * The Tokenization service — issues and manages tokenized real-world assets: deployment,
  * mint/burn/transfer, wallet whitelisting, holder balances, and the yield lifecycle
- * (rate updates, coupon payments, claims, and principal redemption) for `YIELD_BEARING`
- * tokens.
+ * (rate updates, coupon payments, claims, principal redemption, and reclaiming unclaimed
+ * payouts) for `YIELD_BEARING` tokens.
  */
 declare class TokenizationResource extends APIResource {
     /**
@@ -683,15 +737,20 @@ declare class TokenizationResource extends APIResource {
     /** Returns token transactions, optionally filtered by token. */
     listTokenTransactions(params?: ListTokenTransactionsParams, overrides?: RequestOverrides): Promise<Page<TokenTransactionRecord>>;
     /** Updates the annual yield rate for a yield-bearing token. */
-    updateYield(params: UpdateTokenYieldParams, overrides?: RequestOverrides): Promise<YieldTxResult>;
+    updateYield(params: UpdateTokenYieldParams, overrides?: RequestOverrides): Promise<UpdateYieldResult>;
     /** Funds and distributes a yield payout to holders. Unclaimed funds may be reclaimed after `reclaimAfter`. */
     distributeYield(params: DistributeYieldParams, overrides?: IdempotentRequestOverrides): Promise<YieldOperationResult>;
     /** Pays the scheduled coupon for a yield-bearing token. Set `pushYield` to push funds rather than let investors claim. */
     payCoupon(params: PayCouponParams, overrides?: IdempotentRequestOverrides): Promise<YieldOperationResult>;
     /** Claims an investor's yield for a given distribution snapshot. */
     claimYield(params: ClaimYieldParams, overrides?: IdempotentRequestOverrides): Promise<YieldTxResult>;
-    /** Redeems principal to holders at maturity. Set `pushYield` to push funds rather than let investors claim. */
-    redeemPrincipal(params: RedeemPrincipalParams, overrides?: IdempotentRequestOverrides): Promise<YieldTxResult>;
+    /** Redeems principal to holders at maturity. */
+    redeemPrincipal(params: RedeemPrincipalParams, overrides?: IdempotentRequestOverrides): Promise<RedeemPrincipalResult>;
+    /**
+     * Returns a snapshot's unclaimed yield to the issuer once its `reclaimAfter` window has
+     * passed. An `Idempotency-Key` is generated per call unless you pass your own.
+     */
+    reclaimUnclaimedYield(params: ReclaimUnclaimedYieldParams, overrides?: IdempotentRequestOverrides): Promise<ReclaimUnclaimedYieldResult>;
 }
 
 type SubscriptionStatus = LooseUnion<"active" | "paused" | "deleted">;
@@ -946,4 +1005,4 @@ declare function verifyIndexerWebhookSignature(options: VerifyIndexerWebhookOpti
 /** Generates a UUIDv4 suitable for use as an `Idempotency-Key` header value. */
 declare function generateIdempotencyKey(): string;
 
-export { AuthenticationError, BadRequestError, type BurnTokenParams, type Chain, type ChainType, type ClaimYieldParams, ConflictError, type CreateSubscriptionParams, type CreateTokenParams, type DeactivateWalletParams, type DistributeYieldParams, type EventCatalogEntry, type EventFamily, type EventKind, type FlatPaginatedResponse, type GenerateWalletsParams, type GeneratedWallet, type GetTokenHoldersParams, type GetTransactionHistoryParams, type GetWalletByAddressIndexParams, type GetWalletByAddressParams, type GetWalletCountParams, type HdEnabledStatus, type HttpMethod, type IdempotentRequestOverrides, IndexerResource, type IndexerSubscription, type IndexerSubscriptionWithSecret, InfraAPIError, InfraAuthTokenError, InfraClient, type InfraClientOptions, InfraConnectionError, InfraConnectionTimeoutError, InfraError, type InitiateTransferParams, InternalServerError, type ListEventCatalogParams, type ListSubscriptionsParams, type ListTokenTransactionsParams, type ListTokensParams, type ListWalletsParams, type LooseUnion, type MetaPaginatedResponse, type MintTokenParams, type Network, NotFoundError, type OffsetPaginatedResponse, Page, type PayCouponParams, PaymentRequiredError, PermissionDeniedError, type QueryValue, RateLimitError, type RedeemPrincipalParams, type RegisterTokenWalletParams, type RegisterTokenWalletResult, type RequestOptions, type RequestOverrides, ServiceUnavailableError, type SignTransactionParams, type SignTransactionRequest, type SignedTransactionResult, type SubscriptionStatus, type SupportedChain, type TokenChainDeployment, type TokenDeploymentResult, type TokenDetail, type TokenHolder, type TokenOperationResult, type TokenStatus, type TokenSummary, type TokenTransactionRecord, type TokenTransactionStatus, type TokenTransactionType, type TokenTransferResult, type TokenType, TokenizationResource, type TransactionStatus, type TransferTokenParams, UnknownAPIError, UnprocessableEntityError, type UpdateSubscriptionParams, type UpdateTokenYieldParams, type VerifyIndexerWebhookOptions, type VerifyWalletWebhookOptions, type Wallet, type WalletBalance, type WalletCount, WalletResource, type WalletTransaction, WebhookSignatureVerificationError, type YieldOperationResult, type YieldParams, type YieldTxResult, generateIdempotencyKey, verifyIndexerWebhookSignature, verifyWalletWebhookSignature };
+export { type AssetClass, AuthenticationError, BadRequestError, type BurnTokenParams, type Chain, type ChainType, type ClaimYieldParams, ConflictError, type CreateSubscriptionParams, type CreateTokenParams, type DeactivateWalletParams, type DistributeYieldParams, type EventCatalogEntry, type EventFamily, type EventKind, type FlatPaginatedResponse, type ForcedTransferTokenParams, type GenerateWalletsParams, type GeneratedWallet, type GetTokenHoldersParams, type GetTransactionHistoryParams, type GetWalletBalanceParams, type GetWalletByAddressIndexParams, type GetWalletByAddressParams, type GetWalletCountParams, type HdEnabledStatus, type HttpMethod, type IdempotentRequestOverrides, IndexerResource, type IndexerSubscription, type IndexerSubscriptionWithSecret, InfraAPIError, InfraAuthTokenError, InfraClient, type InfraClientOptions, InfraConnectionError, InfraConnectionTimeoutError, InfraError, type InitiateTransferParams, InternalServerError, type ListEventCatalogParams, type ListSubscriptionsParams, type ListTokenTransactionsParams, type ListTokensParams, type ListWalletsParams, type LooseUnion, type MetaPaginatedResponse, type MintTokenParams, type Network, NotFoundError, type OffsetPaginatedResponse, Page, type PayCouponParams, PaymentRequiredError, PermissionDeniedError, type QueryValue, RateLimitError, type ReclaimUnclaimedYieldParams, type ReclaimUnclaimedYieldResult, type RedeemPrincipalParams, type RedeemPrincipalResult, type RegisterTokenWalletParams, type RegisterTokenWalletResult, type RequestOptions, type RequestOverrides, ServiceUnavailableError, type SignTransactionParams, type SignTransactionRequest, type SignedTransactionResult, type SubscriptionStatus, type SupportedChain, type TokenChainDeployment, type TokenChainId, type TokenDeploymentResult, type TokenDetail, type TokenHolder, type TokenOperationResult, type TokenStatus, type TokenSummary, type TokenTransactionRecord, type TokenTransactionStatus, type TokenTransactionType, type TokenTransferResult, type TokenType, type TokenWalletBalance, TokenizationResource, type TransactionStatus, type TransferTokenParams, UnknownAPIError, UnprocessableEntityError, type UpdateSubscriptionParams, type UpdateTokenYieldParams, type UpdateYieldResult, type VerifyIndexerWebhookOptions, type VerifyWalletWebhookOptions, type Wallet, type WalletBalance, type WalletCount, WalletResource, type WalletTransaction, WebhookSignatureVerificationError, type YieldDayCount, type YieldOperationResult, type YieldParams, type YieldPayoutToken, type YieldTxResult, generateIdempotencyKey, verifyIndexerWebhookSignature, verifyWalletWebhookSignature };

package/dist/index.js

@@ -742,7 +742,7 @@ var TokenizationResource = class extends APIResource {
       ...rest
     });
   }
-  /** Redeems principal to holders at maturity. Set `pushYield` to push funds rather than let investors claim. */
+  /** Redeems principal to holders at maturity. */
   async redeemPrincipal(params, overrides = {}) {
     const { idempotencyKey, ...rest } = overrides;
     return this.client.request({
@@ -753,6 +753,20 @@ var TokenizationResource = class extends APIResource {
       ...rest
     });
   }
+  /**
+   * Returns a snapshot's unclaimed yield to the issuer once its `reclaimAfter` window has
+   * passed. An `Idempotency-Key` is generated per call unless you pass your own.
+   */
+  async reclaimUnclaimedYield(params, overrides = {}) {
+    const { idempotencyKey, ...rest } = overrides;
+    return this.client.request({
+      method: "POST",
+      path: "/v1/tokens/yield/reclaim",
+      body: params,
+      idempotencyKey: idempotencyKey ?? generateIdempotencyKey(),
+      ...rest
+    });
+  }
 };
 
 // src/resources/indexer/index.ts