@coinbase-sample/prime-sdk-ts 0.8.2 → 0.10.0

package/dist/types/model/CrossMarginPrimeXMPosition.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+/**
+ * CrossMarginPrimeXMPosition is a single per-asset XM row (proto-backed fields from XMPositionDetails).
+ */
+export type CrossMarginPrimeXMPosition = {
+    /**
+     * Position currency
+     */
+    currency?: string;
+    /**
+     * Current market price
+     */
+    marketPrice?: string;
+    /**
+     * XM spot balance nominal
+     */
+    spotBalance?: string;
+    /**
+     * XM spot balance notional
+     */
+    spotBalanceNotional?: string;
+    /**
+     * XM futures balance nominal
+     */
+    futuresBalance?: string;
+    /**
+     * XM futures balance notional
+     */
+    futuresBalanceNotional?: string;
+    /**
+     * Base margin requirement notional
+     */
+    baseRequirement?: string;
+    /**
+     * Total margin required
+     */
+    totalPositionMargin?: string;
+    /**
+     * Basis offset credit applied to this asset row.
+     */
+    basisCredit?: string;
+    /**
+     * Post-netting USD notional for futures on this asset
+     */
+    futuresNettedNotional?: string;
+    /**
+     * Margin attributed to futures netting for this asset row.
+     */
+    futuresNettingMargin?: string;
+    /**
+     * Per-asset long amount from position_summary.
+     */
+    longAmount?: string;
+    /**
+     * Per-asset short amount from position_summary.
+     */
+    shortAmount?: string;
+    /**
+     * Volatility margin add-on for this asset.
+     */
+    volatilityAddon?: string;
+    /**
+     * Liquidity margin add-on for this asset.
+     */
+    liquidityAddon?: string;
+};

package/dist/types/model/CrossMarginRiskParameters.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+/**
+ * XM 2.0 risk parameters for an asset tier
+ */
+export type CrossMarginRiskParameters = {
+    /**
+     * Asset tier identifier
+     */
+    assetTier?: string;
+    /**
+     * Base ratio for long positions
+     */
+    baseRatioLong?: string;
+    /**
+     * Base ratio for short positions
+     */
+    baseRatioShort?: string;
+    /**
+     * Volatility rate for long positions
+     */
+    volatilityRateLong?: string;
+    /**
+     * Volatility rate for short positions
+     */
+    volatilityRateShort?: string;
+    /**
+     * Volatility low threshold
+     */
+    volatilityLowThreshold?: string;
+    /**
+     * Volatility high threshold
+     */
+    volatilityHighThreshold?: string;
+    /**
+     * Liquidity A for long positions
+     */
+    liquidityALong?: string;
+    /**
+     * Liquidity A for short positions
+     */
+    liquidityAShort?: string;
+    /**
+     * Liquidity B for short positions
+     */
+    liquidityBShort?: string;
+    /**
+     * Liquidity threshold
+     */
+    liquidityThreshold?: string;
+    /**
+     * Basis offset credit rate
+     */
+    basisOffsetCreditRate?: string;
+};

package/dist/types/model/EntityUser.d.ts

@@ -17,6 +17,7 @@
  *
  *  Do not edit the class manually.
  */
+import { SecondaryPermission } from './enums/SecondaryPermission';
 import { UserRole } from './enums/UserRole';
 export type EntityUser = {
     /**
@@ -36,4 +37,12 @@ export type EntityUser = {
      */
     entityId?: string;
     role?: UserRole;
+    /**
+     * All primary roles assigned to the user.
+     */
+    roles?: Array<UserRole>;
+    /**
+     * All secondary permissions assigned to the user.
+     */
+    secondaryPermissions?: Array<SecondaryPermission>;
 };

package/dist/types/model/{StakingInputs.d.ts → FcmScheduledMaintenance.d.ts}

@@ -1,5 +1,5 @@
 /**
- * Copyright 2025-present Coinbase Global, Inc.
+ * Copyright 2026-present Coinbase Global, Inc.
  *
  * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
  *
@@ -17,9 +17,13 @@
  *
  *  Do not edit the class manually.
  */
