holaplex.graphql

directive @defer(if: Boolean! = true, label: String) on FRAGMENT_SPREAD | INLINE_FRAGMENT

"""Input required for accepting an invitation to the organization."""
input AcceptInviteInput {
  """The ID of the invitation."""
  invite: UUID!
}

"""
The response returned after accepting an invitation to the organization.
"""
type AcceptInvitePayload {
  """The invitation to the organization that has been accepted."""
  invite: Invite!
}

"""
An access token used to authenticate and authorize access to the Hub API.
"""
type AccessToken {
  """A string representing the access token used to authenticate requests."""
  accessToken: String!

  """A timestamp indicating when the access token will expire."""
  expiresAt: NaiveDateTime!

  """A string indicating the type of access token, such as "Bearer"."""
  tokenType: String!
}

enum Action {
  CREATE_DROP
  CREATE_WALLET
  MINT_EDITION
  RETRY_DROP
  RETRY_MINT
  TRANSFER_ASSET
}

"""
Represents the cost of performing a certain action on different blockchains
"""
type ActionCost {
  """enum that represents the type of action being performed."""
  action: Action!

  """
  a vector of BlockchainCost structs that represents the cost of performing the action on each blockchain.
  """
  blockchains: [BlockchainCost!]!
}

"""
An enum type named Affiliation that defines a user's association to an organization. The enum is derived using a Union attribute. It has two variants, each containing an associated data type:
"""
union Affiliation = Member | Owner

"""Fireblocks-defined blockchain identifiers."""
enum AssetType {
  """Ethereum Mainnet"""
  ETH

  """Mainnet Polygon"""
  MATIC

  """Mainnet Solana"""
  SOL
}

enum Blockchain {
  ETHEREUM
  POLYGON
  SOLANA
}

"""Represents the cost of performing an action on a specific blockchain"""
type BlockchainCost {
  """
  enum that represents the blockchain on which the action is being performed.
  """
  blockchain: Blockchain!

  """
  represents the cost in credits for performing the action on the blockchain.
  """
  credits: Int!
}

type Collection {
  """
  The blockchain address of the collection used to view it in blockchain explorers.
  On Solana this is the mint address.
  On EVM chains it is the concatenation of the contract address and the token id `{contractAddress}:{tokenId}`.
  """
  address: String

  """The blockchain of the collection."""
  blockchain: Blockchain!

  """
  The creation status of the collection. When the collection is in a `CREATED` status you can mint NFTs from the collection.
  """
  creationStatus: CreationStatus!

  """The list of attributed creators for the collection."""
  creators: [CollectionCreator!]

  """The list of current holders of NFTs from the collection."""
  holders: [Holder!]

  """The unique identifier for the collection."""
  id: UUID!

  """
  The metadata json associated to the collection.
  ## References
  [Metaplex v1.1.0 Standard](https://docs.metaplex.com/programs/token-metadata/token-standard)
  """
  metadataJson: MetadataJson

  """
  The list of minted NFTs from the collection including the NFTs address and current owner's wallet address.
  """
  mints: [CollectionMint!]

  """
  A list of all NFT purchases from the collection, including both primary and secondary sales.
  """
  purchases: [Purchase!]

  """
  The royalties assigned to mints belonging to the collection expressed in basis points.
  """
  sellerFeeBasisPoints: Int!

  """The transaction signature of the collection."""
  signature: String

  """
  The total supply of the collection. Setting to `null` implies unlimited minting.
  """
  supply: Int

  """The current number of NFTs minted from the collection."""
  totalMints: Int!
}

type CollectionCreator {
  address: String!
  collectionId: UUID!
  share: Int!
  verified: Boolean!
}

"""An attributed creator for a colleciton."""
input CollectionCreatorInput {
  """The wallet address of the creator."""
  address: String!

  """The share of royalties payout the creator should receive."""
  share: Int!

  """
  This field indicates whether the collection's creator has been verified. This feature is only supported on the Solana blockchain.
  ## References
  [Metaplex Token Metadata - Verify creator instruction](https://docs.metaplex.com/programs/token-metadata/instructions#verify-a-creator)
  """
  verified: Boolean
}

"""Represents a single NFT minted from a collection."""
type CollectionMint {
  """
  The address of the NFT
  On Solana this is the mint address.
  On EVM chains it is the concatenation of the contract address and the token id `{contractAddress}:{tokenId}`.
  """
  address: String

  """The collection the NFT was minted from."""
  collection: Collection

  """The ID of the collection the NFT was minted from."""
  collectionId: UUID!

  """The date and time when the NFT was created."""
  createdAt: DateTime!

  """The unique ID of the creator of the NFT."""
  createdBy: UUID!

  """The status of the NFT creation."""
  creationStatus: CreationStatus!

  """credits deduction id"""
  creditsDeductionId: UUID

  """The unique edition number of the NFT."""
  edition: Int!

  """The unique ID of the minted NFT."""
  id: UUID!

  """
  The metadata json associated to the collection.
  [Metaplex v1.1.0 Standard](https://docs.metaplex.com/programs/token-metadata/token-standard)
  """
  metadataJson: MetadataJson

  """The wallet address of the owner of the NFT."""
  owner: String!

  """The seller fee basis points (ie royalties) for the NFT."""
  sellerFeeBasisPoints: Int!

  """The transaction signature associated with the NFT."""
  signature: String
}

