@coinbase-sample/prime-sdk-ts 0.7.0 → 0.8.0

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 (103) hide show
  1. package/dist/constants.js +1 -1
  2. package/dist/financing/index.js +18 -0
  3. package/dist/futures/index.js +20 -0
  4. package/dist/model/Candle.js +21 -0
  5. package/dist/model/DateOfBirth.js +21 -0
  6. package/dist/model/DetailedAddress.js +21 -0
  7. package/dist/model/GetCandlesResponse.js +21 -0
  8. package/dist/model/GetFcmSettingsResponse.js +21 -0
  9. package/dist/model/GetUnstakingStatusResponse.js +21 -0
  10. package/dist/model/ListFinancingEligibleAssetsResponse.js +21 -0
  11. package/dist/model/ListTFObligationsResponse.js +21 -0
  12. package/dist/model/NaturalPersonName.js +21 -0
  13. package/dist/model/PreviewUnstakeRequest.js +21 -0
  14. package/dist/model/PreviewUnstakeResponse.js +21 -0
  15. package/dist/model/ProcessRequirements.js +21 -0
  16. package/dist/model/RewardMetadata.js +21 -0
  17. package/dist/model/SetFcmSettingsRequest.js +21 -0
  18. package/dist/model/SetFcmSettingsResponse.js +21 -0
  19. package/dist/model/TFAsset.js +21 -0
  20. package/dist/model/TFObligation.js +21 -0
  21. package/dist/model/TravelRuleEntry.js +21 -0
  22. package/dist/model/TravelRuleParty.js +21 -0
  23. package/dist/model/TravelRuleWalletDetails.js +21 -0
  24. package/dist/model/UnstakingStatus.js +21 -0
  25. package/dist/model/VASP.js +21 -0
  26. package/dist/model/ValidatorUnstakingInfo.js +21 -0
  27. package/dist/model/enums/CandlesGranularity.js +34 -0
  28. package/dist/model/enums/EstimateType.js +28 -0
  29. package/dist/model/enums/OrderType.js +2 -1
  30. package/dist/model/enums/PegOffsetType.js +31 -0
  31. package/dist/model/enums/RewardSubtype.js +34 -0
  32. package/dist/model/enums/TransactionType.js +3 -1
  33. package/dist/model/enums/TravelRuleStatus.js +28 -0
  34. package/dist/model/enums/TravelRuleWalletType.js +31 -0
  35. package/dist/model/enums/UnstakeType.js +28 -0
  36. package/dist/model/enums/UserRole.js +2 -1
  37. package/dist/model/enums/XMCallType.js +2 -1
  38. package/dist/model/enums/XMEntityCallStatus.js +2 -1
  39. package/dist/model/enums/index.js +16 -1
  40. package/dist/products/index.js +16 -0
  41. package/dist/shared/__tests__/validation.test.js +210 -0
  42. package/dist/shared/validation.js +380 -0
  43. package/dist/staking/index.js +22 -0
  44. package/dist/types/activities/types.d.ts +1 -0
  45. package/dist/types/constants.d.ts +1 -1
  46. package/dist/types/financing/index.d.ts +5 -1
  47. package/dist/types/financing/types.d.ts +7 -1
  48. package/dist/types/futures/index.d.ts +6 -2
  49. package/dist/types/futures/types.d.ts +10 -1
  50. package/dist/types/index.d.ts +1 -1
  51. package/dist/types/model/Candle.d.ts +42 -0
  52. package/dist/types/model/CreateOrderRequest.d.ts +8 -1
  53. package/dist/types/model/CreatePortfolioAddressBookEntryRequest.d.ts +6 -0
  54. package/dist/types/model/DateOfBirth.d.ts +24 -0
  55. package/dist/types/model/DetailedAddress.d.ts +28 -0
  56. package/dist/types/model/GetCandlesResponse.d.ts +23 -0
  57. package/dist/types/model/GetFcmSettingsResponse.d.ts +25 -0
  58. package/dist/types/model/GetUnstakingStatusResponse.d.ts +42 -0
  59. package/dist/types/model/ListFinancingEligibleAssetsResponse.d.ts +26 -0
  60. package/dist/types/model/ListTFObligationsResponse.d.ts +26 -0
  61. package/dist/types/model/NaturalPersonName.d.ts +24 -0
  62. package/dist/types/model/NetworkDetails.d.ts +4 -0
  63. package/dist/types/model/Order.d.ts +12 -0
  64. package/dist/types/model/OrderPreviewRequest.d.ts +7 -0
  65. package/dist/types/model/PreviewUnstakeRequest.d.ts +28 -0
  66. package/dist/types/model/PreviewUnstakeResponse.d.ts +28 -0
  67. package/dist/types/model/ProcessRequirements.d.ts +23 -0
  68. package/dist/types/model/RewardMetadata.d.ts +23 -0
  69. package/dist/types/model/SetFcmSettingsRequest.d.ts +25 -0
  70. package/dist/types/model/SetFcmSettingsResponse.d.ts +25 -0
  71. package/dist/types/model/TFAsset.d.ts +33 -0
  72. package/dist/types/model/TFObligation.d.ts +41 -0
  73. package/dist/types/model/Transaction.d.ts +2 -0
  74. package/dist/types/model/TransactionMetadata.d.ts +2 -0
  75. package/dist/types/model/TravelRuleEntry.d.ts +38 -0
  76. package/dist/types/model/TravelRuleParty.d.ts +32 -0
  77. package/dist/types/model/TravelRuleWalletDetails.d.ts +28 -0
  78. package/dist/types/model/UnstakingStatus.d.ts +45 -0
  79. package/dist/types/model/VASP.d.ts +27 -0
  80. package/dist/types/model/ValidatorUnstakingInfo.d.ts +30 -0
  81. package/dist/types/model/enums/CandlesGranularity.d.ts +30 -0
  82. package/dist/types/model/enums/EstimateType.d.ts +24 -0
  83. package/dist/types/model/enums/OrderType.d.ts +3 -2
  84. package/dist/types/model/enums/PegOffsetType.d.ts +27 -0
  85. package/dist/types/model/enums/RewardSubtype.d.ts +30 -0
  86. package/dist/types/model/enums/TransactionType.d.ts +4 -2
  87. package/dist/types/model/enums/TravelRuleStatus.d.ts +24 -0
  88. package/dist/types/model/enums/TravelRuleWalletType.d.ts +27 -0
  89. package/dist/types/model/enums/UnstakeType.d.ts +24 -0
  90. package/dist/types/model/enums/UserRole.d.ts +3 -2
  91. package/dist/types/model/enums/XMCallType.d.ts +3 -2
  92. package/dist/types/model/enums/XMEntityCallStatus.d.ts +3 -2
  93. package/dist/types/model/enums/index.d.ts +7 -0
  94. package/dist/types/model/index.d.ts +23 -0
  95. package/dist/types/products/index.d.ts +3 -1
  96. package/dist/types/products/types.d.ts +10 -1
  97. package/dist/types/shared/__tests__/validation.test.d.ts +1 -0
  98. package/dist/types/shared/validation.d.ts +176 -0
  99. package/dist/types/staking/index.d.ts +5 -1
  100. package/dist/types/staking/types.d.ts +12 -1
  101. package/dist/types/transactions/types.d.ts +3 -1
  102. package/dist/types/wallets/types.d.ts +1 -0
  103. package/package.json +8 -8
