coinbase

type Account struct {
	ID               *uuid.UUID       `json:"uuid"`              // Unique identifier for account.
	Name             *string          `json:"name"`              // Name for the account.
	Currency         *string          `json:"currency"`          // Currency symbol for the account.
	AvailableBalance AvailableBalance `json:"available_balance"` // Available balance of account.
	Default          *bool            `json:"default"`           // Whether or not this account is the user's primary account.
	Active           *bool            `json:"active"`            // Whether or not this account is active and okay to use.
	CreatedAt        *time.Time       `json:"created_at"`        // Time at which this account was created.
	UpdatedAt        *time.Time       `json:"updated_at"`        // Time at which this account was updated.
	DeletedAt        *time.Time       `json:"deleted_at"`        // Time at which this account was deleted.
	Type             *AccountType     `json:"type"`              // Type of account.
	Ready            *bool            `json:"ready"`             // Whether or not this account is ready to trade.
	Hold             Hold             `json:"hold"`
}

type AccountListOptions struct {
	// A pagination limit with default of 49 and maximum of 250.
	// If has_next is true, additional orders are available to be fetched with pagination and the cursor value
	// in the response can be passed as cursor parameter in the subsequent request.
	Limit *int32 `url:"limit,omitempty"`
	// Cursor used for pagination. When provided, the response returns responses after this cursor.
	Cursor *string `url:"cursor,omitempty"`
}

type AccountService service

type AccountType string

type AllocatePortfolioOptions struct {
	PortfolioUUID uuid.UUID `json:"portfolio_uuid"` // The unique identifier for the perpetuals portfolio.
	Symbol        string    `json:"symbol"`         // The product_id for which funds must be allocated.
	Amount        string    `json:"amount"`         // The value of funds to be allocated for a specific isolated position.
	Currency      string    `json:"currency"`       // The currency of funds to be allocated for a specific isolated position.
}

type Authenticator interface {
	Authenticate(*http.Request) error
}

type AvailableBalance struct {
	Value    string `json:"value"`    // Amount of currency that this object represents.
	Currency string `json:"currency"` // Denomination of the currency.
}

type BalanceSummary struct {
	FuturesBuyingPower          Funds `json:"futures_buying_power"`          // The amount of your cash balance that is available to trade CFM futures.
	TotalBalance                Funds `json:"total_usd_balance"`             // Aggregate USD maintained across your CFTC-regulated futures account and your Coinbase Inc. spot account
	CBIBalance                  Funds `json:"cbi_usd_balance"`               // USD maintained in your Coinbase Inc. spot account.
	CFMBalance                  Funds `json:"cfm_usd_balance"`               // USD maintained in your CFTC-regulated futures account. Funds held in your futures account are not available to trade spot.
	TotalOpenOrdersHoldAmmount  Funds `json:"total_open_orders_hold_amount"` // Your total balance on hold for spot and futures open orders.
	UnrealizedPNL               Funds `json:"unrealized_pnl"`                // Your current unrealized PnL across all open positions.
	DailyRealizedPNL            Funds `json:"daily_realized_pnl"`            // Your realized PnL from the current trade date. May include profit or loss from positions you’ve closed on the current trade date.
	InitialMargin               Funds `json:"initial_margin"`                // Margin required to initiate futures positions. Once futures orders are placed, these funds cannot be used to trade spot. The actual amount of funds necessary to support executed futures orders will be moved to your futures account.
	AvailableMargin             Funds `json:"available_margin"`              // Funds available to meet your anticipated margin requirement. This includes your CBI spot USD, CFM futures USD, and Futures PnL, less any holds for open spot or futures orders.
	LiquidationThreshold        Funds `json:"liquidation_threshold"`         // When your available funds for collateral drop to the liquidation threshold, some or all of your futures positions will be liquidated.
	LiquidationBufferAmount     Funds `json:"liquidation_buffer_amount"`     // Funds available in excess of the liquidation threshold, calculated as available margin minus liquidation threshold. If your liquidation buffer amount reaches 0, your futures positions and/or open orders will be liquidated as necessary.
	LiquidationBufferPercentage Funds `json:"liquidation_buffer_percentage"` // Funds available in excess of the liquidation threshold expressed as a percentage. If your liquidation buffer percentage reaches 0%, your futures positions and/or open orders will be liquidated as necessary.
}

type BidAsk struct {
	Price *string `json:"price"`
	Size  *string `json:"size"`
}

type CancelOrderFailureReason string

