@coinbase-sample/prime-sdk-ts 0.6.4 → 0.7.0

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

@@ -0,0 +1,25 @@
+/**
+ * Copyright 2025-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 EditOrderResponse = {
+    /**
+     * The ID of the order being edited
+     */
+    orderId?: string;
+};

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

@@ -0,0 +1,23 @@
+/**
+ * Copyright 2025-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 { CrossMarginOverview } from './CrossMarginOverview';
+export type GetCrossMarginOverviewResponse = {
+    overview?: CrossMarginOverview;
+};

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

@@ -0,0 +1,35 @@
+/**
+ * Copyright 2025-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 { SortDirection } from './enums/SortDirection';
+export type ListTransactionValidatorsRequest = {
+    /**
+     * List of transaction IDs to filter validators by. Maximum of 100 transaction IDs allowed per request.
+     */
+    transactionIds: Array<string>;
+    /**
+     * Cursor for pagination
+     */
+    cursor?: string;
+    /**
+     * Maximum number of transaction-validator associations to return per page. Default is 100, maximum is 1000.
+     */
+    limit?: number;
+    sortDirection?: SortDirection;
+};

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

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2025-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 { PaginatedResponse } from './PaginatedResponse';
+import { TransactionValidator } from './TransactionValidator';
+export type ListTransactionValidatorsResponse = {
+    /**
+     * List of transaction-to-validator associations. Each entry represents one transaction staking to one validator.
+     */
+    transactionValidators: Array<TransactionValidator>;
+    pagination: PaginatedResponse;
+};

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

@@ -18,11 +18,32 @@
  *  Do not edit the class manually.
  */
 export type RFQProductDetails = {
+    /**
+     * Whether the product is tradable via RFQ
+     */
     tradable?: boolean;
+    /**
+     * Deprecated: Value will be an empty string
+     */
     minNotionalSize?: string;
+    /**
+     * Deprecated: Value will be an empty string
+     */
     maxNotionalSize?: string;
+    /**
+     * Minimum base size for RFQ
+     */
     minBaseSize?: string;
+    /**
+     * Maximum base size for RFQ
+     */
     maxBaseSize?: string;
+    /**
+     * Minimum quote size for RFQ
+     */
     minQuoteSize?: string;
+    /**
+     * Maximum quote size for RFQ
+     */
     maxQuoteSize?: string;
 };

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

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2025-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 { WalletClaimRewardsInputs } from './WalletClaimRewardsInputs';
+export type StakingClaimRewardsRequest = {
+    /**
+     * The client generated idempotency key for requested execution. Any subsequent requests with the same key will return the original response
+     */
+    idempotencyKey: string;
+    inputs?: WalletClaimRewardsInputs;
+};

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

@@ -0,0 +1,33 @@
+/**
+ * Copyright 2025-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 StakingClaimRewardsResponse = {
+    /**
+     * The wallet ID
+     */
+    walletId: string;
+    /**
+     * ID of the newly created transaction, can be used to fetch details of the current state of execution
+     */
+    transactionId: string;
+    /**
+     * The ID for the activity generated for this request
+     */
+    activityId: string;
+};

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

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2025-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 { ValidatorStatus } from './enums/ValidatorStatus';
+export type TransactionValidator = {
+    /**
+     * The ID of the transaction which staked to this validator
+     */
+    transactionId: string;
+    /**
+     * The address (public key) of the validator
+     */
+    validatorAddress: string;
+    validatorStatus: ValidatorStatus;
+};

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

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2025-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.
+ */
+/**
+ * WalletClaimRewardsInputs contains the custom inputs for claim rewards operations on a wallet. Requirements and supported fields vary by asset type.
+ */
+export type WalletClaimRewardsInputs = {
+    /**
+     * Optional amount to claim rewards (ETH only). If omitted, the wallet will claim the maximum amount available
+     */
+    amount?: string;
+};

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

