@coinbase-sample/prime-sdk-ts 0.1.0

package/dist/model/OrderPreviewRequest.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/model/PaginatedResponse.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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 PaginatedResponse = {
+    /**
+     * Cursor to navigate to next page
+     */
+    nextCursor: string;
+    sortDirection: SortDirection;
+    /**
+     * A boolean value indicating whether there are more items to paginate through
+     */
+    hasNext: boolean;
+};

package/dist/model/PaginatedResponse.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/model/PaymentMethodDestination.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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 PaymentMethodDestination = {
+    paymentMethodId?: string;
+};

package/dist/model/PaymentMethodDestination.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/model/PaymentMethodDetails.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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 { PaymentMethodType } from './enums/PaymentMethodType';
+export type PaymentMethodDetails = {
+    id?: string;
+    symbol?: string;
+    paymentMethodType?: PaymentMethodType;
+    name?: string;
+    accountNumber?: string;
+    bankCode?: string;
+};

package/dist/model/PaymentMethodDetails.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/model/PaymentMethodSummary.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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 { PaymentMethodType } from './enums/PaymentMethodType';
+export type PaymentMethodSummary = {
+    id?: string;
+    symbol?: string;
+    paymentMethodType?: PaymentMethodType;
+    bankName?: string;
+    accountNumber?: string;
+    bankName2?: string;
+};

package/dist/model/PaymentMethodSummary.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/model/PortfolioUser.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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 { UserRole } from './enums/UserRole';
+export type PortfolioUser = {
+    /**
+     * The unique ID of the user.
+     */
+    id?: string;
+    /**
+     * The name of the user.
+     */
+    name?: string;
+    /**
+     * The email of the user.
+     */
+    email?: string;
+    /**
+     * The portfolio to which this user and associated permissions are identified.
+     */
+    portfolioId?: string;
+    /**
+     * The entity to which this user and associated permissions are identified.
+     */
+    entityId?: string;
+    role?: UserRole;
+};

package/dist/model/PortfolioUser.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/model/PostOrderPreviewResponse.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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 { OrderSide } from './enums/OrderSide';
+import { OrderType } from './enums/OrderType';
+import { TimeInForceType } from './enums/TimeInForceType';
+export type PostOrderPreviewResponse = {
+    /**
+     * The ID of the portfolio that owns the order
+     */
+    portfolioId?: string;
+    /**
+     * The ID of the product being traded by the order
+     */
+    productId?: string;
+    side?: OrderSide;
+    type?: OrderType;
+    /**
+     * Order size in base asset units (either `base_quantity` or `quote_value` is required)
+     */
+    baseQuantity?: string;
+    /**
+     * Order size in quote asset units, i.e. the amount the user wants to spend (when buying) or receive (when selling); the quantity in base units will be determined based on the market liquidity and indicated `quote_value`. Either `base_quantity` or `quote_value` is required
+     */
+    quoteValue?: string;
+    /**
+     * The limit price (required for TWAP, VWAP, LIMIT, and STOP_LIMIT orders)
+     */
+    limitPrice?: string;
+    /**
+     * The start time of the order in UTC (only applies to TWAP orders.)
+     */
+    startTime?: Date;
+    /**
+     * The expiry time of the order in UTC (TWAP, VWAP, LIMIT and STOP_LIMIT GTD only). Required for TWAP and VWAP orders if historical_pov is unspecified
+     */
+    expiryTime?: Date;
+    timeInForce?: TimeInForceType;
+    /**
+     * Indicate the total commission paid on this order in quote currency - only applicable if the order has any fills
+     */
+    commission?: string;
+    /**
+     * How much slippage is expected
+     */
+    slippage?: string;
+    /**
+     * Current best bid for order book
+     */
+    bestBid?: string;
+    /**
+     * Current best ask for order book
+     */
+    bestAsk?: string;
+    /**
+     * Indicate expected average filled price based on the current order book
+     */
+    averageFilledPrice?: string;
+    /**
+     * Order quantity + fees
+     */
+    orderTotal?: string;
+    /**
+     * The estimated participation rate for a TWAP/VWAP order. This field can be specified instead of expiry time, and will be used to compute the expiry time of the order based on historical participation rate.
+     */
+    historicalPov?: string;
+};

