@coinbase-sample/prime-sdk-ts 0.2.1 → 0.3.1

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

@@ -0,0 +1,49 @@
+/**
+ * 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 ConversionDetail = {
+    /**
+     * The currency symbol
+     */
+    symbol?: string;
+    /**
+     * Trade finance balance after the conversion
+     */
+    tfBalance?: string;
+    /**
+     * Notional trade finance balance after the conversion
+     */
+    notionalTfBalance?: string;
+    /**
+     * Converted balance
+     */
+    convertedBalance?: string;
+    /**
+     * Notional converted balance
+     */
+    notionalConvertedBalance?: string;
+    /**
+     * Interest rate
+     */
+    interestRate?: string;
+    /**
+     * Conversion rate
+     */
+    conversionRate?: string;
+};

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

@@ -0,0 +1,37 @@
+/**
+ * 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 CreateNewLocatesRequest = {
+    /**
+     * Currency symbol
+     */
+    symbol: string;
+    /**
+     * Locate Amount
+     */
+    amount: string;
+    /**
+     * Deprecated: Use locate_date instead
+     */
+    conversionDate?: string;
+    /**
+     * The target date of the locate (YYYY-MM-DD)
+     */
+    locateDate?: string;
+};

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

@@ -0,0 +1,22 @@
+/**
+ * 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 CreateNewLocatesResponse = {
+    locateId?: string;
+};

package/dist/{model → types/model}/CreateOnchainTransactionRequestEvmParams.d.ts

@@ -23,11 +23,19 @@ export type CreateOnchainTransactionRequestEvmParams = {
      */
     disableDynamicGas?: boolean;
     /**
-     * Transaction ID to replace (for speed-up/cancel operations). Common use cases: 1) Gas Price Adjustments: When a transaction is stuck due to low gas price, a new transaction with the same nonce but higher gas price can be submitted to replace it. 2) Transaction Cancellation: A user might want to cancel a pending transaction by replacing it with a new transaction (often a 0-value transfer to themselves with higher gas price).
+     * Option to disable dynamic nonce when creating a transaction. Defaults to false.
+     */
+    disableDynamicNonce?: boolean;
+    /**
+     * Transaction ID to replace (for speed-up/cancel operations). Common use cases: 1) Gas Price Adjustments: When a transaction is stuck due to low gas price, a new transaction with the same nonce but higher gas price can be submitted to replace it. 2) Transaction Cancellation: A user might want to cancel a pending transaction by replacing it with a new transaction (often a 0-value transfer to themselves with higher gas price). Note: When using this field, the disable_dynamic_nonce option must be set to false because the nonce will be automatically managed by the system.
      */
     replacedTransactionId?: string;
     /**
      * Chain ID for EVM transactions. (EVM-only)
      */
     chainId?: string;
+    /**
+     * Network name for EVM transactions. (EVM-only)
+     */
+    networkName?: string;
 };

package/dist/{model → types/model}/CreateOrderRequest.d.ts

@@ -37,4 +37,8 @@ export type CreateOrderRequest = {
     isRaiseExact?: boolean;
     historicalPov?: string;
     stopPrice?: string;
+    /**
+     * next: 19
+     */
+    settlCurrency?: string;
 };

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

@@ -0,0 +1,41 @@
+/**
+ * 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 EntityBalance = {
+    /**
+     * The display symbol for the asset
+     */
+    symbol?: string;
+    /**
+     * The long balance
+     */
+    longAmount?: string;
+    /**
+     * The long balance in notional value
+     */
+    longNotional?: string;
+    /**
+     * The short balance
+     */
+    shortAmount?: string;
+    /**
+     * The short balance in notional value
+     */
+    shortNotional?: string;
+};

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

@@ -0,0 +1,65 @@
+/**
+ * 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 ExistingLocate = {
+    /**
+     * The locate ID
+     */
+    locateId?: string;
+    /**
+     * The unique ID of the entity
+     */
+    entityId?: string;
+    /**
+     * The unique ID of the portfolio
+     */
+    portfolioId?: string;
+    /**
+     * The currency symbol
+     */
+    symbol?: string;
+    /**
+     * The requested locate amount
+     */
+    requestedAmount?: string;
+    /**
+     * The interest rate of PM loan
+     */
+    interestRate?: string;
+    /**
+     * The locate status
+     */
+    status?: string;
+    /**
+     * The approved locate amount
+     */
+    approvedAmount?: string;
+    /**
+     * Deprecated: Use locate_date instead
+     */
+    conversionDate?: string;
+    /**
+     * The date when the locate was submitted in RFC3339 format
+     */
+    createdAt?: string;
+    /**
+     * The locate date from the CreateNewLocatesRequest in RFC3339 format
+     */
+    locateDate?: string;
+};