@@ -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
+ };
@@ -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 declare enum CandlesGranularity {
21
+ OneMinute = "ONE_MINUTE",
22
+ FiveMinutes = "FIVE_MINUTES",
23
+ FifteenMinutes = "FIFTEEN_MINUTES",
24
+ OneHour = "ONE_HOUR",
25
+ SixHours = "SIX_HOURS",
26
+ OneDay = "ONE_DAY",
27
+ ThirtyMinutes = "THIRTY_MINUTES",
28
+ TwoHours = "TWO_HOURS",
29
+ FourHours = "FOUR_HOURS"
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
  }
@@ -10,7 +10,9 @@ export { AllocationSizeType } from './AllocationSizeType';
10
10
  export { AllocationStatus } from './AllocationStatus';
11
11
  export { AssetChangeType } from './AssetChangeType';
12
12
  export { Benchmark } from './Benchmark';
13
+ export { CandlesGranularity } from './CandlesGranularity';
13
14
  export { DestinationType } from './DestinationType';
15
+ export { EstimateType } from './EstimateType';
14
16
  export { FcmFuturesSweepStatus } from './FcmFuturesSweepStatus';
15
17
  export { FcmMarginCallState } from './FcmMarginCallState';
16
18
  export { FcmMarginCallType } from './FcmMarginCallType';
