opensea

type AssetRequest struct {
	// The NFT contract address for the assets
	AssetContractAddress string `path:"asset_contract_address,required"`
	// Address of the contract for this NFT
	TokenID string `path:"token_id,required"`
	// Address of an owner of the token.
	// If you include this, the response will include an ownership object that includes
	// the number of tokens owned by the address provided instead of the top_ownerships object
	// included in the standard response, which provides the number of tokens owned by each of
	// the 10 addresses with the greatest supply of the token.
	AccountAddress string `query:"account_address"`
	// A flag determining if order information should be included in the response. The default value of this flag is false.
	IncludeOrders bool `query:"include_orders"`
}

type AssetValidateRequest struct {
	// The NFT contract address for the assets
	AssetContractAddress string `path:"asset_contract_address,required"`
	// Address of the contract for this NFT
	TokenID string `path:"token_id,required"`
	// Address of an owner of the token.
	// If you include this, the response will include an ownership object that includes
	// the number of tokens owned by the address provided instead of the top_ownerships object
	// included in the standard response, which provides the number of tokens owned by each of
	// the 10 addresses with the greatest supply of the token.
	Validate string `path:"validate,required"`
}

type AssetValidateResponse struct {
	Valid    bool        `opensea:"valid" json:"valid"`
	TokenUri string      `opensea:"token_uri" json:"tokenUri"`
	Errors   interface{} `opensea:"errors" json:"errors"`
}

type AssetsRequest struct {
	// The address of the owner of the assets
	Owner string `query:"owner"`
	// An array of token IDs to search for (e.g. ?token_ids=1&token_ids=209).
	// Will return a list of assets with token_id matching any of the IDs in this array.
	TokenIDs []string `query:"token_ids"`
	// The NFT contract address for the assets
	AssetContractAddress string `query:"asset_contract_address"`
	// An array of contract addresses to search for (e.g. ?asset_contract_addresses=0x1...&asset_contract_addresses=0x2...).
	// Will return a list of assets with contracts matching any of the addresses in this array.
	// If "token_ids" is also specified, then it will only return assets that match each (address, token_id) pairing, respecting order.
	AssetContractAddresses []string `query:"asset_contract_addresses"`
	// How to order the assets returned. By default, the API returns the fastest ordering.
	// Options you can set are sale_date (the last sale's transaction's timestamp),
	// sale_count (number of sales), and sale_price (the last sale's total_price)
	OrderBy string `query:"order_by"`
	// Can be asc for ascending or desc for descending
	OrderDirection string `query:"order_direction,required"`
	// Offset
	Offset int32 `query:"offset"`
	// Limit
	Limit int32 `query:"limit,required"`

	//Cursor A cursor pointing to the page to retrieve
	Cursor string `query:"cursor"`

	// Limit responses to members of a collection.
	// Case-sensitive and must match the collection slug exactly.
	// Will return all assets from all contracts in a collection.
	// For more information on collections, see our collections documentation.
	Collection string `query:"collection"`

	// Limit responses to members of a collection.
	// Case sensitive and must match the collection slug exactly.
	// Will return all assets from all contracts in a collection.
	// For more information on collections,
	CollectionSlug string `query:"collection_slug"`

	// CollectionEditor
	CollectionEditor string `query:"collection_editor"`

	// A flag determining if order information should be included in the response.
	IncludeOrders bool `query:"include_orders"`
}

type AssetsResponse struct {
	Assets   []*model.Asset `opensea:"assets"`
	Next     string         `opensea:"next"`
	Previous string         `opensea:"previous"`
}

type BundlesRequest struct {
	// If set to true, only show bundles currently on sale.
	// If set to false, only show bundles that have been sold or cancelled.
	OnSale bool `json:"on_sale"`
	// The address of the owner of the assets
	Owner string `query:"owner"`
	// The NFT contract address for the assets
	AssetContractAddress string `query:"asset_contract_address"`
	// An array of contract addresses to search for (e.g. ?asset_contract_addresses=0x1...&asset_contract_addresses=0x2...).
	// Will return a list of assets with contracts matching any of the addresses in this array.
	// If "token_ids" is also specified, then it will only return assets that match each (address, token_id) pairing, respecting order.
	AssetContractAddresses []string `query:"asset_contract_addresses"`
	// An array of token IDs to search for (e.g. ?token_ids=1&token_ids=209).
	// Will return a list of assets with token_id matching any of the IDs in this array.
	TokenIDs []string `query:"token_ids"`
	// Limit
	Limit int32 `query:"limit,required"`
	// Offset
	Offset int32 `query:"offset,required"`
}

type BundlesResponse struct {
	Bundles []*model.Bundle `opensea:"bundles"`
}

type Client struct {
	*restgo.Client
	// contains filtered or unexported fields
}

type CollectionRequest struct {
	CollectionSlug string `path:"collection_slug,required"`
}

type CollectionResponse struct {
	Collection *model.Collection `opensea:"collection"`
}

type CollectionStatsResponse struct {
	Stats *model.CollectionStats `opensea:"stats"`
}

type CollectionsRequest struct {
	// A wallet address. If specified, will return collections where the owner owns at least one asset belonging to smart contracts in the collection.
	// The number of assets the account owns is shown as owned_asset_count for each collection.
	AssetOwner string `query:"asset_owner"`
	// Offset
	Offset int32 `query:"offset,required"`
	// Limit
	Limit int32 `query:"limit,required"`
}