package/dist/{model → types/model}/Fill.d.ts

@@ -31,6 +31,10 @@ export type Fill = {
      * The product ID of the fill
      */
     productId?: string;
+    /**
+     * The client product ID of the fill indicating the settlement currency
+     */
+    clientProductId?: string;
     side?: OrderSide;
     /**
      * Filled size (in base asset units)

package/dist/types/model/GetBuyingPowerResponse.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 { BuyingPower } from './BuyingPower';
+export type GetBuyingPowerResponse = {
+    buyingPower?: BuyingPower;
+};

package/dist/types/model/GetExistingLocatesResponse.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 { ExistingLocate } from './ExistingLocate';
+export type GetExistingLocatesResponse = {
+    locates?: Array<ExistingLocate>;
+};

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

@@ -0,0 +1,24 @@
+/**
+ * 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 { Accrual } from './Accrual';
+export type GetInterestAccrualsResponse = {
+    totalNotionalAccrual?: string;
+    accruals?: Array<Accrual>;
+};

package/dist/types/model/GetLocateAvailabilitiesResponse.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 { Locate } from './Locate';
+export type GetLocateAvailabilitiesResponse = {
+    locates?: Array<Locate>;
+};

package/dist/types/model/GetMarginConversionsResponse.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 { Conversion } from './Conversion';
+export type GetMarginConversionsResponse = {
+    conversions?: Array<Conversion>;
+};

package/dist/types/model/GetMarginInformationResponse.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 { MarginInformation } from './MarginInformation';
+export type GetMarginInformationResponse = {
+    marginInformation?: MarginInformation;
+};

package/dist/types/model/GetMarginSummariesResponse.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 { MarginSummaryHistorical } from './MarginSummaryHistorical';
+export type GetMarginSummariesResponse = {
+    marginSummaries?: Array<MarginSummaryHistorical>;
+};

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

@@ -0,0 +1,24 @@
+/**
+ * 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 { Accrual } from './Accrual';
+export type GetPortfolioInterestAccrualsResponse = {
+    totalNotionalAccrual?: string;
+    accruals?: Array<Accrual>;
+};

package/dist/types/model/GetTFTieredPricingFeesResponse.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 { TieredPricingFee } from './TieredPricingFee';
+export type GetTFTieredPricingFeesResponse = {
+    fees?: Array<TieredPricingFee>;
+};

package/dist/types/model/GetWithdrawalPowerResponse.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 { WithdrawalPower } from './WithdrawalPower';
+export type GetWithdrawalPowerResponse = {
+    withdrawalPower?: WithdrawalPower;
+};

package/dist/types/model/ListAggregateEntityPositionsResponse.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.
+ */
+import { PaginatedResponse } from './PaginatedResponse';
+import { Position } from './Position';
+export type ListAggregateEntityPositionsResponse = {
+    positions: Array<Position>;
+    pagination: PaginatedResponse;
+};

package/dist/types/model/ListEntityBalancesResponse.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.
+ */
+import { EntityBalance } from './EntityBalance';
+import { PaginatedResponse } from './PaginatedResponse';
+export type ListEntityBalancesResponse = {
+    balances: Array<EntityBalance>;
+    pagination: PaginatedResponse;
+};

package/dist/types/model/ListEntityPositionsResponse.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.
+ */
+import { PaginatedResponse } from './PaginatedResponse';
+import { Position } from './Position';
+export type ListEntityPositionsResponse = {
+    positions: Array<Position>;
+    pagination: PaginatedResponse;
+};

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

@@ -0,0 +1,41 @@
+/**
+ * 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 LoanInfo = {
+    /**
+     * The unique ID of the portfolio
+     */
+    portfolioId?: string;
+    /**
+     * The currency symbol
+     */
+    symbol?: string;
+    /**
+     * Balance amount
+     */
+    amount?: string;
+    /**
+     * Notional balance amount
+     */
+    notionalAmount?: string;
+    /**
+     * Settlement due date
+     */
+    dueDate?: string;
+};

package/dist/types/model/Locate.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 Locate = {
+    /**
+     * The currency symbol
+     */
+    symbol?: string;
+    /**
+     * The available quantity located
+     */
+    quantity?: string;
+    /**
+     * The interest rate for located symbol
+     */
+    rate?: string;
+};