type CancelledOrder struct {
	Success       bool                      `json:"success"` // Whether the cancel request was submitted successfully.
	FailureReason *CancelOrderFailureReason `json:"failure_reason"`
	ID            string                    `json:"order_id"` // The IDs of order cancel request was initiated for.
}

type Candles struct {
	Start  *string `json:"start"`  // Timestamp for bucket start time, in UNIX time.
	Low    *string `json:"low"`    // Lowest price during the bucket interval.
	High   *string `json:"high"`   // Highest price during the bucket interval.
	Open   *string `json:"open"`   // Opening price (first trade) in the bucket interval.
	Close  *string `json:"close"`  // Closing price (last trade) in the bucket interval.
	Volume *string `json:"volume"` // Volume of trading activity during the bucket interval.
}

type Client struct {
	Accounts  *AccountService    // Interface with the Advanced Trade REST API Accounts APIs.
	Orders    *OrdersService     // Interface with the Advanced Trade REST API Orders APIs.
	Products  *ProductsService   // Interface with the Advanced Trade REST API Products API.
	Fees      *FeesService       // Interface with the Advanced Trade REST API Fees API.
	Portfolio *PortfoliosService // Interface with the Advanced Trade REST API Portfolios API.
	Futures   *FuturesService    // Interface with the Advanced Trade REST API Futures API.
	Common    *CommonService     // Interface with the Advanced Trade REST API Common API.
	// contains filtered or unexported fields
}

type CoinbaseError struct {
	Err     *string        `json:"error"`
	Code    *int32         `json:"code"`
	Message *string        `json:"message"`
	Details []ErrorDetails `json:"details"`
}

type CoinbaseUnixTime struct {
	ISO          *string `json:"iso"`          // An ISO-8601 representation of the timestamp.
	EpochSeconds *string `json:"epochSeconds"` // A second-precision representation of the timestamp.
	EpochMillis  *string `json:"epochMillis"`  // A millisecond-precision representation of the timestamp.
}

type CommonService service

type ContractExpiryType string

type CreateOrderErrorMetadata struct {
	Error                 *OrderFailureReason   `json:"error"`
	Message               *string               `json:"message"`       // Generic error message explaining why the order was not created.
	ErrorDetails          *string               `json:"error_details"` // Descriptive error message explaining why the order was not created.
	PreviewFailureReason  *PreviewFailureReason `json:"preview_failure_reason"`
	NewOrderFailureReason *OrderFailureReason   `json:"new_order_failure_reason"`
}

type CreateOrderOptions struct {
	ClientOrderID         string             `json:"client_order_id"`          // A unique ID provided by the client for their own identification purposes. This ID differs from the order_id generated for the order. If the ID provided is not unique, the order fails to be created and the order corresponding to that ID is returned.
	ProductID             string             `json:"product_id"`               // The product this order was created for e.g. 'BTC-USD'.
	Side                  *Side              `json:"side"`                     // Possible values: [BUY, SELL].
	OrderConfiguration    OrderConfiguration `json:"order_configuration"`      // Configuration of the order details.
	SelfTradePreventionID *string            `json:"self_trade_prevention_id"` // Self trade prevention ID, to prevent an order crossing against the same user.
	Leverage              *string            `json:"leverage"`                 // Leverage for this order; default value is "1.0".
	MarginType            *MarginType        `json:"margin_type"`              // Side the order is on (BUY, SELL).
	RetailPortfolioID     *string            `json:"retail_portfolio_id"`      // Retail portfolio uuid, to associate this order with a retail portfolio.
}

type CreateOrderResponse struct {
	Success            bool                       `json:"success"`        // Whether the order was created.
	OrderFailureReason *OrderFailureReason        `json:"failure_reason"` // Reason for order failure if failure occurs.
	OrderID            *string                    `json:"order_id"`       // The ID of the order created.
	SuccessResponse    CreateOrderSuccessMetadata `json:"success_response"`
	ErrorResponse      CreateOrderErrorMetadata   `json:"error_response"`
	OrderConfiguration *OrderConfiguration        `json:"order_configuration"`
}

type CreateOrderSuccessMetadata struct {
	OrderID       string  `json:"order_id"`        // The ID of the order created.
	ProductID     *string `json:"product_id"`      // The product this order was created for e.g. 'BTC-USD'.
	Side          *Side   `json:"side"`            // Possible values: [BUY, SELL].
	ClientOrderID *string `json:"client_order_id"` // Client specified ID of order.
}

type EditFailureReason string

type EditOrderOptions struct {
	OrderID string  `json:"order_id"` // ID of order to edit.
	Price   *string `json:"price"`    // New price for order.
	Size    *string `json:"size"`     // New size for order.
}