"""
This struct represents the input for creating a new API credential, including the ID of the organization that the credential will be associated with and the friendly name assigned to the credential.
"""
input CreateCredentialInput {
  """The friendly name assigned to the new API credential."""
  name: String!

  """
  The ID of the organization that the new API credential will be associated with.
  """
  organization: UUID!
}

"""
The response payload returned after successfully creating an API credential. It includes the newly created Credential object, which represents the API credential, as well as an `AccessToken` object that can be used to authenticate requests to the Hub API.
"""
type CreateCredentialPayload {
  """
  An `AccessToken` object that can be used to authenticate requests to the Hub API.
  """
  accessToken: AccessToken!

  """A `Credential` object representing the newly created API credential."""
  credential: Credential!
}

"""
This input object is used for creating a customer and associated treasury for holding custodial wallets on behalf of the user.
"""
input CreateCustomerInput {
  """
  The unique identifier of the project to which the customer is associated.
  """
  project: UUID!
}

"""
This response represents the payload returned after successfully creating a new `customer` record. It contains a single field customer which is a `Customer` object representing the newly created customer record.
"""
type CreateCustomerPayload {
  """The customer record created by the create customer mutation."""
  customer: Customer!
}

"""Input for creating a customer wallet."""
input CreateCustomerWalletInput {
  """Blockchain for wallet creation."""
  assetType: AssetType!

  """The customer ID."""
  customer: UUID!
}

"""Response after wallet creation."""
type CreateCustomerWalletPayload {
  wallet: Wallet!
}

input CreateDropInput {
  blockchain: Blockchain!
  creators: [CollectionCreatorInput!]!
  endTime: DateTime
  metadataJson: MetadataJsonInput!
  price: Int
  project: UUID!
  sellerFeeBasisPoints: Int
  startTime: DateTime
  supply: Int
}

type CreateDropPayload {
  drop: Drop!
}

input CreateOrganizationInput {
  name: String!
  profileImageUrl: String
}

type CreateOrganizationPayload {
  organization: Organization!
}

"""The input used for creating a project."""
input CreateProjectInput {
  """
  The friendly name to denote the project from others belonging to the organization.
  """
  name: String!

  """The ID of the organization the project belongs to."""
  organization: UUID!

  """The URL of the project's profile image."""
  profileImageUrl: String
}

"""* The payload returned by the `createProject` mutation."""
type CreateProjectPayload {
  """* The project that was created."""
  project: Project!
}

input CreateWebhookInput {
  description: String!
  filterTypes: [FilterType!]!
  organization: UUID!
  projects: [UUID!]!
  url: String!
}

type CreateWebhookPayload {
  secret: String!
  webhook: Webhook!
}

enum CreationStatus {
  BLOCKED
  CANCELED
  CREATED
  FAILED
  PENDING
  REJECTED
}

"""
An `OAuth2` client application used for authentication with the Hub API.
"""
type Credential {
  """A unique identifier for the credential."""
  clientId: String!

  """The datetime in UTC when the credential was created."""
  createdAt: NaiveDateTime!

  """This field represents the user who created the credential."""
  createdBy: User

  """The ID of the user who created the credential."""
  createdById: UUID!

  """A user-friendly name assigned to the credential."""
  name: String!

  """The ID of the organization the credential belongs to."""
  organizationId: UUID!
}

type CreditDeposit {
  cost: Float!
  createdAt: DateTime!
  credits: Int!
  id: UUID!
  initiatedBy: UUID!
  organization: UUID!
  perCreditCost: Float!
  reason: DepositReason!
}

type Credits {
  balance: Int!
  deposits: [CreditDeposit!]
  id: UUID!
}

"""
A customer record represents a user in your service and is used to group custodial wallets within a specific project. This allows for easy management of wallets and associated assets for a particular customer within your service.
"""
type Customer {
  """
  Returns all the wallet addresses associated with the customer. The blockchain of the address is not included and they are in no particular order. In the future, the blockchain may be indicated with a pattern of {blockchain}:{address}.
  This field returns null when there is no treasury assigned to the customer yet.
  """
  addresses: [String!]

  """The datetime when the customer record was created."""
  createdAt: NaiveDateTime!

  """The unique identifier for the customer record."""
  id: UUID!

  """The NFTs owned by any of the customers' wallets."""
  mints: [CollectionMint!]

  """The ID of the project to which the customer record belongs."""
  projectId: UUID!

  """
  The treasury assigned to the customer, which contains the customer's wallets.
  """
  treasury: Treasury

  """
  An optional datetime indicating the last time the customer record was updated. If the customer record has not been updated, this field will be `null`.
  """
  updatedAt: NaiveDateTime
  wallet(assetId: AssetType): [Wallet!]
}

