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

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

@@ -18,10 +18,12 @@
  *  Do not edit the class manually.
  */
 import { LimitOrderEdit } from './LimitOrderEdit';
+import { CommissionDetailTotal } from './CommissionDetailTotal';
 import { OrderEdit } from './OrderEdit';
 import { OrderSide } from './enums/OrderSide';
 import { OrderStatus } from './enums/OrderStatus';
 import { OrderType } from './enums/OrderType';
+import { ProductType } from './enums/ProductType';
 import { TimeInForceType } from './enums/TimeInForceType';
 export type Order = {
     /**
@@ -152,4 +154,6 @@ export type Order = {
      * The wig (would if good) level for PEG orders - best price opposite to limit_price
      */
     wigLevel?: string;
+    productType?: ProductType;
+    commissionDetailTotal?: CommissionDetailTotal;
 };

package/dist/types/model/PerpetualProductDetails.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 PerpetualProductDetails = {
+    /**
+     * Open interest
+     */
+    openInterest?: string;
+    /**
+     * Current funding rate
+     */
+    fundingRate?: string;
+    /**
+     * Next funding time
+     */
+    fundingTime?: Date;
+    /**
+     * Maximum leverage allowed
+     */
+    maxLeverage?: string;
+    /**
+     * The type of underlying for the perpetual product
+     */
+    underlyingType?: string;
+};

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

@@ -17,6 +17,7 @@
  *
  *  Do not edit the class manually.
  */
