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

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

@@ -0,0 +1,42 @@
+/**
+ * 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 { BetaPrimeXMMarginThreshold } from './BetaPrimeXMMarginThreshold';
+export type BetaPrimeXMMarginCallThresholds = {
+    /**
+     * Deficit threshold (DT).
+     */
+    deficitThreshold?: string;
+    /**
+     * Warning threshold (WT).
+     */
+    warningThreshold?: string;
+    /**
+     * Urgent margin call threshold (UMCT).
+     */
+    criticalThreshold?: string;
+    /**
+     * Liquidation threshold (LT).
+     */
+    liquidationThreshold?: string;
+    /**
+     * Structured margin thresholds by margin level.
+     */
+    marginThresholds?: Array<BetaPrimeXMMarginThreshold>;
+};

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

@@ -0,0 +1,41 @@
+/**
+ * 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 BetaPrimeXMMarginRequirementBreakdown = {
+    /**
+     * Base margin requirement component.
+     */
+    baseMargin?: string;
+    /**
+     * Volatility add-on component.
+     */
+    volatilityAddon?: string;
+    /**
+     * Liquidity add-on component.
+     */
+    liquidityAddon?: string;
+    /**
+     * Credits that offset margin charges due to portfolio composition.
+     */
+    offsetCredit?: string;
+    /**
+     * Futures margin charge applied for any futures trades of the opposing direction but of the same underlying.
+     */
+    futuresMargin?: string;
+};

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

@@ -0,0 +1,26 @@
+/**
+ * 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 { BetaPrimeXMMarginLevel } from './enums/BetaPrimeXMMarginLevel';
+import { BetaPrimeXMMarginThresholdType } from './enums/BetaPrimeXMMarginThresholdType';
+export type BetaPrimeXMMarginThreshold = {
+    marginLevel?: BetaPrimeXMMarginLevel;
+    thresholdType?: BetaPrimeXMMarginThresholdType;
+    thresholdValue?: string;
+};

package/dist/types/model/BetaPrimeXMOffsetCreditBreakdown.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 BetaPrimeXMOffsetCreditBreakdown = {
+    /**
+     * Basis offset credit component.
+     */
+    basisCredit?: string;
+    /**
+     * Long/short tier-pair offset credit.
+     */
+    longShortCredit?: string;
+    /**
+     * Long/long tier-pair offset credit.
+     */
+    longLongCredit?: string;
+    /**
+     * Short/short tier-pair offset credit.
+     */
+    shortShortCredit?: string;
+    /**
+     * Same-tier offset credit.
+     */
+    sameTierCredit?: string;
+    /**
+     * Total offset credit.
+     */
+    totalCredit?: string;
+};

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

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+/**
+ * SetFundingSettingsResponse returns PCS activity metadata after the proposal is created.
+ */
+export type BetaSetFundingSettingsResponse = {
+    /**
+     * Identifier for the created activity / proposal
+     */
+    activityId?: string;
+    /**
+     * Type of the activity (e.g. PCS proposal type)
+     */
+    activityType?: string;
+    /**
+     * Number of approvals still required before the change applies
+     */
+    numApprovalsRemaining?: number;
+};

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

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+/**
+ * TierPairRateEntry represents a single (tier_a, tier_b) -> rate entry in an offset credit matrix.
+ */
+export type BetaTierPairRateEntry = {
+    /**
+     * First tier in the pair
+     */
+    tierA?: string;
+    /**
+     * Second tier in the pair
+     */
+    tierB?: string;
+    /**
+     * Credit rate for this tier pair
+     */
+    rate?: string;
+};

package/dist/types/model/BlindMatchMetadata.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.
+ */
+/**
+ * BlindMatchMetadata contains metadata specific to blind match advanced transfers.
+ */
+export type BlindMatchMetadata = {
+    referenceId?: string;
+    /**
+     * The intended time of Transfer settlement in YYYYMMDD format
+     */
+    settlementDate?: string;
+    /**
+     * Optional date of the original Trade in YYYYMMMDD format
+     */
+    tradeDate?: string;
+    /**
+     * Optional time of transfer settlement in HHMM format in UTC. If not provided, it defaults to 09:30 Eastern Time.
+     */
+    settlementTime?: string;
+};