@@ -26,16 +28,21 @@ export { OrderSide } from './OrderSide';
26
28
  export { OrderStatus } from './OrderStatus';
27
29
  export { OrderType } from './OrderType';
28
30
  export { PaymentMethodType } from './PaymentMethodType';
31
+ export { PegOffsetType } from './PegOffsetType';
29
32
  export { PortfolioBalanceType } from './PortfolioBalanceType';
30
33
  export { PositionReferenceType } from './PositionReferenceType';
31
34
  export { ProductPermissions } from './ProductPermissions';
32
35
  export { RateType } from './RateType';
36
+ export { RewardSubtype } from './RewardSubtype';
33
37
  export { SigningStatus } from './SigningStatus';
34
38
  export { SortDirection } from './SortDirection';
35
39
  export { TimeInForceType } from './TimeInForceType';
36
40
  export { TransactionStatus } from './TransactionStatus';
37
41
  export { TransactionType } from './TransactionType';
38
42
  export { TransferLocationType } from './TransferLocationType';
43
+ export { TravelRuleStatus } from './TravelRuleStatus';
44
+ export { TravelRuleWalletType } from './TravelRuleWalletType';
45
+ export { UnstakeType } from './UnstakeType';
39
46
  export { UserRole } from './UserRole';
40
47
  export { ValidatorStatus } from './ValidatorStatus';
41
48
  export { VisibilityStatus } from './VisibilityStatus';
@@ -22,6 +22,7 @@ export type { BlockchainAddress } from './BlockchainAddress';
22
22
  export type { BuyingPower } from './BuyingPower';
23
23
  export type { CancelFuturesSweepResponse } from './CancelFuturesSweepResponse';
24
24
  export type { CancelOrderResponse } from './CancelOrderResponse';
25
+ export type { Candle } from './Candle';
25
26
  export type { Commission } from './Commission';
26
27
  export type { Conversion } from './Conversion';
27
28
  export type { ConversionDetail } from './ConversionDetail';
@@ -42,8 +43,10 @@ export type { CreateWalletResponse } from './CreateWalletResponse';
42
43
  export type { CreateWalletTransferResponse } from './CreateWalletTransferResponse';
43
44
  export type { CreateWalletWithdrawalResponse } from './CreateWalletWithdrawalResponse';
44
45
  export type { CrossMarginOverview } from './CrossMarginOverview';
46
+ export type { DateOfBirth } from './DateOfBirth';
45
47
  export type { DefiBalance } from './DefiBalance';
46
48
  export type { DestinationAlloc } from './DestinationAlloc';
49
+ export type { DetailedAddress } from './DetailedAddress';
47
50
  export type { EditOrderResponse } from './EditOrderResponse';
48
51
  export type { EntityBalance } from './EntityBalance';
49
52
  export type { EntityUser } from './EntityUser';
@@ -58,6 +61,7 @@ export type { GetActivityResponse } from './GetActivityResponse';
58
61
  export type { GetAllocationResponse } from './GetAllocationResponse';
59
62
  export type { GetAllocationsByClientNettingIdResponse } from './GetAllocationsByClientNettingIdResponse';
60
63
  export type { GetBuyingPowerResponse } from './GetBuyingPowerResponse';
64
+ export type { GetCandlesResponse } from './GetCandlesResponse';
61
65
  export type { GetCrossMarginOverviewResponse } from './GetCrossMarginOverviewResponse';
62
66
  export type { GetEntityActivitiesResponse } from './GetEntityActivitiesResponse';
63
67
  export type { GetEntityAssetsResponse } from './GetEntityAssetsResponse';
@@ -68,6 +72,7 @@ export type { GetExistingLocatesResponse } from './GetExistingLocatesResponse';
68
72
  export type { GetFcmBalanceResponse } from './GetFcmBalanceResponse';
69
73
  export type { GetFcmMarginCallDetailsResponse } from './GetFcmMarginCallDetailsResponse';
70
74
  export type { GetFcmRiskLimitsResponse } from './GetFcmRiskLimitsResponse';
75
+ export type { GetFcmSettingsResponse } from './GetFcmSettingsResponse';
71
76
  export type { GetFuturesSweepsResponse } from './GetFuturesSweepsResponse';
72
77
  export type { GetInterestAccrualsResponse } from './GetInterestAccrualsResponse';
