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

package/dist/types/model/GetUnstakingStatusResponse.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { ValidatorUnstakingInfo } from './ValidatorUnstakingInfo';
+export type GetUnstakingStatusResponse = {
+    /**
+     * The portfolio ID
+     */
+    portfolioId: string;
+    /**
+     * The wallet ID
+     */
+    walletId: string;
+    /**
+     * The wallet address
+     */
+    walletAddress: string;
+    /**
+     * Current timestamp at time of API call
+     */
+    currentTimestamp: Date;
+    /**
+     * List of validators with unstaking information for this wallet
+     */
+    validators: Array<ValidatorUnstakingInfo>;
+};

package/dist/types/model/ListFinancingEligibleAssetsResponse.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { TFAsset } from './TFAsset';
+export type ListFinancingEligibleAssetsResponse = {
+    /**
+     * List of assets eligible for Trade Finance
+     */
+    assets?: Array<TFAsset>;
+};

package/dist/types/model/ListTFObligationsResponse.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { TFObligation } from './TFObligation';
+export type ListTFObligationsResponse = {
+    /**
+     * The list of obligations (loans) for the entity.
+     */
+    obligations?: Array<TFObligation>;
+};

package/dist/types/model/NaturalPersonName.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type NaturalPersonName = {
+    firstName?: string;
+    middleName?: string;
+    lastName?: string;
+};

package/dist/types/model/NetworkDetails.d.ts

@@ -52,4 +52,8 @@ export type NetworkDetails = {
      * Base URL to our recommended block explorer (crypto only)
      */
     networkLink?: string;
+    /**
+     * Indicates the symbol that can be used to query other endpoints, related to transactions, wallets, and activities, to get information particularly for this asset on the network
+     */
+    networkScopedSymbol?: string;
 };

package/dist/types/model/Order.d.ts

@@ -140,4 +140,16 @@ export type Order = {
      * The maximum order size that will show up on venue order books (in base currency).
      */
     displayBaseSize?: string;
+    /**
+     * The peg offset type for PEG orders (PRICE, BASIS_POINTS, or CUMULATIVE_DEPTH_IN_BASE_UNITS)
+     */
+    pegOffsetType?: string;
+    /**
+     * The offset value for PEG orders
+     */
+    offset?: string;
+    /**
+     * The wig (would if good) level for PEG orders - best price opposite to limit_price
+     */
+    wigLevel?: string;
 };

package/dist/types/model/OrderPreviewRequest.d.ts

@@ -19,6 +19,7 @@
  */
 import { OrderSide } from './enums/OrderSide';
 import { OrderType } from './enums/OrderType';