type CollectionsResponse struct {
	Collections []*model.Collection `opensea:"collections"`
}

type ContractRequest struct {
	// Address of the contract
	AssetContractAddress string `path:"asset_contract_address,required"`
}

type EventType string

type EventsRequest struct {
	// Restrict to events on OpenSea auctions. Can be true or false
	OnlyOpensea bool `query:"only_opensea"`
	// The token's id to optionally filter by
	TokenID string `query:"token_id"`
	// The NFT contract address for the assets
	AssetContractAddress string `query:"asset_contract_address"`
	// Limit responses to events from a collection. Case sensitive and must match the collection slug exactly.
	// Will return all assets from all contracts in a collection.
	// For more information on collections, see our collections documentation.
	CollectionSlug   string `query:"collection_slug"`
	CollectionEditor string `query:"collection_editor"`
	// A user account's wallet address to filter for events on an account
	AccountAddress string `query:"account_address"`
	// The event type to filter.
	EventType model.EventType `query:"event_type"`
	// Filter by an auction type.
	AuctionType model.AuctionType `query:"auction_type"`
	// Only show events listed before this timestamp. Seconds since the Unix epoch.
	// eg: 2017-07-21T17:32:28Z
	OccurredBefore string `query:"occurred_before"`
	// Only show events listed after this timestamp. Seconds since the Unix epoch.
	// eg: 2017-07-21T17:32:28Z
	OccurredAfter string `query:"occurred_after"`
	// A cursor pointing to the page to retrieve
	Cursor string `query:"cursor"`
}

type EventsResponse struct {
	// List of Event Object
	AssetEvents []*model.Event `opensea:"asset_events"`
	// A cursor to be supplied as a query param to retrieve the next page
	Next string `opensea:"next"`
	// A cursor to be supplied as a query param to retrieve the previous page
	Previous string `opensea:"previous"`
}

type Network string

type OptionFn func(*option)

type OrderCreateResponse struct {
	Orders   []*model.Order `opensea:"owners"`
	Next     string         `opensea:"next"`
	Previous string         `opensea:"previous"`
}

type OrderResponse struct {
	Orders   []*model.Order `opensea:"owners"`
	Next     string         `opensea:"next"`
	Previous string         `opensea:"previous"`
}

type OrdersCreateRequest struct {
	// Specify the chain you would like to retrieve listings on. The options are "arbitrum", "avalanche", "ethereum", "klaytn", "matic" and "optimism".
	Chain string `path:"chain,required"`
	// Represents the details of the listing to be posted to Seaport. Refer to Orders Parameter Model for more details.
	OrderParameters *model.Protocol `form:"order_parameters,required"`
	Signature       string          `form:"signature,required"`
}

type OrdersRequest struct {
	// Specify the chain you would like to retrieve listings on. The options are "arbitrum", "avalanche", "ethereum", "klaytn", "matic" and "optimism".
	Chain string `path:"chain,required"`
	// Address of the contract for an NFT
	AssetContractAddress string `query:"asset_contract_address"`
	// Number of listings to retrieve
	Limit string `query:"limit,required"`
	// Filter by a list of token IDs for the order's asset.
	// Needs to be defined together with asset_contract_address.
	TokenIDs []string `query:"token_ids"`
	// Filter by the order maker's wallet address
	Maker string `query:"maker"`
	// Filter by the order taker's wallet address.
	// Orders open for any taker have the null address as their taker.
	Taker string `query:"taker"`
	// How to sort the orders. Can be created_date for when they were made,
	// or eth_price to see the lowest-priced orders first (converted to their ETH values).
	// eth_price is only supported when asset_contract_address and token_id are also defined.
	OrderBy string `query:"order_by"`
	// Can be asc or desc for ascending or descending sort.
	// For example, to see the cheapest orders, do order_direction asc and order_by eth_price.
	OrderDirection string `query:"order_direction,required"`
	// Only show orders listed after this timestamp. Seconds since the Unix epoch.
	// eg: 2017-07-21T17:32:28Z
	ListedAfter string `query:"listed_after"`
	// Only show orders listed before this timestamp. Seconds since the Unix epoch.
	// eg: 2017-07-21T17:32:28Z
	ListedBefore string `query:"listed_before"`
}

type OwnersRequest struct {
	// Address of the contract for this NFT
	AssetContractAddress string `path:"asset_contract_address,required"`
	// Address of the contract for this NFT
	TokenID string `path:"token_id,required"`
	// How many results to show. The default value is 20 (if param is omitted), max is 50.
	Limit string `query:"limit,required"`
	// What field to order by. For now, we only support created_date.
	OrderBy string `query:"order_by"`
	// asc or desc. Descending is the default.
	OrderDirection string `query:"order_direction"`
	// The cursor token. Used for going forward / backward to the next/previous pages.
	Cursor string `query:"cursor"`
}

type OwnersResponse struct {
	Assets   []*model.Owner `opensea:"owners"`
	Next     string         `opensea:"next"`
	Previous string         `opensea:"previous"`
}

type StreamClient struct {
	// contains filtered or unexported fields
}