"""
Implement the DateTime<FixedOffset> scalar

The input/output is a string in RFC3339 format.
"""
scalar DateTime

input DeactivateMemberInput {
  id: UUID!
}

type DeductionTotals {
  action: Action!
  spent: Int!
}

"""The input for deleting a credential."""
input DeleteCredentialInput {
  """The unique identifier assigned to the credential to be deleted."""
  credential: String!
}

"""The response for deleting a credential."""
type DeleteCredentialPayload {
  """The unique identifier assigned to the deleted credential."""
  credential: String!
}

input DeleteWebhookInput {
  webhook: UUID!
}

type DeleteWebhookPayload {
  webhook: UUID!
}

enum DepositReason {
  GIFTED
  PURCHASED
}

type Drop {
  """The collection for which the drop is managing mints."""
  collection: Collection!

  """The date and time in UTC when the drop was created."""
  createdAt: DateTime!

  """The user id of the person who created the drop."""
  createdById: UUID!

  """The creation status of the drop."""
  creationStatus: CreationStatus!

  """
  The end date and time in UTC for the drop. A value of `null` means the drop does not end until it is fully minted.
  """
  endTime: DateTime

  """The unique identifier for the drop."""
  id: UUID!
  pausedAt: DateTime

  """
  The cost to mint the drop in US dollars. When purchasing with crypto the user will be charged at the current conversion rate for the blockchain's native coin at the time of minting.
  """
  price: Int!

  """The identifier of the project to which the drop is associated."""
  projectId: UUID!

  """A list of all NFT purchases from this drop."""
  purchases: [Purchase!]

  """
  The shutdown_at field represents the date and time in UTC when the drop was shutdown
  If it is null, the drop is currently not shutdown
  """
  shutdownAt: DateTime

  """
  The date and time in UTC when the drop is eligible for minting. A value of `null` means the drop can be minted immediately.
  """
  startTime: DateTime

  """The current status of the drop."""
  status: DropStatus!
}

"""The different phases of a drop."""
enum DropStatus {
  """The drop is still being created and is not ready to mint."""
  CREATING

  """The drop has expired and its end time has passed."""
  EXPIRED

  """The creation process for the drop has failed"""
  FAILED

  """The minting process for the collection is complete."""
  MINTED

  """Actively minting."""
  MINTING

  """The drop is temporarily paused and cannot be minted at the moment."""
  PAUSED

  """The drop is scheduled for minting."""
  SCHEDULED

  """The drop is permanently shut down and can no longer be minted."""
  SHUTDOWN
}

"""
The input for editing the name of an existing credential by providing the `client_id` of the credential and the new `name` to be assigned.
"""
input EditCredentialInput {
  """A unique string identifier assigned to the credential during creation."""
  clientId: String!

  """The new name to be assigned to the credential."""
  name: String!
}

"""The response for editing the name of a credential."""
type EditCredentialPayload {
  """The updated credential with the edited name."""
  credential: Credential!
}

input EditOrganizationInput {
  id: UUID!
  name: String!
  profileImageUrl: String
}

type EditOrganizationPayload {
  organization: Organization!
}

input EditProjectInput {
  id: UUID!
  name: String!
  profileImageUrl: String
}

type EditProjectPayload {
  project: Project!
}

input EditWebhookInput {
  description: String!
  disabled: Boolean
  filterTypes: [FilterType!]!
  projects: [UUID!]!
  url: String!
  webhook: UUID!
}

type EditWebhookPayload {
  webhook: Webhook!
}

"""An event to which an external service can subscribe."""
type EventType {
  """Whether the event is archived or not."""
  archived: Boolean

  """The date and time when the event was created, in string format."""
  createdAt: String!

  """A description of the event."""
  description: String!

  """The name of the event."""
  name: String!

  """The JSON schema for the event payload."""
  schemas: JSON!

  """The date and time when the event was last updated, in string format."""
  updatedAt: String!
}

"""An enumeration of event types that can be subscribed to by a webhook."""
enum FilterType {
  """Event triggered when a new customer is created"""
  CUSTOMER_CREATED

  """Event triggered when a new customer treasury is created"""
  CUSTOMER_TREASURY_CREATED

  """Event triggered when a new wallet is created for a customer"""
  CUSTOMER_WALLET_CREATED

  """Event triggered when a new drop is created"""
  DROP_CREATED

  """Event triggered when a new drop is minted"""
  DROP_MINTED

  """Event triggered when a mint has been successfully transfered"""
  MINT_TRANSFERED

  """Event triggered when a new project is created"""
  PROJECT_CREATED