@@ -0,0 +1,51 @@
+/**
+ * Copyright 2025-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 { XMParty } from './enums/XMParty';
+export type XMLoan = {
+    /**
+     * Financing loan UUID
+     */
+    loanId?: string;
+    loanParty?: XMParty;
+    /**
+     * Loan principal currency
+     */
+    principalCurrency?: string;
+    /**
+     * Loan principal currency market price
+     */
+    principalCurrencyMarketPrice?: string;
+    /**
+     * Principal amount (nominal) as of loan initiation
+     */
+    initialPrincipalAmount?: string;
+    /**
+     * Current outstanding amount (nominal)
+     */
+    outstandingPrincipalAmount?: string;
+    /**
+     * Timestamp when the loan was created / initiated
+     */
+    createdAt?: Date;
+    /**
+     * Timestamp when the loan was last updated
+     */
+    updatedAt?: Date;
+};

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

@@ -0,0 +1,57 @@
+/**
+ * Copyright 2025-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 { XMCallStatus } from './enums/XMCallStatus';
+import { XMCallType } from './enums/XMCallType';
+import { XMMarginLevel } from './enums/XMMarginLevel';
+import { XMSummary } from './XMSummary';
+export type XMMarginCall = {
+    /**
+     * Financing margin call UUID
+     */
+    marginCallId?: string;
+    /**
+     * Margin call currency
+     */
+    currency?: string;
+    /**
+     * Call amount (notional) as of the margin call creation
+     */
+    initialNotionalAmount?: string;
+    /**
+     * Current outstanding call amount (notional)
+     */
+    outstandingNotionalAmount?: string;
+    marginCallType?: XMCallType;
+    marginCallStatus?: XMCallStatus;
+    calledWithMarginLevel?: XMMarginLevel;
+    calledWithMarginSummary?: XMSummary;
+    /**
+     * Timestamp when the margin call settlement is due
+     */
+    dueAt?: Date;
+    /**
+     * Timestamp when the margin call was created
+     */
+    createdAt?: Date;
+    /**
+     * Timestamp when the margin call was last updated
+     */
+    updatedAt?: Date;
+};

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

@@ -0,0 +1,121 @@
+/**
+ * Copyright 2025-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 XMPosition = {
+    /**
+     * Position currency
+     */
+    currency?: string;
+    /**
+     * Current market price
+     */
+    marketPrice?: string;
+    /**
+     * True if margin eligible, false otherwise
+     */
+    marginEligible?: boolean;
+    /**
+     * Total market capitalization
+     */
+    marketCap?: string;
+    /**
+     * Average daily volume calculated over a 30-day period
+     */
+    adv30Days?: string;
+    /**
+     * Historic volatility calculated over a 5-day period
+     */
+    hist5dVol?: string;
+    /**
+     * Historic volatility calculated over a 30-day period
+     */
+    hist30dVol?: string;
+    /**
+     * Historic volatility calculated over a 90-day period
+     */
+    hist90dVol?: string;
+    /**
+     * Base margin requirement for the specific asset
+     */
+    marginRequirement?: string;
+    /**
+     * XM spot balance nominal
+     */
+    spotBalance?: string;
+    /**
+     * XM spot balance notional
+     */
+    spotBalanceNotional?: string;
+    /**
+     * Pre-netted spot total position margin
+     */
+    spotTotalPositionMargin?: string;
+    /**
+     * XM futures balance nominal
+     */
+    futuresBalance?: string;
+    /**
+     * XM futures balance notional
+     */
+    futuresBalanceNotional?: string;
+    /**
+     * Pre-netted futures total position margin
+     */
+    futuresTotalPositionMargin?: string;
+    /**
+     * Basis GMV = |futures| + |spot| - |unnetted position|
+     */
+    gmvBasis?: string;
+    /**
+     * Base margin requirement notional
+     */
+    baseRequirement?: string;
+    /**
+     * Effective liquidity add-on for the short positions
+     */
+    liqShortsAddOn?: string;
+    /**
+     * Effective liquidity add-on for the long positions
+     */
+    liqLongsAddOn?: string;
+    /**
+     * Effective volatility add-on for the short positions
+     */
+    volShortsAddOn?: string;
+    /**
+     * Effective volatility add-on for the long positions
+     */
+    volLongsAddOn?: string;
+    /**
+     * 5-day volatility add-on
+     */
+    vol5daysAddOn?: string;
+    /**
+     * 30-day volatility add-on
+     */
+    vol30daysAddOn?: string;
+    /**
+     * 90-day volatility add-on
+     */
+    vol90daysAddOn?: string;
+    /**
+     * Total margin required
+     */
+    totalPositionMargin?: string;
+};

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

