Merge pull request #59 from holaplex/espi/docs-update-mint

Generate api docs after adding update mint mutation
holaplex · Aug 28, 2023 · d9d3fd5 · d9d3fd5
2 parents 3eecc38 + 9d94ee7
commit d9d3fd5
Show file tree

Hide file tree

Showing 29 changed files with 643 additions and 15 deletions.
diff --git a/docs/api/enums/action.mdx b/docs/api/enums/action.mdx
@@ -29,6 +29,7 @@ enum Action {
   RETRY_COLLECTION
   MINT
   MINT_COMPRESSED
+  UPDATE_MINT
 }
 ```
 
@@ -75,6 +76,10 @@ enum Action {
 > 
 > 
 
+#### [<code style={{ fontWeight: 'normal' }}>Action.<b>UPDATE_MINT</b></code>](#) 
+> 
+> 
+
 
 
 ### Member of

diff --git a/docs/api/enums/creation-status.mdx b/docs/api/enums/creation-status.mdx
@@ -59,7 +59,7 @@ enum CreationStatus {
 
 ### Member of
 
-[`Collection`](/api/objects/collection)  <Badge class="secondary" text="object"/><Bullet />[`CollectionMint`](/api/objects/collection-mint)  <Badge class="secondary" text="object"/><Bullet />[`Drop`](/api/objects/drop)  <Badge class="secondary" text="object"/><Bullet />[`ImportCollectionPayload`](/api/objects/import-collection-payload)  <Badge class="secondary" text="object"/><Bullet />[`MintHistory`](/api/objects/mint-history)  <Badge class="secondary" text="object"/>
+[`Collection`](/api/objects/collection)  <Badge class="secondary" text="object"/><Bullet />[`CollectionMint`](/api/objects/collection-mint)  <Badge class="secondary" text="object"/><Bullet />[`Drop`](/api/objects/drop)  <Badge class="secondary" text="object"/><Bullet />[`ImportCollectionPayload`](/api/objects/import-collection-payload)  <Badge class="secondary" text="object"/><Bullet />[`MintHistory`](/api/objects/mint-history)  <Badge class="secondary" text="object"/><Bullet />[`RetryUpdateMintPayload`](/api/objects/retry-update-mint-payload)  <Badge class="secondary" text="object"/><Bullet />[`UpdateHistory`](/api/objects/update-history)  <Badge class="secondary" text="object"/>
 
 
 
diff --git a/docs/api/inputs/creator-input.mdx b/docs/api/inputs/creator-input.mdx
@@ -46,7 +46,7 @@ input CreatorInput {
 
 ### Member of
 
-[`CreateCollectionInput`](/api/inputs/create-collection-input)  <Badge class="secondary" text="input"/><Bullet />[`CreateDropInput`](/api/inputs/create-drop-input)  <Badge class="secondary" text="input"/><Bullet />[`MintToCollectionInput`](/api/inputs/mint-to-collection-input)  <Badge class="secondary" text="input"/><Bullet />[`PatchCollectionInput`](/api/inputs/patch-collection-input)  <Badge class="secondary" text="input"/><Bullet />[`PatchDropInput`](/api/inputs/patch-drop-input)  <Badge class="secondary" text="input"/>
+[`CreateCollectionInput`](/api/inputs/create-collection-input)  <Badge class="secondary" text="input"/><Bullet />[`CreateDropInput`](/api/inputs/create-drop-input)  <Badge class="secondary" text="input"/><Bullet />[`MintToCollectionInput`](/api/inputs/mint-to-collection-input)  <Badge class="secondary" text="input"/><Bullet />[`PatchCollectionInput`](/api/inputs/patch-collection-input)  <Badge class="secondary" text="input"/><Bullet />[`PatchDropInput`](/api/inputs/patch-drop-input)  <Badge class="secondary" text="input"/><Bullet />[`UpdateMintInput`](/api/inputs/update-mint-input)  <Badge class="secondary" text="input"/>
 
 
 
diff --git a/docs/api/inputs/metadata-json-input.mdx b/docs/api/inputs/metadata-json-input.mdx
@@ -74,7 +74,7 @@ input MetadataJsonInput {
 
 ### Member of
 
-[`CreateCollectionInput`](/api/inputs/create-collection-input)  <Badge class="secondary" text="input"/><Bullet />[`CreateDropInput`](/api/inputs/create-drop-input)  <Badge class="secondary" text="input"/><Bullet />[`MintToCollectionInput`](/api/inputs/mint-to-collection-input)  <Badge class="secondary" text="input"/><Bullet />[`PatchCollectionInput`](/api/inputs/patch-collection-input)  <Badge class="secondary" text="input"/><Bullet />[`PatchDropInput`](/api/inputs/patch-drop-input)  <Badge class="secondary" text="input"/>
+[`CreateCollectionInput`](/api/inputs/create-collection-input)  <Badge class="secondary" text="input"/><Bullet />[`CreateDropInput`](/api/inputs/create-drop-input)  <Badge class="secondary" text="input"/><Bullet />[`MintToCollectionInput`](/api/inputs/mint-to-collection-input)  <Badge class="secondary" text="input"/><Bullet />[`PatchCollectionInput`](/api/inputs/patch-collection-input)  <Badge class="secondary" text="input"/><Bullet />[`PatchDropInput`](/api/inputs/patch-drop-input)  <Badge class="secondary" text="input"/><Bullet />[`UpdateMintInput`](/api/inputs/update-mint-input)  <Badge class="secondary" text="input"/>
 
 
 
diff --git a/docs/api/inputs/retry-update-mint-input.mdx b/docs/api/inputs/retry-update-mint-input.mdx
@@ -0,0 +1,40 @@
+---
+id: retry-update-mint-input
+title: RetryUpdateMintInput
+hide_table_of_contents: true
+pagination_next: null
+pagination_prev: null
+---
+
+
+
+export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}>&nbsp;●&nbsp;</span></>
+
+export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></>
+
+export const Badge = (props) => <><span className={'badge badge--' + props.class}>{props.text}</span></>
+
+
+No description
+
+```graphql
+input RetryUpdateMintInput {
+  revisionId: UUID!
+}
+```
+
+
+### Fields
+
+#### [<code style={{ fontWeight: 'normal' }}>RetryUpdateMintInput.<b>revisionId</b></code>](#)<Bullet />[`UUID!`](/api/scalars/uuid) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
+> Update History ID
+> 
+
+
+
+### Member of
+
+[`retryUpdateMint`](/api/mutations/retry-update-mint)  <Badge class="secondary" text="mutation"/>
+
+
+
diff --git a/docs/api/inputs/update-mint-input.mdx b/docs/api/inputs/update-mint-input.mdx
@@ -0,0 +1,57 @@
+---
+id: update-mint-input
+title: UpdateMintInput
+hide_table_of_contents: true
+pagination_next: null
+pagination_prev: null
+---
+
+
+
+export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}>&nbsp;●&nbsp;</span></>
+
+export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></>
+
+export const Badge = (props) => <><span className={'badge badge--' + props.class}>{props.text}</span></>
+
+
+No description
+
+```graphql
+input UpdateMintInput {
+  id: UUID!
+  metadataJson: MetadataJsonInput!
+  sellerFeeBasisPoints: Int
+  creators: [CreatorInput!]!
+}
+```
+
+
+### Fields
+
+#### [<code style={{ fontWeight: 'normal' }}>UpdateMintInput.<b>id</b></code>](#)<Bullet />[`UUID!`](/api/scalars/uuid) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
+> The ID of the mint to be updated
+> 
+
+#### [<code style={{ fontWeight: 'normal' }}>UpdateMintInput.<b>metadataJson</b></code>](#)<Bullet />[`MetadataJsonInput!`](/api/inputs/metadata-json-input) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="input"/>
+> The metadata of the mint
+> 
+
+#### [<code style={{ fontWeight: 'normal' }}>UpdateMintInput.<b>sellerFeeBasisPoints</b></code>](#)<Bullet />[`Int`](/api/scalars/int) <Badge class="secondary" text="scalar"/>
+> The optional seller fee basis points
+> 
+
+#### [<code style={{ fontWeight: 'normal' }}>UpdateMintInput.<b>creators</b></code>](#)<Bullet />[`[CreatorInput!]!`](/api/inputs/creator-input) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="input"/>
+> The creators to be assigned to the NFT.
+For Solana, this can be up to five creators. If the project treasury wallet is set as a creator and verified set to true the creator will be verified on chain.
+For Polygon, this can be only 1 creator.
+> 
+
+
+
+### Member of
+
+[`updateMint`](/api/mutations/update-mint)  <Badge class="secondary" text="mutation"/>
+
+
+
diff --git a/docs/api/mutations/retry-update-mint.mdx b/docs/api/mutations/retry-update-mint.mdx
@@ -0,0 +1,44 @@
+---
+id: retry-update-mint
+title: retryUpdateMint
+hide_table_of_contents: true
+pagination_next: null
+pagination_prev: null
+---
+
+
+
+export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}>&nbsp;●&nbsp;</span></>
+
+export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></>
+
+export const Badge = (props) => <><span className={'badge badge--' + props.class}>{props.text}</span></>
+
+
+This mutation retries updating a mint that failed by providing the ID of the `update_history`.
+# 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.
+
+```graphql
+retryUpdateMint(
+  input: RetryUpdateMintInput!
+): RetryUpdateMintPayload!
+```
+
+
+### Arguments
+
+#### [<code style={{ fontWeight: 'normal' }}>retryUpdateMint.<b>input</b></code>](#)<Bullet />[`RetryUpdateMintInput!`](/api/inputs/retry-update-mint-input) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="input"/>
+> 
+> 
+
+### Type
+
+#### [`RetryUpdateMintPayload`](/api/objects/retry-update-mint-payload) <Badge class="secondary" text="object"/>
+> 
+> 
+
+
+
+
+
diff --git a/docs/api/mutations/update-mint.mdx b/docs/api/mutations/update-mint.mdx
@@ -0,0 +1,44 @@
+---
+id: update-mint
+title: updateMint
+hide_table_of_contents: true
+pagination_next: null
+pagination_prev: null
+---
+
+
+
+export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}>&nbsp;●&nbsp;</span></>
+
+export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></>
+
+export const Badge = (props) => <><span className={'badge badge--' + props.class}>{props.text}</span></>
+
+
+This mutation updates a mint.
+# 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.
+
+```graphql
+updateMint(
+  input: UpdateMintInput!
+): UpdateMintPayload!
+```
+
+
+### Arguments
+
+#### [<code style={{ fontWeight: 'normal' }}>updateMint.<b>input</b></code>](#)<Bullet />[`UpdateMintInput!`](/api/inputs/update-mint-input) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="input"/>
+> 
+> 
+
+### Type
+
+#### [`UpdateMintPayload`](/api/objects/update-mint-payload) <Badge class="secondary" text="object"/>
+> 
+> 
+
+
+
+
+
diff --git a/docs/api/objects/blockchain-cost.mdx b/docs/api/objects/blockchain-cost.mdx
@@ -20,7 +20,7 @@ Represents the cost of performing an action on a specific blockchain
 ```graphql
 type BlockchainCost {
   blockchain: Blockchain!
-  credits: Int!
+  credits: Int
 }
 ```
 
@@ -31,8 +31,8 @@ type BlockchainCost {
 > enum that represents the blockchain on which the action is being performed.
 > 
 
-#### [<code style={{ fontWeight: 'normal' }}>BlockchainCost.<b>credits</b></code>](#)<Bullet />[`Int!`](/api/scalars/int) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
-> represents the cost in credits for performing the action on the blockchain.
+#### [<code style={{ fontWeight: 'normal' }}>BlockchainCost.<b>credits</b></code>](#)<Bullet />[`Int`](/api/scalars/int) <Badge class="secondary" text="scalar"/>
+> represents the cost in credits for performing the action on the blockchain. If nil then the action is not supported on the blockchain.
 > 
 
 

diff --git a/docs/api/objects/collection-mint.mdx b/docs/api/objects/collection-mint.mdx
@@ -33,6 +33,10 @@ type CollectionMint {
   compressed: Boolean!
   collection: Collection
   metadataJson: MetadataJson
+  updateHistories: [UpdateHistory!]
+  creators: [MintCreator!]
+  mintHistory: MintHistory
+  transferHistories: [NftTransfer!]
 }
 ```
 