  """Event triggered when a new wallet is created for a project"""
  PROJECT_WALLET_CREATED
}

"""The holder of a collection."""
type Holder {
  """The wallet address of the holder."""
  address: String!

  """The collection ID that the holder owns."""
  collectionId: UUID!

  """The specific mints from the collection that the holder owns."""
  mints: [UUID!]!

  """The number of NFTs that the holder owns in the collection."""
  owns: Int!
}

"""An invitation sent to join a Holaplex organization."""
type Invite {
  """
  The datetime, in UTC, when the invitation to join the organization was created.
  """
  createdAt: DateTime!

  """The ID of the user who created the invitation."""
  createdBy: UUID!

  """
  The email address of the user being invited to become a member of the organization.
  """
  email: String!

  """The ID of the invitation."""
  id: UUID!

  """
  The member record that is generated after the invitation to join the organization is accepted. When the user has not accepted the invitation, this field returns `null`.
  """
  member: Member

  """The organization to which the invitation to join belongs."""
  organization: Organization

  """The ID of the organization to which the invitation belongs."""
  organizationId: UUID!

  """The status of the invitation."""
  status: InviteStatus!

  """The datetime, in UTC, when the invitation status was updated."""
  updatedAt: DateTime
}

"""Input required for inviting a member to the organization."""
input InviteMemberInput {
  """The email address of the invited user."""
  email: String!

  """The ID of the organization."""
  organization: UUID!
}

"""The status of a member invitation."""
enum InviteStatus {
  """The member invitation has been accepted by the invited user."""
  ACCEPTED

  """
  The member invitation has been revoked by an existing member of the organization and is no longer valid.
  """
  REVOKED

  """The member invitation has been sent to the invited user."""
  SENT
}

"""A scalar that can represent any JSON value."""
scalar JSON

"""
A member of a Holaplex organization, representing an individual who has been granted access to the organization.
"""
type Member {
  """The datetime, in UTC, when the member joined the organization."""
  createdAt: DateTime!

  """
  The datetime, in UTC, when the member was deactivated from the organization.
  """
  deactivatedAt: DateTime

  """The unique identifier of the member."""
  id: UUID!

  """
  The invitation to join the Holaplex organization that the member accepted in order to gain access to the organization.
  """
  invite: Invite

  """
  The ID of the invitation that the member accepted to join the organization.
  """
  inviteId: UUID!

  """
  The Holaplex organization to which the member belongs, representing an individual who has been granted access to the organization.
  """
  organization: Organization

  """
  The ID of the Holaplex organization to which the user has been granted access.
  """
  organizationId: UUID!

  """
  The datetime, in UTC, when the member was revoked from the organization.
  """
  revokedAt: DateTime

  """The user identity who is a member of the organization."""
  user: User

  """
  The ID of the user who has been granted access to the Holaplex organization as a member.
  """
  userId: UUID!
}

"""
The collection's associated metadata JSON.
## References
[Metaplex v1.1.0 Standard](https://docs.metaplex.com/programs/token-metadata/token-standard)
"""
type MetadataJson {
  """An optional animated version of the NFT art."""
  animationUrl: String
  attributes: [MetadataJsonAttribute!]

  """The description of the NFT."""
  description: String!

  """
  An optional URL where viewers can find more information on the NFT, such as the collection's homepage or Twitter page.
  """
  externalUrl: String
  id: UUID!
  identifier: String!
  image: String

  """The image URI for the NFT."""
  imageOriginal: String!

  """The assigned name of the NFT."""
  name: String!

  """The symbol of the NFT."""
  symbol: String!

  """The URI for the complete metadata JSON."""
  uri: String!
}

"""An attribute of the NFT."""
type MetadataJsonAttribute {
  id: UUID!
  metadataJsonId: UUID!

  """The name of the attribute."""
  traitType: String!

  """The value of the attribute."""
  value: String!
}

input MetadataJsonAttributeInput {
  traitType: String!
  value: String!
}

input MetadataJsonCollectionInput {
  family: String
  name: String
}

input MetadataJsonFileInput {
  fileType: String
  uri: String
}

input MetadataJsonInput {
  animationUrl: String
  attributes: [MetadataJsonAttributeInput!]!
  collection: MetadataJsonCollectionInput
  description: String!
  externalUrl: String
  image: String!
  name: String!
  properties: MetadataJsonPropertyInput
  symbol: String!
}

input MetadataJsonPropertyInput {
  category: String
  files: [MetadataJsonFileInput!]
}

"""
Represents input data for `mint_edition` mutation with a UUID and recipient as fields
"""
input MintDropInput {
  drop: UUID!
  recipient: String!
}

"""Represents payload data for the `mint_edition` mutation"""
type MintEditionPayload {
  collectionMint: CollectionMint!
}

