@coinbase-sample/prime-sdk-ts 0.5.0 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/dist/constants.js +1 -1
  2. package/dist/financing/index.js +18 -0
  3. package/dist/index.js +3 -1
  4. package/dist/model/Counterparty.js +21 -0
  5. package/dist/model/CounterpartyDestination.js +21 -0
  6. package/dist/model/CreateNetAllocationRequest.js +21 -0
  7. package/dist/model/FCMMarginCall.js +21 -0
  8. package/dist/model/GetFcmMarginCallDetailsResponse.js +21 -0
  9. package/dist/model/GetFcmRiskLimitsResponse.js +21 -0
  10. package/dist/model/GetOrderEditHistoryResponse.js +21 -0
  11. package/dist/model/GetPortfolioCounterpartyIDResponse.js +21 -0
  12. package/dist/model/LimitOrderEdit.js +21 -0
  13. package/dist/model/OrderEdit.js +21 -0
  14. package/dist/model/PortfolioStakingInitiateRequest.js +21 -0
  15. package/dist/model/PortfolioStakingInitiateResponse.js +21 -0
  16. package/dist/model/PortfolioStakingMetadata.js +21 -0
  17. package/dist/model/PortfolioStakingUnstakeRequest.js +21 -0
  18. package/dist/model/PortfolioStakingUnstakeResponse.js +21 -0
  19. package/dist/model/StakingUnstakeRequest.js +21 -0
  20. package/dist/model/WalletStakeInputs.js +21 -0
  21. package/dist/model/WalletUnstakeInputs.js +21 -0
  22. package/dist/model/enums/AllocationSizeType.js +0 -1
  23. package/dist/model/enums/AssetChangeType.js +0 -1
  24. package/dist/model/enums/CustodyActivityType.js +0 -1
  25. package/dist/model/enums/DestinationType.js +4 -4
  26. package/dist/model/enums/FcmMarginCallState.js +30 -0
  27. package/dist/model/enums/FcmMarginCallType.js +28 -0
  28. package/dist/model/enums/OrderSide.js +0 -1
  29. package/dist/model/enums/OrderStatus.js +0 -1
  30. package/dist/model/enums/OrderType.js +0 -1
  31. package/dist/model/enums/PaymentMethodType.js +3 -4
  32. package/dist/model/enums/PortfolioBalanceType.js +0 -1
  33. package/dist/model/enums/ProductPermissions.js +0 -1
  34. package/dist/model/enums/SigningStatus.js +0 -1
  35. package/dist/model/enums/TimeInForceType.js +0 -1
  36. package/dist/model/enums/TransactionStatus.js +0 -1
  37. package/dist/model/enums/TransactionType.js +0 -1
  38. package/dist/model/enums/TransferLocationType.js +0 -1
  39. package/dist/model/enums/UserRole.js +0 -1
  40. package/dist/model/enums/VisibilityStatus.js +0 -1
  41. package/dist/model/enums/WalletDepositInstructionType.js +0 -1
  42. package/dist/model/enums/WalletType.js +0 -1
  43. package/dist/model/enums/index.js +5 -1
  44. package/dist/orders/index.js +11 -0
  45. package/dist/portfolios/index.js +9 -0
  46. package/dist/staking/index.js +24 -0
  47. package/dist/transactions/index.js +1 -1
  48. package/dist/types/constants.d.ts +1 -1
  49. package/dist/types/financing/index.d.ts +5 -1
  50. package/dist/types/financing/types.d.ts +9 -1
  51. package/dist/types/index.d.ts +5 -4
  52. package/dist/types/model/Counterparty.d.ts +25 -0
  53. package/dist/types/model/CounterpartyDestination.d.ts +22 -0
  54. package/dist/types/model/CreateAllocationRequest.d.ts +0 -4
  55. package/dist/types/model/CreateNetAllocationRequest.d.ts +48 -0
  56. package/dist/types/model/CreateOrderRequest.d.ts +6 -2
  57. package/dist/types/model/CreateWalletWithdrawalRequest.d.ts +2 -0
  58. package/dist/types/model/CreateWalletWithdrawalResponse.d.ts +2 -0
  59. package/dist/types/model/FCMMarginCall.d.ts +41 -0
  60. package/dist/types/model/Fill.d.ts +8 -0
  61. package/dist/types/model/GetFcmBalanceResponse.d.ts +4 -0
  62. package/dist/types/model/GetFcmMarginCallDetailsResponse.d.ts +26 -0
  63. package/dist/types/model/GetFcmRiskLimitsResponse.d.ts +45 -0
  64. package/dist/types/model/GetOrderEditHistoryResponse.d.ts +35 -0
  65. package/dist/types/model/GetPortfolioCounterpartyIDResponse.d.ts +23 -0
  66. package/dist/types/model/LimitOrderEdit.d.ts +29 -0
  67. package/dist/types/model/Order.d.ts +30 -0
  68. package/dist/types/model/OrderEdit.d.ts +30 -0
  69. package/dist/types/model/OrderPreviewRequest.d.ts +11 -2
  70. package/dist/types/model/PortfolioStakingInitiateRequest.d.ts +35 -0
  71. package/dist/types/model/PortfolioStakingInitiateResponse.d.ts +29 -0
  72. package/dist/types/model/PortfolioStakingMetadata.d.ts +25 -0
  73. package/dist/types/model/PortfolioStakingUnstakeRequest.d.ts +35 -0
  74. package/dist/types/model/PortfolioStakingUnstakeResponse.d.ts +29 -0
  75. package/dist/types/model/PostOrderPreviewResponse.d.ts +20 -0
  76. package/dist/types/model/RFQProductDetails.d.ts +4 -0
  77. package/dist/types/model/StakingInitiateRequest.d.ts +5 -2
  78. package/dist/types/model/StakingInitiateResponse.d.ts +3 -0
  79. package/dist/types/model/StakingUnstakeRequest.d.ts +30 -0
  80. package/dist/types/model/StakingUnstakeResponse.d.ts +3 -0
  81. package/dist/types/model/WalletStakeInputs.d.ts +32 -0
  82. package/dist/types/model/WalletUnstakeInputs.d.ts +28 -0
  83. package/dist/types/model/enums/AllocationSizeType.d.ts +0 -1
  84. package/dist/types/model/enums/AssetChangeType.d.ts +0 -1
  85. package/dist/types/model/enums/CustodyActivityType.d.ts +0 -1
  86. package/dist/types/model/enums/DestinationType.d.ts +4 -4
  87. package/dist/types/model/enums/FcmMarginCallState.d.ts +26 -0
  88. package/dist/types/model/enums/FcmMarginCallType.d.ts +24 -0
  89. package/dist/types/model/enums/OrderSide.d.ts +0 -1
  90. package/dist/types/model/enums/OrderStatus.d.ts +0 -1
  91. package/dist/types/model/enums/OrderType.d.ts +0 -1
  92. package/dist/types/model/enums/PaymentMethodType.d.ts +3 -4
  93. package/dist/types/model/enums/PortfolioBalanceType.d.ts +0 -1
  94. package/dist/types/model/enums/ProductPermissions.d.ts +0 -1
  95. package/dist/types/model/enums/SigningStatus.d.ts +0 -1
  96. package/dist/types/model/enums/TimeInForceType.d.ts +0 -1
  97. package/dist/types/model/enums/TransactionStatus.d.ts +0 -1
  98. package/dist/types/model/enums/TransactionType.d.ts +0 -1
  99. package/dist/types/model/enums/TransferLocationType.d.ts +0 -1
  100. package/dist/types/model/enums/UserRole.d.ts +0 -1
  101. package/dist/types/model/enums/VisibilityStatus.d.ts +0 -1
  102. package/dist/types/model/enums/WalletDepositInstructionType.d.ts +0 -1
  103. package/dist/types/model/enums/WalletType.d.ts +0 -1
  104. package/dist/types/model/enums/index.d.ts +2 -0
  105. package/dist/types/model/index.d.ts +18 -0
  106. package/dist/types/orders/index.d.ts +3 -1
  107. package/dist/types/orders/types.d.ts +6 -1
  108. package/dist/types/portfolios/index.d.ts +3 -1
  109. package/dist/types/portfolios/types.d.ts +5 -1
  110. package/dist/types/staking/index.d.ts +5 -1
  111. package/dist/types/staking/types.d.ts +9 -1
  112. package/package.json +11 -10
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Copyright 2025-present Coinbase Global, Inc.
3
+ *
4
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ *
18
+ * Do not edit the class manually.
19
+ */
20
+ export type LimitOrderEdit = {
21
+ price?: string;
22
+ size?: string;
23
+ displaySize?: string;
24
+ stopPrice?: string;
25
+ stopLimitPrice?: string;
26
+ endTime?: Date;
27
+ acceptTime?: Date;
28
+ clientOrderId?: string;
29
+ };
@@ -17,6 +17,8 @@
17
17
  *