type EditOrderResponse struct {
	Success bool `json:"success"` // Whether the order edit request was placed.
	Errors  []struct {
		EditFailureReason    *EditFailureReason    `json:"edit_failure_reason"`
		PreviewFailureReason *PreviewFailureReason `json:"preview_failure_reason"`
	} `json:"errors"` // Details of any errors that may have occured.
}

type EditPortfolioOptions struct {
	Name string `json:"name"`
}

type ErrorDetails struct {
	// A URL/resource name that uniquely identifies the type of the serialized protocol buffer message.
	// This string must contain at least one "/" character.
	// The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`).
	// The name should be in a canonical form (e.g., leading "." is not accepted).
	// In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any.
	// However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type
	// URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield
	// a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results
	// based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved o
	// n changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in
	// the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than `http`, `https`
	// (or the empty scheme) might be used with implementation specific semantics.
	TypeUrl string `json:"type_url"`
	Value   byte   `json:"value"` // Must be a valid serialized protocol buffer of the above specified type.
}

type ExpiringContractStatus string

type FCMTradingSessionDetails struct {
	IsSessionOpen *bool      `json:"is_session_open"`
	OpenTime      *time.Time `json:"open_time"`
	CloseTime     *time.Time `json:"close_time"`
}

type FeeTier struct {
	PricingTier  *string `json:"pricing_tier"`   // Pricing tier for user, determined by notional (USD) volume.
	USDFrom      *string `json:"usd_from"`       // Lower bound (inclusive) of pricing tier in notional volume.
	USDTo        *string `json:"usd_to"`         // Upper bound (exclusive) of pricing tier in notional volume.
	TakerFeeRate *string `json:"taker_fee_rate"` // Taker fee rate, applied if the order takes liquidity.
	MakerFeeRate *string `json:"maker_fee_rate"` // Maker fee rate, applied if the order creates liquidity.
	AOPFrom      *string `json:"aop_from"`       // Lower bound (inclusive) of pricing tier in usd of total assets on platform.
	AOPTO        *string `json:"aop_to"`         // Upper bound (exclusive) of pricing tier in usd of total assets on platform.
}

type FeesService service

type Fill struct {
	EntryID            *string             `json:"entry_id"`            // Unique identifier for the fill.
	TradeID            *string             `json:"trade_id"`            // ID of the fill -- unique for all `FILL` trade_types but not unique for adjusted fills.
	OrderID            *string             `json:"order_id"`            // ID of the order the fill belongs to.
	TradeTime          *time.Time          `json:"trade_time"`          // Time at which this fill was completed.
	TradeType          *TradeType          `json:"trade_type"`          // String denoting what type of fill this is. Regular fills have the value `FILL`. Adjusted fills have possible values `REVERSAL`, `CORRECTION`, `SYNTHETIC`.
	Price              *string             `json:"price"`               // Price the fill was posted at.
	Size               *string             `json:"size"`                // Amount of order that was transacted at this fill.
	Commission         *string             `json:"commission"`          //  Fee amount for fill.
	ProductID          *string             `json:"product_id"`          // The product this order was created for.
	SequenceTimestamp  *time.Time          `json:"sequence_timestamp"`  // Time at which this fill was posted.
	LiquidityIndicator *LiquidityIndicator `json:"liquidity_indicator"` // Possible values: [UNKNOWN_LIQUIDITY_INDICATOR, MAKER, TAKER]
	SizeInQuote        *bool               `json:"size_in_quote"`       // Whether the order was placed with quote currency.
	UserID             *string             `json:"user_id"`             // User that placed the order the fill belongs to.
	Side               *Side               `json:""`                    // Side the fill is on [BUY, SELL].
}

type Funds struct {
	Value    string `json:"value"`    // These two values fully represent the monetary amount. Non-localized amount in decimal notation (e.g. "1.234").
	Currency string `json:"currency"` // Currency symbol (USD, BTC, etc). Not an asset UUID.
}