+import { PegOffsetType } from './enums/PegOffsetType';
 import { TimeInForceType } from './enums/TimeInForceType';
 export type OrderPreviewRequest = {
     productId: string;
@@ -46,4 +47,10 @@ export type OrderPreviewRequest = {
      * The maximum order size that will show up on venue order books (in base currency).
      */
     displayBaseSize?: string;
+    pegOffsetType?: PegOffsetType;
+    offset?: string;
+    /**
+     * next: 21
+     */
+    wigLevel?: string;
 };

package/dist/types/model/PreviewUnstakeRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+/**
+ * PreviewUnstakeRequest represents a request to preview an unstaking operation.
+ */
+export type PreviewUnstakeRequest = {
+    /**
+     * Amount to preview unstaking
+     */
+    amount: string;
+};

package/dist/types/model/PreviewUnstakeResponse.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+/**
+ * PreviewUnstakeResponse contains the response data from previewing an unstaking operation.
+ */
+export type PreviewUnstakeResponse = {
+    /**
+     * Estimated amount that would be unstaked
+     */
+    estimatedAmount: string;
+};

package/dist/types/model/ProcessRequirements.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { TravelRuleStatus } from './enums/TravelRuleStatus';
+export type ProcessRequirements = {
+    travelRuleStatus?: TravelRuleStatus;
+};

package/dist/types/model/RewardMetadata.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { RewardSubtype } from './enums/RewardSubtype';
+export type RewardMetadata = {
+    subtype?: RewardSubtype;
+};

package/dist/types/model/SetFcmSettingsRequest.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type SetFcmSettingsRequest = {
+    /**
+     * Target CFM Excess amount to set. Only non-negative number is allowed
+     */
+    targetDerivativesExcess?: string;
+};

package/dist/types/model/SetFcmSettingsResponse.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type SetFcmSettingsResponse = {
+    /**
+     * Success
+     */
+    success?: boolean;
+};

package/dist/types/model/TFAsset.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type TFAsset = {
+    /**
+     * The asset symbol
+     */
+    symbol?: string;
+    /**
+     * The asset adjustment factor for Trade Finance
+     */
+    assetAdjustment?: string;
+    /**
+     * The liability adjustment factor for Trade Finance
+     */
+    liabilityAdjustment?: string;
+};

package/dist/types/model/TFObligation.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type TFObligation = {
+    /**
+     * The unique ID of the portfolio
+     */
+    portfolioId?: string;
+    /**
+     * The currency symbol
+     */
+    symbol?: string;
+    /**
+     * Current amount due
+     */
+    amountDue?: string;
+    /**
+     * Loan notional amount
+     */
+    notionalAmount?: string;
+    /**
+     * Settlement due date
+     */
+    dueDate?: string;
+};

package/dist/types/model/Transaction.d.ts

@@ -21,6 +21,7 @@ import { AssetChange } from './AssetChange';
 import { EstimatedNetworkFees } from './EstimatedNetworkFees';
 import { Network } from './Network';
 import { OnchainTransactionDetails } from './OnchainTransactionDetails';
+import { ProcessRequirements } from './ProcessRequirements';
 import { TransactionMetadata } from './TransactionMetadata';
 import { TransactionStatus } from './enums/TransactionStatus';
 import { TransactionType } from './enums/TransactionType';
@@ -98,4 +99,5 @@ export type Transaction = {
     idempotencyKey?: string;
     onchainDetails?: OnchainTransactionDetails;
     networkInfo?: Network;
+    processRequirements?: ProcessRequirements;
 };

package/dist/types/model/TransactionMetadata.d.ts

@@ -18,8 +18,10 @@
  *  Do not edit the class manually.
  */
 import { MatchMetadata } from './MatchMetadata';
+import { RewardMetadata } from './RewardMetadata';
 import { Web3TransactionMetadata } from './Web3TransactionMetadata';
 export type TransactionMetadata = {
     matchMetadata?: MatchMetadata;
     web3TransactionMetadata?: Web3TransactionMetadata;
+    rewardMetadata?: RewardMetadata;
 };

package/dist/types/model/TravelRuleEntry.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { BlockchainAddress } from './BlockchainAddress';
+import { TravelRuleParty } from './TravelRuleParty';
+import { TravelRuleWalletDetails } from './TravelRuleWalletDetails';
+import { VASP } from './VASP';
+/**
+ * Travel Rule Entry for sending addresses.
+ */
+export type TravelRuleEntry = {
+    id?: string;
+    blockchainAddress?: BlockchainAddress;
+    originator?: TravelRuleParty;
+    beneficiary?: TravelRuleParty;
+    vasp?: VASP;
+    walletDetails?: TravelRuleWalletDetails;
+    transferPurpose?: string;
+    isSelfCertified?: boolean;
+    isIntermediary?: boolean;
+    isSelf?: boolean;
+};

package/dist/types/model/TravelRuleParty.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { DateOfBirth } from './DateOfBirth';
+import { DetailedAddress } from './DetailedAddress';
+import { NaturalPersonName } from './NaturalPersonName';
+/**
+ * Represents one of the Transmittal Parties involved in a Travel Rule transfer, either originator or beneficiary.
+ */
+export type TravelRuleParty = {
+    name?: string;
+    detailedAddress?: DetailedAddress;
+    naturalPersonName?: NaturalPersonName;
+    dateOfBirth?: DateOfBirth;
+    telephoneNumber?: string;
+};

package/dist/types/model/TravelRuleWalletDetails.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { BlockchainAddress } from './BlockchainAddress';
+import { TravelRuleWalletType } from './enums/TravelRuleWalletType';
+/**
+ * Details about the custody wallet used in the transfer.
+ */
+export type TravelRuleWalletDetails = {
+    walletType?: TravelRuleWalletType;
+    walletAddress?: BlockchainAddress;
+};

package/dist/types/model/UnstakingStatus.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { EstimateType } from './enums/EstimateType';
+import { UnstakeType } from './enums/UnstakeType';
+export type UnstakingStatus = {
+    /**
+     * Amount being unstaked (whole amount, e.g., 16 ETH)
+     */
+    amount: string;
+    unstakeType?: UnstakeType;
+    /**
+     * Estimated date when unstaking will complete (ISO 8601 format)
+     */
+    finishingAt?: Date;
+    /**
+     * Estimated hours until this unstaking request completes
+     */
+    remainingHours?: number;
+    /**
+     * Timestamp when the unstake request was originally created
+     */
+    requestedAt?: Date;
+    estimateType: EstimateType;
+    /**
+     * Detailed explanation of the estimate status for display to users.
+     */
+    estimateDescription: string;
+};

package/dist/types/model/VASP.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+/**
+ * Virtual Asset Service Provider (VASP).
+ */
+export type VASP = {
+    id?: string;
+    countryCode?: string;
+    leiNumber?: string;
+};

package/dist/types/model/ValidatorUnstakingInfo.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { UnstakingStatus } from './UnstakingStatus';
+export type ValidatorUnstakingInfo = {
+    /**
+     * The validator address (public key)
+     */
+    validatorAddress: string;
+    /**
+     * List of active unstaking requests for this validator
+     */
+    statuses: Array<UnstakingStatus>;
+};

package/dist/types/model/enums/CandlesGranularity.d.ts

@@ -24,7 +24,7 @@ export declare enum CandlesGranularity {
     OneHour = "ONE_HOUR",
     SixHours = "SIX_HOURS",
     OneDay = "ONE_DAY",
-    ThirtyMinute = "THIRTY_MINUTE",
-    TwoHour = "TWO_HOUR",
-    FourHour = "FOUR_HOUR"
+    ThirtyMinutes = "THIRTY_MINUTES",
+    TwoHours = "TWO_HOURS",
+    FourHours = "FOUR_HOURS"
 }