-export type StakingInputs = {
+export type FcmScheduledMaintenance = {
     /**
-     * Optional amount to stake or unstake. If omitted, the wallet will stake or unstake the maximum amount available
+     * Maintenance window start time
      */
-    amount?: string;
+    startTime?: Date;
+    /**
+     * Maintenance window end time
+     */
+    endTime?: Date;
 };

package/dist/types/model/FcmTradingSessionDetails.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { FcmScheduledMaintenance } from './FcmScheduledMaintenance';
+import { FcmTradingSessionClosedReason } from './enums/FcmTradingSessionClosedReason';
+import { FcmTradingSessionState } from './enums/FcmTradingSessionState';
+export type FcmTradingSessionDetails = {
+    /**
+     * Whether the trading session is currently open
+     */
+    sessionOpen?: boolean;
+    /**
+     * Trading session open time
+     */
+    openTime?: Date;
+    /**
+     * Trading session close time
+     */
+    closeTime?: Date;
+    sessionState?: FcmTradingSessionState;
+    /**
+     * Whether after-hours order entry is disabled
+     */
+    afterHoursOrderEntryDisabled?: boolean;
+    closedReason?: FcmTradingSessionClosedReason;
+    maintenance?: FcmScheduledMaintenance;
+    /**
+     * Settlement timestamp from previous trading day
+     */
+    settlementTimestamp?: Date;
+    /**
+     * Settlement price from previous trading day
+     */
+    settlementPrice?: string;
+};

package/dist/types/model/Fill.d.ts

@@ -17,7 +17,9 @@
  *
  *  Do not edit the class manually.
  */
+import { CommissionDetailTotal } from './CommissionDetailTotal';
 import { OrderSide } from './enums/OrderSide';
+import { ProductType } from './enums/ProductType';
 export type Fill = {
     /**
      * The unique ID of the fill
@@ -68,4 +70,6 @@ export type Fill = {
      * The CES commission incurred for the fill
      */
     cesCommission?: string;
+    productType?: ProductType;
+    commissionDetailTotal?: CommissionDetailTotal;
 };

package/dist/types/model/FundMovement.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { TransferLocation } from './TransferLocation';
+/**
+ * FundMovement represents a single movement of funds between two counterparties.
+ */
+export type FundMovement = {
+    id?: string;
+    source?: TransferLocation;
+    target?: TransferLocation;
+    currency?: string;
+    amount?: string;
+};

package/dist/types/model/FutureProductDetails.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { ContractExpiryType } from './enums/ContractExpiryType';
+import { PerpetualProductDetails } from './PerpetualProductDetails';
+import { RiskManagementType } from './enums/RiskManagementType';
+export type FutureProductDetails = {
+    /**
+     * Contract code identifier
+     */
+    contractCode?: string;
+    /**
+     * Contract size
+     */
+    contractSize?: string;
+    /**
+     * Contract expiry timestamp
+     */
+    contractExpiry?: Date;
+    /**
+     * Contract root unit (underlying asset)
+     */
+    contractRootUnit?: string;
+    contractExpiryType?: ContractExpiryType;
+    riskManagedBy?: RiskManagementType;
+    /**
+     * The venue this product trades on
+     */
+    venue?: string;
+    /**
+     * Descriptive name for the product group
+     */
+    groupDescription?: string;
+    /**
+     * IANA time zone for contract expiration
+     */
+    contractExpiryTimezone?: string;
+    /**
+     * Short version of the group description
+     */
+    groupShortDescription?: string;
+    perpetualDetails?: PerpetualProductDetails;
+};

package/dist/types/model/GetCrossMarginPrimeOverviewResponse.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { CrossMarginPrimeMarginSummary } from './CrossMarginPrimeMarginSummary';
+import { PrimeXMControlStatus } from './enums/PrimeXMControlStatus';
+import { PrimeXMMarginLevel } from './enums/PrimeXMMarginLevel';
+export type GetCrossMarginPrimeOverviewResponse = {
+    controlStatus?: PrimeXMControlStatus;
+    marginLevel?: PrimeXMMarginLevel;
+    /**
+     * When margin metrics were evaluated.
+     */
+    evaluatedAt?: Date;
+    marginSummary?: CrossMarginPrimeMarginSummary;
+};

package/dist/types/model/GetCrossMarginRiskParametersResponse.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { CrossMarginRiskParameters } from './CrossMarginRiskParameters';
+import { TierPairRateEntry } from './TierPairRateEntry';
+export type GetCrossMarginRiskParametersResponse = {
+    /**
+     * Current XM tier risk parameters for the entity\'s client tier
+     */
+    riskParameters?: Array<CrossMarginRiskParameters>;
+    /**
+     * Offset credit rate matrix for long/short tier pairs
+     */
+    offsetCreditMatrixLongShort?: Array<TierPairRateEntry>;
+    /**
+     * Offset credit rate matrix for long/long tier pairs
+     */
+    offsetCreditMatrixLongLong?: Array<TierPairRateEntry>;
+    /**
+     * Offset credit rate matrix for short/short tier pairs
+     */
+    offsetCreditMatrixShortShort?: Array<TierPairRateEntry>;
+    /**
+     * Margin period of risk (number of days)
+     */
+    marginPeriodOfRisk?: number;
+};

package/dist/types/model/GetFcmEquityResponse.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type GetFcmEquityResponse = {
+    /**
+     * Prior EOD account equity (ending balance + realized P&L + commissions/fees)
+     */
+    eodAccountEquity?: string;
+    /**
+     * Prior EOD unrealized P&L on open futures positions
+     */
+    eodUnrealizedPnl?: string;
+    /**
+     * Current Derivatives Account Balance minus prior EOD margin requirement. (Positive = excess; negative = deficit)
+     */
+    currentExcessDeficit?: string;
+    /**
+     * Excess funds in the Derivatives account available to transfer (\"sweep\") to the designated funding portfolio
+     */
+    availableToSweep?: string;
+};

package/dist/types/model/GetFcmRiskLimitsResponse.d.ts

@@ -17,6 +17,7 @@
  *
  *  Do not edit the class manually.
  */
+import { FcmMarginHealthState } from './enums/FcmMarginHealthState';
 export type GetFcmRiskLimitsResponse = {
     /**
      * Risk Limit set for a client
@@ -42,4 +43,9 @@ export type GetFcmRiskLimitsResponse = {
      * Unsettled accrued funding PNL from the last settlement
      */
     cfmUnsettledAccruedFundingPnl?: string;
+    /**
+     * Margin utilization as a decimal percentage between 0 and 1 (e.g. 0.5 means 50%)
+     */
+    marginUtilizationPercent?: string;
+    marginHealthState?: FcmMarginHealthState;
 };

package/dist/types/model/{GetWalletAddressesResponse.d.ts → GetMarketDataResponse.d.ts}

@@ -1,5 +1,5 @@
 /**
- * Copyright 2025-present Coinbase Global, Inc.
+ * Copyright 2026-present Coinbase Global, Inc.
  *
  * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
  *
@@ -17,9 +17,12 @@
  *
  *  Do not edit the class manually.
  */
-import { BlockchainAddress } from './BlockchainAddress';
+import { MarketData } from './MarketData';
 import { PaginatedResponse } from './PaginatedResponse';
-export type GetWalletAddressesResponse = {
-    addresses: Array<BlockchainAddress>;
-    pagination: PaginatedResponse;
+export type GetMarketDataResponse = {
+    /**
+     * List of market data entries
+     */
+    marketData?: Array<MarketData>;
+    pagination?: PaginatedResponse;
 };

package/dist/types/model/GetTransactionTravelRuleDataResponse.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { TravelRuleParty } from './TravelRuleParty';
+export type GetTransactionTravelRuleDataResponse = {
+    fulfilled: boolean;
+    isSelf?: boolean;
+    originator?: TravelRuleParty;
+    beneficiary?: TravelRuleParty;
+    amount?: string;
+    amountCurrency?: string;
+    fiatAmount?: string;
+    fiatAmountCurrency?: string;
+    blockchainNetwork?: string;
+};

package/dist/types/model/ListAdvancedTransferTransactionsResponse.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { Transaction } from './Transaction';
+/**
+ * ListAdvancedTransferTransactionsResponse contains the transactions associated with an advanced transfer.
+ */
+export type ListAdvancedTransferTransactionsResponse = {
+    /**
+     * The transactions associated with an Advanced Transfer
+     */
+    transactions: Array<Transaction>;
+};

package/dist/types/model/ListAdvancedTransfersResponse.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { AdvancedTransfer } from './AdvancedTransfer';
+import { PaginatedResponse } from './PaginatedResponse';
+/**
+ * ListAdvancedTransfersResponse contains the list of advanced transfers and pagination info.
+ */
+export type ListAdvancedTransfersResponse = {
+    advancedTransfers: Array<AdvancedTransfer>;
+    pagination?: PaginatedResponse;
+};

package/dist/types/model/MarketData.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type MarketData = {
+    /**
+     * Base asset symbol (e.g., BTC, ETH, SOL)
+     */
+    symbol?: string;
+    /**
+     * Daily historical volatility over trailing 5 days (decimal, e.g., 0.65 = 65%)
+     */
+    vol5d?: string;
+    /**
+     * Daily historical volatility over trailing 30 days (decimal, e.g., 0.65 = 65%)
+     */
+    vol30d?: string;
+    /**
+     * Daily historical volatility over trailing 90 days (decimal, e.g., 0.65 = 65%)
+     */
+    vol90d?: string;
+    /**
+     * Average daily trading volume over trailing 30 days (USD)
+     */
+    adv30d?: string;
+    /**
+     * Weighted blend of the most recent vol_5d and the max vol_5d over last 30 days into a single volatility measure (decimal).
+     */
+    weightedVol?: string;
+};

package/dist/types/model/NetworkDetails.d.ts

@@ -56,4 +56,16 @@ export type NetworkDetails = {
      * Indicates the symbol that can be used to query other endpoints, related to transactions, wallets, and activities, to get information particularly for this asset on the network
      */
     networkScopedSymbol?: string;
+    /**
+     * The minimum withdrawal amount for this network. Applies to trading, prime custody, and vault wallets.
+     */
+    minWithdrawalAmount?: string;
+    /**
+     * The platform maximum withdrawal amount for this network. Applies to trading, prime custody, and vault wallets. Note that Prime Transfer policies may override this value.
+     */
+    maxWithdrawalAmount?: string;
+    /**
+     * The minimum deposit amount for this network. Applies to trading, prime custody, and vault wallets.
+     */
+    minDepositAmount?: string;
 };