type FutureProductDetails struct {
	Venue                  *string             `json:"venue"`
	ContractCode           *string             `json:"contract_code"`
	ContractExpiry         *time.Time          `json:"contract_expiry"`
	ContractSize           *string             `json:"contract_size"`
	ContractRootUnit       *string             `json:"contract_root_unit"`
	GroupDescription       *string             `json:"group_description"` // Descriptive name for the product series, eg "Nano Bitcoin Futures".
	ContractExpiryTimezone *string             `json:"contract_expiry_timezone"`
	GroupShortDescription  *string             `json:"group_short_description"` // Short version of the group_description, eg "Nano BTC".
	RiskManagedBy          *RiskManagedBy      `json:"risk_managed_by"`
	ContractExpiryType     *ContractExpiryType `json:"contract_expiry_type"`
	PerpetualDetails       *struct {
		OpenInterest *string    `json:"open_interest"`
		FundingRate  *string    `json:"funding_rate"`
		FundingTime  *time.Time `json:"funding_time"`
	} `json:"perpetual_details"`
	ContractDisplayName *string `json:"contract_display_name"`
}

type FuturesPosition struct {
	ProductID         *string      `json:"product_id"`          // The ID of the CFM futures product.
	ExpirationTime    *time.Time   `json:"expiration_time"`     // The expiry of your position.
	Side              *FuturesSide `json:"side"`                // The side of your position.
	NumberOfContracts *string      `json:"number_of_contracts"` // The size of your position in contracts.
	CurrentPrice      *string      `json:"current_price"`       // The current price of the product.
	AverageEntryPrice *string      `json:"avg_entry_price"`     // The average entry price at which you entered your current position.
	UnrealizedPNL     *string      `json:"unrealized_pnl"`      // Your current unrealized PnL for your position.
	DailyRealizedPNL  *string      `json:"daily_realized_pnl"`  // Your realized PnL from your trades in this product on current trade date.
}

type FuturesPositionSide string

type FuturesService service

type FuturesSide string

type FuturesSweep struct {
	ID              *string `json:"id"` // The ID of the sweep request scheduled.
	RequestedAmount struct {
		Value    *string `json:"value"`
		Currency *string `json:"currency"`
	} `json:"requested_amount"` //The requested sweep amount.
	ShouldSweepAll *bool        `json:"should_sweep_all"` // True if the request was to sweep all available funds from your CFM futures account
	Status         *SweepStatus `json:"status"`           // A pending sweep is a sweep that has not started processing and can be cancelled. A processing sweep is a sweep that is currently being processed and cannot be cancelled.
	ScheduledTime  *time.Time   `json:"scheduled_time"`   // The timestamp at which the sweep request was submitted.
}

type GetBestBidAskResponse struct {
	PriceBooks []PriceBook `json:"pricebooks"`
}

type GetMarketTradeOptions struct {
	ProductID string     `url:"-"`                    // The trading pair, i.e., 'BTC-USD'.
	Limit     int        `url:"limit"`                // Number of trades to return.
	Start     *time.Time `url:"start,unix,omitempty"` // Timestamp for starting range of aggregations.
	End       *time.Time `url:"end,unix,omitempty"`   // Timestamp for starting range of aggregations.
}

type GetMarketTradesResponse struct {
	Trades  []Trade `json:"trades"`
	BestBid *string `json:"best_bid"` // The best bid for the `product_id`, in quote currency.
	BestAsk *string `json:"best_ask"` // The best ask for the `product_id`, in quote currency.
}

type GetProductCandlesOptions struct {
	ProductID   string          `url:"-"`           // The trading pair.
	Start       time.Time       `url:"start,unix"`  // Timestamp for starting range of aggregations.
	End         time.Time       `url:"end,unix"`    // Timestamp for ending range of aggregations.
	Granularity TimeGranularity `url:"granularity"` // The time slice value for each candle.
}

type GetTransactionsSummaryOptions struct {
	ProductType        *string             `url:"product_type,omitempty"`
	ContractExpiryType *ContractExpiryType `url:"contract_expiry_type,omitempty"`
}

type GetTransactionsSummaryResponse struct {
	TotalVolume         float64 `json:"total_volume"` // Total volume across assets, denoted in USD.
	TotalFees           float64 `json:"total_fees"`   // Total fees across assets, denoted in USD.
	FeeTier             FeeTier `json:"fee_tier"`
	GoodsAndServicesTax struct {
		Rate *string `json:"rate"`
		Type *string `json:"type"` // Possible values: [INCLUSIVE, EXCLUSIVE] // TODO: enum.
	} `json:"goods_and_services_tax"`
	AdvancedTradeOnlyVolume *float64 `json:"advanced_trade_only_volume"` // Advanced Trade volume (non-inclusive of Pro) across assets, denoted in USD.
	AdvancedTradeOnlyFees   *float64 `json:"advanced_trade_only_fees"`   // Advanced Trade fees (non-inclusive of Pro) across assets, denoted in USD.
	CoinbaseProVolume       *float64 `json:"coinbase_pro_volume"`        // Coinbase Pro volume across assets, denoted in USD.
	CoinbaseProFees         *float64 `json:"coinbase_pro_fees"`          // Coinbase Pro fees across assets, denoted in USD.
}