18
18
  * Do not edit the class manually.
19
19
  */
20
+ import { LimitOrderEdit } from './LimitOrderEdit';
21
+ import { OrderEdit } from './OrderEdit';
20
22
  import { OrderSide } from './enums/OrderSide';
21
23
  import { OrderStatus } from './enums/OrderStatus';
22
24
  import { OrderType } from './enums/OrderType';
@@ -110,4 +112,32 @@ export type Order = {
110
112
  * The client product ID of the fill indictating the settlment currency
111
113
  */
112
114
  clientProductId?: string;
115
+ /**
116
+ * Post-only flag - indicates whether the order was placed as post-only
117
+ */
118
+ postOnly?: boolean;
119
+ /**
120
+ * The history of order edits (deprecated: use edit_history instead)
121
+ */
122
+ orderEditHistory?: Array<LimitOrderEdit>;
123
+ /**
124
+ * Indicates if this was a raise exact order (size inclusive of fees for sell orders in quote)
125
+ */
126
+ isRaiseExact?: boolean;
127
+ /**
128
+ * Display size for the order
129
+ */
130
+ displaySize?: string;
131
+ /**
132
+ * The history of order edits
133
+ */
134
+ editHistory?: Array<OrderEdit>;
135
+ /**
136
+ * The maximum order size that will show up on venue order books (in quote currency).
137
+ */
138
+ displayQuoteSize?: string;
139
+ /**
140
+ * The maximum order size that will show up on venue order books (in base currency).
141
+ */
142
+ displayBaseSize?: string;
113
143
  };
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Copyright 2025-present Coinbase Global, Inc.
3
+ *
4
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ *
18
+ * Do not edit the class manually.
19
+ */
20
+ export type OrderEdit = {
21
+ price?: string;
22
+ baseQuantity?: string;
23
+ quoteValue?: string;
24
+ displayBaseSize?: string;
25
+ displayQuoteSize?: string;
26
+ stopPrice?: string;
27
+ expiryTime?: Date;
28
+ acceptTime?: Date;
29
+ clientOrderId?: string;
30
+ };
@@ -33,8 +33,17 @@ export type OrderPreviewRequest = {
33
33
  isRaiseExact?: boolean;
34
34
  historicalPov?: string;
35
35
  stopPrice?: string;
36
+ settlCurrency?: string;
36
37
  /**
37
- * next: 15
38
+ * Specifies whether the order is treated as a post only order.
38
39
  */
39
- settlCurrency?: string;
40
+ postOnly?: boolean;
41
+ /**
42
+ * The maximum order size that will show up on venue order books (in quote currency).
43
+ */
44
+ displayQuoteSize?: string;
45
+ /**
46
+ * The maximum order size that will show up on venue order books (in base currency).
47
+ */
48
+ displayBaseSize?: string;
40
49
  };
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Copyright 2025-present Coinbase Global, Inc.
3
+ *
4
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ *
18
+ * Do not edit the class manually.
19
+ */
20
+ import { PortfolioStakingMetadata } from './PortfolioStakingMetadata';
21
+ export type PortfolioStakingInitiateRequest = {
22
+ /**
23
+ * The client generated idempotency key (uuid required) for requested execution. Subsequent requests using the same key will not create new transactions.
24
+ */
25
+ idempotencyKey: string;
26
+ /**
27
+ * The currency symbol to stake
28
+ */
29
+ currencySymbol: string;
30
+ /**
31
+ * The quantity of the chosen currency to stake
32
+ */
33
+ amount: string;
34
+ metadata?: PortfolioStakingMetadata;
35
+ };
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Copyright 2025-present Coinbase Global, Inc.
3
+ *
4
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ *
18
+ * Do not edit the class manually.
19
+ */
20
+ export type PortfolioStakingInitiateResponse = {
21
+ /**
22
+ * The ID for the created activity
23
+ */
24
+ activityId?: string;
25
+ /**
26
+ * The ID for the created transaction
27
+ */
28
+ transactionId?: string;
29
+ };
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Copyright 2025-present Coinbase Global, Inc.
3
+ *
4
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ *
18
+ * Do not edit the class manually.
19
+ */
20
+ export type PortfolioStakingMetadata = {
21
+ /**
22
+ * An optional custom identifier (up to 255 characters) to attach to the transaction. This is not a searchable transaction field.
23
+ */
24
+ externalId?: string;
25
+ };
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Copyright 2025-present Coinbase Global, Inc.
3
+ *
4
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ *
18
+ * Do not edit the class manually.
19
+ */
20
+ import { PortfolioStakingMetadata } from './PortfolioStakingMetadata';
21
+ export type PortfolioStakingUnstakeRequest = {
22
+ /**
23
+ * The client generated idempotency key (uuid required) for requested execution. Subsequent requests using the same key will not create new transactions.
24
+ */
25
+ idempotencyKey: string;
26
+ /**
27
+ * The currency symbol to unstake
28
+ */
29
+ currencySymbol: string;
30
+ /**
31
+ * The quantity of the chosen currency to unstake
32
+ */
33
+ amount: string;
34
+ metadata?: PortfolioStakingMetadata;
35
+ };
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Copyright 2025-present Coinbase Global, Inc.
3
+ *
4
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ *
18
+ * Do not edit the class manually.
19
+ */
20
+ export type PortfolioStakingUnstakeResponse = {
21
+ /**
22
+ * The ID for the created activity
23
+ */
24
+ activityId?: string;
25
+ /**
26
+ * The ID for the created transaction
27
+ */
28
+ transactionId?: string;
29
+ };
@@ -80,4 +80,24 @@ export type PostOrderPreviewResponse = {
80
80
  * 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.
81
81
  */
82
82
  historicalPov?: string;
83
+ /**
84
+ * Raise Exact order flag
85
+ */
86
+ isRaiseExact?: boolean;
87
+ /**
88
+ * Stop price for the order
89
+ */
90
+ stopPrice?: string;
91
+ /**
92
+ * The maximum order size that will show up on venue order books.
93
+ */
94
+ displaySize?: string;
95
+ /**
96
+ * The maximum order size that will show up on venue order books (in quote currency).
97
+ */
98
+ displayQuoteSize?: string;
99
+ /**
100
+ * The maximum order size that will show up on venue order books (in base currency).
101
+ */
102
+ displayBaseSize?: string;
83
103
  };