type Mutation {
  """
  Accept an invite to the organization.
  # Error
  This mutation will produce an error if it is unable to connect to the database or if the user's email does not match the invitation.
  """
  acceptInvite(input: AcceptInviteInput!): AcceptInvitePayload!

  """
  Create an API credential to authenticate and authorize API requests to the Holaplex Hub.
  """
  createCredential(input: CreateCredentialInput!): CreateCredentialPayload!

  """
  This mutation creates a customer record and a corresponding treasury that holds custodial wallets on behalf of a user. The treasury serves as a way to group the customer's wallets together. This makes it easier to manage wallets and associated assets for the user within a specific project. The customer and treasury are associated with the specified project ID. The response includes the newly created customer record. If there is an error connecting to the database or unable to emit a customer created event, the mutation will fail and an error will be returned.
  """
  createCustomer(input: CreateCustomerInput!): CreateCustomerPayload!

  """
  Create a wallet for a customer and assign it to the customer's treasury account.
  
  # Errors
  The mutation will result in an error if it is unable to interact with the database or communicate with Fireblocks.
  """
  createCustomerWallet(input: CreateCustomerWalletInput!): CreateCustomerWalletPayload!

  """
  This mutation creates a new NFT drop and its associated collection. The drop returns immediately with a creation status of CREATING. You can [set up a webhook](https://docs.holaplex.dev/hub/For%20Developers/webhooks-overview) to receive a notification when the drop is ready to be minted.
  Error
  If the drop cannot be saved to the database or fails to be emitted for submission to the desired blockchain, the mutation will result in an error.
  """
  createDrop(input: CreateDropInput!): CreateDropPayload!

  """
  This mutation creates a new Holaplex organization, with the user triggering the mutation automatically assigned as the owner of the organization.
  # Errors
  This mutation produces an error if it is unable to connect to the database, emit the organization creation event, or if the user is not set in the X-USER-ID header.
  """
  createOrganization(input: CreateOrganizationInput!): CreateOrganizationPayload!

  """
  This mutation creates a new project under the specified organization.
  
  # Errors
  This mutation produces an error if it is unable to connect to the database, emit the project creation event, or if the user is not set in the X-USER-ID header.
  """
  createProject(input: CreateProjectInput!): CreateProjectPayload!

  """
  Res
  
  # Errors
  This function fails if ...
  """
  createWebhook(input: CreateWebhookInput!): CreateWebhookPayload!

  """
  Returns member object on success
  
  # Errors
  This code may result in an error if the update to the database fails or if it fails to produce an event.
  """
  deactivateMember(input: DeactivateMemberInput!): Member!

  """Delete the OAuth2 API credential."""
  deleteCredential(input: DeleteCredentialInput!): DeleteCredentialPayload!

  """
  Res
  
  # Errors
  This function fails if ...
  """
  deleteWebhook(input: DeleteWebhookInput!): DeleteWebhookPayload!

  """Edit the name assigned to the API credential."""
  editCredential(input: EditCredentialInput!): EditCredentialPayload!

  """This mutation edits the name or profile image of the organization."""
  editOrganization(input: EditOrganizationInput!): EditOrganizationPayload!

  """This mutations edits the name and profile image of the project."""
  editProject(input: EditProjectInput!): EditProjectPayload!

  """
  Res
  
  # Errors
  This function fails if ...
  """
  editWebhook(input: EditWebhookInput!): EditWebhookPayload!

  """
  To invite a person to the organization, provide their email address.
  # Error
  This mutation will produce an error if it is unable to connect to the database or if there is no associated user set in the X-USER-ID header.
  """
  inviteMember(input: InviteMemberInput!): Invite!
  mint: CollectionMint

  """
  This mutation mints an NFT edition for a specific drop ID. The mint returns immediately with a creation status of CREATING. You can [set up a webhook](https://docs.holaplex.dev/hub/For%20Developers/webhooks-overview) to receive a notification when the mint is accepted by the blockchain.
  # Errors
  If the mint cannot be saved to the database or fails to be emitted for submission to the desired blockchain, the mutation will result in an error.
  """
  mintEdition(input: MintDropInput!): MintEditionPayload!

  """
  This mutation allows updating a drop and it's associated collection by ID.
  It returns an error if it fails to reach the database, emit update events or assemble the on-chain transaction.
  Returns the `PatchDropPayload` object on success.
  """
  patchDrop(input: PatchDropInput!): PatchDropPayload!

  """
  This mutation allows for the temporary blocking of the minting of editions and can be resumed by calling the resumeDrop mutation.
  """
  pauseDrop(input: PauseDropInput!): PauseDropPayload!

  """
  Returns member object on success
  
  # Errors
  This code may result in an error if the update to the database fails or if it fails to produce an event.
  """
  reactivateMember(input: ReactivateMemberInput!): Member!

  """
  This mutation resumes a paused drop, allowing minting of editions to be restored
  """
  resumeDrop(input: ResumeDropInput!): ResumeDropPayload!

  """
  This mutation retries an existing drop.
  The drop returns immediately with a creation status of CREATING.
  You can [set up a webhook](https://docs.holaplex.dev/hub/For%20Developers/webhooks-overview) to receive a notification when the drop is ready to be minted.
  Errors
  The mutation will fail if the drop and its related collection cannot be located,
  if the transaction response cannot be built,
  or if the transaction event cannot be emitted.
  """
  retryDrop(input: RetryDropInput!): CreateDropPayload!

  """
  This mutation retries a mint which failed or is in pending state. The mint returns immediately with a creation status of CREATING. You can [set up a webhook](https://docs.holaplex.dev/hub/For%20Developers/webhooks-overview) to receive a notification when the mint is accepted by the blockchain.
  # Errors
  If the mint cannot be saved to the database or fails to be emitted for submission to the desired blockchain, the mutation will result in an error.
  """
  retryMint(input: RetryMintInput!): RetryMintPayload!

  """
  Shuts down a drop by writing the current UTC timestamp to the shutdown_at field of drop record.
  Returns the `Drop` object on success.
  
  # Errors
  Fails if the drop or collection is not found, or if updating the drop record fails.
  """
  shutdownDrop(input: ShutdownDropInput!): ShutdownDropPayload!

  """
  Transfers an asset from one user to another on a supported blockchain network.
  
  # Arguments
  
  * `self` - A reference to the current instance of the struct.
  * `ctx` - A context object containing application context data.
  * `input` - A TransferAssetInput struct containing the input data for the asset transfer.
  
  # Returns
  
  Returns a Result containing a TransferAssetPayload struct with the updated mint information upon success.
  
  # Errors
  This function returns an error :
  If the specified blockchain is not currently supported.
  If the specified mint does not exist.
  If there is an error while making a transfer request to the Solana blockchain.
  If there is an error while sending the TransferAsset event to the event producer.
  """
  transferAsset(input: TransferAssetInput!): TransferAssetPayload!
  transferMint(id: String!, wallet: String!): CollectionMint
}