package/dist/model/PostOrderPreviewResponse.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/model/PostTradeCreditInformation.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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 { AmountDue } from './AmountDue';
+export type PostTradeCreditInformation = {
+    /**
+     * The unique ID of the portfolio
+     */
+    portfolioId?: string;
+    /**
+     * The currency symbol credit is denoted in
+     */
+    currency?: string;
+    /**
+     * The maximum credit limit
+     */
+    limit?: string;
+    /**
+     * The amount of credit used
+     */
+    utilized?: string;
+    /**
+     * The amount of credit available
+     */
+    available?: string;
+    /**
+     * Whether or not a portfolio is frozen due to balance outstanding or other reason
+     */
+    frozen?: boolean;
+    /**
+     * The reason why the portfolio is frozen
+     */
+    frozenReason?: string;
+    amountsDue?: Array<AmountDue>;
+    /**
+     * Whether the portfolio has credit enabled
+     */
+    enabled?: boolean;
+    /**
+     * The amount of adjusted credit used
+     */
+    adjustedCreditUtilized?: string;
+    /**
+     * The amount of adjusted portfolio equity
+     */
+    adjustedPortfolioEquity?: string;
+};

package/dist/model/PostTradeCreditInformation.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/model/Product.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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 { ProductPermissions } from './enums/ProductPermissions';
+export type Product = {
+    /**
+     * The product ID, written as `BASE-QUOTE`
+     */
+    id?: string;
+    /**
+     * The smallest permitted unit of denomination for the base asset (varies by product)
+     */
+    baseIncrement?: string;
+    /**
+     * The smallest permitted unit of denomination for the quote asset (varies by product)
+     */
+    quoteIncrement?: string;
+    /**
+     * The minimum size (in base asset units) for which an order can be placed
+     */
+    baseMinSize?: string;
+    /**
+     * The minimum size (in quote asset units) for which an order can be placed
+     */
+    quoteMinSize?: string;
+    /**
+     * The maximum size (in base asset units) for which an order can be placed
+     */
+    baseMaxSize?: string;
+    /**
+     * The maximum size (in quote asset units) for which an order can be placed
+     */
+    quoteMaxSize?: string;
+    /**
+     * Permissions given to the user for a product
+     */
+    permissions?: Array<ProductPermissions>;
+    /**
+     * The smallest permitted price increment for the product
+     */
+    priceIncrement?: string;
+};

package/dist/model/Product.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/model/Transaction.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Copyright 2024-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generato
+ *
+ * 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 { AssetChange } from './AssetChange';
+import { EstimatedNetworkFees } from './EstimatedNetworkFees';
+import { TransactionMetadata } from './TransactionMetadata';
+import { TransactionStatus } from './enums/TransactionStatus';
+import { TransactionType } from './enums/TransactionType';
+import { TransferLocation } from './TransferLocation';
+export type Transaction = {
+    /**
+     * The ID of the transaction
+     */
+    id?: string;
+    /**
+     * The wallet ID of the transaction
+     */
+    walletId?: string;
+    /**
+     * The portfolio ID of the transaction
+     */
+    portfolioId?: string;
+    type?: TransactionType;
+    status?: TransactionStatus;
+    /**
+     * The asset symbol
+     */
+    symbol?: string;
+    /**
+     * The transaction creation time (as a UTC timestamp)
+     */
+    createdAt?: Date;
+    /**
+     * The transaction completion time (as a UTC timestamp)
+     */
+    completedAt?: Date;
+    /**
+     * The transaction amount in whole units
+     */
+    amount?: string;
+    transferFrom?: TransferLocation;
+    transferTo?: TransferLocation;
+    /**
+     * The blockchain network fees (in whole units) required in order to broadcast the transaction
+     */
+    networkFees?: string;
+    /**
+     * The fees that the customer paid for the transaction (in whole units)
+     */
+    fees?: string;
+    /**
+     * The asset in which fees will be paid
+     */
+    feeSymbol?: string;
+    /**
+     * The cryptocurrency network transaction hashes/IDs generated upon broadcast
+     */
+    blockchainIds?: Array<string>;
+    /**
+     * The 8 character alphanumeric short form id for the transaction
+     */
+    transactionId?: string;
+    /**
+     * The destination asset symbol
+     */
+    destinationSymbol?: string;
+    estimatedNetworkFees?: EstimatedNetworkFees;
+    /**
+     * The network name
+     */
+    network?: string;
+    /**
+     * The estimated asset changes (web3)
+     */
+    estimatedAssetChanges?: Array<AssetChange>;
+    metadata?: TransactionMetadata;
+    /**
+     * The idempotency key associated with the transaction creation request
+     */
+    idempotencyKey?: string;
+};