@coinbase-sample/prime-sdk-ts 0.7.1 → 0.8.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 (114) hide show
  1. package/dist/activities/index.js +14 -0
  2. package/dist/addressBooks/index.js +10 -0
  3. package/dist/allocations/index.js +12 -0
  4. package/dist/assets/index.js +4 -0
  5. package/dist/balances/index.js +15 -0
  6. package/dist/commission/index.js +4 -0
  7. package/dist/constants.js +1 -1
  8. package/dist/financing/index.js +70 -0
  9. package/dist/futures/index.js +53 -0
  10. package/dist/index.js +7 -1
  11. package/dist/invoices/index.js +4 -0
  12. package/dist/model/DateOfBirth.js +21 -0
  13. package/dist/model/DetailedAddress.js +21 -0
  14. package/dist/model/GetFcmSettingsResponse.js +21 -0
  15. package/dist/model/GetUnstakingStatusResponse.js +21 -0
  16. package/dist/model/ListFinancingEligibleAssetsResponse.js +21 -0
  17. package/dist/model/ListTFObligationsResponse.js +21 -0
  18. package/dist/model/NaturalPersonName.js +21 -0
  19. package/dist/model/PreviewUnstakeRequest.js +21 -0
  20. package/dist/model/PreviewUnstakeResponse.js +21 -0
  21. package/dist/model/ProcessRequirements.js +21 -0
  22. package/dist/model/RewardMetadata.js +21 -0
  23. package/dist/model/SetFcmSettingsRequest.js +21 -0
  24. package/dist/model/SetFcmSettingsResponse.js +21 -0
  25. package/dist/model/TFAsset.js +21 -0
  26. package/dist/model/TFObligation.js +21 -0
  27. package/dist/model/TravelRuleEntry.js +21 -0
  28. package/dist/model/TravelRuleParty.js +21 -0
  29. package/dist/model/TravelRuleWalletDetails.js +21 -0
  30. package/dist/model/UnstakingStatus.js +21 -0
  31. package/dist/model/VASP.js +21 -0
  32. package/dist/model/ValidatorUnstakingInfo.js +21 -0
  33. package/dist/model/enums/CandlesGranularity.js +3 -3
  34. package/dist/model/enums/EstimateType.js +28 -0
  35. package/dist/model/enums/OrderType.js +2 -1
  36. package/dist/model/enums/PegOffsetType.js +31 -0
  37. package/dist/model/enums/RewardSubtype.js +34 -0
  38. package/dist/model/enums/TransactionType.js +3 -1
  39. package/dist/model/enums/TravelRuleStatus.js +28 -0
  40. package/dist/model/enums/TravelRuleWalletType.js +31 -0
  41. package/dist/model/enums/UnstakeType.js +28 -0
  42. package/dist/model/enums/UserRole.js +2 -1
  43. package/dist/model/enums/XMCallType.js +2 -1
  44. package/dist/model/enums/XMEntityCallStatus.js +2 -1
  45. package/dist/model/enums/index.js +14 -2
  46. package/dist/onchainAddressBook/index.js +14 -0
  47. package/dist/orders/index.js +59 -0
  48. package/dist/paymentMethods/index.js +8 -0
  49. package/dist/portfolios/index.js +10 -0
  50. package/dist/positions/index.js +7 -0
  51. package/dist/products/index.js +11 -0
  52. package/dist/shared/__tests__/validation.test.js +270 -0
  53. package/dist/shared/validation.js +210 -0
  54. package/dist/staking/index.js +63 -0
  55. package/dist/transactions/index.js +42 -0
  56. package/dist/types/activities/types.d.ts +1 -0
  57. package/dist/types/constants.d.ts +1 -1
  58. package/dist/types/financing/index.d.ts +5 -1
  59. package/dist/types/financing/types.d.ts +7 -1
  60. package/dist/types/futures/index.d.ts +6 -2
  61. package/dist/types/futures/types.d.ts +10 -1
  62. package/dist/types/index.d.ts +3 -0
  63. package/dist/types/model/CreateOrderRequest.d.ts +8 -1
  64. package/dist/types/model/CreatePortfolioAddressBookEntryRequest.d.ts +6 -0
  65. package/dist/types/model/DateOfBirth.d.ts +24 -0
  66. package/dist/types/model/DetailedAddress.d.ts +28 -0
  67. package/dist/types/model/GetFcmSettingsResponse.d.ts +25 -0
  68. package/dist/types/model/GetUnstakingStatusResponse.d.ts +42 -0
  69. package/dist/types/model/ListFinancingEligibleAssetsResponse.d.ts +26 -0
  70. package/dist/types/model/ListTFObligationsResponse.d.ts +26 -0
  71. package/dist/types/model/NaturalPersonName.d.ts +24 -0
  72. package/dist/types/model/NetworkDetails.d.ts +4 -0
  73. package/dist/types/model/Order.d.ts +12 -0
  74. package/dist/types/model/OrderPreviewRequest.d.ts +7 -0
  75. package/dist/types/model/PreviewUnstakeRequest.d.ts +28 -0
  76. package/dist/types/model/PreviewUnstakeResponse.d.ts +28 -0
  77. package/dist/types/model/ProcessRequirements.d.ts +23 -0
  78. package/dist/types/model/RewardMetadata.d.ts +23 -0
  79. package/dist/types/model/SetFcmSettingsRequest.d.ts +25 -0
  80. package/dist/types/model/SetFcmSettingsResponse.d.ts +25 -0
  81. package/dist/types/model/TFAsset.d.ts +33 -0
  82. package/dist/types/model/TFObligation.d.ts +41 -0
  83. package/dist/types/model/Transaction.d.ts +2 -0
  84. package/dist/types/model/TransactionMetadata.d.ts +2 -0
  85. package/dist/types/model/TravelRuleEntry.d.ts +38 -0
  86. package/dist/types/model/TravelRuleParty.d.ts +32 -0
  87. package/dist/types/model/TravelRuleWalletDetails.d.ts +28 -0
  88. package/dist/types/model/UnstakingStatus.d.ts +45 -0
  89. package/dist/types/model/VASP.d.ts +27 -0
  90. package/dist/types/model/ValidatorUnstakingInfo.d.ts +30 -0
  91. package/dist/types/model/enums/CandlesGranularity.d.ts +3 -3
  92. package/dist/types/model/enums/EstimateType.d.ts +24 -0
  93. package/dist/types/model/enums/OrderType.d.ts +3 -2
  94. package/dist/types/model/enums/PegOffsetType.d.ts +27 -0
  95. package/dist/types/model/enums/RewardSubtype.d.ts +30 -0
  96. package/dist/types/model/enums/TransactionType.d.ts +4 -2
  97. package/dist/types/model/enums/TravelRuleStatus.d.ts +24 -0
  98. package/dist/types/model/enums/TravelRuleWalletType.d.ts +27 -0
  99. package/dist/types/model/enums/UnstakeType.d.ts +24 -0
  100. package/dist/types/model/enums/UserRole.d.ts +3 -2
  101. package/dist/types/model/enums/XMCallType.d.ts +3 -2
  102. package/dist/types/model/enums/XMEntityCallStatus.d.ts +3 -2
  103. package/dist/types/model/enums/index.d.ts +6 -0
  104. package/dist/types/model/index.d.ts +21 -0
  105. package/dist/types/orders/types.d.ts +1 -1
  106. package/dist/types/shared/__tests__/validation.test.d.ts +1 -0
  107. package/dist/types/shared/validation.d.ts +88 -0
  108. package/dist/types/staking/index.d.ts +5 -1
  109. package/dist/types/staking/types.d.ts +12 -1
  110. package/dist/types/transactions/types.d.ts +3 -1
  111. package/dist/types/wallets/types.d.ts +2 -1
  112. package/dist/users/index.js +7 -0
  113. package/dist/wallets/index.js +27 -0
  114. package/package.json +13 -9