type Hold struct {
	Value    string `json:"value"`    // Amount of currency that this object represents.
	Currency string `json:"currency"` // Denomination of the currency.
}

type LimitOrderGTC struct {
	BaseSize   *string `json:"base_size"`   // Amount of base currency to spend on order.
	LimitPrice *string `json:"limit_price"` // Ceiling price for which the order should get filled.
	PostOnly   *bool   `json:"post_only"`   // The post-only flag indicates that the order should only make liquidity. If any part of the order results in taking liquidity, the order will be rejected and no part of it will execute.
}

type LimitOrderGTD struct {
	BaseSize   *string    `json:"base_size"`   // Amount of base currency to spend on order.
	LimitPrice *string    `json:"limit_price"` // Ceiling price for which the order should get filled.
	EndTime    *time.Time `json:"end_time"`    // Time at which the order should be cancelled if it's not filled.
	PostOnly   *bool      `json:"post_only"`   // The post-only flag indicates that the order should only make liquidity. If any part of the order results in taking liquidity, the order will be rejected and no part of it will execute.
}

type LiquidityIndicator string

type ListAccountsResponse struct {
	Accounts []Account `json:"accounts"`
	// Whether there are additional pages for this query.
	HasNext bool `json:"has_next"`
	// Cursor for paginating. Users can use this string to pass in the next call to this
	// endpoint, and repeat this process to fetch all accounts through pagination.
	Cursor *string `json:"cursor"`
	// Number of accounts returned
	Size *int32 `json:"size"`
}

type ListFillsResponse struct {
	Fills  []Fill  `json:"fills"`  // All fills matching the filters.
	Cursor *string `json:"cursor"` // Cursor for paginating. Users can use this string to pass in the next call to this endpoint, and repeat this process to fetch all fills through pagination.
}

type ListOrderFillsOptions struct {
	OrderID           *string    `url:"order_id,omitempty"`                 // ID of order.
	ProductID         *string    `url:"product_id,omitempty"`               // The ID of the product this order was created for.
	StartSequenceTime *time.Time `url:"start_sequence_timestamp,omitempty"` // Start date. Only fills with a trade time at or after this start date are returned.
	EndSequenceTime   *time.Time `url:"end_sequence_timestamp,omitempty"`   // End date. Only fills with a trade time before this start date are returned.
	Limit             *int64     `url:"limit,omitempty"`                    // Maximum number of fills to return in response. Defaults to 100.
	Cursor            *string    `url:"cursor,omitempty"`                   // Cursor used for pagination. When provided, the response returns responses after this cursor.
}

type ListOrdersOptions struct {
	ProductID            *string               `url:"product_id,omitempty"`             // Optional string of the product ID. Defaults to null, or fetch for all products.
	OrderStatus          []OrderStatus         `url:"order_status,omitempty"`           // A list of order statuses.
	Limit                *int32                `url:"limit,omitempty"`                  // Pagination limit with a default of 1000 (which is also the maximum). If has_next is true, additional orders are available to be fetched with pagination; also the cursor value in the response can be passed as cursor parameter in the subsequent request.
	StartDate            *time.Time            `url:"start_date,omitempty"`             // Start date to fetch orders from, inclusive.
	EndDate              *time.Time            `url:"end_date,omitempty"`               // An optional end date for the query window, exclusive. If provided only orders with creation time before this date will be returned.
	OrderType            *OrderType            `url:"order_type,omitempty"`             // Type of orders to return. Default is to return all order types.
	OrderSide            *OrderSide            `url:"order_side,omitempty"`             // Only orders matching this side are returned. Default is to return all sides.
	Cursor               *string               `url:"cursor,omitempty"`                 // Cursor used for pagination. When provided, the response returns responses after this cursor.
	ProductType          *ProductType          `url:"product_type,omitempty"`           // Only orders matching this product type are returned. Default is to return all product types.
	OrderPlacementSource *OrderPlacementSource `url:"order_placement_source,omitempty"` // Only orders matching this placement source are returned. Default is to return RETAIL_ADVANCED placement source.
	ContractExpiryType   *ContractExpiryType   `url:"contract_expiry_type,omitempty"`   // Only orders matching this contract expiry type are returned. Filter is only applied if product_type is set to FUTURE in the request.
	AssetFilters         []string              `url:"asset_filters,omitempty"`          // Only returns orders where the quote, base, or underlying asset matches the provided asset filter(s), i.e., 'BTC'.
	RetailPortfolioID    *string               `url:"retail_portfolio_id,omitempty"`    // Only orders matching this retail portfolio id are returned. Default is to return orders for all retail portfolio ids.
}