73
78
  export type { GetInvoicesResponse } from './GetInvoicesResponse';
@@ -98,6 +103,7 @@ export type { GetPositionsResponse } from './GetPositionsResponse';
98
103
  export type { GetPostTradeCreditResponse } from './GetPostTradeCreditResponse';
99
104
  export type { GetTFTieredPricingFeesResponse } from './GetTFTieredPricingFeesResponse';
100
105
  export type { GetTransactionResponse } from './GetTransactionResponse';
106
+ export type { GetUnstakingStatusResponse } from './GetUnstakingStatusResponse';
101
107
  export type { GetWalletBalanceResponse } from './GetWalletBalanceResponse';
102
108
  export type { GetWalletDepositInstructionsResponse } from './GetWalletDepositInstructionsResponse';
103
109
  export type { GetWalletResponse } from './GetWalletResponse';
@@ -109,7 +115,9 @@ export type { InvoiceItem } from './InvoiceItem';
109
115
  export type { ListAggregateEntityPositionsResponse } from './ListAggregateEntityPositionsResponse';
110
116
  export type { ListEntityBalancesResponse } from './ListEntityBalancesResponse';
111
117
  export type { ListEntityPositionsResponse } from './ListEntityPositionsResponse';
118
+ export type { ListFinancingEligibleAssetsResponse } from './ListFinancingEligibleAssetsResponse';
112
119
  export type { ListOnchainAddressGroupsResponse } from './ListOnchainAddressGroupsResponse';
120
+ export type { ListTFObligationsResponse } from './ListTFObligationsResponse';
113
121
  export type { ListTransactionValidatorsResponse } from './ListTransactionValidatorsResponse';
114
122
  export type { ListWalletAddressesResponse } from './ListWalletAddressesResponse';
115
123
  export type { ListWeb3WalletBalancesResponse } from './ListWeb3WalletBalancesResponse';
@@ -124,6 +132,7 @@ export type { MarketRate } from './MarketRate';
124
132
  export type { MatchMetadata } from './MatchMetadata';
125
133
  export type { NFTCollection } from './NFTCollection';
126
134
  export type { NFTItem } from './NFTItem';
135
+ export type { NaturalPersonName } from './NaturalPersonName';
127
136
  export type { Network } from './Network';
128
137
  export type { NetworkDetails } from './NetworkDetails';
129
138
  export type { OnchainTransactionDetails } from './OnchainTransactionDetails';
@@ -143,23 +152,35 @@ export type { Position } from './Position';
143
152
  export type { PositionReference } from './PositionReference';
144
153
  export type { PostOrderPreviewResponse } from './PostOrderPreviewResponse';
145
154
  export type { PostTradeCreditInformation } from './PostTradeCreditInformation';
155
+ export type { PreviewUnstakeResponse } from './PreviewUnstakeResponse';
156
+ export type { ProcessRequirements } from './ProcessRequirements';
146
157
  export type { Product } from './Product';
147
158
  export type { QuoteResponse } from './QuoteResponse';
148
159
  export type { RFQProductDetails } from './RFQProductDetails';
160
+ export type { RewardMetadata } from './RewardMetadata';
149
161
  export type { RiskAssessment } from './RiskAssessment';
150
162
  export type { RpcConfig } from './RpcConfig';
151
163
  export type { ScheduleFuturesSweepResponse } from './ScheduleFuturesSweepResponse';
152
164
  export type { SetAutoSweepResponse } from './SetAutoSweepResponse';
165
+ export type { SetFcmSettingsResponse } from './SetFcmSettingsResponse';
153
166
  export type { ShortCollateral } from './ShortCollateral';
154
167
  export type { StakingClaimRewardsResponse } from './StakingClaimRewardsResponse';
155
168
  export type { StakingInitiateResponse } from './StakingInitiateResponse';
156
169
  export type { StakingUnstakeResponse } from './StakingUnstakeResponse';
170
+ export type { TFAsset } from './TFAsset';
171
+ export type { TFObligation } from './TFObligation';
157
172
  export type { TieredPricingFee } from './TieredPricingFee';
158
173
  export type { Transaction } from './Transaction';
159
174
  export type { TransactionMetadata } from './TransactionMetadata';
160
175
  export type { TransactionValidator } from './TransactionValidator';
161
176
  export type { TransferLocation } from './TransferLocation';