@@ -21,4 +21,8 @@ export type RFQProductDetails = {
21
21
  tradable?: boolean;
22
22
  minNotionalSize?: string;
23
23
  maxNotionalSize?: string;
24
+ minBaseSize?: string;
25
+ maxBaseSize?: string;
26
+ minQuoteSize?: string;
27
+ maxQuoteSize?: string;
24
28
  };
@@ -17,11 +17,14 @@
17
17
  *
18
18
  * Do not edit the class manually.
19
19
  */
20
- import { StakingInputs } from './StakingInputs';
20
+ import { WalletStakeInputs } from './WalletStakeInputs';
21
+ /**
22
+ * StakingInitiateRequest represents a request to initiate a staking operation.
23
+ */
21
24
  export type StakingInitiateRequest = {
22
25
  /**
23
26
  * The client generated idempotency key for requested execution. Subsequent requests using the same key will fail
24
27
  */
25
28
  idempotencyKey: string;
26
- inputs?: StakingInputs;
29
+ inputs?: WalletStakeInputs;
27
30
  };
@@ -17,6 +17,9 @@
17
17
  *
18
18
  * Do not edit the class manually.
19
19
  */
20
+ /**
21
+ * StakingInitiateResponse contains the response data from initiating a staking operation.
22
+ */
20
23
  export type StakingInitiateResponse = {
21
24
  /**
22
25
  * The wallet ID
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Copyright 2025-present Coinbase Global, Inc.
3
+ *
4
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ *
18
+ * Do not edit the class manually.
19
+ */
20
+ import { WalletUnstakeInputs } from './WalletUnstakeInputs';
21
+ /**
22
+ * StakingUnstakeRequest represents a request to initiate an unstaking operation.
23
+ */
24
+ export type StakingUnstakeRequest = {
25
+ /**
26
+ * The client generated idempotency key for requested execution. Subsequent requests using the same key will fail
27
+ */
28
+ idempotencyKey: string;
29
+ inputs?: WalletUnstakeInputs;
30
+ };
@@ -17,6 +17,9 @@
17
17
  *
18
18
  * Do not edit the class manually.
19
19
  */
20
+ /**
21
+ * StakingUnstakeResponse contains the response data from initiating an unstaking operation.
22
+ */
20
23
  export type StakingUnstakeResponse = {
21
24
  /**
22
25
  * The wallet ID
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Copyright 2025-present Coinbase Global, Inc.
3
+ *
4
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ *
18
+ * Do not edit the class manually.
19
+ */
20
+ /**
21
+ * WalletStakeInputs contains the custom inputs for staking operations on a wallet. Requirements and supported fields vary by asset type.
22
+ */
23
+ export type WalletStakeInputs = {
24
+ /**
25
+ * Optional amount to stake (ETH only). If omitted, the wallet will stake the maximum amount available
26
+ */
27
+ amount?: string;
28
+ /**
29
+ * Optional validator address, defaults to Coinbase validator. For SOL, must be the vote account address. Ignored for ETH.
30
+ */
31
+ validatorAddress?: string;
32
+ };
@@ -0,0 +1,28 @@
1
+ /**
2
+ * Copyright 2025-present Coinbase Global, Inc.
3
+ *
4
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ *
18
+ * Do not edit the class manually.
19
+ */
20
+ /**
21
+ * WalletUnstakeInputs contains the custom inputs for unstaking operations on a wallet. Requirements and supported fields vary by asset type.
22
+ */
23
+ export type WalletUnstakeInputs = {
24
+ /**
25
+ * Optional amount to unstake (ETH only). If omitted, the wallet will unstake the maximum amount available
26
+ */
27
+ amount?: string;
28
+ };
@@ -18,7 +18,6 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  export declare enum AllocationSizeType {
21
- AllocationSizeTypeUnknown = "ALLOCATION_SIZE_TYPE_UNKNOWN",
22
21
  Base = "BASE",
23
22
  Quote = "QUOTE",
24
23
  Percent = "PERCENT"
@@ -18,7 +18,6 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  export declare enum AssetChangeType {
21
- AssetChangeTypeUnknown = "ASSET_CHANGE_TYPE_UNKNOWN",
22
21
  BalanceTransfer = "BALANCE_TRANSFER",
23
22
  BalanceApproval = "BALANCE_APPROVAL",
24
23
  ItemTransfer = "ITEM_TRANSFER",
@@ -18,7 +18,6 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  export declare enum ActivityType {
21
- Unknown = "ACTIVITY_TYPE_UNKNOWN",
22
21
  GovernanceVote = "ACTIVITY_TYPE_GOVERNANCE_VOTE",
23
22
  Invitation = "ACTIVITY_TYPE_INVITATION",
24
23
  WalletChange = "ACTIVITY_TYPE_WALLET_CHANGE",
@@ -18,8 +18,8 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  export declare enum DestinationType {
21
- UnknownDestination = "UNKNOWN_DESTINATION",
22
- DestinationPaymentMethod = "DESTINATION_PAYMENT_METHOD",
23
- DestinationBlockchain = "DESTINATION_BLOCKCHAIN",
24
- DestinationWallet = "DESTINATION_WALLET"
21
+ PaymentMethod = "DESTINATION_PAYMENT_METHOD",
22
+ Blockchain = "DESTINATION_BLOCKCHAIN",
23
+ Wallet = "DESTINATION_WALLET",
24
+ Counterparty = "DESTINATION_COUNTERPARTY"
25
25
  }
@@ -0,0 +1,26 @@
1
+ /**
2
+ * Copyright 2025-present Coinbase Global, Inc.
3
+ *
4
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ *
18
+ * Do not edit the class manually.
19
+ */
20
+ export declare enum FcmMarginCallState {
21
+ Unspecified = "FCM_MARGIN_CALL_STATE_UNSPECIFIED",
22
+ Closed = "FCM_MARGIN_CALL_STATE_CLOSED",
23
+ RolledOver = "FCM_MARGIN_CALL_STATE_ROLLED_OVER",
24
+ Default = "FCM_MARGIN_CALL_STATE_DEFAULT",
25
+ Official = "FCM_MARGIN_CALL_STATE_OFFICIAL"
26
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Copyright 2025-present Coinbase Global, Inc.
3
+ *
4
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ *
18
+ * Do not edit the class manually.
19
+ */
20
+ export declare enum FcmMarginCallType {
21
+ Unspecified = "FCM_MARGIN_CALL_TYPE_UNSPECIFIED",
22
+ Urgent = "FCM_MARGIN_CALL_TYPE_URGENT",
23
+ Regular = "FCM_MARGIN_CALL_TYPE_REGULAR"
24
+ }
@@ -21,7 +21,6 @@
21
21
  * - UNKNOWN_ORDER_SIDE: nil value - BUY: Buy order - SELL: Sell order
22
22
  */
23
23
  export declare enum OrderSide {
24
- UnknownOrderSide = "UNKNOWN_ORDER_SIDE",
25
24
  Buy = "BUY",
26
25
  Sell = "SELL"
27
26
  }
@@ -21,7 +21,6 @@
21
21
  * - UNKNOWN_ORDER_STATUS: nil value - OPEN: The order is open but unfilled - FILLED: The order was filled - CANCELLED: The order was cancelled - EXPIRED: The order has expired - FAILED: Order submission failed - PENDING: The order has been sent but is not yet confirmed
22
22
  */
23
23
  export declare enum OrderStatus {
24
- UnknownOrderStatus = "UNKNOWN_ORDER_STATUS",
25
24
  Open = "OPEN",
26
25
  Filled = "FILLED",
27
26
  Cancelled = "CANCELLED",
@@ -21,7 +21,6 @@
21
21
  * - UNKNOWN_ORDER_TYPE: nil value - MARKET: A [market order](https://en.wikipedia.org/wiki/Order_(exchange)#Market_order) - LIMIT: A [limit order](https://en.wikipedia.org/wiki/Order_(exchange)#Limit_order) - TWAP: A [time-weighted average price order](https://en.wikipedia.org/wiki/Time-weighted_average_price) - BLOCK: A [block trade](https://en.wikipedia.org/wiki/Block_trade) - VWAP: A [volume-weighted average price order](https://en.wikipedia.org/wiki/Volume-weighted_average_price) - STOP_LIMIT: A [conditional order combined of stop order and limit order](https://en.wikipedia.org/wiki/Order_(exchange)#Stop-limit_order) - RFQ: A [request for quote](https://en.wikipedia.org/wiki/Request_for_quote)
22
22
  */
23
23
  export declare enum OrderType {
24
- UnknownOrderType = "UNKNOWN_ORDER_TYPE",
25
24
  Market = "MARKET",
26
25
  Limit = "LIMIT",
27
26
  Twap = "TWAP",
@@ -21,8 +21,7 @@
21
21
  * - UNKNOWN_PAYMENT_METHOD_TYPE: nil value - METHOD_WIRE: Wire transfer - METHOD_SEN: Silvergate exchange network - METHOD_SWIFT: Swift
22
22
  */
23
23
  export declare enum PaymentMethodType {
24
- UnknownPaymentMethodType = "UNKNOWN_PAYMENT_METHOD_TYPE",
25
- MethodWire = "METHOD_WIRE",
26
- MethodSen = "METHOD_SEN",
27
- MethodSwift = "METHOD_SWIFT"
24
+ Wire = "METHOD_WIRE",
25
+ Sen = "METHOD_SEN",
26
+ Swift = "METHOD_SWIFT"
28
27
  }
@@ -18,7 +18,6 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  export declare enum PortfolioBalanceType {
21
- UnknownBalanceType = "UNKNOWN_BALANCE_TYPE",
22
21
  TradingBalances = "TRADING_BALANCES",
23
22
  VaultBalances = "VAULT_BALANCES",
24
23
  TotalBalances = "TOTAL_BALANCES",
@@ -18,7 +18,6 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  export declare enum ProductPermissions {
21
- Unknown = "PRODUCT_PERMISSION_UNKNOWN",
22
21
  Read = "PRODUCT_PERMISSION_READ",
23
22
  Trade = "PRODUCT_PERMISSION_TRADE",
24
23
  Lending = "PRODUCT_PERMISSION_LENDING"
@@ -18,7 +18,6 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  export declare enum SigningStatus {
21
- SigningStatusUnknown = "SIGNING_STATUS_UNKNOWN",
22
21
  Signed = "SIGNED",
23
22
  Unsigned = "UNSIGNED"
24
23
  }
@@ -21,7 +21,6 @@
21
21
  * - UNKNOWN_TIME_IN_FORCE: nil value - GOOD_UNTIL_DATE_TIME: Expires at a certain date/time - GOOD_UNTIL_CANCELLED: Order stays on the books until cancelled - IMMEDIATE_OR_CANCEL: Order is executed immediately at submission or is cancelled - FILL_OR_KILL: Order is executed immediately and fully at submission or is cancelled
22
22
  */
23
23
  export declare enum TimeInForceType {
24
- UnknownTimeInForce = "UNKNOWN_TIME_IN_FORCE",
25
24
  GoodUntilDateTime = "GOOD_UNTIL_DATE_TIME",
26
25
  GoodUntilCancelled = "GOOD_UNTIL_CANCELLED",
27
26
  ImmediateOrCancel = "IMMEDIATE_OR_CANCEL",
@@ -21,7 +21,6 @@
21
21
  * - UNKNOWN_TRANSACTION_STATUS: An Unknown Transaction status - TRANSACTION_CREATED: The Transaction has been created and is awaiting Consensus approval This is a non-terminal status - TRANSACTION_REQUESTED: The Transaction has reached User Consensus and is awaiting Coinbase Prime approval This is a non-terminal status - TRANSACTION_APPROVED: The Transaction has been authorized by Coinbase Prime This is a non-terminal status - TRANSACTION_GASSING: The transaction is awaiting blockchain resources for broadcast This is a non-terminal status - TRANSACTION_GASSED: The transaction has received blockchain resources for broadcasting This is a non-terminal status - TRANSACTION_PROVISIONED: The transaction has been provisioned and is awaiting planning This is a non-terminal status - TRANSACTION_PLANNED: The transaction has been constructed. This is a non-terminal status - TRANSACTION_PROCESSING: The transaction is currently processing and awaiting finalization This is a non-terminal status - TRANSACTION_RESTORED: The transaction has been broadcasted to the network. This is a non-terminal status - TRANSACTION_DONE: The transaction has confirmed on-chain and finished. This is a terminal status - TRANSACTION_IMPORT_PENDING: The transaction deposit has been detected and is awaiting finalization. This is a non-terminal status - TRANSACTION_IMPORTED: The transaction deposit and reward has been detected. This is a terminal status - TRANSACTION_CANCELLED: The transaction has been cancelled This is a terminal status - TRANSACTION_REJECTED: The transaction was rejected before construction and broadcasting. This is a terminal status - TRANSACTION_DELAYED: The transaction s taking longer than expected to confirm on-chain. This is a non-terminal status - TRANSACTION_RETRIED: The transaction has been recreated and retried, this occurs when network congestion results in transfers becoming extremely delayed due to insufficient fees or network resources such as CPU, RAM, or NET This is a terminal status - TRANSACTION_FAILED: The transaction failed on-chain (the fee was spent but the operation failed). This is a terminal status - TRANSACTION_EXPIRED: The transaction has expired. This is a terminal status - TRANSACTION_BROADCASTING: The transaction is currently broadcasting to the cryptocurrency network. This is a non-terminal status - OTHER_TRANSACTION_STATUS: The transaction has reached an OTHER status. This is a non-terminal status - TRANSACTION_CONSTRUCTED: The transaction bctx is constructed but not yet broadcasting on chain This is a non-terminal status
22
22
  */
23
23
  export declare enum TransactionStatus {
24
- UnknownTransactionStatus = "UNKNOWN_TRANSACTION_STATUS",
25
24
  TransactionCreated = "TRANSACTION_CREATED",
26
25
  TransactionRequested = "TRANSACTION_REQUESTED",
27
26
  TransactionApproved = "TRANSACTION_APPROVED",
@@ -21,7 +21,6 @@
21
21
  * - TRANSACTION_TYPE_UNKNOWN: An unknown transaction type - DEPOSIT: A fiat or crypto deposit - WITHDRAWAL: A fiat or crypto withdrawal - INTERNAL_DEPOSIT: An internal fiat or crypto deposit - INTERNAL_WITHDRAWAL: An internal fiat or crypto withdrawal - SWEEP_DEPOSIT: Internal automated deposit to a cold address from a restored address - SWEEP_WITHDRAWAL: Internal automated withdrawal from a restored address to a cold address - PROXY_DEPOSIT: On-chain deposit of funds into proxy contract from cold address - PROXY_WITHDRAWAL: On-chain withdrawal of funds from proxy contract to cold address - BILLING_WITHDRAWAL: Coinbase Prime automated invoice settlement payment - REWARD: Reward payment to an associated address for a staked asset - COINBASE_REFUND: Coinbase Prime refund for the leftover amount for a CPFP (child pays for parent) transaction - TRANSACTION_TYPE_OTHER: An OTHER type of transaction - WITHDRAWAL_ADJUSTMENT: A manual adjustment withdrawal transaction - DEPOSIT_ADJUSTMENT: A manual adjustment deposit transaction - KEY_REGISTRATION: An on-chain registration for an address - DELEGATION: An on-chain delegation transaction - UNDELEGATION: An on-chain undelegation transaction - RESTAKE: On-chain restaking transaction - COMPLETE_UNBONDING: On-chain unbonding event transaction - WITHDRAW_UNBONDED: On-chain event indicating unbonding period is over - STAKE_ACCOUNT_CREATE: On-chain transaction to begin staking from an address - CHANGE_VALIDATOR: On-chain transaction alter validator - STAKE: On-chain transaction to begin staking in Cryptocurrency network - UNSTAKE: On-chain transaction to stop staking in Cryptocurrency network - REMOVE_AUTHORIZED_PARTY: On-chain transaction to remove a party from a multi-signature wallet - STAKE_AUTHORIZE_WITH_SEED: On-chain transaction to begin staking from a seed account - SLASH: On-chain transaction indicating a slash event has occurred - COINBASE_DEPOSIT: On-chain transaction deposit for the purpose of transaction operations - CONVERSION: Internal conversion between two assets - CLAIM_REWARDS: On-chain transaction to claim rewards from Vote Account - VOTE_AUTHORIZE: On-chain transaction to transfer the reward claiming permission to other pubkey - WEB3_TRANSACTION: On-chain transaction initiated with Prime Onchain Wallet Deprecated: Use ONCHAIN_TRANSACTION instead - ONCHAIN_TRANSACTION: On-chain transaction initiated with Prime Onchain Wallet
22
22
  */
23
23
  export declare enum TransactionType {
24
- TransactionTypeUnknown = "TRANSACTION_TYPE_UNKNOWN",
25
24
  Deposit = "DEPOSIT",
26
25
  Withdrawal = "WITHDRAWAL",
27
26
  InternalDeposit = "INTERNAL_DEPOSIT",