package/dist/types/model/CancelAdvancedTransferResponse.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.
+ */
+/**
+ * CancelAdvancedTransferResponse is the response after canceling an advanced transfer.
+ */
+export type CancelAdvancedTransferResponse = {
+    /**
+     * The ID of the canceled Advanced Transfer
+     */
+    advancedTransferId?: string;
+};

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

@@ -0,0 +1,40 @@
+/**
+ * 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 CommissionDetailTotal = {
+    totalCommission?: string;
+    /**
+     * CB fee
+     */
+    clientCommission?: string;
+    /**
+     * Exchange fees
+     */
+    venueCommission?: string;
+    cesCommission?: string;
+    financingCommission?: string;
+    /**
+     * NFA fees
+     */
+    regulatoryCommission?: string;
+    /**
+     * Clearing fees
+     */
+    clearingCommission?: string;
+};

package/dist/types/model/{CreateAddressGroup.d.ts → CreateAdvancedTransferRequest.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,10 +17,10 @@
  *
  *  Do not edit the class manually.
  */
-import { AddressEntry } from './AddressEntry';
-import { NetworkType } from './enums/NetworkType';
-export type CreateAddressGroup = {
-    name?: string;
-    networkType?: NetworkType;
-    addresses?: Array<AddressEntry>;
+import { AdvancedTransfer } from './AdvancedTransfer';
+/**
+ * CreateAdvancedTransferRequest is the request to create an advanced transfer.
+ */
+export type CreateAdvancedTransferRequest = {
+    advancedTransfer: AdvancedTransfer;
 };

package/dist/types/model/{DateOfBirth.d.ts → CreateAdvancedTransferResponse.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,8 +17,10 @@
  *
  *  Do not edit the class manually.
  */
-export type DateOfBirth = {
-    year?: number;
-    month?: number;
-    day?: number;
+import { AdvancedTransfer } from './AdvancedTransfer';
+/**
+ * CreateAdvancedTransferResponse is the response after creating an advanced transfer.
+ */
+export type CreateAdvancedTransferResponse = {
+    advancedTransfer: AdvancedTransfer;
 };

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

@@ -17,6 +17,7 @@
  *
  *  Do not edit the class manually.
  */
+import { ActiveLiquidationSummary } from './ActiveLiquidationSummary';
 import { XMControlStatus } from './enums/XMControlStatus';
 import { XMEntityCallStatus } from './enums/XMEntityCallStatus';
 import { XMLoan } from './XMLoan';
@@ -36,4 +37,5 @@ export type CrossMarginOverview = {
      * List of active XM loans
      */
     activeLoans?: Array<XMLoan>;
+    activeLiquidation?: ActiveLiquidationSummary;
 };

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

@@ -0,0 +1,40 @@
+/**
+ * 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.
+ */
+/**
+ * Breakdown of the components of derivatives equity.
+ */
+export type CrossMarginPrimeDerivativesEquityBreakdown = {
+    /**
+     * Derivatives cash balance component.
+     */
+    cashBalance?: string;
+    /**
+     * Unrealized PnL component of derivatives equity.
+     */
+    unrealizedPnl?: string;
+    /**
+     * Realized PnL component of derivatives equity.
+     */
+    realizedPnl?: string;
+    /**
+     * Accrued funding PnL component of derivatives equity.
+     */
+    accruedFundingPnl?: string;
+};

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

@@ -0,0 +1,100 @@
+/**
+ * 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 { CrossMarginPrimeDerivativesEquityBreakdown } from './CrossMarginPrimeDerivativesEquityBreakdown';
+import { CrossMarginPrimeRiskNettingInfo } from './CrossMarginPrimeRiskNettingInfo';
+import { CrossMarginPrimeSpotEquityBreakdown } from './CrossMarginPrimeSpotEquityBreakdown';
+import { PrimeXMHealthStatus } from './enums/PrimeXMHealthStatus';
+import { PrimeXMMarginCallThresholds } from './PrimeXMMarginCallThresholds';
+import { PrimeXMMarginRequirementType } from './enums/PrimeXMMarginRequirementType';
+/**
+ * Cross-margin account summary and nested breakdowns.
+ */
+export type CrossMarginPrimeMarginSummary = {
+    /**
+     * Cross Margin Margin Requirement (XMMR) notional
+     */
+    marginRequirement?: string;
+    marginRequirementType?: PrimeXMMarginRequirementType;
+    /**
+     * Equity notional
+     */
+    accountEquity?: string;
+    /**
+     * Equity - XMMR (margin excess is > 0)
+     */
+    marginExcessShortfall?: string;
+    /**
+     * Credit consumed from Cross Margin Credit Limit (XMCL)
+     */
+    consumedCredit?: string;
+    /**
+     * XM Credit Limit (XMCL) is the maximum notional USD of total fiat and digital asset loans
+     */
+    xmCreditLimit?: string;
+    /**
+     * XM Margin Limit (XMML) is the maximum notional USD deficit
+     */
+    xmMarginLimit?: string;
+    /**
+     * Amount of the XM margin limit consumed by excess deficit.
+     */
+    consumedMarginLimit?: string;
+    /**
+     * Equity attributed by spot
+     */
+    spotEquity?: string;
+    /**
+     * Equity attributed by futures
+     */
+    futuresEquity?: string;
+    /**
+     * Gross market value.
+     */
+    grossMarketValue?: string;
+    /**
+     * Net market value.
+     */
+    netMarketValue?: string;
+    /**
+     * Net exposure.
+     */
+    netExposure?: string;
+    /**
+     * Gross leverage.
+     */
+    grossLeverage?: string;
+    spotEquityBreakdown?: CrossMarginPrimeSpotEquityBreakdown;
+    derivativesEquityBreakdown?: CrossMarginPrimeDerivativesEquityBreakdown;
+    riskNettingInfo?: CrossMarginPrimeRiskNettingInfo;
+    healthStatus?: PrimeXMHealthStatus;
+    /**
+     * Equity ratio.
+     */
+    equityRatio?: string;
+    /**
+     * Deficit ratio.
+     */
+    deficitRatio?: string;
+    marginThresholds?: PrimeXMMarginCallThresholds;
+    /**
+     * FCM excess available to return.
+     */
+    fcmExcessAvailableToReturn?: string;
+};

package/dist/types/model/CrossMarginPrimeRiskNettingInfo.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 { CrossMarginPrimeXMPosition } from './CrossMarginPrimeXMPosition';
+import { PrimeXMMarginRequirementBreakdown } from './PrimeXMMarginRequirementBreakdown';
+import { PrimeXMOffsetCreditBreakdown } from './PrimeXMOffsetCreditBreakdown';
+/**
+ * Groups XM margin requirement components, offset credits, and per-asset rows.
+ */
+export type CrossMarginPrimeRiskNettingInfo = {
+    /**
+     * Derivatives Clearing Organization Margin Requirement (DMR) is the margin requirement for all futures positions, derived from the Derivatives Clearing Organization model
+     */
+    dcoMarginRequirement?: string;
+    /**
+     * Portfolio Margin Requirement (PMR) is the margin requirement for all spot positions, derived from the XM model
+     */
+    portfolioMarginRequirement?: string;
+    /**
+     * Integrated Portfolio Margin Requirement (IPMR) is the margin requirement for all spot positions + futures positions with underlying assets eligible in Portfolio Margin.
+     */
+    integratedPortfolioMarginRequirement?: string;
+    /**
+     * Ineligible Futures Margin Requirement (IFMR) is the margin requirement for IPMR-ineligible futures contracts
+     */
+    ineligibleFuturesMarginRequirement?: string;
+    pmrBreakdown?: PrimeXMMarginRequirementBreakdown;
+    ipmrBreakdown?: PrimeXMMarginRequirementBreakdown;
+    portfolioMarginOffsetCreditBreakdown?: PrimeXMOffsetCreditBreakdown;
+    integratedPortfolioMarginOffsetCreditBreakdown?: PrimeXMOffsetCreditBreakdown;
+    /**
+     * Netted positions used in the model calculation.
+     */
+    xmPositions?: Array<CrossMarginPrimeXMPosition>;
+};

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

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ * Breakdown of the components of spot equity.
+ */
+export type CrossMarginPrimeSpotEquityBreakdown = {
+    /**
+     * PM cash balance component of spot equity.
+     */
+    cashBalance?: string;
+    /**
+     * Long market value component of spot equity.
+     */
+    longMarketValue?: string;
+    /**
+     * Short market value component of spot equity.
+     */
+    shortMarketValue?: string;
+    /**
+     * Short collateral component of spot equity.
+     */
+    shortCollateral?: string;
+    /**
+     * Pending transfers affecting spot equity.
+     */
+    pendingTransfers?: string;
+};