"""
ISO 8601 combined date and time without timezone.

# Examples

* `2015-07-01T08:59:60.123`,
"""
scalar NaiveDateTime

"""
A Holaplex organization is the top-level account within the Holaplex ecosystem. Each organization has a single owner who can invite members to join. Organizations use projects to organize NFT campaigns or initiatives.
"""
type Organization {
  """
  The datetime, in UTC, when the Holaplex organization was created by its owner.
  """
  createdAt: DateTime!

  """
  Get a single API credential by client ID.
  
  # Arguments
  
  * `ctx` - The GraphQL context object containing the database connection pool and other data.
  * `client_id` - The client ID of the API credential to retrieve.
  
  # Returns
  
  The API credential with the specified client ID.
  """
  credential(clientId: String!): Credential!

  """
  Get a list of API credentials associated with this organization.
  
  # Arguments
  
  * `ctx` - The GraphQL context object containing the database connection pool and other data.
  * `limit` - Optional limit on the number of credentials to retrieve.
  * `offset` - Optional offset for the credentials to retrieve.
  
  # Returns
  
  A list of API credentials associated with this organization.
  """
  credentials(limit: Int, offset: Int): [Credential!]!

  """
  Define an asynchronous function to load the credits for the organization
  Returns `Credits` object
  #Errors
  returns error if credits_loader is not found in the context or if the loader fails to load the credits
  """
  credits: Credits

  """
  The datetime, in UTC, when the Holaplex organization was deactivated by its owner.
  """
  deactivatedAt: DateTime

  """
  Define an asynchronous function to load the total credits deducted for each action
  Returns `DeductionTotals` object
  #Errors
  returns error if total_deductions_loader is not found in the context or if the loader fails to load the total deductions
  """
  deductionTotals: [DeductionTotals!]

  """
  The unique identifier assigned to the Holaplex organization, which is used to distinguish it from other organizations within the Holaplex ecosystem.
  """
  id: UUID!

  """
  The invitations to join the Holaplex organization that have been sent to email addresses and are either awaiting or have been accepted by the recipients.
  """
  invites(status: InviteStatus): [Invite!]!

  """
  The members who have been granted access to the Holaplex organization, represented by individuals who have been invited and accepted the invitation to join the organization.
  """
  members: [Member!]

  """
  The name given to the Holaplex organization, which is used to identify it within the Holaplex ecosystem and to its members and users.
  """
  name: String!

  """
  The owner of the Holaplex organization, who has created the organization and has full control over its settings and members.
  """
  owner: Owner
  profileImageUrl: String

  """
  The optional profile image associated with the Holaplex organization, which can be used to visually represent the organization.
  """
  profileImageUrlOriginal: String

  """
  The projects that have been created and are currently associated with the Holaplex organization, which are used to organize NFT campaigns or initiatives within the organization.
  """
  projects: [Project!]!

  """
  Retrieves a specific webhook associated with the organization, based on its ID.
  
  # Arguments
  
  * `ctx` - The context object representing the current request.
  * `id` - The UUID of the Webhook to retrieve.
  
  # Returns
  
  The specified Webhook object, or None if it does not exist.
  
  # Errors
  
  This function will return an error if the data context cannot be retrieved.
  """
  webhook(id: UUID!): Webhook

  """
  Retrieves a list of all webhooks associated with the organization.
  
  # Arguments
  
  * `ctx` - The context object representing the current request.
  
  # Returns
  
  A vector of all Webhook objects associated with the Organization, or None if there are none.
  
  # Errors
  
  This function will return an error if the data context cannot be retrieved.
  """
  webhooks: [Webhook!]
}