@@ -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 SetFcmSettingsRequest = {
21
+ /**
22
+ * Target CFM Excess amount to set. Only non-negative number is allowed
23
+ */
24
+ targetDerivativesExcess?: string;
25
+ };
@@ -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 SetFcmSettingsResponse = {
21
+ /**
22
+ * Success
23
+ */
24
+ success?: boolean;
25
+ };
@@ -0,0 +1,33 @@
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 TFAsset = {
21
+ /**
22
+ * The asset symbol
23
+ */
24
+ symbol?: string;
25
+ /**
26
+ * The asset adjustment factor for Trade Finance
27
+ */
28
+ assetAdjustment?: string;
29
+ /**
30
+ * The liability adjustment factor for Trade Finance
31
+ */
32
+ liabilityAdjustment?: string;
33
+ };
@@ -0,0 +1,41 @@
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 TFObligation = {
21
+ /**
22
+ * The unique ID of the portfolio
23
+ */
24
+ portfolioId?: string;
25
+ /**
26
+ * The currency symbol
27
+ */
28
+ symbol?: string;
29
+ /**
30
+ * Current amount due
31
+ */
32
+ amountDue?: string;
33
+ /**
34
+ * Loan notional amount
35
+ */
36
+ notionalAmount?: string;
37
+ /**
38
+ * Settlement due date
39
+ */
40
+ dueDate?: string;
41
+ };
@@ -21,6 +21,7 @@ import { AssetChange } from './AssetChange';
21
21
  import { EstimatedNetworkFees } from './EstimatedNetworkFees';