+import { SecondaryPermission } from './enums/SecondaryPermission';
 import { UserRole } from './enums/UserRole';
 export type PortfolioUser = {
     /**
@@ -40,4 +41,12 @@ export type PortfolioUser = {
      */
     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/PreviewUnstakeResponse.d.ts

@@ -17,6 +17,7 @@
  *
  *  Do not edit the class manually.
  */
+import { ValidatorUnstakePreview } from './ValidatorUnstakePreview';
 /**
  * PreviewUnstakeResponse contains the response data from previewing an unstaking operation.
  */
@@ -25,4 +26,20 @@ export type PreviewUnstakeResponse = {
      * Estimated amount that would be unstaked
      */
     estimatedAmount: string;
+    /**
+     * The wallet ID
+     */
+    walletId?: string;
+    /**
+     * The blockchain address of the wallet
+     */
+    walletAddress?: string;
+    /**
+     * Timestamp at which this preview was generated (ISO 8601)
+     */
+    currentTimestamp?: string;
+    /**
+     * Per-validator breakdown of the unstake simulation
+     */
+    validators?: Array<ValidatorUnstakePreview>;
 };

package/dist/types/model/PrimeXMMarginCallThresholds.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 { PrimeXMMarginThreshold } from './PrimeXMMarginThreshold';
+export type PrimeXMMarginCallThresholds = {
+    /**
+     * 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<PrimeXMMarginThreshold>;
+};

package/dist/types/model/PrimeXMMarginRequirementBreakdown.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 PrimeXMMarginRequirementBreakdown = {
+    /**
+     * 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/PrimeXMMarginThreshold.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 { PrimeXMMarginLevel } from './enums/PrimeXMMarginLevel';
+import { PrimeXMMarginThresholdType } from './enums/PrimeXMMarginThresholdType';
+export type PrimeXMMarginThreshold = {
+    marginLevel?: PrimeXMMarginLevel;
+    thresholdType?: PrimeXMMarginThresholdType;
+    thresholdValue?: string;
+};

package/dist/types/model/PrimeXMOffsetCreditBreakdown.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 PrimeXMOffsetCreditBreakdown = {
+    /**
+     * 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/Product.d.ts

@@ -17,7 +17,10 @@
  *
  *  Do not edit the class manually.
  */
+import { FcmTradingSessionDetails } from './FcmTradingSessionDetails';
+import { FutureProductDetails } from './FutureProductDetails';
 import { ProductPermissions } from './enums/ProductPermissions';
+import { ProductType } from './enums/ProductType';
 import { RFQProductDetails } from './RFQProductDetails';
 export type Product = {
     /**
@@ -57,4 +60,7 @@ export type Product = {
      */
     priceIncrement?: string;
     rfqProductDetails?: RFQProductDetails;
+    productType?: ProductType;
+    fcmTradingSessionDetails?: FcmTradingSessionDetails;
+    futureProductDetails?: FutureProductDetails;
 };

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

@@ -23,4 +23,8 @@ export type QuoteResponse = {
     bestPrice?: string;
     orderTotal?: string;
     priceInclusiveOfFees?: string;
+    /**
+     * Echo of the quote_duration_ms supplied in the request. 0 if the client did not supply a value, in which case the server applies the default of 3000 ms (3 seconds).
+     */
+    quoteDurationMs?: string;
 };

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

@@ -32,4 +32,8 @@ export type RFQ = {
     quoteValue?: string;
     limitPrice: string;
     settlCurrency?: string;
+    /**
+     * Optional quote timeout in milliseconds. Defaults to 3000 ms (3 seconds) if not specified. Maximum allowed value is 30000 ms (30 seconds); requests with a larger value are rejected. Mirrors FIX tag 8090 (QuoteRequestGoodForMs).
+     */
+    quoteDurationMs?: string;
 };

package/dist/types/model/SetFundingSettingsRequest.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.
+ */
+/**
+ * SetFundingSettingsRequest sets FCM funding configuration for an entity (creates a PCS proposal). entity_id is also bound from the URL path.
+ */
+export type SetFundingSettingsRequest = {
+    /**
+     * Set the Derivatives Funding Portfolio that will be used to fund FCM margin calls and receive excess margin sweeps. Only one portfolio per entity.
+     */
+    designatedFundingPortfolioId: string;
+    /**
+     * When true, USDC in your Derivatives Funding Portfolio will be converted to USD to meet FCM margin calls (Auto-Convert USDC).
+     */
+    automaticConversionEnabled: boolean;
+    /**
+     * When true, Coinbase affiliates may initiate loans on your behalf to meet FCM margin calls, per your Lending agreement. Available to Portfolio Margin or Cross Margin clients only. (Auto-Initiate Loans)
+     */
+    automaticLoanEnabled: boolean;
+    /**
+     * When true, any FCM account balance above your margin requirements will be automatically swept back to your Derivatives funding portfolio. (Auto-Return Excess Margin)
+     */
+    automaticExcessReturnEnabled: boolean;
+    /**
+     * Weekend Buying Power: Setting a target amount to maintain in your Futures account above margin requirements. You can only withdraw funds in excess of this amount.
+     */
+    excessFundsTargetAmount: string;
+};

package/dist/types/model/SetFundingSettingsResponse.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 SetFundingSettingsResponse = {
+    /**
+     * 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/TierPairRateEntry.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 TierPairRateEntry = {
+    /**
+     * 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/ValidatorAllocation.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * ValidatorAllocation specifies the validator and amount for staking or unstaking. Used for granular ETH V2 validator-level staking or unstaking operations.
+ */
+export type ValidatorAllocation = {
+    /**
+     * The validator address for performing staking operations
+     */
+    validatorAddress: string;
+    /**
+     * Amount for performing staking operations with this validator
+     */
+    amount: string;
+};

package/dist/types/model/ValidatorUnstakePreview.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.
+ */
+/**
+ * ValidatorUnstakePreview contains the per-validator breakdown for an unstake preview.
+ */
+export type ValidatorUnstakePreview = {
+    /**
+     * Public address of the validator being unstaked from
+     */
+    validatorAddress?: string;
+    /**
+     * Estimated amount that would be unstaked from this validator (in ETH)
+     */
+    estimatedUnstakingAmount?: string;
+    /**
+     * Estimated time until this validator\'s unstake completes, in hours
+     */
+    unstakeTimeEstimateInHours?: number;
+    /**
+     * Estimated date when this validator\'s unstake will complete (ISO 8601)
+     */
+    estimatedUnstakeDate?: string;
+};

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

@@ -17,6 +17,7 @@
  *
  *  Do not edit the class manually.
  */
+import { ValidatorAllocation } from './ValidatorAllocation';
 /**
  * WalletUnstakeInputs contains the custom inputs for unstaking operations on a wallet. Requirements and supported fields vary by asset type.
  */
@@ -25,4 +26,8 @@ export type WalletUnstakeInputs = {
      * Optional amount to unstake (ETH only). If omitted, the wallet will unstake the maximum amount available
      */
     amount?: string;
+    /**
+     * (Alpha) Optional validator-level allocations for ETH V2 unstaking. Allows specifying which validators to unstake from and how much. This feature is in alpha. Please reach out to your Coinbase Prime account manager for more information
+     */
+    validatorAllocations?: Array<ValidatorAllocation>;
 };

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

@@ -21,9 +21,9 @@ import { MarginAddOn } from './MarginAddOn';
 import { XMPosition } from './XMPosition';
 export type XMRiskNettingInfo = {
     /**
-     * Nodal Margin Requirement (NMR) is the margin requirement for all futures positions, derived from the Nodal model
+     * Derivatives Clearing Organization Margin Requirement (DMR) is the margin requirement for all futures positions, derived from the Derivatives Clearing Organization model
      */
-    nodalMarginRequirement?: string;
+    dcoMarginRequirement?: string;
     /**
      * Portfolio Margin Requirement (PMR) is the margin requirement for all spot positions, derived from the XM model
      */

package/dist/types/model/enums/AdvancedTransferState.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.
+ */
+/**
+ * AdvancedTransferState represents the lifecycle state of an advanced transfer.
+ */
+export declare enum AdvancedTransferState {
+    AdvancedTransferStateCreated = "ADVANCED_TRANSFER_STATE_CREATED",
+    AdvancedTransferStateProcessing = "ADVANCED_TRANSFER_STATE_PROCESSING",
+    AdvancedTransferStateDone = "ADVANCED_TRANSFER_STATE_DONE",
+    AdvancedTransferStateCancelled = "ADVANCED_TRANSFER_STATE_CANCELLED",
+    AdvancedTransferStateFailed = "ADVANCED_TRANSFER_STATE_FAILED",
+    AdvancedTransferStateExpired = "ADVANCED_TRANSFER_STATE_EXPIRED"
+}

package/dist/types/model/enums/AdvancedTransferType.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+/**
+ * AdvancedTransferType specifies the type of advanced transfer.
+ */
+export declare enum AdvancedTransferType {
+    AdvancedTransferTypeBlindMatch = "ADVANCED_TRANSFER_TYPE_BLIND_MATCH"
+}

package/dist/types/model/enums/BetaPrimeXMControlStatus.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.
+ */
+/**
+ * - TRADES_AND_WITHDRAWALS: Allowed to trade and withdraw. See XM Margin Methodology for full description of when trading and withdrawals are enabled or disabled.  - TRADES_ONLY: Allowed to trade but not withdraw. See XM Margin Methodology for full description of when trading and withdrawals are enabled or disabled.  - SESSION_LOCKED: Not allowed to trade or withdraw. See XM Margin Methodology for full description of when trading and withdrawals are enabled or disabled.
+ */
+export declare enum BetaPrimeXMControlStatus {
+    XmControlStatusUnspecified = "XM_CONTROL_STATUS_UNSPECIFIED",
+    TradesAndWithdrawals = "TRADES_AND_WITHDRAWALS",
+    TradesOnly = "TRADES_ONLY",
+    SessionLocked = "SESSION_LOCKED"
+}

package/dist/types/model/enums/BetaPrimeXMHealthStatus.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ *  - HEALTH_STATUS_HEALTHY: Margin level is healthy.  - HEALTH_STATUS_WARNING: Margin level is breaching the warning threshold (WT) which will result in the issuance of a Margin Call if this is still the case by the scheduled next Margin Call (as defined in the margin methodology). WT is differentiated from DT in that it means margin health is approaching the UMCT.  - HEALTH_STATUS_CRITICAL: Margin level is breaching the UMCT and, as defined in the margin methodology, this will trigger an urgent margin call.  - HEALTH_STATUS_SUSPENDED: Trading and withdrawals are suspended per XM margin methodology.  - HEALTH_STATUS_RESTRICTED: Account is in a restricted state per XM margin methodology.  - HEALTH_STATUS_PRE_LIQUIDATION: Margin level is breaching the liquidation threshold (LT) and, as defined in the margin methodology, this will trigger the SESSION_LOCKED control status and liquidation may commence.  - HEALTH_STATUS_LIQUIDATING: Liquidation has commenced.  - HEALTH_STATUS_IN_DEFICIT: Margin level is breaching the deficit threshold (DT) which will result in the issuance of a Margin Call if this is still the case by the scheduled next Margin Call time (as defined in the margin methodology).
+ */
+export declare enum BetaPrimeXMHealthStatus {
+    HealthStatusHealthy = "HEALTH_STATUS_HEALTHY",
+    HealthStatusWarning = "HEALTH_STATUS_WARNING",
+    HealthStatusCritical = "HEALTH_STATUS_CRITICAL",
+    HealthStatusSuspended = "HEALTH_STATUS_SUSPENDED",
+    HealthStatusRestricted = "HEALTH_STATUS_RESTRICTED",
+    HealthStatusPreLiquidation = "HEALTH_STATUS_PRE_LIQUIDATION",
+    HealthStatusLiquidating = "HEALTH_STATUS_LIQUIDATING",
+    HealthStatusInDeficit = "HEALTH_STATUS_IN_DEFICIT"
+}