diff --git a/README.md b/README.md index 14e755c..9bb63ca 100644 --- a/README.md +++ b/README.md @@ -30,12 +30,23 @@ This command generates static content into the `build` directory and can be serv ### Commands -Retrieve the most recent version of the GraphQL schema and generate documentation pages for the "API Reference." +Retrieve the most recent version of the GraphQL schema and generate documentation pages for the "API Reference. + +Add `.env` file to the root of the project and set the below environment variables. You can generate an auth token from the credentials tab of your HUB account. + +``` +HOLAPLEX_API_ENDPOINT=https://api.holaplex.com/graphql +HOLAPLEX_AUTH_TOKEN= +``` + +Once your environment is set run the below script to re-generate the api documentation. ```bash $ yarn run graphql-to-doc ``` +Create a branch, commit the changes, open a pull request, and merge. Once the changes are merged into the `main` branch they will be automatically deployed via a github action workflow. + ### Deployment Using SSH: diff --git a/docs/api/enums/action.mdx b/docs/api/enums/action.mdx index 058a40b..c81d9cd 100644 --- a/docs/api/enums/action.mdx +++ b/docs/api/enums/action.mdx @@ -30,6 +30,7 @@ enum Action { MINT MINT_COMPRESSED UPDATE_MINT + SWITCH_COLLECTION } ``` @@ -80,6 +81,10 @@ enum Action { > > +#### [Action.SWITCH_COLLECTION](#) +> +> + ### Member of diff --git a/docs/api/enums/creation-status.mdx b/docs/api/enums/creation-status.mdx index 2bf2f32..fb1f4c6 100644 --- a/docs/api/enums/creation-status.mdx +++ b/docs/api/enums/creation-status.mdx @@ -25,6 +25,7 @@ enum CreationStatus { FAILED PENDING REJECTED + QUEUED } ``` @@ -55,11 +56,15 @@ enum CreationStatus { > > +#### [CreationStatus.QUEUED](#) +> +> + ### Member of -[`Collection`](/api/objects/collection) [`CollectionMint`](/api/objects/collection-mint) [`Drop`](/api/objects/drop) [`ImportCollectionPayload`](/api/objects/import-collection-payload) [`MintHistory`](/api/objects/mint-history) [`RetryUpdateMintPayload`](/api/objects/retry-update-mint-payload) [`UpdateHistory`](/api/objects/update-history) +[`Collection`](/api/objects/collection) [`CollectionMint`](/api/objects/collection-mint) [`Drop`](/api/objects/drop) [`ImportCollectionPayload`](/api/objects/import-collection-payload) [`MintHistory`](/api/objects/mint-history) [`RetryUpdateMintPayload`](/api/objects/retry-update-mint-payload) [`SwitchCollectionHistory`](/api/objects/switch-collection-history) [`UpdateHistory`](/api/objects/update-history) diff --git a/docs/api/enums/drop-type.mdx b/docs/api/enums/drop-type.mdx new file mode 100644 index 0000000..b05fe0d --- /dev/null +++ b/docs/api/enums/drop-type.mdx @@ -0,0 +1,45 @@ +--- +id: drop-type +title: DropType +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +No description + +```graphql +enum DropType { + EDITION + OPEN +} +``` + + +### Values + +#### [DropType.EDITION](#) +> +> + +#### [DropType.OPEN](#) +> +> + + + +### Member of + +[`CreateDropInput`](/api/inputs/create-drop-input) [`Drop`](/api/objects/drop) + + + diff --git a/docs/api/generated.md b/docs/api/generated.md index e69de29..6738bac 100644 --- a/docs/api/generated.md +++ b/docs/api/generated.md @@ -0,0 +1,19 @@ +--- +id: schema +slug: /api/generated +title: Schema Documentation +sidebar_position: 1 +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +sidebar_class_name: navbar__toggle +--- + +This documentation has been automatically generated from the GraphQL schema. + +Use the docs in the sidebar to find out how to use the schema: + +- **Allowed operations**: queries and mutations. +- **Schema-defined types**: scalars, objects, enums, interfaces, unions, and input objects. + +Generated on 9/28/2023, 10:33:27 AM. diff --git a/docs/api/inputs/create-collection-input.mdx b/docs/api/inputs/create-collection-input.mdx index 00478af..938aa68 100644 --- a/docs/api/inputs/create-collection-input.mdx +++ b/docs/api/inputs/create-collection-input.mdx @@ -15,7 +15,7 @@ export const SpecifiedBy = (props) => <>Specification <>{props.text} -No description +Input object for creating a collection. ```graphql input CreateCollectionInput { diff --git a/docs/api/inputs/create-drop-input.mdx b/docs/api/inputs/create-drop-input.mdx index f3042ed..866e95b 100644 --- a/docs/api/inputs/create-drop-input.mdx +++ b/docs/api/inputs/create-drop-input.mdx @@ -28,6 +28,7 @@ input CreateDropInput { blockchain: Blockchain! creators: [CreatorInput!]! metadataJson: MetadataJsonInput! + type: DropType! } ``` @@ -70,6 +71,10 @@ input CreateDropInput { > > +#### [CreateDropInput.type](#)[`DropType!`](/api/enums/drop-type) +> +> + ### Member of diff --git a/docs/api/inputs/metadata-json-input.mdx b/docs/api/inputs/metadata-json-input.mdx index 41f3ab4..7a5f76a 100644 --- 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) [`CreateDropInput`](/api/inputs/create-drop-input) [`MintToCollectionInput`](/api/inputs/mint-to-collection-input) [`PatchCollectionInput`](/api/inputs/patch-collection-input) [`PatchDropInput`](/api/inputs/patch-drop-input) [`UpdateMintInput`](/api/inputs/update-mint-input) +[`CreateCollectionInput`](/api/inputs/create-collection-input) [`CreateDropInput`](/api/inputs/create-drop-input) [`MintToCollectionInput`](/api/inputs/mint-to-collection-input) [`PatchCollectionInput`](/api/inputs/patch-collection-input) [`PatchDropInput`](/api/inputs/patch-drop-input) [`QueueMintToDropInput`](/api/inputs/queue-mint-to-drop-input) [`UpdateMintInput`](/api/inputs/update-mint-input) diff --git a/docs/api/inputs/mint-queued-input.mdx b/docs/api/inputs/mint-queued-input.mdx new file mode 100644 index 0000000..56abec7 --- /dev/null +++ b/docs/api/inputs/mint-queued-input.mdx @@ -0,0 +1,50 @@ +--- +id: mint-queued-input +title: MintQueuedInput +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +Represents input data for `mint_queued` mutation + +```graphql +input MintQueuedInput { + mint: UUID! + recipient: String! + compressed: Boolean! +} +``` + + +### Fields + +#### [MintQueuedInput.mint](#)[`UUID!`](/api/scalars/uuid) +> +> + +#### [MintQueuedInput.recipient](#)[`String!`](/api/scalars/string) +> +> + +#### [MintQueuedInput.compressed](#)[`Boolean!`](/api/scalars/boolean) +> +> + + + +### Member of + +[`mintQueued`](/api/mutations/mint-queued) + + + diff --git a/docs/api/inputs/mint-random-queued-input.mdx b/docs/api/inputs/mint-random-queued-input.mdx new file mode 100644 index 0000000..377e63e --- /dev/null +++ b/docs/api/inputs/mint-random-queued-input.mdx @@ -0,0 +1,50 @@ +--- +id: mint-random-queued-input +title: MintRandomQueuedInput +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +Represents input data for `mint_random_queued` mutation + +```graphql +input MintRandomQueuedInput { + drop: UUID! + recipient: String! + compressed: Boolean! +} +``` + + +### Fields + +#### [MintRandomQueuedInput.drop](#)[`UUID!`](/api/scalars/uuid) +> +> + +#### [MintRandomQueuedInput.recipient](#)[`String!`](/api/scalars/string) +> +> + +#### [MintRandomQueuedInput.compressed](#)[`Boolean!`](/api/scalars/boolean) +> +> + + + +### Member of + +[`mintRandomQueuedToDrop`](/api/mutations/mint-random-queued-to-drop) + + + diff --git a/docs/api/inputs/queue-mint-to-drop-input.mdx b/docs/api/inputs/queue-mint-to-drop-input.mdx new file mode 100644 index 0000000..4ccff91 --- /dev/null +++ b/docs/api/inputs/queue-mint-to-drop-input.mdx @@ -0,0 +1,45 @@ +--- +id: queue-mint-to-drop-input +title: QueueMintToDropInput +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +Represents input data for `queue_mint_to_drop` mutation + +```graphql +input QueueMintToDropInput { + drop: UUID! + metadataJson: MetadataJsonInput! +} +``` + + +### Fields + +#### [QueueMintToDropInput.drop](#)[`UUID!`](/api/scalars/uuid) +> +> + +#### [QueueMintToDropInput.metadataJson](#)[`MetadataJsonInput!`](/api/inputs/metadata-json-input) +> +> + + + +### Member of + +[`queueMintToDrop`](/api/mutations/queue-mint-to-drop) + + + diff --git a/docs/api/inputs/switch-collection-input.mdx b/docs/api/inputs/switch-collection-input.mdx new file mode 100644 index 0000000..1a38eaa --- /dev/null +++ b/docs/api/inputs/switch-collection-input.mdx @@ -0,0 +1,45 @@ +--- +id: switch-collection-input +title: SwitchCollectionInput +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +Input object for switching a mint's collection. + +```graphql +input SwitchCollectionInput { + mint: UUID! + collectionAddress: String! +} +``` + + +### Fields + +#### [SwitchCollectionInput.mint](#)[`UUID!`](/api/scalars/uuid) +> +> + +#### [SwitchCollectionInput.collectionAddress](#)[`String!`](/api/scalars/string) +> +> + + + +### Member of + +[`switchCollection`](/api/mutations/switch-collection) + + + diff --git a/docs/api/mutations/create-collection.mdx b/docs/api/mutations/create-collection.mdx index 97854ab..37e6cc9 100644 --- a/docs/api/mutations/create-collection.mdx +++ b/docs/api/mutations/create-collection.mdx @@ -34,7 +34,7 @@ createCollection( ### Type #### [`CreateCollectionPayload`](/api/objects/create-collection-payload) -> +> Result of a successful create collection mutation. > diff --git a/docs/api/mutations/mint-queued.mdx b/docs/api/mutations/mint-queued.mdx new file mode 100644 index 0000000..5994260 --- /dev/null +++ b/docs/api/mutations/mint-queued.mdx @@ -0,0 +1,42 @@ +--- +id: mint-queued +title: mintQueued +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +This mutation mints a specific queued drop mint. + +```graphql +mintQueued( + input: MintQueuedInput! +): MintQueuedPayload! +``` + + +### Arguments + +#### [mintQueued.input](#)[`MintQueuedInput!`](/api/inputs/mint-queued-input) +> +> + +### Type + +#### [`MintQueuedPayload`](/api/objects/mint-queued-payload) +> Represents payload data for `mint_queued` mutation +> + + + + + diff --git a/docs/api/mutations/mint-random-queued-to-drop.mdx b/docs/api/mutations/mint-random-queued-to-drop.mdx new file mode 100644 index 0000000..7b08e9b --- /dev/null +++ b/docs/api/mutations/mint-random-queued-to-drop.mdx @@ -0,0 +1,42 @@ +--- +id: mint-random-queued-to-drop +title: mintRandomQueuedToDrop +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +This mutation mints a random queued drop mint. + +```graphql +mintRandomQueuedToDrop( + input: MintRandomQueuedInput! +): MintQueuedPayload! +``` + + +### Arguments + +#### [mintRandomQueuedToDrop.input](#)[`MintRandomQueuedInput!`](/api/inputs/mint-random-queued-input) +> +> + +### Type + +#### [`MintQueuedPayload`](/api/objects/mint-queued-payload) +> Represents payload data for `mint_queued` mutation +> + + + + + diff --git a/docs/api/mutations/queue-mint-to-drop.mdx b/docs/api/mutations/queue-mint-to-drop.mdx new file mode 100644 index 0000000..918b7b2 --- /dev/null +++ b/docs/api/mutations/queue-mint-to-drop.mdx @@ -0,0 +1,42 @@ +--- +id: queue-mint-to-drop +title: queueMintToDrop +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +No description + +```graphql +queueMintToDrop( + input: QueueMintToDropInput! +): QueueMintToDropPayload! +``` + + +### Arguments + +#### [queueMintToDrop.input](#)[`QueueMintToDropInput!`](/api/inputs/queue-mint-to-drop-input) +> +> + +### Type + +#### [`QueueMintToDropPayload`](/api/objects/queue-mint-to-drop-payload) +> Represents payload data for `queue_mint_to_drop` mutation +> + + + + + diff --git a/docs/api/mutations/retry-collection.mdx b/docs/api/mutations/retry-collection.mdx index 6b85a76..3395214 100644 --- a/docs/api/mutations/retry-collection.mdx +++ b/docs/api/mutations/retry-collection.mdx @@ -33,7 +33,7 @@ retryCollection( ### Type #### [`CreateCollectionPayload`](/api/objects/create-collection-payload) -> +> Result of a successful create collection mutation. > diff --git a/docs/api/mutations/retry-mint-to-collection.mdx b/docs/api/mutations/retry-mint-to-collection.mdx index 763f9e5..822c3a5 100644 --- a/docs/api/mutations/retry-mint-to-collection.mdx +++ b/docs/api/mutations/retry-mint-to-collection.mdx @@ -15,7 +15,8 @@ export const SpecifiedBy = (props) => <>Specification <>{props.text} -No description +Retries a mint which failed by passing its ID. +# Errors ```graphql retryMintToCollection( diff --git a/docs/api/mutations/switch-collection.mdx b/docs/api/mutations/switch-collection.mdx new file mode 100644 index 0000000..dcd98ff --- /dev/null +++ b/docs/api/mutations/switch-collection.mdx @@ -0,0 +1,44 @@ +--- +id: switch-collection +title: switchCollection +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +This mutation allows you to change the collection to which a mint belongs. +For Solana, the mint specified by `input` must already belong to a Metaplex Certified Collection. +The collection you are aiming to switch to must also be Metaplex Certified Collection. + +```graphql +switchCollection( + input: SwitchCollectionInput! +): SwitchCollectionPayload! +``` + + +### Arguments + +#### [switchCollection.input](#)[`SwitchCollectionInput!`](/api/inputs/switch-collection-input) +> +> + +### Type + +#### [`SwitchCollectionPayload`](/api/objects/switch-collection-payload) +> Represents the result of a successful switch collection mutation. +> + + + + + diff --git a/docs/api/objects/collection-mint.mdx b/docs/api/objects/collection-mint.mdx index 7fce0c5..4761d32 100644 --- a/docs/api/objects/collection-mint.mdx +++ b/docs/api/objects/collection-mint.mdx @@ -22,7 +22,7 @@ type CollectionMint { id: UUID! collectionId: UUID! address: String - owner: String! + owner: String creationStatus: CreationStatus! createdBy: UUID! createdAt: DateTime! @@ -30,13 +30,14 @@ type CollectionMint { edition: Int! sellerFeeBasisPoints: Int! creditsDeductionId: UUID - compressed: Boolean! + compressed: Boolean collection: Collection metadataJson: MetadataJson updateHistories: [UpdateHistory!] creators: [MintCreator!] mintHistory: MintHistory transferHistories: [NftTransfer!] + switchCollectionHistories: [SwitchCollectionHistory!] } ``` @@ -57,7 +58,7 @@ On Solana this is the mint address. On EVM chains it is the concatenation of the contract address and the token id `{contractAddress}:{tokenId}`. > -#### [CollectionMint.owner](#)[`String!`](/api/scalars/string) +#### [CollectionMint.owner](#)[`String`](/api/scalars/string) > The wallet address of the owner of the NFT. > @@ -89,7 +90,7 @@ On EVM chains it is the concatenation of the contract address and the token id ` > credits deduction id > -#### [CollectionMint.compressed](#)[`Boolean!`](/api/scalars/boolean) +#### [CollectionMint.compressed](#)[`Boolean`](/api/scalars/boolean) > Indicates if the NFT is compressed. Compression is only supported on Solana. > @@ -118,6 +119,10 @@ On EVM chains it is the concatenation of the contract address and the token id ` > The history of transfers for the mint. > +#### [CollectionMint.switchCollectionHistories](#)[`[SwitchCollectionHistory!]`](/api/objects/switch-collection-history) +> The history of switched collections for the mint. +> + ### Returned by @@ -126,7 +131,7 @@ On EVM chains it is the concatenation of the contract address and the token id ` ### Member of -[`Collection`](/api/objects/collection) [`Customer`](/api/objects/customer) [`MintEditionPayload`](/api/objects/mint-edition-payload) [`MintHistory`](/api/objects/mint-history) [`MintToCollectionPayload`](/api/objects/mint-to-collection-payload) [`RetryMintEditionPayload`](/api/objects/retry-mint-edition-payload) [`TransferAssetPayload`](/api/objects/transfer-asset-payload) [`UpdateMintPayload`](/api/objects/update-mint-payload) [`Wallet`](/api/objects/wallet) +[`Collection`](/api/objects/collection) [`Customer`](/api/objects/customer) [`Drop`](/api/objects/drop) [`MintEditionPayload`](/api/objects/mint-edition-payload) [`MintHistory`](/api/objects/mint-history) [`MintQueuedPayload`](/api/objects/mint-queued-payload) [`MintToCollectionPayload`](/api/objects/mint-to-collection-payload) [`QueueMintToDropPayload`](/api/objects/queue-mint-to-drop-payload) [`RetryMintEditionPayload`](/api/objects/retry-mint-edition-payload) [`SwitchCollectionPayload`](/api/objects/switch-collection-payload) [`TransferAssetPayload`](/api/objects/transfer-asset-payload) [`UpdateMintPayload`](/api/objects/update-mint-payload) [`Wallet`](/api/objects/wallet) diff --git a/docs/api/objects/create-collection-payload.mdx b/docs/api/objects/create-collection-payload.mdx index 4c78c9b..b29d4f7 100644 --- a/docs/api/objects/create-collection-payload.mdx +++ b/docs/api/objects/create-collection-payload.mdx @@ -15,7 +15,7 @@ export const SpecifiedBy = (props) => <>Specification <>{props.text} -No description +Result of a successful create collection mutation. ```graphql type CreateCollectionPayload { diff --git a/docs/api/objects/drop.mdx b/docs/api/objects/drop.mdx index 4a5898c..3e8a386 100644 --- a/docs/api/objects/drop.mdx +++ b/docs/api/objects/drop.mdx @@ -20,6 +20,7 @@ No description ```graphql type Drop { id: UUID! + dropType: DropType! projectId: UUID! creationStatus: CreationStatus! startTime: DateTime @@ -31,6 +32,7 @@ type Drop { shutdownAt: DateTime collection: Collection! status: DropStatus! + queuedMints: [CollectionMint!] purchases: [MintHistory!] } ``` @@ -42,6 +44,10 @@ type Drop { > The unique identifier for the drop. > +#### [Drop.dropType](#)[`DropType!`](/api/enums/drop-type) +> +> + #### [Drop.projectId](#)[`UUID!`](/api/scalars/uuid) > The identifier of the project to which the drop is associated. > @@ -87,6 +93,10 @@ If it is null, the drop is currently not shutdown > The current status of the drop. > +#### [Drop.queuedMints](#)[`[CollectionMint!]`](/api/objects/collection-mint) +> +> + #### [Drop.purchases](#)[`[MintHistory!]`](/api/objects/mint-history) > A list of all NFT purchases from this drop. > diff --git a/docs/api/objects/mint-queued-payload.mdx b/docs/api/objects/mint-queued-payload.mdx new file mode 100644 index 0000000..9b33145 --- /dev/null +++ b/docs/api/objects/mint-queued-payload.mdx @@ -0,0 +1,40 @@ +--- +id: mint-queued-payload +title: MintQueuedPayload +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +Represents payload data for `mint_queued` mutation + +```graphql +type MintQueuedPayload { + collectionMint: CollectionMint! +} +``` + + +### Fields + +#### [MintQueuedPayload.collectionMint](#)[`CollectionMint!`](/api/objects/collection-mint) +> +> + + + +### Returned by + +[`mintQueued`](/api/mutations/mint-queued) [`mintRandomQueuedToDrop`](/api/mutations/mint-random-queued-to-drop) + + + diff --git a/docs/api/objects/queue-mint-to-drop-payload.mdx b/docs/api/objects/queue-mint-to-drop-payload.mdx new file mode 100644 index 0000000..df0e0d6 --- /dev/null +++ b/docs/api/objects/queue-mint-to-drop-payload.mdx @@ -0,0 +1,40 @@ +--- +id: queue-mint-to-drop-payload +title: QueueMintToDropPayload +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +Represents payload data for `queue_mint_to_drop` mutation + +```graphql +type QueueMintToDropPayload { + collectionMint: CollectionMint! +} +``` + + +### Fields + +#### [QueueMintToDropPayload.collectionMint](#)[`CollectionMint!`](/api/objects/collection-mint) +> +> + + + +### Returned by + +[`queueMintToDrop`](/api/mutations/queue-mint-to-drop) + + + diff --git a/docs/api/objects/switch-collection-history.mdx b/docs/api/objects/switch-collection-history.mdx new file mode 100644 index 0000000..aef79f8 --- /dev/null +++ b/docs/api/objects/switch-collection-history.mdx @@ -0,0 +1,75 @@ +--- +id: switch-collection-history +title: SwitchCollectionHistory +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +No description + +```graphql +type SwitchCollectionHistory { + id: UUID! + collectionMintId: UUID! + collectionId: UUID! + creditDeductionId: UUID! + signature: String + status: CreationStatus! + initiatedBy: UUID! + createdAt: NaiveDateTime! +} +``` + + +### Fields + +#### [SwitchCollectionHistory.id](#)[`UUID!`](/api/scalars/uuid) +> +> + +#### [SwitchCollectionHistory.collectionMintId](#)[`UUID!`](/api/scalars/uuid) +> +> + +#### [SwitchCollectionHistory.collectionId](#)[`UUID!`](/api/scalars/uuid) +> +> + +#### [SwitchCollectionHistory.creditDeductionId](#)[`UUID!`](/api/scalars/uuid) +> +> + +#### [SwitchCollectionHistory.signature](#)[`String`](/api/scalars/string) +> +> + +#### [SwitchCollectionHistory.status](#)[`CreationStatus!`](/api/enums/creation-status) +> +> + +#### [SwitchCollectionHistory.initiatedBy](#)[`UUID!`](/api/scalars/uuid) +> +> + +#### [SwitchCollectionHistory.createdAt](#)[`NaiveDateTime!`](/api/scalars/naive-date-time) +> +> + + + +### Member of + +[`CollectionMint`](/api/objects/collection-mint) + + + diff --git a/docs/api/objects/switch-collection-payload.mdx b/docs/api/objects/switch-collection-payload.mdx new file mode 100644 index 0000000..fdf5ee3 --- /dev/null +++ b/docs/api/objects/switch-collection-payload.mdx @@ -0,0 +1,40 @@ +--- +id: switch-collection-payload +title: SwitchCollectionPayload +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +Represents the result of a successful switch collection mutation. + +```graphql +type SwitchCollectionPayload { + collectionMint: CollectionMint! +} +``` + + +### Fields + +#### [SwitchCollectionPayload.collectionMint](#)[`CollectionMint!`](/api/objects/collection-mint) +> +> + + + +### Returned by + +[`switchCollection`](/api/mutations/switch-collection) + + + diff --git a/docs/api/objects/wallet.mdx b/docs/api/objects/wallet.mdx index c9c14fc..fb10c6d 100644 --- a/docs/api/objects/wallet.mdx +++ b/docs/api/objects/wallet.mdx @@ -72,6 +72,10 @@ type Wallet { +### Returned by + +[`wallet`](/api/queries/wallet) + ### Member of [`CreateCustomerWalletPayload`](/api/objects/create-customer-wallet-payload) [`Customer`](/api/objects/customer) [`Treasury`](/api/objects/treasury) diff --git a/docs/api/queries/wallet.mdx b/docs/api/queries/wallet.mdx new file mode 100644 index 0000000..57685cf --- /dev/null +++ b/docs/api/queries/wallet.mdx @@ -0,0 +1,47 @@ +--- +id: wallet +title: wallet +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + + + +export const Bullet = () => <> ●  + +export const SpecifiedBy = (props) => <>Specification⎘ + +export const Badge = (props) => <>{props.text} + + +Query to find a `Wallet` by its blockchain address. + +# Errors +This function fails if the `AppContext` cannot be accessed, +the address provided is not a valid blockchain address +or fails to load from the database. + +```graphql +wallet( + address: String! +): Wallet +``` + + +### Arguments + +#### [wallet.address](#)[`String!`](/api/scalars/string) +> +> + +### Type + +#### [`Wallet`](/api/objects/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. +> + + + + + diff --git a/docs/api/scalars/boolean.mdx b/docs/api/scalars/boolean.mdx index 431925c..70143b1 100644 --- a/docs/api/scalars/boolean.mdx +++ b/docs/api/scalars/boolean.mdx @@ -26,7 +26,7 @@ scalar Boolean ### Member of -[`CollectionCreator`](/api/objects/collection-creator) [`CollectionMint`](/api/objects/collection-mint) [`CreatorInput`](/api/inputs/creator-input) [`defer`](/api/directives/defer) [`EditWebhookInput`](/api/inputs/edit-webhook-input) [`EventType`](/api/objects/event-type) [`include`](/api/directives/include) [`MintCreator`](/api/objects/mint-creator) [`MintToCollectionInput`](/api/inputs/mint-to-collection-input) [`skip`](/api/directives/skip) +[`CollectionCreator`](/api/objects/collection-creator) [`CollectionMint`](/api/objects/collection-mint) [`CreatorInput`](/api/inputs/creator-input) [`defer`](/api/directives/defer) [`EditWebhookInput`](/api/inputs/edit-webhook-input) [`EventType`](/api/objects/event-type) [`include`](/api/directives/include) [`MintCreator`](/api/objects/mint-creator) [`MintQueuedInput`](/api/inputs/mint-queued-input) [`MintRandomQueuedInput`](/api/inputs/mint-random-queued-input) [`MintToCollectionInput`](/api/inputs/mint-to-collection-input) [`skip`](/api/directives/skip) diff --git a/docs/api/scalars/naive-date-time.mdx b/docs/api/scalars/naive-date-time.mdx index 4beda0f..63a9d75 100644 --- a/docs/api/scalars/naive-date-time.mdx +++ b/docs/api/scalars/naive-date-time.mdx @@ -30,7 +30,7 @@ scalar NaiveDateTime ### Member of -[`AccessToken`](/api/objects/access-token) [`Credential`](/api/objects/credential) [`Customer`](/api/objects/customer) [`UpdateHistory`](/api/objects/update-history) [`Webhook`](/api/objects/webhook) +[`AccessToken`](/api/objects/access-token) [`Credential`](/api/objects/credential) [`Customer`](/api/objects/customer) [`SwitchCollectionHistory`](/api/objects/switch-collection-history) [`UpdateHistory`](/api/objects/update-history) [`Webhook`](/api/objects/webhook) diff --git a/docs/api/scalars/string.mdx b/docs/api/scalars/string.mdx index aa980b0..54eb052 100644 --- a/docs/api/scalars/string.mdx +++ b/docs/api/scalars/string.mdx @@ -26,7 +26,7 @@ scalar String ### Member of -[`AccessToken`](/api/objects/access-token) [`Collection`](/api/objects/collection) [`CollectionCreator`](/api/objects/collection-creator) [`CollectionMint`](/api/objects/collection-mint) [`CreateCredentialInput`](/api/inputs/create-credential-input) [`CreateOrganizationInput`](/api/inputs/create-organization-input) [`CreateProjectInput`](/api/inputs/create-project-input) [`CreateWebhookInput`](/api/inputs/create-webhook-input) [`CreateWebhookPayload`](/api/objects/create-webhook-payload) [`CreatorInput`](/api/inputs/creator-input) [`Credential`](/api/objects/credential) [`Customer`](/api/objects/customer) [`defer`](/api/directives/defer) [`DeleteCredentialInput`](/api/inputs/delete-credential-input) [`DeleteCredentialPayload`](/api/objects/delete-credential-payload) [`deprecated`](/api/directives/deprecated) [`EditCredentialInput`](/api/inputs/edit-credential-input) [`EditOrganizationInput`](/api/inputs/edit-organization-input) [`EditProjectInput`](/api/inputs/edit-project-input) [`EditWebhookInput`](/api/inputs/edit-webhook-input) [`EventType`](/api/objects/event-type) [`Holder`](/api/objects/holder) [`ImportCollectionInput`](/api/inputs/import-collection-input) [`Invite`](/api/objects/invite) [`InviteMemberInput`](/api/inputs/invite-member-input) [`MetadataJson`](/api/objects/metadata-json) [`MetadataJsonAttribute`](/api/objects/metadata-json-attribute) [`MetadataJsonAttributeInput`](/api/inputs/metadata-json-attribute-input) [`MetadataJsonCollectionInput`](/api/inputs/metadata-json-collection-input) [`MetadataJsonFileInput`](/api/inputs/metadata-json-file-input) [`MetadataJsonInput`](/api/inputs/metadata-json-input) [`MetadataJsonPropertyInput`](/api/inputs/metadata-json-property-input) [`MintCreator`](/api/objects/mint-creator) [`MintDropInput`](/api/inputs/mint-drop-input) [`MintHistory`](/api/objects/mint-history) [`MintToCollectionInput`](/api/inputs/mint-to-collection-input) [`NftTransfer`](/api/objects/nft-transfer) [`Organization`](/api/objects/organization) [`Project`](/api/objects/project) [`specifiedBy`](/api/directives/specified-by) [`TransferAssetInput`](/api/inputs/transfer-asset-input) [`Treasury`](/api/objects/treasury) [`UpdateHistory`](/api/objects/update-history) [`User`](/api/objects/user) [`Wallet`](/api/objects/wallet) [`Webhook`](/api/objects/webhook) +[`AccessToken`](/api/objects/access-token) [`Collection`](/api/objects/collection) [`CollectionCreator`](/api/objects/collection-creator) [`CollectionMint`](/api/objects/collection-mint) [`CreateCredentialInput`](/api/inputs/create-credential-input) [`CreateOrganizationInput`](/api/inputs/create-organization-input) [`CreateProjectInput`](/api/inputs/create-project-input) [`CreateWebhookInput`](/api/inputs/create-webhook-input) [`CreateWebhookPayload`](/api/objects/create-webhook-payload) [`CreatorInput`](/api/inputs/creator-input) [`Credential`](/api/objects/credential) [`Customer`](/api/objects/customer) [`defer`](/api/directives/defer) [`DeleteCredentialInput`](/api/inputs/delete-credential-input) [`DeleteCredentialPayload`](/api/objects/delete-credential-payload) [`deprecated`](/api/directives/deprecated) [`EditCredentialInput`](/api/inputs/edit-credential-input) [`EditOrganizationInput`](/api/inputs/edit-organization-input) [`EditProjectInput`](/api/inputs/edit-project-input) [`EditWebhookInput`](/api/inputs/edit-webhook-input) [`EventType`](/api/objects/event-type) [`Holder`](/api/objects/holder) [`ImportCollectionInput`](/api/inputs/import-collection-input) [`Invite`](/api/objects/invite) [`InviteMemberInput`](/api/inputs/invite-member-input) [`MetadataJson`](/api/objects/metadata-json) [`MetadataJsonAttribute`](/api/objects/metadata-json-attribute) [`MetadataJsonAttributeInput`](/api/inputs/metadata-json-attribute-input) [`MetadataJsonCollectionInput`](/api/inputs/metadata-json-collection-input) [`MetadataJsonFileInput`](/api/inputs/metadata-json-file-input) [`MetadataJsonInput`](/api/inputs/metadata-json-input) [`MetadataJsonPropertyInput`](/api/inputs/metadata-json-property-input) [`MintCreator`](/api/objects/mint-creator) [`MintDropInput`](/api/inputs/mint-drop-input) [`MintHistory`](/api/objects/mint-history) [`MintQueuedInput`](/api/inputs/mint-queued-input) [`MintRandomQueuedInput`](/api/inputs/mint-random-queued-input) [`MintToCollectionInput`](/api/inputs/mint-to-collection-input) [`NftTransfer`](/api/objects/nft-transfer) [`Organization`](/api/objects/organization) [`Project`](/api/objects/project) [`specifiedBy`](/api/directives/specified-by) [`SwitchCollectionHistory`](/api/objects/switch-collection-history) [`SwitchCollectionInput`](/api/inputs/switch-collection-input) [`TransferAssetInput`](/api/inputs/transfer-asset-input) [`Treasury`](/api/objects/treasury) [`UpdateHistory`](/api/objects/update-history) [`User`](/api/objects/user) [`Wallet`](/api/objects/wallet) [`wallet`](/api/queries/wallet) [`Webhook`](/api/objects/webhook) diff --git a/docs/api/scalars/uuid.mdx b/docs/api/scalars/uuid.mdx index 760894b..fd214c9 100644 --- a/docs/api/scalars/uuid.mdx +++ b/docs/api/scalars/uuid.mdx @@ -33,7 +33,7 @@ scalar UUID ### Member of -[`AcceptInviteInput`](/api/inputs/accept-invite-input) [`Collection`](/api/objects/collection) [`collection`](/api/queries/collection) [`CollectionCreator`](/api/objects/collection-creator) [`CollectionMint`](/api/objects/collection-mint) [`CreateCollectionInput`](/api/inputs/create-collection-input) [`CreateCredentialInput`](/api/inputs/create-credential-input) [`CreateCustomerInput`](/api/inputs/create-customer-input) [`CreateCustomerWalletInput`](/api/inputs/create-customer-wallet-input) [`CreateDropInput`](/api/inputs/create-drop-input) [`CreateProjectInput`](/api/inputs/create-project-input) [`CreateWebhookInput`](/api/inputs/create-webhook-input) [`Credential`](/api/objects/credential) [`CreditDeposit`](/api/objects/credit-deposit) [`Credits`](/api/objects/credits) [`Customer`](/api/objects/customer) [`DeactivateMemberInput`](/api/inputs/deactivate-member-input) [`DeleteWebhookInput`](/api/inputs/delete-webhook-input) [`DeleteWebhookPayload`](/api/objects/delete-webhook-payload) [`Drop`](/api/objects/drop) [`drop`](/api/queries/drop) [`EditOrganizationInput`](/api/inputs/edit-organization-input) [`EditProjectInput`](/api/inputs/edit-project-input) [`EditWebhookInput`](/api/inputs/edit-webhook-input) [`Holder`](/api/objects/holder) [`ImportCollectionInput`](/api/inputs/import-collection-input) [`Invite`](/api/objects/invite) [`invite`](/api/queries/invite) [`InviteMemberInput`](/api/inputs/invite-member-input) [`Member`](/api/objects/member) [`MetadataJson`](/api/objects/metadata-json) [`MetadataJsonAttribute`](/api/objects/metadata-json-attribute) [`mint`](/api/queries/mint) [`MintCreator`](/api/objects/mint-creator) [`MintDropInput`](/api/inputs/mint-drop-input) [`MintHistory`](/api/objects/mint-history) [`MintToCollectionInput`](/api/inputs/mint-to-collection-input) [`NftTransfer`](/api/objects/nft-transfer) [`Organization`](/api/objects/organization) [`organization`](/api/queries/organization) [`Owner`](/api/objects/owner) [`PatchCollectionInput`](/api/inputs/patch-collection-input) [`PatchDropInput`](/api/inputs/patch-drop-input) [`PauseDropInput`](/api/inputs/pause-drop-input) [`Project`](/api/objects/project) [`project`](/api/queries/project) [`ReactivateMemberInput`](/api/inputs/reactivate-member-input) [`ResumeDropInput`](/api/inputs/resume-drop-input) [`RetryCollectionInput`](/api/inputs/retry-collection-input) [`RetryDropInput`](/api/inputs/retry-drop-input) [`RetryMintEditionInput`](/api/inputs/retry-mint-edition-input) [`RetryUpdateMintInput`](/api/inputs/retry-update-mint-input) [`ShutdownDropInput`](/api/inputs/shutdown-drop-input) [`TransferAssetInput`](/api/inputs/transfer-asset-input) [`Treasury`](/api/objects/treasury) [`UpdateHistory`](/api/objects/update-history) [`UpdateMintInput`](/api/inputs/update-mint-input) [`User`](/api/objects/user) [`user`](/api/queries/user) [`Wallet`](/api/objects/wallet) [`Webhook`](/api/objects/webhook) +[`AcceptInviteInput`](/api/inputs/accept-invite-input) [`Collection`](/api/objects/collection) [`collection`](/api/queries/collection) [`CollectionCreator`](/api/objects/collection-creator) [`CollectionMint`](/api/objects/collection-mint) [`CreateCollectionInput`](/api/inputs/create-collection-input) [`CreateCredentialInput`](/api/inputs/create-credential-input) [`CreateCustomerInput`](/api/inputs/create-customer-input) [`CreateCustomerWalletInput`](/api/inputs/create-customer-wallet-input) [`CreateDropInput`](/api/inputs/create-drop-input) [`CreateProjectInput`](/api/inputs/create-project-input) [`CreateWebhookInput`](/api/inputs/create-webhook-input) [`Credential`](/api/objects/credential) [`CreditDeposit`](/api/objects/credit-deposit) [`Credits`](/api/objects/credits) [`Customer`](/api/objects/customer) [`DeactivateMemberInput`](/api/inputs/deactivate-member-input) [`DeleteWebhookInput`](/api/inputs/delete-webhook-input) [`DeleteWebhookPayload`](/api/objects/delete-webhook-payload) [`Drop`](/api/objects/drop) [`drop`](/api/queries/drop) [`EditOrganizationInput`](/api/inputs/edit-organization-input) [`EditProjectInput`](/api/inputs/edit-project-input) [`EditWebhookInput`](/api/inputs/edit-webhook-input) [`Holder`](/api/objects/holder) [`ImportCollectionInput`](/api/inputs/import-collection-input) [`Invite`](/api/objects/invite) [`invite`](/api/queries/invite) [`InviteMemberInput`](/api/inputs/invite-member-input) [`Member`](/api/objects/member) [`MetadataJson`](/api/objects/metadata-json) [`MetadataJsonAttribute`](/api/objects/metadata-json-attribute) [`mint`](/api/queries/mint) [`MintCreator`](/api/objects/mint-creator) [`MintDropInput`](/api/inputs/mint-drop-input) [`MintHistory`](/api/objects/mint-history) [`MintQueuedInput`](/api/inputs/mint-queued-input) [`MintRandomQueuedInput`](/api/inputs/mint-random-queued-input) [`MintToCollectionInput`](/api/inputs/mint-to-collection-input) [`NftTransfer`](/api/objects/nft-transfer) [`Organization`](/api/objects/organization) [`organization`](/api/queries/organization) [`Owner`](/api/objects/owner) [`PatchCollectionInput`](/api/inputs/patch-collection-input) [`PatchDropInput`](/api/inputs/patch-drop-input) [`PauseDropInput`](/api/inputs/pause-drop-input) [`Project`](/api/objects/project) [`project`](/api/queries/project) [`QueueMintToDropInput`](/api/inputs/queue-mint-to-drop-input) [`ReactivateMemberInput`](/api/inputs/reactivate-member-input) [`ResumeDropInput`](/api/inputs/resume-drop-input) [`RetryCollectionInput`](/api/inputs/retry-collection-input) [`RetryDropInput`](/api/inputs/retry-drop-input) [`RetryMintEditionInput`](/api/inputs/retry-mint-edition-input) [`RetryUpdateMintInput`](/api/inputs/retry-update-mint-input) [`ShutdownDropInput`](/api/inputs/shutdown-drop-input) [`SwitchCollectionHistory`](/api/objects/switch-collection-history) [`SwitchCollectionInput`](/api/inputs/switch-collection-input) [`TransferAssetInput`](/api/inputs/transfer-asset-input) [`Treasury`](/api/objects/treasury) [`UpdateHistory`](/api/objects/update-history) [`UpdateMintInput`](/api/inputs/update-mint-input) [`User`](/api/objects/user) [`user`](/api/queries/user) [`Wallet`](/api/objects/wallet) [`Webhook`](/api/objects/webhook) diff --git a/graphql-markdown.config.js b/graphql-markdown.config.js index b5e57ce..69ff1f7 100644 --- a/graphql-markdown.config.js +++ b/graphql-markdown.config.js @@ -13,6 +13,7 @@ module.exports = { routeBasePath: 'api', rootPath: './docs', baseURL: '/api', + homepage: 'docs/api/starting.md', loaders: { UrlLoader: '@graphql-tools/url-loader' },