22
22
  import { Network } from './Network';
23
23
  import { OnchainTransactionDetails } from './OnchainTransactionDetails';
24
+ import { ProcessRequirements } from './ProcessRequirements';
24
25
  import { TransactionMetadata } from './TransactionMetadata';
25
26
  import { TransactionStatus } from './enums/TransactionStatus';
26
27
  import { TransactionType } from './enums/TransactionType';
@@ -98,4 +99,5 @@ export type Transaction = {
98
99
  idempotencyKey?: string;
99
100
  onchainDetails?: OnchainTransactionDetails;
100
101
  networkInfo?: Network;
102
+ processRequirements?: ProcessRequirements;
101
103
  };
@@ -18,8 +18,10 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  import { MatchMetadata } from './MatchMetadata';
21
+ import { RewardMetadata } from './RewardMetadata';
21
22
  import { Web3TransactionMetadata } from './Web3TransactionMetadata';
22
23
  export type TransactionMetadata = {
23
24
  matchMetadata?: MatchMetadata;
24
25
  web3TransactionMetadata?: Web3TransactionMetadata;
26
+ rewardMetadata?: RewardMetadata;
25
27
  };
@@ -0,0 +1,38 @@
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 { BlockchainAddress } from './BlockchainAddress';
21
+ import { TravelRuleParty } from './TravelRuleParty';
22
+ import { TravelRuleWalletDetails } from './TravelRuleWalletDetails';
23
+ import { VASP } from './VASP';
24
+ /**
25
+ * Travel Rule Entry for sending addresses.
26
+ */
27
+ export type TravelRuleEntry = {
28
+ id?: string;
29
+ blockchainAddress?: BlockchainAddress;
30
+ originator?: TravelRuleParty;
31
+ beneficiary?: TravelRuleParty;
32
+ vasp?: VASP;
33
+ walletDetails?: TravelRuleWalletDetails;
34
+ transferPurpose?: string;
35
+ isSelfCertified?: boolean;
36
+ isIntermediary?: boolean;
37
+ isSelf?: boolean;
38
+ };
@@ -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
+ import { DateOfBirth } from './DateOfBirth';
21
+ import { DetailedAddress } from './DetailedAddress';
22
+ import { NaturalPersonName } from './NaturalPersonName';
23
+ /**
24
+ * Represents one of the Transmittal Parties involved in a Travel Rule transfer, either originator or beneficiary.
25
+ */
26
+ export type TravelRuleParty = {
27
+ name?: string;
28
+ detailedAddress?: DetailedAddress;
29
+ naturalPersonName?: NaturalPersonName;
30
+ dateOfBirth?: DateOfBirth;
31
+ telephoneNumber?: 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
+ import { BlockchainAddress } from './BlockchainAddress';
21
+ import { TravelRuleWalletType } from './enums/TravelRuleWalletType';
22
+ /**
23
+ * Details about the custody wallet used in the transfer.
24
+ */
25
+ export type TravelRuleWalletDetails = {
26
+ walletType?: TravelRuleWalletType;
27
+ walletAddress?: BlockchainAddress;
28
+ };
@@ -0,0 +1,45 @@
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 { EstimateType } from './enums/EstimateType';
21
+ import { UnstakeType } from './enums/UnstakeType';
22
+ export type UnstakingStatus = {
23
+ /**
24
+ * Amount being unstaked (whole amount, e.g., 16 ETH)
25
+ */
26
+ amount: string;
27
+ unstakeType?: UnstakeType;
28
+ /**
29
+ * Estimated date when unstaking will complete (ISO 8601 format)
30
+ */
31
+ finishingAt?: Date;
32
+ /**
33
+ * Estimated hours until this unstaking request completes
34
+ */
35
+ remainingHours?: number;
36
+ /**
37
+ * Timestamp when the unstake request was originally created
38
+ */
39
+ requestedAt?: Date;
40
+ estimateType: EstimateType;
41
+ /**
42
+ * Detailed explanation of the estimate status for display to users.
43
+ */
44
+ estimateDescription: string;
45
+ };
@@ -0,0 +1,27 @@
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
+ * Virtual Asset Service Provider (VASP).
22
+ */
23
+ export type VASP = {
24
+ id?: string;
25
+ countryCode?: string;
26
+ leiNumber?: string;
27
+ };
@@ -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 { UnstakingStatus } from './UnstakingStatus';
21
+ export type ValidatorUnstakingInfo = {
22
+ /**
23
+ * The validator address (public key)
24
+ */
25
+ validatorAddress: string;
26
+ /**
27
+ * List of active unstaking requests for this validator
28
+ */
29
+ statuses: Array<UnstakingStatus>;
30
+ };
@@ -24,7 +24,7 @@ export declare enum CandlesGranularity {
24
24
  OneHour = "ONE_HOUR",
25
25
  SixHours = "SIX_HOURS",
26
26
  OneDay = "ONE_DAY",
27
- ThirtyMinute = "THIRTY_MINUTE",
28
- TwoHour = "TWO_HOUR",
29
- FourHour = "FOUR_HOUR"
27
+ ThirtyMinutes = "THIRTY_MINUTES",
28
+ TwoHours = "TWO_HOURS",
29
+ FourHours = "FOUR_HOURS"
30
30
  }
@@ -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 EstimateType {
21
+ Unspecified = "UNSPECIFIED",
22
+ Live = "LIVE",
23
+ Interim = "INTERIM"
24
+ }
@@ -18,7 +18,7 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  /**
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)
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) - PEG: A pegged order that dynamically adjust based on market conditions while maintaining execution discretion and avoiding adverse selection
22
22
  */
23
23
  export declare enum OrderType {
24
24
  Market = "MARKET",
@@ -27,5 +27,6 @@ export declare enum OrderType {
27
27
  Block = "BLOCK",
28
28
  Vwap = "VWAP",
29
29
  StopLimit = "STOP_LIMIT",
30
- Rfq = "RFQ"
30
+ Rfq = "RFQ",
31
+ Peg = "PEG"
31
32
  }
@@ -0,0 +1,27 @@
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
+ * - UNKNOWN_PEG_OFFSET_TYPE: nil value - PEG_OFFSET_TYPE_PRICE: Offset specified in price units - PEG_OFFSET_TYPE_BPS: Offset specified in basis points (BPS) - PEG_OFFSET_TYPE_DEPTH: Offset specified in depth
22
+ */
23
+ export declare enum PegOffsetType {
24
+ PegOffsetTypePrice = "PEG_OFFSET_TYPE_PRICE",
25
+ PegOffsetTypeBps = "PEG_OFFSET_TYPE_BPS",
26
+ PegOffsetTypeDepth = "PEG_OFFSET_TYPE_DEPTH"
27
+ }
@@ -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
+ /**
21
+ * - REWARD_SUBTYPE_UNKNOWN: An unknown reward subtype, reward subtype may not be supported in the API response yet - MEV_REWARD: A maximal extractable value reward i.e. sol mev rewards - INFLATION_REWARD: An inflationary reward i.e. solana inflationary rewards - BLOCK_REWARD: A block reward i.e. solana block rewards - VALIDATOR_REWARD: A validator reward i.e. ethereum validator (consensus layer) rewards - TRANSACTION_REWARD: A transaction reward i.e. ethereum transaction (execution layer) rewards - STAKING_FEE_REBATE_REWARD: A staking fee rebate reward i.e. coinbase pays rebates for staking fees to eligible delegators
22
+ */
23
+ export declare enum RewardSubtype {
24
+ MevReward = "MEV_REWARD",
25
+ InflationReward = "INFLATION_REWARD",
26
+ BlockReward = "BLOCK_REWARD",
27
+ ValidatorReward = "VALIDATOR_REWARD",
28
+ TransactionReward = "TRANSACTION_REWARD",
29
+ StakingFeeRebateReward = "STAKING_FEE_REBATE_REWARD"
30
+ }
@@ -18,7 +18,7 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  /**
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
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 - PORTFOLIO_STAKE: Portfolio-level staking operation - PORTFOLIO_UNSTAKE: Portfolio-level unstaking operation
22
22
  */
23
23
  export declare enum TransactionType {
24
24
  Deposit = "DEPOSIT",
@@ -53,5 +53,7 @@ export declare enum TransactionType {
53
53
  ClaimRewards = "CLAIM_REWARDS",
54
54
  VoteAuthorize = "VOTE_AUTHORIZE",
55
55
  Web3Transaction = "WEB3_TRANSACTION",
56
- OnchainTransaction = "ONCHAIN_TRANSACTION"
56
+ OnchainTransaction = "ONCHAIN_TRANSACTION",
57
+ PortfolioStake = "PORTFOLIO_STAKE",
58
+ PortfolioUnstake = "PORTFOLIO_UNSTAKE"
57
59
  }
@@ -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 TravelRuleStatus {
21
+ TravelRuleStatusUnspecified = "TRAVEL_RULE_STATUS_UNSPECIFIED",
22
+ TravelRuleStatusPending = "TRAVEL_RULE_STATUS_PENDING",
23
+ TravelRuleStatusSubmitted = "TRAVEL_RULE_STATUS_SUBMITTED"
24
+ }
@@ -0,0 +1,27 @@
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
+ * - TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED: Default unspecified wallet type - TRAVEL_RULE_WALLET_TYPE_VASP: Centralized exchange wallet - TRAVEL_RULE_WALLET_TYPE_SELF_CUSTODIED: Self-hosted/custodial wallet
22
+ */
23
+ export declare enum TravelRuleWalletType {
24
+ TravelRuleWalletTypeUnspecified = "TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED",
25
+ TravelRuleWalletTypeVasp = "TRAVEL_RULE_WALLET_TYPE_VASP",
26
+ TravelRuleWalletTypeSelfCustodied = "TRAVEL_RULE_WALLET_TYPE_SELF_CUSTODIED"
27
+ }
@@ -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 UnstakeType {
21
+ UnstakeTypeUnspecified = "UNSTAKE_TYPE_UNSPECIFIED",
22
+ UnstakeTypePartial = "UNSTAKE_TYPE_PARTIAL",
23
+ UnstakeTypeFull = "UNSTAKE_TYPE_FULL"
24
+ }
@@ -18,7 +18,7 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  /**
21
- * - USER_ROLE_UNKNOWN: nil value - AUDITOR: An auditor - SIGNATORY: A signatory - ADMIN: An admin - INITIATOR: An initiator - REVIEWER: A reviewer - TRADER: A trader - FULL_TRADER: A trader with full permissions - TEAM_MANAGER: A team manager - APPROVER: An approver
21
+ * - USER_ROLE_UNKNOWN: nil value - AUDITOR: An auditor - SIGNATORY: A signatory - ADMIN: An admin - INITIATOR: An initiator - REVIEWER: A reviewer - TRADER: A trader - FULL_TRADER: A trader with full permissions - TEAM_MANAGER: A team manager - APPROVER: An approver - TAX_MANAGER: A tax manager
22
22
  */
23
23
  export declare enum UserRole {
24
24
  Auditor = "AUDITOR",
@@ -29,5 +29,6 @@ export declare enum UserRole {
29
29
  Trader = "TRADER",
30
30
  FullTrader = "FULL_TRADER",
31
31
  TeamManager = "TEAM_MANAGER",
32
- Approver = "APPROVER"
32
+ Approver = "APPROVER",
33
+ TaxManager = "TAX_MANAGER"
33
34
  }
@@ -18,10 +18,11 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  /**
21
- * - CALL_TYPE_STANDARD: Evaluated at standard margin call evaluation time - CALL_TYPE_URGENT: Evaluated in realtime
21
+ * - CALL_TYPE_STANDARD: Evaluated at standard margin call evaluation time - CALL_TYPE_URGENT: Evaluated in realtime - CALL_TYPE_DEBIT: Evaluated at debit call evaluation time
22
22
  */
23
23
  export declare enum XMCallType {
24
24
  XmCallTypeUnspecified = "XM_CALL_TYPE_UNSPECIFIED",
25
25
  CallTypeStandard = "CALL_TYPE_STANDARD",
26
- CallTypeUrgent = "CALL_TYPE_URGENT"
26
+ CallTypeUrgent = "CALL_TYPE_URGENT",
27
+ CallTypeDebit = "CALL_TYPE_DEBIT"
27
28
  }
@@ -18,12 +18,13 @@
18
18
  * Do not edit the class manually.
19
19
  */
20
20
  /**
21
- * - ENTITY_NO_CALL: There are no margin calls - ENTITY_OPEN_STANDARD_CALL: There is a standard margin call. There are no urgent margin calls, and no expired margin calls. - ENTITY_OPEN_URGENT_CALL: There is an urgent margin call. It is possible that there could also be a standard margin call, but there are no expired margin calls. - ENTITY_AGED_CALL: At least one open margin call is aged (standard or urgent). This may trigger the SESSION_LOCKED control status.
21
+ * XMEntityCallStatus summarizes the state of open margin calls or debit calls. When multiple calls exist, the status reflects the highest priority call type. Priority order (highest to lowest): aged > urgent > standard > debit. - ENTITY_NO_CALL: There are no margin calls or debit calls. - ENTITY_OPEN_STANDARD_CALL: There is a standard margin call. There may also be debit calls, but there are no urgent margin calls or expired calls.. - ENTITY_OPEN_URGENT_CALL: There is an urgent margin call. There may also be standard margin calls or debit calls, but there are no expired calls. - ENTITY_AGED_CALL: At least one open margin call (standard or urgent) or debit call is aged. This will trigger the SESSION_LOCKED control status. - ENTITY_OPEN_DEBIT_CALL: There is a debit call. There are no standard margin calls, urgent margin calls, or expired calls.
22
22
  */
23
23
  export declare enum XMEntityCallStatus {
24
24
  XmEntityCallStatusUnspecified = "XM_ENTITY_CALL_STATUS_UNSPECIFIED",
25
25
  EntityNoCall = "ENTITY_NO_CALL",
26
26
  EntityOpenStandardCall = "ENTITY_OPEN_STANDARD_CALL",
27
27
  EntityOpenUrgentCall = "ENTITY_OPEN_URGENT_CALL",
28
- EntityAgedCall = "ENTITY_AGED_CALL"
28
+ EntityAgedCall = "ENTITY_AGED_CALL",
29
+ EntityOpenDebitCall = "ENTITY_OPEN_DEBIT_CALL"
29
30
  }