@coinbase-sample/prime-sdk-ts 0.1.0

package/dist/model/Allocation.d.ts

@@ -0,0 +1,78 @@
+/**
+ * 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 { AllocationStatus } from './enums/AllocationStatus';
+import { DestinationAlloc } from './DestinationAlloc';
+import { OrderSide } from './enums/OrderSide';
+export type Allocation = {
+    /**
+     * The ID that ties together an allocation and all of its legs.
+     */
+    rootId?: string;
+    /**
+     * The ID of the allocation if this allocation is a reversal. In this case, the root_id would be the original allocation ID.
+     */
+    reversalId?: string;
+    /**
+     * Time the final leg of the root allocation was completed.
+     */
+    allocationCompletedAt?: Date;
+    /**
+     * The ID of the user that created the allocation.
+     */
+    userId?: string;
+    /**
+     * The ID of the product of the orders allocated.
+     */
+    productId?: string;
+    side?: OrderSide;
+    /**
+     * Price the allocation was done at.
+     */
+    avgPrice?: string;
+    /**
+     * Amount allocated in base asset units.
+     */
+    baseQuantity?: string;
+    /**
+     * Amount allocated in quote asset units.
+     */
+    quoteValue?: string;
+    /**
+     * Fees from original trade execution allocated in quote asset units.
+     */
+    feesAllocated?: string;
+    status?: AllocationStatus;
+    /**
+     * Portfolio ID of the source portfolio.
+     */
+    source?: string;
+    /**
+     * All order IDs that were aggregated to calculate the avg_price, quantity to allocate in each leg. Each order_id should tie back to the single allocation root_id.
+     */
+    orderIds?: Array<string>;
+    /**
+     * Array of objects, each containing the leg ID, destination portfolio ID and amount in chosen units allocated to each portfolio: [{leg_id, portfolio_id, allocation_base, allocation_quote}, {leg_id, portfolio_id, allocation_base, allocation_quote}...]
+     */
+    destinations?: Array<DestinationAlloc>;
+    /**
+     * The netting ID of the allocation, not empty if the allocation was submitted as part of a net allocation
+     */
+    nettingId?: string;
+};

package/dist/model/Allocation.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/AllocationLeg.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 AllocationLeg = {
+    /**
+     * The ID of the portfolio of the allocation leg
+     */
+    allocationLegId: string;
+    /**
+     * The ID of the destination portfolio of the allocation leg
+     */
+    destinationPortfolioId: string;
+    /**
+     * The amount size for the allocation leg
+     */
+    amount: string;
+};

package/dist/model/AllocationLeg.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/AmountDue.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 AmountDue = {
+    /**
+     * The currency this loan is due in
+     */
+    currency?: string;
+    /**
+     * The amount due
+     */
+    amount?: string;
+    /**
+     * The date this settlement is due, expressed in UTC
+     */
+    dueDate?: Date;
+};

package/dist/model/AmountDue.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/Asset.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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 Asset = {
+    /**
+     * The name of the asset
+     */
+    name?: string;
+    /**
+     * The mutable series of letters used to identify the asset
+     */
+    symbol?: string;
+    /**
+     * The number of decimals supported for the asset
+     */
+    decimalPrecision?: string;
+    /**
+     * Indicates whether this asset can be traded
+     */
+    tradingSupported?: boolean;
+    /**
+     * Base URL to our recommended block explorer (crypto only)
+     */
+    explorerUrl?: string;
+};

package/dist/model/Asset.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/AssetChange.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 { AssetChangeType } from './enums/AssetChangeType';
+import { NFTCollection } from './NFTCollection';
+import { NFTItem } from './NFTItem';
+export type AssetChange = {
+    type?: AssetChangeType;
+    /**
+     * The currency symbol associated with the balance operation
+     */
+    symbol?: string;
+    /**
+     * The amount in whole units being transferred or approved
+     */
+    amount?: string;
+    collection?: NFTCollection;
+    item?: NFTItem;
+};

package/dist/model/AssetChange.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/Balance.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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 Balance = {
+    /**
+     * The display symbol for the asset
+     */
+    symbol?: string;
+    /**
+     * The total amount in whole units with full precision. Includes the `holds` amount.
+     */
+    amount?: string;
+    /**
+     * Amount that is currently held in obligation to an open order\'s position or a pending withdrawal
+     */
+    holds?: string;
+    /**
+     * Amount that is currently locked due to bonding/staking, potentially subject to an unbonding period, in whole units
+     */
+    bondedAmount?: string;
+    /**
+     * Amount that must remain in the wallet due to the protocol, in whole units
+     */
+    reservedAmount?: string;
+    /**
+     * Amount that is in the process of unbonding, in whole units
+     */
+    unbondingAmount?: string;
+    /**
+     * Unrealized amount subject to a vesting schedule, in whole units
+     */
+    unvestedAmount?: string;
+    /**
+     * Pending bonding/staking rewards that have not yet been realized, in whole units
+     */
+    pendingRewardsAmount?: string;
+    /**
+     * Previously realized bonding/staking rewards, in whole units
+     */
+    pastRewardsAmount?: string;
+    /**
+     * Amount available for bonding/staking, in whole units
+     */
+    bondableAmount?: string;
+    /**
+     * Amount available to withdraw, in whole units
+     */
+    withdrawableAmount?: string;
+    /**
+     * The total amount in fiat unit
+     */
+    fiatAmount?: string;
+};

package/dist/model/Balance.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/BlockchainAddress.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 BlockchainAddress = {
+    address?: string;
+    accountIdentifier?: string;
+};

package/dist/model/BlockchainAddress.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/CancelOrderResponse.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 CancelOrderResponse = {
+    /**
+     * The unique UUID for the order
+     */
+    id?: string;
+};

package/dist/model/CancelOrderResponse.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/Commission.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 Commission = {
+    /**
+     * Hardcode type to all_in. When we support cost+, we will have cost_plus type
+     */
+    type?: string;
+    /**
+     * Commission rate (in whole percentage. Commission of 15bps is \"0.0015\")
+     */
+    rate?: string;
+    /**
+     * Average 30 days over past 3 months (e.g. 90 days divided by 3)
+     */
+    tradingVolume?: string;
+};

package/dist/model/Commission.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/CreateAllocationRequest.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 { AllocationLeg } from './AllocationLeg';
+import { AllocationSizeType } from './enums/AllocationSizeType';
+export type CreateAllocationRequest = {
+    /**
+     * The ID of the allocation
+     */
+    allocationId?: string;
+    /**
+     * The source portfolio id for the allocation
+     */
+    sourcePortfolioId?: string;
+    /**
+     * The product for the allocation
+     */
+    productId?: string;
+    /**
+     * The list of order ids in the allocation
+     */
+    orderIds?: Array<string>;
+    /**
+     * The list of allocation_legs for the allocation
+     */
+    allocationLegs?: Array<AllocationLeg>;
+    sizeType?: AllocationSizeType;
+    /**
+     * The portfolio where to allocate the remainder of the size
+     */
+    remainderDestinationPortfolio?: string;
+    /**
+     * The ID to identify an in-flight net allocation.
+     */
+    nettingId?: string;
+};

package/dist/model/CreateAllocationRequest.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 });