"""
The owner of the Holaplex organization, who is the individual that created the organization.
"""
type Owner {
  """The datetime, in UTC, when the organization was created."""
  createdAt: DateTime!

  """
  The unique identifier assigned to the record of the user who created the Holaplex organization and serves as its owner, which is used to distinguish their record from other records within the Holaplex ecosystem.
  """
  id: UUID!

  """The Holaplex organization owned by the user."""
  organization: Organization

  """
  The ID assigned to the Holaplex organization owned by the user, which is used to distinguish it from other organizations within the Holaplex ecosystem."
  """
  organizationId: UUID!

  """The user identity associated with the owner of the organization."""
  user: User

  """
  The ID of the user who created the Holaplex organization and serves as its owner.
  """
  userId: UUID!
}

"""Input object for patching a drop and associated collection by ID"""
input PatchDropInput {
  """The creators of the drop"""
  creators: [CollectionCreatorInput!]

  """The new end time for the drop in UTC"""
  endTime: DateTime

  """The unique identifier of the drop"""
  id: UUID!

  """The new metadata JSON for the drop"""
  metadataJson: MetadataJsonInput

  """The new price for the drop in the native token of the blockchain"""
  price: Int

  """The new seller fee basis points for the drop"""
  sellerFeeBasisPoints: Int

  """The new start time for the drop in UTC"""
  startTime: DateTime
}

"""Represents the result of a successful patch drop mutation."""
type PatchDropPayload {
  """The drop that has been patched."""
  drop: Drop!
}

"""Represents input fields for pausing a drop."""
input PauseDropInput {
  drop: UUID!
}

"""Represents the result of a successful pause drop mutation."""
type PauseDropPayload {
  """The drop that has been paused."""
  drop: Drop!
}

"""
A Holaplex project that belongs to an organization. Projects are used to group unique NFT campaigns or initiatives, and are used to assign objects that end customers will interact with, such as drops and wallets.
"""
type Project {
  """The datetime, in UTC, when the project was created."""
  createdAt: DateTime!

  """Retrieve a customer record associated with the project, using its ID."""
  customer(id: UUID!): Customer

  """Retrieve all customer records associated with a given project."""
  customers: [Customer!]

  """
  The date and time in Coordinated Universal Time (UTC) when the Holaplex project was created. Once a project is deactivated, objects that were assigned to the project can no longer be interacted with.
  """
  deactivatedAt: DateTime

  """Look up a drop associated with the project by its ID."""
  drop(id: UUID!): Drop

  """The drops associated with the project."""
  drops: [Drop!]

  """The unique identifier assigned to the Holaplex project."""
  id: UUID!

  """
  The friendly name assigned to the Holaplex project to differentiate it from other projects belonging to the organization.
  """
  name: String!
  organization: Organization

  """The ID of the Holaplex organization to which the project belongs."""
  organizationId: UUID!
  profileImageUrl: String

  """
  The optional profile image associated with the project, which can be used to visually represent the project.
  """
  profileImageUrlOriginal: String

  """
  The treasury assigned to the project, which contains the project's wallets.
  """
  treasury: Treasury
}

"""Represents the purchase of an NFT."""
type Purchase {
  """The date and time when the purchase was created."""
  createdAt: DateTime!

  """The ID of the drop that facilitated the purchase, if any."""
  dropId: UUID

  """The ID of the purchase."""
  id: UUID!

  """The ID of the NFT being purchased."""
  mintId: UUID!

  """The amount spent on the purchase."""
  spent: Int!

  """The status of the creation of the NFT."""
  status: CreationStatus!

  """The signature of the transaction, if any."""
  txSignature: String

  """The wallet address of the buyer."""
  wallet: String!
}

type Query {
  collections: [CollectionMint]

  """
  Returns a list of `ActionCost` which represents the cost of each action on different blockchains.
  
  # Errors
  This function fails if it fails to get `CreditsClient` or if blockchain enum conversion fails.
  """
  creditSheet: [ActionCost!]!
  drop: Drop

  """
  Returns a list of event types that an external service can subscribe to.
  
  # Returns
  
  A vector of EventType objects representing the different event types that can be subscribed to.
  
  # Errors
  
  This function returns an error if there was a problem with retrieving the event types.
  """
  eventTypes: [EventType!]!

  """Retrieve a member invitation by its ID."""
  invite(id: UUID!): Invite
  me: User

  """
  Query an organization by its ID, this query returns `null` if the organization does not exist.
  """
  organization(id: UUID!): Organization

  """
  Query a project by it's ID, this query returns `null` if the project does not exist.
  """
  project(id: UUID!): Project

  """Retrieve a user identity by providing their ID."""
  user(id: UUID!): User
}