type ListOrdersResponse struct {
	Orders   []Order `json:"orders"`   // A list of orders matching the query.
	Sequence *string `json:"sequence"` // The sequence of the db at which this state was read.
	HasNext  bool    `json:"has_next"` // Whether there are additional pages for this query.
	Cursor   *string `json:"cursor"`   // Cursor for paginating. Users can use this string to pass in the next call to this endpoint, and repeat this process to fetch all fills through pagination.
}

type ListPortfoliosOptions struct {
	PortfolioType *PortfolioType `url:"portfolio_type,omitempty"`
}

type ListPortfoliosResponse struct {
	Portfolios []Portfolio `json:"portfolios"`
}

type ListProductsOptions struct {
	Limit                  *int32                  `url:"limit,omitempty"`        // A limit describing how many products to return.
	Offset                 *int32                  `url:"limit,omitempty"`        // Number of products to offset before returning.
	ProductType            *ProductType            `url:"product_type,omitempty"` // Type of products to return.
	ProductIDs             []string                `url:"product_ids,omitempty"`  // List of product IDs to return.
	ContractExpiryType     *ContractExpiryType     `url:"contract_expiry_type,omitempty"`
	ExpiringContractStatus *ExpiringContractStatus `url:"expiring_contract_status,omitempty"`
}

type MarginType string

type MarketOrderIOC struct {
	QuoteSize *string `json:"quote_size"` // Amount of quote currency to spend on order. Required for BUY orders
	BaseSize  *string `json:"base_size"`  // Amount of base currency to spend on order. Required for SELL orders.
}

type Order struct {
	ID                    string                `json:"order_id"`            // The unique id for this order.
	ProductID             string                `json:"product_id"`          // The product this order was created for e.g. 'BTC-USD'.
	UserID                string                `json:"user_id"`             // The id of the User owning this Order.
	Configuration         *OrderConfiguration   `json:"order_configuration"` // Configuration of the order.
	Side                  *Side                 `json:"side"`                // Side the order is on (BUY, SELL).
	ClientOrderID         string                `json:"client_order_id"`     // Client specified ID of order.
	Status                *OrderStatus          `json:"status"`              // Status of the order.
	TimeInForce           *TimeInForce          `json:"time_in_force"`
	CreatedTime           time.Time             `json:"created_time"`            // Timestamp for when the order was created.
	CompletionPercentage  string                `json:"completion_percentage"`   // The percent of total order amount that has been filled.
	FilledSize            *string               `json:"filled_size"`             // The portion (in base currency) of total order amount that has been filled.
	AverageFilledPrice    string                `json:"average_filled_price"`    // The average of all prices of fills for this order.
	NumberOfFills         string                `json:"number_of_fills"`         // Number of fills that have been posted for this order.
	FilledValue           *string               `json:"filled_value"`            // The amount -- in quote currency -- of the total order that has been filled.
	PendingCancel         bool                  `json:"pending_cancel"`          // Whether a cancel request has been initiated for the order, and not yet completed.
	SizeInQuote           bool                  `json:"size_in_quote"`           // Whether the order was placed with quote currency.
	TotalFees             string                `json:"total_fees"`              // The total fees for the order.
	SizeInclusiveOfFees   bool                  `json:"size_inclusive_of_fees"`  // Whether the order size includes fees.
	TotalValueAfterFees   string                `json:"total_value_after_fees"`  // Derived field defined as (filled_value + total_fees) for buy orders and (filled_value - total_fees) for sell orders.
	TriggerStatus         *TriggerStatus        `json:"trigger_status"`          // Possible values: [UNKNOWN_TRIGGER_STATUS, INVALID_ORDER_TYPE, STOP_PENDING, STOP_TRIGGERED].
	Type                  *OrderType            `json:"order_type"`              // Possible values: [UNKNOWN_ORDER_TYPE, MARKET, LIMIT, STOP, STOP_LIMIT].
	RejectReason          *RejectReason         `json:"reject_reason"`           // Rejection Reason; Possible values: [REJECT_REASON_UNSPECIFIED].
	Settled               *bool                 `json:"settled"`                 // True if the order is fully filled, false otherwise.
	ProductType           *ProductType          `json:"product_type"`            // Possible values: [SPOT, FUTURE].
	RejectMessage         *string               `json:"reject_message"`          // Message stating why the order was rejected.
	CancelMessage         *string               `json:"cancel_message"`          // Message stating why the order was canceled.
	OrderPlacementSource  *OrderPlacementSource `json:"order_placement_source"`  // Possible values: [RETAIL_SIMPLE, RETAIL_ADVANCED].
	OutstandingHoldAmount *string               `json:"outstanding_hold_amount"` // The remaining hold amount calculated as (holdAmount - holdAmountReleased). If the hold is released, returns 0.
	IsLiquidation         *bool                 `json:"is_liquidation"`          // True if order is of liquidation type.
	LastFillTime          *time.Time            `json:"last_fill_time"`          // Time of the most recent fill for this order.
	EditHistory           []struct {
		Price                  *string    `json:"price"`
		Size                   *string    `json:"size"`
		ReplaceAcceptTimestamp *time.Time `json:"replace_accept_timestamp"`
	} `json:"edit_history"` // An array of the latest 5 edits per order.
}