@@ -0,0 +1,76 @@
+/**
+ * Copyright 2025-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 { 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
+     */
+    nodalMarginRequirement?: 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, via the XM model with one-leg netting
+     */
+    integratedPortfolioMarginRequirement?: string;
+    /**
+     * Ineligible Futures Margin Requirement (IFMR) is the margin requirement for IPMR-ineligible futures contracts
+     */
+    ineligibleFuturesMarginRequirement?: string;
+    /**
+     * Position margin requirement for all spot positions
+     */
+    positionMarginRequirement?: string;
+    /**
+     * Portfolio margin addon for all spot positions
+     */
+    portfolioMarginAddon?: string;
+    /**
+     * Position margin requirement for spot + futures positions
+     */
+    integratedPositionMarginRequirement?: string;
+    /**
+     * Portfolio margin addon for spot + futures positions
+     */
+    integratedPortfolioMarginAddon?: string;
+    /**
+     * Post-netting USD notional for all futures positions
+     */
+    nettedFuturesNotional?: string;
+    /**
+     * Total basis gross market value of all XM-eligible positions (i.e. crypto underliers)
+     */
+    totalGmvBasis?: string;
+    /**
+     * Integrated Portfolio Margin cash balance
+     */
+    ipmCashBalance?: string;
+    integratedScenarioAddon?: MarginAddOn;
+    /**
+     * All integrated scenario add-ons
+     */
+    allIntegratedScenarioAddons?: Array<MarginAddOn>;
+    /**
+     * Netted positions used in the model calculation
+     */
+    xmPositions?: Array<XMPosition>;
+};

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

@@ -0,0 +1,55 @@
+/**
+ * Copyright 2025-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 { XMRiskNettingInfo } from './XMRiskNettingInfo';
+export type XMSummary = {
+    /**
+     * Cross Margin Margin Requirement (XMMR) notional
+     */
+    marginRequirement?: string;
+    /**
+     * 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;
+    /**
+     * Equity attributed by spot
+     */
+    spotEquity?: string;
+    /**
+     * Equity attributed by futures
+     */
+    futuresEquity?: string;
+    riskNettingInfo?: XMRiskNettingInfo;
+};

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

@@ -22,7 +22,6 @@ export declare enum ActivityCategory {
     ActivityCategoryOrder = "ACTIVITY_CATEGORY_ORDER",
     ActivityCategoryTransaction = "ACTIVITY_CATEGORY_TRANSACTION",
     ActivityCategoryAccount = "ACTIVITY_CATEGORY_ACCOUNT",
-    ActivityCategoryAdmin = "ACTIVITY_CATEGORY_ADMIN",
     ActivityCategoryAllocation = "ACTIVITY_CATEGORY_ALLOCATION",
     ActivityCategoryLending = "ACTIVITY_CATEGORY_LENDING"
 }

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

@@ -18,7 +18,7 @@
  *  Do not edit the class manually.
  */
 export declare enum ActivityLevel {
-    All = "ACTIVITY_LEVEL_ALL",
-    Portfolio = "ACTIVITY_LEVEL_PORTFOLIO",
-    Entity = "ACTIVITY_LEVEL_ENTITY"
+    ActivityLevelAll = "ACTIVITY_LEVEL_ALL",
+    ActivityLevelPortfolio = "ACTIVITY_LEVEL_PORTFOLIO",
+    ActivityLevelEntity = "ACTIVITY_LEVEL_ENTITY"
 }

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

@@ -18,7 +18,7 @@
  *  Do not edit the class manually.
  */
 export declare enum AddressBookType {
-    Unspecified = "ADDRESS_BOOK_TYPE_UNSPECIFIED",
-    Address = "ADDRESS_BOOK_TYPE_ADDRESS",
-    CounterpartyId = "ADDRESS_BOOK_TYPE_COUNTERPARTY_ID"
+    AddressBookTypeUnspecified = "ADDRESS_BOOK_TYPE_UNSPECIFIED",
+    AddressBookTypeAddress = "ADDRESS_BOOK_TYPE_ADDRESS",
+    AddressBookTypeCounterpartyId = "ADDRESS_BOOK_TYPE_COUNTERPARTY_ID"
 }