177
+ export type { TravelRuleEntry } from './TravelRuleEntry';
178
+ export type { TravelRuleParty } from './TravelRuleParty';
179
+ export type { TravelRuleWalletDetails } from './TravelRuleWalletDetails';
180
+ export type { UnstakingStatus } from './UnstakingStatus';
162
181
  export type { UserAction } from './UserAction';
182
+ export type { VASP } from './VASP';
183
+ export type { ValidatorUnstakingInfo } from './ValidatorUnstakingInfo';
163
184
  export type { Wallet } from './Wallet';
164
185
  export type { WalletClaimRewardsInputs } from './WalletClaimRewardsInputs';
165
186
  export type { WalletCryptoDepositInstructions } from './WalletCryptoDepositInstructions';
@@ -190,8 +211,10 @@ export type { ListTransactionValidatorsRequest } from './ListTransactionValidato
190
211
  export type { OrderPreviewRequest } from './OrderPreviewRequest';
191
212
  export type { PortfolioStakingInitiateRequest } from './PortfolioStakingInitiateRequest';
192
213
  export type { PortfolioStakingUnstakeRequest } from './PortfolioStakingUnstakeRequest';
214
+ export type { PreviewUnstakeRequest } from './PreviewUnstakeRequest';
193
215
  export type { ScheduleFuturesSweepRequest } from './ScheduleFuturesSweepRequest';
194
216
  export type { SetAutoSweepRequest } from './SetAutoSweepRequest';
217
+ export type { SetFcmSettingsRequest } from './SetFcmSettingsRequest';
195
218
  export type { StakingClaimRewardsRequest } from './StakingClaimRewardsRequest';
196
219
  export type { StakingInitiateRequest } from './StakingInitiateRequest';
197
220
  export type { StakingUnstakeRequest } from './StakingUnstakeRequest';
@@ -14,12 +14,14 @@
14
14
  * limitations under the License.
15
15
  */
16
16
  import { IPrimeApiClient, CoinbaseCallOptions } from '../clients';
17
- import { ListProductsRequest, ListProductsResponse } from './types';
17
+ import { ListProductsRequest, ListProductsResponse, ListProductCandlesRequest, ListProductCandlesResponse } from './types';
18
18
  export interface IProductsService {
19
19
  listProducts(request: ListProductsRequest, options?: CoinbaseCallOptions): Promise<ListProductsResponse>;
20
+ listProductCandles(request: ListProductCandlesRequest, options?: CoinbaseCallOptions): Promise<ListProductCandlesResponse>;
20
21
  }
21
22
  export declare class ProductsService implements IProductsService {
22
23
  private client;
23
24
  constructor(client: IPrimeApiClient);
24
25
  listProducts(request: ListProductsRequest, options?: CoinbaseCallOptions): Promise<ListProductsResponse>;
26
+ listProductCandles(request: ListProductCandlesRequest, options?: CoinbaseCallOptions): Promise<ListProductCandlesResponse>;
25
27
  }
@@ -14,7 +14,8 @@
14
14
  * limitations under the License.
15
15
  */
16
16
  import { Brand } from '../shared/brand';
17
- import { GetPortfolioProductsResponse } from '../model/';
17
+ import { GetPortfolioProductsResponse, GetCandlesResponse } from '../model/';
18
+ import { CandlesGranularity } from '../model/enums/';
18
19
  import { Pagination } from '../shared/pagination';
19
20
  import { PaginatedResponseMethods, BasePaginatedRequest } from '../shared/paginatedResponse';
20
21
  export type ListProductsRequest = Pagination & {
@@ -22,3 +23,11 @@ export type ListProductsRequest = Pagination & {
22
23
  };
23
24
  export type BaseListProductsResponse = Brand<GetPortfolioProductsResponse, 'ListProductsResponse'>;
24
25
  export type ListProductsResponse = BaseListProductsResponse & PaginatedResponseMethods<ListProductsRequest & BasePaginatedRequest, BaseListProductsResponse, any>;
26
+ export type ListProductCandlesRequest = {
27
+ portfolioId: string;
28
+ productId: string;
29
+ startTime: string;
30
+ endTime: string;
31
+ granularity: CandlesGranularity;
32
+ };
33
+ export type ListProductCandlesResponse = Brand<GetCandlesResponse, 'ListProductCandlesResponse'>;
@@ -0,0 +1 @@
1
+ export {};