@@ -98,11 +102,31 @@ On EVM chains it is the concatenation of the contract address and the token id `
 [Metaplex v1.1.0 Standard](https://docs.metaplex.com/programs/token-metadata/token-standard)
 > 
 
+#### [<code style={{ fontWeight: 'normal' }}>CollectionMint.<b>updateHistories</b></code>](#)<Bullet />[`[UpdateHistory!]`](/api/objects/update-history) <Badge class="secondary" text="list"/> <Badge class="secondary" text="object"/>
+> The update history of the mint.
+> 
+
+#### [<code style={{ fontWeight: 'normal' }}>CollectionMint.<b>creators</b></code>](#)<Bullet />[`[MintCreator!]`](/api/objects/mint-creator) <Badge class="secondary" text="list"/> <Badge class="secondary" text="object"/>
+> The creators of the mint. Includes the creator addresses and their shares.
+> 
+
+#### [<code style={{ fontWeight: 'normal' }}>CollectionMint.<b>mintHistory</b></code>](#)<Bullet />[`MintHistory`](/api/objects/mint-history) <Badge class="secondary" text="object"/>
+> The record of the original mint.
+> 
+
+#### [<code style={{ fontWeight: 'normal' }}>CollectionMint.<b>transferHistories</b></code>](#)<Bullet />[`[NftTransfer!]`](/api/objects/nft-transfer) <Badge class="secondary" text="list"/> <Badge class="secondary" text="object"/>
+> The history of transfers for the mint.
+> 
+
+
+
+### Returned by
 
+[`mint`](/api/queries/mint)  <Badge class="secondary" text="query"/>
 
 ### Member of
 
-[`Collection`](/api/objects/collection)  <Badge class="secondary" text="object"/><Bullet />[`Customer`](/api/objects/customer)  <Badge class="secondary" text="object"/><Bullet />[`MintEditionPayload`](/api/objects/mint-edition-payload)  <Badge class="secondary" text="object"/><Bullet />[`MintToCollectionPayload`](/api/objects/mint-to-collection-payload)  <Badge class="secondary" text="object"/><Bullet />[`RetryMintEditionPayload`](/api/objects/retry-mint-edition-payload)  <Badge class="secondary" text="object"/><Bullet />[`TransferAssetPayload`](/api/objects/transfer-asset-payload)  <Badge class="secondary" text="object"/><Bullet />[`Wallet`](/api/objects/wallet)  <Badge class="secondary" text="object"/>
+[`Collection`](/api/objects/collection)  <Badge class="secondary" text="object"/><Bullet />[`Customer`](/api/objects/customer)  <Badge class="secondary" text="object"/><Bullet />[`MintEditionPayload`](/api/objects/mint-edition-payload)  <Badge class="secondary" text="object"/><Bullet />[`MintHistory`](/api/objects/mint-history)  <Badge class="secondary" text="object"/><Bullet />[`MintToCollectionPayload`](/api/objects/mint-to-collection-payload)  <Badge class="secondary" text="object"/><Bullet />[`RetryMintEditionPayload`](/api/objects/retry-mint-edition-payload)  <Badge class="secondary" text="object"/><Bullet />[`TransferAssetPayload`](/api/objects/transfer-asset-payload)  <Badge class="secondary" text="object"/><Bullet />[`UpdateMintPayload`](/api/objects/update-mint-payload)  <Badge class="secondary" text="object"/><Bullet />[`Wallet`](/api/objects/wallet)  <Badge class="secondary" text="object"/>
 
 
 
diff --git a/docs/api/objects/collection.mdx b/docs/api/objects/collection.mdx
@@ -126,6 +126,10 @@ On EVM chains it is the concatenation of the contract address and the token id `
 
 
 