type OrderConfiguration struct {
	MarketIOC    *MarketOrderIOC    `json:"market_market_ioc"`
	LimitGTC     *LimitOrderGTC     `json:"limit_limit_gtc"`
	LimitGTD     *LimitOrderGTD     `json:"limit_limit_gtd"`
	StopLimitGTC *StopLimitOrderGTC `json:"stop_limit_stop_limit_gtc"`
	StopLimitGTD *StopLimitOrderGTD `json:"stop_limit_stop_limit_gtd"`
}

type OrderFailureReason string

type OrderPlacementSource string

type OrderSide string

type OrderStatus string

type OrderType string

type OrdersService service

type PorfoliosMoveFundsResponse struct {
	SourcePortfolioUUID *uuid.UUID `json:"source_portfolio_uuid"` // UUID of the portfolio the funds were transfered from.
	TargetPortfolioUUID *uuid.UUID `json:"target_portfolio_uuid"` // UUID of the portfolio the funds were transfered to.
}

type Portfolio struct {
	Name    *string        `json:"name"`
	UUID    *uuid.UUID     `json:"uuid"`
	Type    *PortfolioType `json:"type"`
	Deleted *bool          `json:"deleted"`
}

type PortfolioMoveFundsOptions struct {
	Funds               Funds     `json:"funds"`                 // Represents a monetary amount.
	SourcePortfolioUUID uuid.UUID `json:"source_portfolio_uuid"` // UUID of the portfolio to transfer funds from.
	TargetPortfolioUUID uuid.UUID `json:"target_portfolio_uuid"` // UUID of the portfolio to transfer funds to.
}

type PortfolioType string

type PortfoliosService service

type PreviewFailureReason string

type PriceBook struct {
	ProductID string     `json:"product_id"`
	Bids      []BidAsk   `json:"bids"`
	Asks      []BidAsk   `json:"asks"`
	Time      *time.Time `json:"time"`
}