input ReactivateMemberInput {
  id: UUID!
}

"""Represents input fields for resuming a paused drop."""
input ResumeDropInput {
  drop: UUID!
}

"""Represents the result of a successful resume drop mutation."""
type ResumeDropPayload {
  """The drop that has been resumed."""
  drop: Drop!
}

input RetryDropInput {
  drop: UUID!
}

"""
Represents input data for `retry_mint` mutation with an ID as a field of type UUID
"""
input RetryMintInput {
  id: UUID!
}

"""Represents payload data for `retry_mint` mutation"""
type RetryMintPayload {
  collectionMint: CollectionMint!
}

"""Represents the input fields for shutting down a drop"""
input ShutdownDropInput {
  drop: UUID!
}

"""Represents the result of a successful shutdown drop mutation"""
type ShutdownDropPayload {
  """Drop that has been shutdown"""
  drop: Drop!
}

input TransferAssetInput {
  id: UUID!
  recipient: String!
}

type TransferAssetPayload {
  mint: CollectionMint!
}

"""
A collection of wallets assigned to different entities in the Holaplex ecosystem.
"""
type Treasury {
  """The creation DateTimeWithTimeZone of the vault."""
  createdAt: DateTime!

  """The unique identifier for the treasury."""
  id: UUID!

  """
  The associated Fireblocks vault ID.
  ## Reference
  [Vault Objects](https://docs.fireblocks.com/api/#vault-objects)
  """
  vaultId: String!

  """Lookup a wallet based on its `asset_type`."""
  wallet(assetType: AssetType!): Wallet

  """The treasury's associated wallets."""
  wallets: [Wallet!]
}

"""
A UUID is a unique 128-bit number, stored as 16 octets. UUIDs are parsed as
Strings within GraphQL. UUIDs are used to assign unique identifiers to
entities without requiring a central allocating authority.

# References

* [Wikipedia: Universally Unique Identifier](http://en.wikipedia.org/wiki/Universally_unique_identifier)
* [RFC4122: A Universally Unique IDentifier (UUID) URN Namespace](http://tools.ietf.org/html/rfc4122)
"""
scalar UUID

"""
A unique user identity across the entire Holaplex ecosystem. A user can be associated with multiple organizations, but they are not required to have separate login credentials.
"""
type User {
  affiliations: [Affiliation!]!

  """The timestamp in UTC when the user identity was created."""
  createdAt: String!

  """The email address associated with the user identity."""
  email: String!

  """The first name of the user identity."""
  firstName: String!

  """The unique identifier for the user identity."""
  id: UUID!
  image: String

  """The last name of the user identity."""
  lastName: String!
  name: String

  """The profile image associated with the user identity."""
  profileImage: String

  """The timestamp in UTC when the user identity was last updated."""
  updatedAt: String!
  wallet: Wallet
}

"""
A blockchain wallet is a digital wallet that allows users to securely store, manage, and transfer their cryptocurrencies or other digital assets on a blockchain network.
"""
type Wallet {
  """The wallet address."""
  address: String

  """The wallet's associated blockchain."""
  assetId: AssetType!
  createdAt: DateTime!
  createdBy: UUID!
  deductionId: UUID
  id: UUID!

  """
  The NFTs that were minted from Holaplex and are owned by the wallet's address.
  """
  mints: [CollectionMint!]
  removedAt: DateTime
  treasuryId: UUID!
}

"""
A webhook represents an endpoint registered to receive notifications for specific events within a project.
"""
type Webhook {
  """Retrieves the channels the webhook is subscribed to."""
  channels: [String!]!

  """Retrieves the creation datetime of the webhook."""
  createdAt: NaiveDateTime!

  """The user who created the webhook."""
  createdBy: User

  """Retrieves the ID of the user who created the webhook."""
  createdById: UUID!

  """Retrieves the webhook's description."""
  description: String!

  """Retrieves the ID of the webhook's endpoint."""
  endpointId: String!

  """Retrieves the events the webhook is subscribed to."""
  events: [FilterType!]!

  """Retrieves the ID of the webhook."""
  id: UUID!

  """Retrieves the ID of the organization the webhook belongs to."""
  organizationId: UUID!

  """
  This field specifies the list of projects for which an associated object will trigger a webhook event.
  """
  projects: [Project!]!

  """Retrieves the last update datetime of the webhook."""
  updatedAt: NaiveDateTime

  """Retrieves the URL of the webhook's endpoint."""
  url: String!
}