+### Returned by
+
+[`collection`](/api/queries/collection)  <Badge class="secondary" text="query"/>
+
 ### Member of
 
 [`CollectionMint`](/api/objects/collection-mint)  <Badge class="secondary" text="object"/><Bullet />[`CreateCollectionPayload`](/api/objects/create-collection-payload)  <Badge class="secondary" text="object"/><Bullet />[`Drop`](/api/objects/drop)  <Badge class="secondary" text="object"/><Bullet />[`PatchCollectionPayload`](/api/objects/patch-collection-payload)  <Badge class="secondary" text="object"/><Bullet />[`Project`](/api/objects/project)  <Badge class="secondary" text="object"/>

diff --git a/docs/api/objects/customer.mdx b/docs/api/objects/customer.mdx
@@ -25,6 +25,7 @@ type Customer {
   updatedAt: NaiveDateTime
   addresses: [String!]
   mints: [CollectionMint!]
+  mintHistories: [MintHistory!]
   treasury: Treasury
   wallet(
   assetId: AssetType
@@ -60,6 +61,10 @@ This field returns null when there is no treasury assigned to the customer yet.
 > The NFTs owned by any of the customers' wallets.
 > 
 
+#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>mintHistories</b></code>](#)<Bullet />[`[MintHistory!]`](/api/objects/mint-history) <Badge class="secondary" text="list"/> <Badge class="secondary" text="object"/>
+> The NFTs minted by the customer.
+> 
+
 #### [<code style={{ fontWeight: 'normal' }}>Customer.<b>treasury</b></code>](#)<Bullet />[`Treasury`](/api/objects/treasury) <Badge class="secondary" text="object"/>
 > The treasury assigned to the customer, which contains the customer's wallets.
 > 

diff --git a/docs/api/objects/drop.mdx b/docs/api/objects/drop.mdx
@@ -93,6 +93,10 @@ If it is null, the drop is currently not shutdown
 
 
 
+### Returned by
+
+[`drop`](/api/queries/drop)  <Badge class="secondary" text="query"/>
+
 ### Member of
 
 [`Collection`](/api/objects/collection)  <Badge class="secondary" text="object"/><Bullet />[`CreateDropPayload`](/api/objects/create-drop-payload)  <Badge class="secondary" text="object"/><Bullet />[`PatchDropPayload`](/api/objects/patch-drop-payload)  <Badge class="secondary" text="object"/><Bullet />[`PauseDropPayload`](/api/objects/pause-drop-payload)  <Badge class="secondary" text="object"/><Bullet />[`Project`](/api/objects/project)  <Badge class="secondary" text="object"/><Bullet />[`ResumeDropPayload`](/api/objects/resume-drop-payload)  <Badge class="secondary" text="object"/><Bullet />[`ShutdownDropPayload`](/api/objects/shutdown-drop-payload)  <Badge class="secondary" text="object"/>

diff --git a/docs/api/objects/mint-creator.mdx b/docs/api/objects/mint-creator.mdx
@@ -0,0 +1,55 @@
+---
+id: mint-creator
+title: MintCreator
+hide_table_of_contents: true
+pagination_next: null
+pagination_prev: null
+---
+
+
+
+export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}>&nbsp;●&nbsp;</span></>
+
+export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></>
+
+export const Badge = (props) => <><span className={'badge badge--' + props.class}>{props.text}</span></>
+
+
+No description
+
+```graphql
+type MintCreator {
+  collectionMintId: UUID!
+  address: String!
+  verified: Boolean!
+  share: Int!
+}
+```
+
+
+### Fields
+
+#### [<code style={{ fontWeight: 'normal' }}>MintCreator.<b>collectionMintId</b></code>](#)<Bullet />[`UUID!`](/api/scalars/uuid) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
+> 
+> 
+
+#### [<code style={{ fontWeight: 'normal' }}>MintCreator.<b>address</b></code>](#)<Bullet />[`String!`](/api/scalars/string) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
+> 
+> 
+
+#### [<code style={{ fontWeight: 'normal' }}>MintCreator.<b>verified</b></code>](#)<Bullet />[`Boolean!`](/api/scalars/boolean) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
+> 
+> 
+
+#### [<code style={{ fontWeight: 'normal' }}>MintCreator.<b>share</b></code>](#)<Bullet />[`Int!`](/api/scalars/int) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
+> 
+> 
+
+
+
+### Member of
+
+[`CollectionMint`](/api/objects/collection-mint)  <Badge class="secondary" text="object"/>
+
+
+