type Product struct {
	ID                            string                    `json:"product_id"`                   // The trading pair.
	Price                         string                    `json:"price"`                        // The current price for the product, in quote currency.
	PricePercentageChange24Hours  string                    `json:"price_percentage_change_24h"`  // The amount the price of the product has changed, in percent, in the last 24 hours.
	Volume24Hours                 string                    `json:"volume_24h"`                   // The trading volume for the product in the last 24 hours.
	VolumePercentageChange24Hours string                    `json:"volume_percentage_change_24h"` // The percentage amount the volume of the product has changed in the last 24 hours.
	BaseIncrement                 string                    `json:"base_increment"`               // Minimum amount base value can be increased or decreased at once.
	QuoteIncrement                string                    `json:"quote_increment"`              // Minimum amount quote value can be increased or decreased at once.
	QuoteMinimumSize              string                    `json:"quote_min_size"`               // Minimum size that can be represented of quote currency.
	QuoteMaximumSize              string                    `json:"quote_max_size"`               // Maximum size that can be represented of quote currency.
	BaseMinimimSize               string                    `json:"base_min_size"`                // Minimum size that can be represented of base currency.
	BaseMaximumSize               string                    `json:"base_max_size"`                // Maximum size that can be represented of base currency.
	BaseName                      string                    `json:"base_name"`                    // Name of the base currency.
	QuoteName                     string                    `json:"quote_name"`                   // Name of the quote currency.
	Watched                       bool                      `json:"watched"`                      // Whether or not the product is on the user's watchlist.
	IsDisabled                    bool                      `json:"is_disabled"`                  // Whether or not the product is disabled for trading.
	New                           bool                      `json:"new"`                          // Whether or not the product is 'new'.
	Status                        string                    `json:"status"`                       // Status of the product.
	CancelOnly                    bool                      `json:"cancel_only"`                  // Whether or not orders of the product can only be cancelled, not placed or edited.
	LimitOnly                     bool                      `json:"limit_only"`                   // Whether or not orders of the product can only be limit orders, not market orders.
	PostOnly                      bool                      `json:"post_only"`                    // Whether or not orders of the product can only be posted, not cancelled.
	TradingDisabled               bool                      `json:"trading_disabled"`             // Whether or not the product is disabled for trading for all market participants.
	AuctionMode                   bool                      `json:"auction_mode"`                 // Whether or not the product is in auction mode.
	Type                          *ProductType              `json:"product_type"`                 // Type of product.
	QuoteCurrencyID               *string                   `json:"quote_currency_id"`            // Symbol of the quote currency.
	BaseCurrencyID                *string                   `json:"base_currency_id"`             // Symbol of the base currency.
	FCMTradingSessionDetails      *FCMTradingSessionDetails `json:"fcm_trading_session_details"`
	MidMarketPrice                *string                   `json:"mid_market_price"`     // The current midpoint of the bid-ask spread, in quote currency.
	Alias                         *string                   `json:"alias"`                // Product id for the corresponding unified book.
	AliasTo                       []string                  `json:"alias_to"`             // Product ids that this product serves as an alias for.
	BaseDisplaySymbol             string                    `json:"base_display_symbol"`  // Symbol of the base display currency.
	QuoteDisplaySymbol            string                    `json:"quote_display_symbol"` // Symbol of the quote display currency.
	ViewOnly                      *bool                     `json:"view_only"`            // Whether or not the product is in view only mode.
	PriceIncrement                *string                   `json:"price_increment"`      // Minimum amount price can be increased or decreased at once.
	FutureProductDetails          *FutureProductDetails     `json:"future_product_details"`
}

type ProductType string

type ProductsService service

type RejectReason string

type RiskManagedBy string

type ScheduleSweepOptions struct {
	USDAmmount *string `json:"usd_amount"` // The amount you want to sweep from your CFM futures account into your CBI spot account. Leave empty to sweep all available excess funds.
}

type ScheduleSweepResponse struct {
	Success *bool `json:"success"`
}

type Side string

type StopDirection string

type StopLimitOrderGTC struct {
	BaseSize      *string        `json:"base_size"`      // Amount of base currency to spend on order.
	LimitPrice    *string        `json:"limit_price"`    // Ceiling price for which the order should get filled.
	StopPrice     *string        `json:"stop_price"`     // Price at which the order should trigger - if stop direction is Up, then the order will trigger when the last trade price goes above this, otherwise order will trigger when last trade price goes below this price.
	StopDirection *StopDirection `json:"stop_direction"` // Possible values: [STOP_DIRECTION_STOP_UP, STOP_DIRECTION_STOP_DOWN].
}

type StopLimitOrderGTD struct {
	BaseSize      *string    `json:"base_size"`      // Amount of base currency to spend on order.
	LimitPrice    *string    `json:"limit_price"`    // Ceiling price for which the order should get filled.
	StopPrice     *string    `json:"stop_price"`     // Price at which the order should trigger - if stop direction is Up, then the order will trigger when the last trade price goes above this, otherwise order will trigger when last trade price goes below this price.
	EndTime       *time.Time `json:"end_time"`       // Time at which the order should be cancelled if it's not filled.
	StopDirection *string    `json:"stop_direction"` // Possible values: [STOP_DIRECTION_STOP_UP, STOP_DIRECTION_STOP_DOWN].
}

type SweepStatus string

type TimeGranularity string

type TimeInForce string

type Trade struct {
	ID        *string    `json:"trade_id"`   // The ID of the trade that was placed.
	ProductID *string    `json:"product_id"` // The trading pair.
	Price     *string    `json:"price"`      // The price of the trade, in quote currency.
	Size      *string    `json:"size"`       // The size of the trade, in base currency.
	Time      *time.Time `json:"time"`       // The time of the trade.
	Side      *Side      `json:"side"`       // Side of the transaction the trade is on: [BUY, SELL].
	Bid       *string    `json:"bid"`        // The best bid for the `product_id`, in quote currency.
	Ask       *string    `json:"ask"`        // The best ask for the `product_id`, in quote currency.
}

type TradeType string

type TriggerStatus string