# storefront-service-api ## GraphQL API Reference GraphQl endpoints for storefront-service! **API Endpoints** ``` # devel: https://storefront-service.devel.original.works # staging: https://storefront-service.stage.original.works # prod: https://storefront-service.original.works ``` ## Queries ### `collectionEntities` **Response** Returns a [`CollectionEntityConnection!`](#definition-CollectionEntityConnection) **Arguments** | Name | Description | | -------------------------------------------------------------------------- | ------------------------------------------------------ | | `filter` - [`CollectionEntityFilter!`](#definition-CollectionEntityFilter) | Specify to filter the records returned. Default = `{}` | | `paging` - [`OffsetPaging!`](#definition-OffsetPaging) | Limit or page results. Default = `{limit: 10}` | | `sorting` - [`[CollectionEntitySort!]!`](#definition-CollectionEntitySort) | Specify to sort results. Default = `[]` | **Example** **Query** ```gql query CollectionEntities( $filter: CollectionEntityFilter!, $paging: OffsetPaging!, $sorting: [CollectionEntitySort!]! ) { collectionEntities( filter: $filter, paging: $paging, sorting: $sorting ) { nodes { avatarUrl bannerUrl createdAt description email entityUri id name networkConfigs { ...NetworkConfigFragment } redirectDomains { ...RedirectDomainFragment } tenant { ...TenantFragment } tenantId type updatedAt } pageInfo { hasNextPage hasPreviousPage } totalCount } } ``` **Variables** ```json {"filter": {}, "paging": {"limit": 10}, "sorting": [""]} ``` **Response** ```json { "data": { "collectionEntities": { "nodes": [CollectionEntity], "pageInfo": OffsetPageInfo, "totalCount": 987 } } } ``` [Queries](#group-Operations-Queries) ### `collectionEntity` **Response** Returns a [`CollectionEntity!`](#definition-CollectionEntity) **Arguments** | Name | Description | | ------------------------------ | ----------------------------- | | `id` - [`ID!`](#definition-ID) | The id of the record to find. | **Example** **Query** ```gql query CollectionEntity($id: ID!) { collectionEntity(id: $id) { avatarUrl bannerUrl createdAt description email entityUri id name networkConfigs { activitiesSubgraphUrl agreementFactoryAddress agreementSubgraphUrl alchemyApiKey capabilities { ...NetworkCapabilityFragment } chainId createdAt defaultStripeFeeInPercent dmmAddress feeManagerAddress id jsonRpcUrl lendingContractAddress marketAddress marketOwner nativeCoin nativeCoinDecimals networkName nftSubgraphUrl payeeVaultFactoryAddress paymentBatcherFactoryAddress royaltyLoanFactoryAddress studioPublicJsonRpcUrl updatedAt } redirectDomains { domain } tenant { createdAt id minPaymentBatcherBalanceInUSDC name paymentBatcherAddress tenantUri updatedAt } tenantId type updatedAt } } ``` **Variables** ```json {"id": 4} ``` **Response** ```json { "data": { "collectionEntity": { "avatarUrl": "xyz789", "bannerUrl": "abc123", "createdAt": "2007-12-03T10:15:30Z", "description": "abc123", "email": "abc123", "entityUri": "xyz789", "id": "4", "name": "xyz789", "networkConfigs": [NetworkConfig], "redirectDomains": [RedirectDomain], "tenant": Tenant, "tenantId": 4, "type": "ARTIST", "updatedAt": "2007-12-03T10:15:30Z" } } } ``` [Queries](#group-Operations-Queries) ### `collectionEntityRelation` **Response** Returns a [`CollectionEntityRelation!`](#definition-CollectionEntityRelation) **Arguments** | Name | Description | | ------------------------------ | ----------------------------- | | `id` - [`ID!`](#definition-ID) | The id of the record to find. | **Example** **Query** ```gql query CollectionEntityRelation($id: ID!) { collectionEntityRelation(id: $id) { childEntityId createdAt id network { activitiesSubgraphUrl agreementFactoryAddress agreementSubgraphUrl alchemyApiKey capabilities { ...NetworkCapabilityFragment } chainId createdAt defaultStripeFeeInPercent dmmAddress feeManagerAddress id jsonRpcUrl lendingContractAddress marketAddress marketOwner nativeCoin nativeCoinDecimals networkName nftSubgraphUrl payeeVaultFactoryAddress paymentBatcherFactoryAddress royaltyLoanFactoryAddress studioPublicJsonRpcUrl updatedAt } parentEntityId relationType tenant { createdAt id minPaymentBatcherBalanceInUSDC name paymentBatcherAddress tenantUri updatedAt } tenantId updatedAt } } ``` **Variables** ```json {"id": 4} ``` **Response** ```json { "data": { "collectionEntityRelation": { "childEntityId": "xyz789", "createdAt": "2007-12-03T10:15:30Z", "id": "4", "network": NetworkConfig, "parentEntityId": "abc123", "relationType": "ENTERPIRSE_ARTIST", "tenant": Tenant, "tenantId": "abc123", "updatedAt": "2007-12-03T10:15:30Z" } } } ``` [Queries](#group-Operations-Queries) ### `collectionEntityRelations` **Response** Returns a [`CollectionEntityRelationConnection!`](#definition-CollectionEntityRelationConnection) **Arguments** | Name | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------ | | `filter` - [`CollectionEntityRelationFilter!`](#definition-CollectionEntityRelationFilter) | Specify to filter the records returned. Default = `{}` | | `paging` - [`OffsetPaging!`](#definition-OffsetPaging) | Limit or page results. Default = `{limit: 10}` | | `sorting` - [`[CollectionEntityRelationSort!]!`](#definition-CollectionEntityRelationSort) | Specify to sort results. Default = `[]` | **Example** **Query** ```gql query CollectionEntityRelations( $filter: CollectionEntityRelationFilter!, $paging: OffsetPaging!, $sorting: [CollectionEntityRelationSort!]! ) { collectionEntityRelations( filter: $filter, paging: $paging, sorting: $sorting ) { nodes { childEntityId createdAt id network { ...NetworkConfigFragment } parentEntityId relationType tenant { ...TenantFragment } tenantId updatedAt } pageInfo { hasNextPage hasPreviousPage } totalCount } } ``` **Variables** ```json {"filter": {}, "paging": {"limit": 10}, "sorting": [""]} ``` **Response** ```json { "data": { "collectionEntityRelations": { "nodes": [CollectionEntityRelation], "pageInfo": OffsetPageInfo, "totalCount": 123 } } } ``` [Queries](#group-Operations-Queries) ### `contactByNickName` **Description** Returns a contact by nickname. **Response** Returns a [`ContactDto!`](#definition-ContactDto) **Arguments** | Name | Description | | -------------------------------------------- | ---------------------- | | `nickName` - [`String!`](#definition-String) | nick name of a contact | **Example** **Query** ```gql query ContactByNickName($nickName: String!) { contactByNickName(nickName: $nickName) { createdAt id nickName ownerUri updatedAt walletAddress } } ``` **Variables** ```json {"nickName": "xyz789"} ``` **Response** ```json { "data": { "contactByNickName": { "createdAt": "2007-12-03T10:15:30Z", "id": 123.45, "nickName": "xyz789", "ownerUri": "abc123", "updatedAt": "2007-12-03T10:15:30Z", "walletAddress": "abc123" } } } ``` [Queries](#group-Operations-Queries) ### `contactByWalletAddress` **Description** Returns a contact by wallet address. **Response** Returns a [`ContactDto!`](#definition-ContactDto) **Arguments** | Name | Description | | ------------------------------------------------- | --------------------------- | | `walletAddress` - [`String!`](#definition-String) | wallet address of a contact | **Example** **Query** ```gql query ContactByWalletAddress($walletAddress: String!) { contactByWalletAddress(walletAddress: $walletAddress) { createdAt id nickName ownerUri updatedAt walletAddress } } ``` **Variables** ```json {"walletAddress": "xyz789"} ``` **Response** ```json { "data": { "contactByWalletAddress": { "createdAt": "2007-12-03T10:15:30Z", "id": 123.45, "nickName": "xyz789", "ownerUri": "xyz789", "updatedAt": "2007-12-03T10:15:30Z", "walletAddress": "abc123" } } } ``` [Queries](#group-Operations-Queries) ### `contacts` **Description** Returns contacts of a contactBook entity. **Response** Returns a [`ContactsDto!`](#definition-ContactsDto) **Example** **Query** ```gql query Contacts { contacts { count items { createdAt id nickName ownerUri updatedAt walletAddress } } } ``` **Response** ```json { "data": { "contacts": {"count": 123.45, "items": [ContactDto]} } } ``` [Queries](#group-Operations-Queries) ### `getEntityByTokenPayload` **Response** Returns a [`CollectionEntity!`](#definition-CollectionEntity) **Example** **Query** ```gql query GetEntityByTokenPayload { getEntityByTokenPayload { avatarUrl bannerUrl createdAt description email entityUri id name networkConfigs { activitiesSubgraphUrl agreementFactoryAddress agreementSubgraphUrl alchemyApiKey capabilities { ...NetworkCapabilityFragment } chainId createdAt defaultStripeFeeInPercent dmmAddress feeManagerAddress id jsonRpcUrl lendingContractAddress marketAddress marketOwner nativeCoin nativeCoinDecimals networkName nftSubgraphUrl payeeVaultFactoryAddress paymentBatcherFactoryAddress royaltyLoanFactoryAddress studioPublicJsonRpcUrl updatedAt } redirectDomains { domain } tenant { createdAt id minPaymentBatcherBalanceInUSDC name paymentBatcherAddress tenantUri updatedAt } tenantId type updatedAt } } ``` **Response** ```json { "data": { "getEntityByTokenPayload": { "avatarUrl": "xyz789", "bannerUrl": "xyz789", "createdAt": "2007-12-03T10:15:30Z", "description": "xyz789", "email": "abc123", "entityUri": "xyz789", "id": "4", "name": "xyz789", "networkConfigs": [NetworkConfig], "redirectDomains": [RedirectDomain], "tenant": Tenant, "tenantId": "4", "type": "ARTIST", "updatedAt": "2007-12-03T10:15:30Z" } } } ``` [Queries](#group-Operations-Queries) ### `networkConfigByNameV2` **Description** Returns networkConfig for given network name **Response** Returns a [`NetworkConfigV2Model!`](#definition-NetworkConfigV2Model) **Arguments** | Name | Description | | --------------------------------------------------------- | ----------- | | `networkName` - [`NetworkName!`](#definition-NetworkName) | | **Example** **Query** ```gql query NetworkConfigByNameV2($networkName: NetworkName!) { networkConfigByNameV2(networkName: $networkName) { agreementFactoryAddress agreementSubgraphUrl capabilities { networkCapability } chainId createdAt currencies { lendingToken { ...CurrencyModelFragment } nativeCoin { ...CurrencyModelFragment } otherCurrencies { ...CurrencyModelFragment } } explorer feeManagerAddress id ipfsEndpoint isTestNet jsonRpcUrl lendingContractAddress marketAddress marketOwner networkName nftSubgraphUrl updatedAt } } ``` **Variables** ```json {"networkName": "amoy"} ``` **Response** ```json { "data": { "networkConfigByNameV2": { "agreementFactoryAddress": "abc123", "agreementSubgraphUrl": "abc123", "capabilities": [NetworkCapabilitiesModel], "chainId": 123.45, "createdAt": "2007-12-03T10:15:30Z", "currencies": CurrenciesModel, "explorer": "xyz789", "feeManagerAddress": "xyz789", "id": "xyz789", "ipfsEndpoint": "abc123", "isTestNet": true, "jsonRpcUrl": "abc123", "lendingContractAddress": "xyz789", "marketAddress": "abc123", "marketOwner": "abc123", "networkName": "amoy", "nftSubgraphUrl": "abc123", "updatedAt": "2007-12-03T10:15:30Z" } } } ``` [Queries](#group-Operations-Queries) ### `networkConfigs` **Response** Returns a [`NetworkConfigConnection!`](#definition-NetworkConfigConnection) **Arguments** | Name | Description | | -------------------------------------------------------------------- | ------------------------------------------------------ | | `filter` - [`NetworkConfigFilter!`](#definition-NetworkConfigFilter) | Specify to filter the records returned. Default = `{}` | | `paging` - [`OffsetPaging!`](#definition-OffsetPaging) | Limit or page results. Default = `{limit: 10}` | | `sorting` - [`[NetworkConfigSort!]!`](#definition-NetworkConfigSort) | Specify to sort results. Default = `[]` | **Example** **Query** ```gql query NetworkConfigs( $filter: NetworkConfigFilter!, $paging: OffsetPaging!, $sorting: [NetworkConfigSort!]! ) { networkConfigs( filter: $filter, paging: $paging, sorting: $sorting ) { nodes { activitiesSubgraphUrl agreementFactoryAddress agreementSubgraphUrl alchemyApiKey capabilities { ...NetworkCapabilityFragment } chainId createdAt defaultStripeFeeInPercent dmmAddress feeManagerAddress id jsonRpcUrl lendingContractAddress marketAddress marketOwner nativeCoin nativeCoinDecimals networkName nftSubgraphUrl payeeVaultFactoryAddress paymentBatcherFactoryAddress royaltyLoanFactoryAddress studioPublicJsonRpcUrl updatedAt } pageInfo { hasNextPage hasPreviousPage } totalCount } } ``` **Variables** ```json {"filter": {}, "paging": {"limit": 10}, "sorting": [""]} ``` **Response** ```json { "data": { "networkConfigs": { "nodes": [NetworkConfig], "pageInfo": OffsetPageInfo, "totalCount": 123 } } } ``` [Queries](#group-Operations-Queries) ### `networkConfigsV2` **Description** Returns list of networkConfigs **Response** Returns [`[NetworkConfigV2Model!]!`](#definition-NetworkConfigV2Model) **Example** **Query** ```gql query NetworkConfigsV2 { networkConfigsV2 { agreementFactoryAddress agreementSubgraphUrl capabilities { networkCapability } chainId createdAt currencies { lendingToken { ...CurrencyModelFragment } nativeCoin { ...CurrencyModelFragment } otherCurrencies { ...CurrencyModelFragment } } explorer feeManagerAddress id ipfsEndpoint isTestNet jsonRpcUrl lendingContractAddress marketAddress marketOwner networkName nftSubgraphUrl updatedAt } } ``` **Response** ```json { "data": { "networkConfigsV2": [ { "agreementFactoryAddress": "xyz789", "agreementSubgraphUrl": "abc123", "capabilities": [NetworkCapabilitiesModel], "chainId": 987.65, "createdAt": "2007-12-03T10:15:30Z", "currencies": CurrenciesModel, "explorer": "xyz789", "feeManagerAddress": "xyz789", "id": "abc123", "ipfsEndpoint": "xyz789", "isTestNet": false, "jsonRpcUrl": "xyz789", "lendingContractAddress": "abc123", "marketAddress": "abc123", "marketOwner": "xyz789", "networkName": "amoy", "nftSubgraphUrl": "abc123", "updatedAt": "2007-12-03T10:15:30Z" } ] } } ``` [Queries](#group-Operations-Queries) ### `publicNetworkConfigsV2` **Description** Returns list of networkConfigs without sensitive data **Response** Returns [`[NetworkConfigPublicModel!]!`](#definition-NetworkConfigPublicModel) **Example** **Query** ```gql query PublicNetworkConfigsV2 { publicNetworkConfigsV2 { capabilities { networkCapability } chainId isTestNet networkName studioPublicJsonRpcUrl } } ``` **Response** ```json { "data": { "publicNetworkConfigsV2": [ { "capabilities": [NetworkCapabilitiesModel], "chainId": 987.65, "isTestNet": false, "networkName": "amoy", "studioPublicJsonRpcUrl": "abc123" } ] } } ``` [Queries](#group-Operations-Queries) ### `testConfig` **Response** Returns a [`String!`](#definition-String) **Example** **Query** ```gql query TestConfig { testConfig } ``` **Response** ```json {"data": {"testConfig": "xyz789"}} ``` ## Mutations ### `createContact` **Description** Create contact record. Returns record of the contactBook entity. **Response** Returns a [`ContactDto!`](#definition-ContactDto) **Arguments** | Name | Description | | ------------------------------------------------- | --------------------------- | | `nickName` - [`String!`](#definition-String) | nick name of a contact | | `walletAddress` - [`String!`](#definition-String) | wallet address of a contact | **Example** **Query** ```gql mutation CreateContact( $nickName: String!, $walletAddress: String! ) { createContact( nickName: $nickName, walletAddress: $walletAddress ) { createdAt id nickName ownerUri updatedAt walletAddress } } ``` **Variables** ```json { "nickName": "xyz789", "walletAddress": "xyz789" } ``` **Response** ```json { "data": { "createContact": { "createdAt": "2007-12-03T10:15:30Z", "id": 987.65, "nickName": "abc123", "ownerUri": "abc123", "updatedAt": "2007-12-03T10:15:30Z", "walletAddress": "abc123" } } } ``` [Mutations](#group-Operations-Mutations) ### `createOneCollectionEntity` **Response** Returns a [`CollectionEntity!`](#definition-CollectionEntity) **Arguments** | Name | Description | | ----------------------------------------------------------------------------------------- | ----------- | | `input` - [`CreateOneCollectionEntityInput!`](#definition-CreateOneCollectionEntityInput) | | **Example** **Query** ```gql mutation CreateOneCollectionEntity($input: CreateOneCollectionEntityInput!) { createOneCollectionEntity(input: $input) { avatarUrl bannerUrl createdAt description email entityUri id name networkConfigs { activitiesSubgraphUrl agreementFactoryAddress agreementSubgraphUrl alchemyApiKey capabilities { ...NetworkCapabilityFragment } chainId createdAt defaultStripeFeeInPercent dmmAddress feeManagerAddress id jsonRpcUrl lendingContractAddress marketAddress marketOwner nativeCoin nativeCoinDecimals networkName nftSubgraphUrl payeeVaultFactoryAddress paymentBatcherFactoryAddress royaltyLoanFactoryAddress studioPublicJsonRpcUrl updatedAt } redirectDomains { domain } tenant { createdAt id minPaymentBatcherBalanceInUSDC name paymentBatcherAddress tenantUri updatedAt } tenantId type updatedAt } } ``` **Variables** ```json {"input": CreateOneCollectionEntityInput} ``` **Response** ```json { "data": { "createOneCollectionEntity": { "avatarUrl": "abc123", "bannerUrl": "xyz789", "createdAt": "2007-12-03T10:15:30Z", "description": "abc123", "email": "xyz789", "entityUri": "xyz789", "id": 4, "name": "abc123", "networkConfigs": [NetworkConfig], "redirectDomains": [RedirectDomain], "tenant": Tenant, "tenantId": 4, "type": "ARTIST", "updatedAt": "2007-12-03T10:15:30Z" } } } ``` [Mutations](#group-Operations-Mutations) ### `createRelation` **Response** Returns a [`CollectionEntityRelation!`](#definition-CollectionEntityRelation) **Arguments** | Name | Description | | -------------------------------------------------------------------------------------------------- | ----------- | | `createRelation` - [`CreateCollectionEntityRelation!`](#definition-CreateCollectionEntityRelation) | | **Example** **Query** ```gql mutation CreateRelation($createRelation: CreateCollectionEntityRelation!) { createRelation(createRelation: $createRelation) { childEntityId createdAt id network { activitiesSubgraphUrl agreementFactoryAddress agreementSubgraphUrl alchemyApiKey capabilities { ...NetworkCapabilityFragment } chainId createdAt defaultStripeFeeInPercent dmmAddress feeManagerAddress id jsonRpcUrl lendingContractAddress marketAddress marketOwner nativeCoin nativeCoinDecimals networkName nftSubgraphUrl payeeVaultFactoryAddress paymentBatcherFactoryAddress royaltyLoanFactoryAddress studioPublicJsonRpcUrl updatedAt } parentEntityId relationType tenant { createdAt id minPaymentBatcherBalanceInUSDC name paymentBatcherAddress tenantUri updatedAt } tenantId updatedAt } } ``` **Variables** ```json {"createRelation": CreateCollectionEntityRelation} ``` **Response** ```json { "data": { "createRelation": { "childEntityId": "abc123", "createdAt": "2007-12-03T10:15:30Z", "id": 4, "network": NetworkConfig, "parentEntityId": "abc123", "relationType": "ENTERPIRSE_ARTIST", "tenant": Tenant, "tenantId": "xyz789", "updatedAt": "2007-12-03T10:15:30Z" } } } ``` [Mutations](#group-Operations-Mutations) ### `createS3Url` **Description** 🔒 JWT Token Creates an s3 url for enterprise's avatar or banner **Response** Returns a [`S3LinkRes!`](#definition-S3LinkRes) **Arguments** | Name | Description | | -------------------------------------------------- | ---------------------------------------------------------- | | `s3ReqDto` - [`S3LinkReq!`](#definition-S3LinkReq) |

🔒 JWT Token

defines fileName and contentType

| **Example** **Query** ```gql mutation CreateS3Url($s3ReqDto: S3LinkReq!) { createS3Url(s3ReqDto: $s3ReqDto) { uploadUrl } } ``` **Variables** ```json {"s3ReqDto": S3LinkReq} ``` **Response** ```json { "data": { "createS3Url": {"uploadUrl": "abc123"} } } ``` [Mutations](#group-Operations-Mutations) ### `deleteContact` **Description** Delete contact record. Returns record of the contactBook entity. **Response** Returns a [`ContactDto!`](#definition-ContactDto) **Arguments** | Name | Description | | ------------------------------------ | --------------- | | `id` - [`Float!`](#definition-Float) | id of a contact | **Example** **Query** ```gql mutation DeleteContact($id: Float!) { deleteContact(id: $id) { createdAt id nickName ownerUri updatedAt walletAddress } } ``` **Variables** ```json {"id": 123.45} ``` **Response** ```json { "data": { "deleteContact": { "createdAt": "2007-12-03T10:15:30Z", "id": 123.45, "nickName": "abc123", "ownerUri": "xyz789", "updatedAt": "2007-12-03T10:15:30Z", "walletAddress": "abc123" } } } ``` [Mutations](#group-Operations-Mutations) ### `deleteManyCollectionEntities` **Response** Returns a [`DeleteManyResponse!`](#definition-DeleteManyResponse) **Arguments** | Name | Description | | ----------------------------------------------------------------------------------------------- | ----------- | | `input` - [`DeleteManyCollectionEntitiesInput!`](#definition-DeleteManyCollectionEntitiesInput) | | **Example** **Query** ```gql mutation DeleteManyCollectionEntities($input: DeleteManyCollectionEntitiesInput!) { deleteManyCollectionEntities(input: $input) { deletedCount } } ``` **Variables** ```json {"input": DeleteManyCollectionEntitiesInput} ``` **Response** ```json {"data": {"deleteManyCollectionEntities": {"deletedCount": 987}}} ``` [Mutations](#group-Operations-Mutations) ### `deleteManyRelations` **Response** Returns a [`DeleteManyResponse!`](#definition-DeleteManyResponse) **Arguments** | Name | Description | | ------------------------------------------------------------------------------------------------------------- | ----------- | | `input` - [`DeleteManyCollectionEntityRelationsInput!`](#definition-DeleteManyCollectionEntityRelationsInput) | | **Example** **Query** ```gql mutation DeleteManyRelations($input: DeleteManyCollectionEntityRelationsInput!) { deleteManyRelations(input: $input) { deletedCount } } ``` **Variables** ```json {"input": DeleteManyCollectionEntityRelationsInput} ``` **Response** ```json {"data": {"deleteManyRelations": {"deletedCount": 123}}} ``` [Mutations](#group-Operations-Mutations) ### `deleteOneCollectionEntity` **Response** Returns a [`CollectionEntityDeleteResponse!`](#definition-CollectionEntityDeleteResponse) **Arguments** | Name | Description | | ----------------------------------------------------------------------------------------- | ----------- | | `input` - [`DeleteOneCollectionEntityInput!`](#definition-DeleteOneCollectionEntityInput) | | **Example** **Query** ```gql mutation DeleteOneCollectionEntity($input: DeleteOneCollectionEntityInput!) { deleteOneCollectionEntity(input: $input) { avatarUrl bannerUrl createdAt description email entityUri id name tenantId type updatedAt } } ``` **Variables** ```json {"input": DeleteOneCollectionEntityInput} ``` **Response** ```json { "data": { "deleteOneCollectionEntity": { "avatarUrl": "abc123", "bannerUrl": "xyz789", "createdAt": "2007-12-03T10:15:30Z", "description": "abc123", "email": "xyz789", "entityUri": "abc123", "id": 4, "name": "abc123", "tenantId": "4", "type": "ARTIST", "updatedAt": "2007-12-03T10:15:30Z" } } } ``` [Mutations](#group-Operations-Mutations) ### `deleteOneRelation` **Response** Returns a [`CollectionEntityRelationDeleteResponse!`](#definition-CollectionEntityRelationDeleteResponse) **Arguments** | Name | Description | | --------------------------------------------------------------------------------------------------------- | ----------- | | `input` - [`DeleteOneCollectionEntityRelationInput!`](#definition-DeleteOneCollectionEntityRelationInput) | | **Example** **Query** ```gql mutation DeleteOneRelation($input: DeleteOneCollectionEntityRelationInput!) { deleteOneRelation(input: $input) { childEntityId createdAt id parentEntityId relationType tenantId updatedAt } } ``` **Variables** ```json {"input": DeleteOneCollectionEntityRelationInput} ``` **Response** ```json { "data": { "deleteOneRelation": { "childEntityId": "xyz789", "createdAt": "2007-12-03T10:15:30Z", "id": 4, "parentEntityId": "xyz789", "relationType": "ENTERPIRSE_ARTIST", "tenantId": "abc123", "updatedAt": "2007-12-03T10:15:30Z" } } } ``` [Mutations](#group-Operations-Mutations) ### `updateContact` **Description** Update contact record. Returns record of the contactBook entity. **Response** Returns a [`ContactDto!`](#definition-ContactDto) **Arguments** | Name | Description | | ------------------------------------------------ | --------------------------- | | `id` - [`Float!`](#definition-Float) | id of a contact | | `nickName` - [`String`](#definition-String) | nick name of a contact | | `walletAddress` - [`String`](#definition-String) | wallet address of a contact | **Example** **Query** ```gql mutation UpdateContact( $id: Float!, $nickName: String, $walletAddress: String ) { updateContact( id: $id, nickName: $nickName, walletAddress: $walletAddress ) { createdAt id nickName ownerUri updatedAt walletAddress } } ``` **Variables** ```json { "id": 987.65, "nickName": "xyz789", "walletAddress": "xyz789" } ``` **Response** ```json { "data": { "updateContact": { "createdAt": "2007-12-03T10:15:30Z", "id": 987.65, "nickName": "xyz789", "ownerUri": "xyz789", "updatedAt": "2007-12-03T10:15:30Z", "walletAddress": "abc123" } } } ``` [Mutations](#group-Operations-Mutations) ### `updateManyCollectionEntities` **Response** Returns an [`UpdateManyResponse!`](#definition-UpdateManyResponse) **Arguments** | Name | Description | | ----------------------------------------------------------------------------------------------- | ----------- | | `input` - [`UpdateManyCollectionEntitiesInput!`](#definition-UpdateManyCollectionEntitiesInput) | | **Example** **Query** ```gql mutation UpdateManyCollectionEntities($input: UpdateManyCollectionEntitiesInput!) { updateManyCollectionEntities(input: $input) { updatedCount } } ``` **Variables** ```json {"input": UpdateManyCollectionEntitiesInput} ``` **Response** ```json {"data": {"updateManyCollectionEntities": {"updatedCount": 987}}} ``` [Mutations](#group-Operations-Mutations) ### `updateOneCollectionEntity` **Response** Returns a [`CollectionEntity!`](#definition-CollectionEntity) **Arguments** | Name | Description | | ----------------------------------------------------------------------------------------- | ----------- | | `input` - [`UpdateOneCollectionEntityInput!`](#definition-UpdateOneCollectionEntityInput) | | **Example** **Query** ```gql mutation UpdateOneCollectionEntity($input: UpdateOneCollectionEntityInput!) { updateOneCollectionEntity(input: $input) { avatarUrl bannerUrl createdAt description email entityUri id name networkConfigs { activitiesSubgraphUrl agreementFactoryAddress agreementSubgraphUrl alchemyApiKey capabilities { ...NetworkCapabilityFragment } chainId createdAt defaultStripeFeeInPercent dmmAddress feeManagerAddress id jsonRpcUrl lendingContractAddress marketAddress marketOwner nativeCoin nativeCoinDecimals networkName nftSubgraphUrl payeeVaultFactoryAddress paymentBatcherFactoryAddress royaltyLoanFactoryAddress studioPublicJsonRpcUrl updatedAt } redirectDomains { domain } tenant { createdAt id minPaymentBatcherBalanceInUSDC name paymentBatcherAddress tenantUri updatedAt } tenantId type updatedAt } } ``` **Variables** ```json {"input": UpdateOneCollectionEntityInput} ``` **Response** ```json { "data": { "updateOneCollectionEntity": { "avatarUrl": "abc123", "bannerUrl": "abc123", "createdAt": "2007-12-03T10:15:30Z", "description": "abc123", "email": "xyz789", "entityUri": "xyz789", "id": "4", "name": "abc123", "networkConfigs": [NetworkConfig], "redirectDomains": [RedirectDomain], "tenant": Tenant, "tenantId": "4", "type": "ARTIST", "updatedAt": "2007-12-03T10:15:30Z" } } } ``` ## Types ### Boolean **Description** The `Boolean` scalar type represents `true` or `false`. **Example** ```json true ``` [Types](#group-Types) ### CollectionEntity **Description** represents an element of the hierarchy within the enterprise. **Fields** | Field Name | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `avatarUrl` - [`String`](#definition-String) | avatar url, displayed on the storefront. | | `bannerUrl` - [`String`](#definition-String) | banner url, displayed on the storefront. | | `createdAt` - [`DateTime!`](#definition-DateTime) | Time at which the object was created. | | `description` - [`String`](#definition-String) | Entity description. | | `email` - [`String`](#definition-String) | collection entity email. | | `entityUri` - [`String`](#definition-String) | Identifier of the entity. This value corresponds to the ID from the revelator database. | | `id` - [`ID!`](#definition-ID) | Auto-incrementing identifier. | | `name` - [`String!`](#definition-String) | Entity name. | | `networkConfigs` - [`[NetworkConfig!]!`](#definition-NetworkConfig) | | |

Arguments

filter - NetworkConfigFilter!

Specify to filter the records returned.

sorting - \[NetworkConfigSort!]!

Specify to sort results.

| | | `redirectDomains` - [`[RedirectDomain!]!`](#definition-RedirectDomain) | | |

Arguments

filter - RedirectDomainFilter!

Specify to filter the records returned.

sorting - \[RedirectDomainSort!]!

Specify to sort results.

| | | `tenant` - [`Tenant!`](#definition-Tenant) | | | `tenantId` - [`ID!`](#definition-ID) | Tenant ID to which artists, enterprise and labels belong. | | `type` - [`CollectionEntityType!`](#definition-CollectionEntityType) | Specifies the type of entry. Represents the hierarchy level within the enterprise. | | `updatedAt` - [`DateTime!`](#definition-DateTime) | Time at which the object was last updated. | **Example** ```json { "avatarUrl": "xyz789", "bannerUrl": "xyz789", "createdAt": "2007-12-03T10:15:30Z", "description": "abc123", "email": "abc123", "entityUri": "xyz789", "id": 4, "name": "xyz789", "networkConfigs": [NetworkConfig], "redirectDomains": [RedirectDomain], "tenant": Tenant, "tenantId": "4", "type": "ARTIST", "updatedAt": "2007-12-03T10:15:30Z" } ``` [Types](#group-Types) ### CollectionEntityConnection **Fields** | Field Name | Description | | ---------------------------------------------------------------- | ---------------------------- | | `nodes` - [`[CollectionEntity!]!`](#definition-CollectionEntity) | Array of nodes. | | `pageInfo` - [`OffsetPageInfo!`](#definition-OffsetPageInfo) | Paging information | | `totalCount` - [`Int!`](#definition-Int) | Fetch total count of records | **Example** ```json { "nodes": [CollectionEntity], "pageInfo": OffsetPageInfo, "totalCount": 987 } ``` [Types](#group-Types) ### CollectionEntityDeleteFilter **Fields** | Input Field | Description | | --------------------------------------------------------------------------------------------------- | ----------- | | `and` - [`[CollectionEntityDeleteFilter!]`](#definition-CollectionEntityDeleteFilter) | | | `avatarUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `bannerUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `createdAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | | `description` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `email` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `entityUri` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `id` - [`IDFilterComparison`](#definition-IDFilterComparison) | | | `name` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `or` - [`[CollectionEntityDeleteFilter!]`](#definition-CollectionEntityDeleteFilter) | | | `tenantId` - [`IDFilterComparison`](#definition-IDFilterComparison) | | | `type` - [`CollectionEntityTypeFilterComparison`](#definition-CollectionEntityTypeFilterComparison) | | | `updatedAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | **Example** ```json { "and": [CollectionEntityDeleteFilter], "avatarUrl": StringFieldComparison, "bannerUrl": StringFieldComparison, "createdAt": DateFieldComparison, "description": StringFieldComparison, "email": StringFieldComparison, "entityUri": StringFieldComparison, "id": IDFilterComparison, "name": StringFieldComparison, "or": [CollectionEntityDeleteFilter], "tenantId": IDFilterComparison, "type": CollectionEntityTypeFilterComparison, "updatedAt": DateFieldComparison } ``` [Types](#group-Types) ### CollectionEntityDeleteResponse **Fields** | Field Name | Description | | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `avatarUrl` - [`String`](#definition-String) | avatar url, displayed on the storefront. | | `bannerUrl` - [`String`](#definition-String) | banner url, displayed on the storefront. | | `createdAt` - [`DateTime`](#definition-DateTime) | Time at which the object was created. | | `description` - [`String`](#definition-String) | Entity description. | | `email` - [`String`](#definition-String) | collection entity email. | | `entityUri` - [`String`](#definition-String) | Identifier of the entity. This value corresponds to the ID from the revelator database. | | `id` - [`ID`](#definition-ID) | Auto-incrementing identifier. | | `name` - [`String`](#definition-String) | Entity name. | | `tenantId` - [`ID`](#definition-ID) | Tenant ID to which artists, enterprise and labels belong. | | `type` - [`CollectionEntityType`](#definition-CollectionEntityType) | Specifies the type of entry. Represents the hierarchy level within the enterprise. | | `updatedAt` - [`DateTime`](#definition-DateTime) | Time at which the object was last updated. | **Example** ```json { "avatarUrl": "xyz789", "bannerUrl": "xyz789", "createdAt": "2007-12-03T10:15:30Z", "description": "xyz789", "email": "xyz789", "entityUri": "xyz789", "id": 4, "name": "abc123", "tenantId": 4, "type": "ARTIST", "updatedAt": "2007-12-03T10:15:30Z" } ``` [Types](#group-Types) ### CollectionEntityFilter **Fields** | Input Field | Description | | -------------------------------------------------------------------------------------------------------------------------- | ----------- | | `and` - [`[CollectionEntityFilter!]`](#definition-CollectionEntityFilter) | | | `avatarUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `bannerUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `createdAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | | `description` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `email` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `entityUri` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `id` - [`IDFilterComparison`](#definition-IDFilterComparison) | | | `name` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `or` - [`[CollectionEntityFilter!]`](#definition-CollectionEntityFilter) | | | `redirectDomains` - [`CollectionEntityFilterRedirectDomainFilter`](#definition-CollectionEntityFilterRedirectDomainFilter) | | | `tenant` - [`CollectionEntityFilterTenantFilter`](#definition-CollectionEntityFilterTenantFilter) | | | `tenantId` - [`IDFilterComparison`](#definition-IDFilterComparison) | | | `type` - [`CollectionEntityTypeFilterComparison`](#definition-CollectionEntityTypeFilterComparison) | | | `updatedAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | **Example** ```json { "and": [CollectionEntityFilter], "avatarUrl": StringFieldComparison, "bannerUrl": StringFieldComparison, "createdAt": DateFieldComparison, "description": StringFieldComparison, "email": StringFieldComparison, "entityUri": StringFieldComparison, "id": IDFilterComparison, "name": StringFieldComparison, "or": [CollectionEntityFilter], "redirectDomains": CollectionEntityFilterRedirectDomainFilter, "tenant": CollectionEntityFilterTenantFilter, "tenantId": IDFilterComparison, "type": CollectionEntityTypeFilterComparison, "updatedAt": DateFieldComparison } ``` [Types](#group-Types) ### CollectionEntityFilterRedirectDomainFilter **Fields** | Input Field | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------- | | `and` - [`[CollectionEntityFilterRedirectDomainFilter!]`](#definition-CollectionEntityFilterRedirectDomainFilter) | | | `domain` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `or` - [`[CollectionEntityFilterRedirectDomainFilter!]`](#definition-CollectionEntityFilterRedirectDomainFilter) | | **Example** ```json { "and": [CollectionEntityFilterRedirectDomainFilter], "domain": StringFieldComparison, "or": [CollectionEntityFilterRedirectDomainFilter] } ``` [Types](#group-Types) ### CollectionEntityFilterTenantFilter **Fields** | Input Field | Description | | ------------------------------------------------------------------------------------------------- | ----------- | | `and` - [`[CollectionEntityFilterTenantFilter!]`](#definition-CollectionEntityFilterTenantFilter) | | | `createdAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | | `id` - [`IDFilterComparison`](#definition-IDFilterComparison) | | | `minPaymentBatcherBalanceInUSDC` - [`NumberFieldComparison`](#definition-NumberFieldComparison) | | | `name` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `or` - [`[CollectionEntityFilterTenantFilter!]`](#definition-CollectionEntityFilterTenantFilter) | | | `paymentBatcherAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `tenantUri` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `updatedAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | **Example** ```json { "and": [CollectionEntityFilterTenantFilter], "createdAt": DateFieldComparison, "id": IDFilterComparison, "minPaymentBatcherBalanceInUSDC": NumberFieldComparison, "name": StringFieldComparison, "or": [CollectionEntityFilterTenantFilter], "paymentBatcherAddress": StringFieldComparison, "tenantUri": StringFieldComparison, "updatedAt": DateFieldComparison } ``` [Types](#group-Types) ### CollectionEntityRelation **Description** represents a relationship between two entities. **Fields** | Field Name | Description | | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | `childEntityId` - [`String!`](#definition-String) | Relationship child ID. | | `createdAt` - [`DateTime!`](#definition-DateTime) | Time at which the object was created. | | `id` - [`ID!`](#definition-ID) | Auto-incrementing identifier. | | `network` - [`NetworkConfig!`](#definition-NetworkConfig) | | | `parentEntityId` - [`String!`](#definition-String) | Relationship parent ID. | | `relationType` - [`CollectionEntityRelationType!`](#definition-CollectionEntityRelationType) | Specifies the type of the relation. For example: LABEL -> ARTIST. | | `tenant` - [`Tenant!`](#definition-Tenant) | | | `tenantId` - [`String!`](#definition-String) | Tenant ID to which artists, enterprise and labels belong. | | `updatedAt` - [`DateTime!`](#definition-DateTime) | Time at which the object was last updated. | **Example** ```json { "childEntityId": "abc123", "createdAt": "2007-12-03T10:15:30Z", "id": "4", "network": NetworkConfig, "parentEntityId": "abc123", "relationType": "ENTERPIRSE_ARTIST", "tenant": Tenant, "tenantId": "abc123", "updatedAt": "2007-12-03T10:15:30Z" } ``` [Types](#group-Types) ### CollectionEntityRelationConnection **Fields** | Field Name | Description | | -------------------------------------------------------------------------------- | ---------------------------- | | `nodes` - [`[CollectionEntityRelation!]!`](#definition-CollectionEntityRelation) | Array of nodes. | | `pageInfo` - [`OffsetPageInfo!`](#definition-OffsetPageInfo) | Paging information | | `totalCount` - [`Int!`](#definition-Int) | Fetch total count of records | **Example** ```json { "nodes": [CollectionEntityRelation], "pageInfo": OffsetPageInfo, "totalCount": 987 } ``` [Types](#group-Types) ### CollectionEntityRelationDeleteFilter **Fields** | Input Field | Description | | --------------------------------------------------------------------------------------------------------------------------- | ----------- | | `and` - [`[CollectionEntityRelationDeleteFilter!]`](#definition-CollectionEntityRelationDeleteFilter) | | | `childEntityId` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `createdAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | | `id` - [`IDFilterComparison`](#definition-IDFilterComparison) | | | `or` - [`[CollectionEntityRelationDeleteFilter!]`](#definition-CollectionEntityRelationDeleteFilter) | | | `parentEntityId` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `relationType` - [`CollectionEntityRelationTypeFilterComparison`](#definition-CollectionEntityRelationTypeFilterComparison) | | | `tenantId` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `updatedAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | **Example** ```json { "and": [CollectionEntityRelationDeleteFilter], "childEntityId": StringFieldComparison, "createdAt": DateFieldComparison, "id": IDFilterComparison, "or": [CollectionEntityRelationDeleteFilter], "parentEntityId": StringFieldComparison, "relationType": CollectionEntityRelationTypeFilterComparison, "tenantId": StringFieldComparison, "updatedAt": DateFieldComparison } ``` [Types](#group-Types) ### CollectionEntityRelationDeleteResponse **Fields** | Field Name | Description | | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | `childEntityId` - [`String`](#definition-String) | Relationship child ID. | | `createdAt` - [`DateTime`](#definition-DateTime) | Time at which the object was created. | | `id` - [`ID`](#definition-ID) | Auto-incrementing identifier. | | `parentEntityId` - [`String`](#definition-String) | Relationship parent ID. | | `relationType` - [`CollectionEntityRelationType`](#definition-CollectionEntityRelationType) | Specifies the type of the relation. For example: LABEL -> ARTIST. | | `tenantId` - [`String`](#definition-String) | Tenant ID to which artists, enterprise and labels belong. | | `updatedAt` - [`DateTime`](#definition-DateTime) | Time at which the object was last updated. | **Example** ```json { "childEntityId": "abc123", "createdAt": "2007-12-03T10:15:30Z", "id": 4, "parentEntityId": "xyz789", "relationType": "ENTERPIRSE_ARTIST", "tenantId": "xyz789", "updatedAt": "2007-12-03T10:15:30Z" } ``` [Types](#group-Types) ### CollectionEntityRelationFilter **Fields** | Input Field | Description | | -------------------------------------------------------------------------------------------------------------------------------- | ----------- | | `and` - [`[CollectionEntityRelationFilter!]`](#definition-CollectionEntityRelationFilter) | | | `childEntityId` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `createdAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | | `id` - [`IDFilterComparison`](#definition-IDFilterComparison) | | | `network` - [`CollectionEntityRelationFilterNetworkConfigFilter`](#definition-CollectionEntityRelationFilterNetworkConfigFilter) | | | `or` - [`[CollectionEntityRelationFilter!]`](#definition-CollectionEntityRelationFilter) | | | `parentEntityId` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `relationType` - [`CollectionEntityRelationTypeFilterComparison`](#definition-CollectionEntityRelationTypeFilterComparison) | | | `tenant` - [`CollectionEntityRelationFilterTenantFilter`](#definition-CollectionEntityRelationFilterTenantFilter) | | | `tenantId` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `updatedAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | **Example** ```json { "and": [CollectionEntityRelationFilter], "childEntityId": StringFieldComparison, "createdAt": DateFieldComparison, "id": IDFilterComparison, "network": CollectionEntityRelationFilterNetworkConfigFilter, "or": [CollectionEntityRelationFilter], "parentEntityId": StringFieldComparison, "relationType": CollectionEntityRelationTypeFilterComparison, "tenant": CollectionEntityRelationFilterTenantFilter, "tenantId": StringFieldComparison, "updatedAt": DateFieldComparison } ``` [Types](#group-Types) ### CollectionEntityRelationFilterNetworkConfigFilter **Fields** | Input Field | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ----------- | | `activitiesSubgraphUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `agreementFactoryAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `agreementSubgraphUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `alchemyApiKey` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `and` - [`[CollectionEntityRelationFilterNetworkConfigFilter!]`](#definition-CollectionEntityRelationFilterNetworkConfigFilter) | | | `chainId` - [`IntFieldComparison`](#definition-IntFieldComparison) | | | `createdAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | | `defaultStripeFeeInPercent` - [`IntFieldComparison`](#definition-IntFieldComparison) | | | `dmmAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `feeManagerAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `id` - [`IDFilterComparison`](#definition-IDFilterComparison) | | | `jsonRpcUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `lendingContractAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `marketAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `marketOwner` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `nativeCoin` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `nativeCoinDecimals` - [`IntFieldComparison`](#definition-IntFieldComparison) | | | `networkName` - [`NetworkNameFilterComparison`](#definition-NetworkNameFilterComparison) | | | `nftSubgraphUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `or` - [`[CollectionEntityRelationFilterNetworkConfigFilter!]`](#definition-CollectionEntityRelationFilterNetworkConfigFilter) | | | `payeeVaultFactoryAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `paymentBatcherFactoryAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `royaltyLoanFactoryAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `studioPublicJsonRpcUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `updatedAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | **Example** ```json { "activitiesSubgraphUrl": StringFieldComparison, "agreementFactoryAddress": StringFieldComparison, "agreementSubgraphUrl": StringFieldComparison, "alchemyApiKey": StringFieldComparison, "and": [ CollectionEntityRelationFilterNetworkConfigFilter ], "chainId": IntFieldComparison, "createdAt": DateFieldComparison, "defaultStripeFeeInPercent": IntFieldComparison, "dmmAddress": StringFieldComparison, "feeManagerAddress": StringFieldComparison, "id": IDFilterComparison, "jsonRpcUrl": StringFieldComparison, "lendingContractAddress": StringFieldComparison, "marketAddress": StringFieldComparison, "marketOwner": StringFieldComparison, "nativeCoin": StringFieldComparison, "nativeCoinDecimals": IntFieldComparison, "networkName": NetworkNameFilterComparison, "nftSubgraphUrl": StringFieldComparison, "or": [ CollectionEntityRelationFilterNetworkConfigFilter ], "payeeVaultFactoryAddress": StringFieldComparison, "paymentBatcherFactoryAddress": StringFieldComparison, "royaltyLoanFactoryAddress": StringFieldComparison, "studioPublicJsonRpcUrl": StringFieldComparison, "updatedAt": DateFieldComparison } ``` [Types](#group-Types) ### CollectionEntityRelationFilterTenantFilter **Fields** | Input Field | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------- | | `and` - [`[CollectionEntityRelationFilterTenantFilter!]`](#definition-CollectionEntityRelationFilterTenantFilter) | | | `createdAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | | `id` - [`IDFilterComparison`](#definition-IDFilterComparison) | | | `minPaymentBatcherBalanceInUSDC` - [`NumberFieldComparison`](#definition-NumberFieldComparison) | | | `name` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `or` - [`[CollectionEntityRelationFilterTenantFilter!]`](#definition-CollectionEntityRelationFilterTenantFilter) | | | `paymentBatcherAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `tenantUri` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `updatedAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | **Example** ```json { "and": [CollectionEntityRelationFilterTenantFilter], "createdAt": DateFieldComparison, "id": IDFilterComparison, "minPaymentBatcherBalanceInUSDC": NumberFieldComparison, "name": StringFieldComparison, "or": [CollectionEntityRelationFilterTenantFilter], "paymentBatcherAddress": StringFieldComparison, "tenantUri": StringFieldComparison, "updatedAt": DateFieldComparison } ``` [Types](#group-Types) ### CollectionEntityRelationSort **Fields** | Input Field | Description | | ------------------------------------------------------------------------------------------------- | ----------- | | `direction` - [`SortDirection!`](#definition-SortDirection) | | | `field` - [`CollectionEntityRelationSortFields!`](#definition-CollectionEntityRelationSortFields) | | | `nulls` - [`SortNulls`](#definition-SortNulls) | | **Example** ```json {"direction": "ASC", "field": "childEntityId", "nulls": "NULLS_FIRST"} ``` [Types](#group-Types) ### CollectionEntityRelationSortFields **Values** | Enum Value | Description | | ---------------- | ----------- | | `childEntityId` | | | `createdAt` | | | `id` | | | `parentEntityId` | | | `relationType` | | | `tenantId` | | | `updatedAt` | | **Example** ```gql "childEntityId" ``` [Types](#group-Types) ### CollectionEntityRelationType **Values** | Enum Value | Description | | ------------------- | ----------- | | `ENTERPIRSE_ARTIST` | | | `ENTERPIRSE_LABEL` | | | `LABEL_ARTIST` | | | `TENANT_ENTERPRISE` | | **Example** ```gql "ENTERPIRSE_ARTIST" ``` [Types](#group-Types) ### CollectionEntityRelationTypeFilterComparison **Fields** | Input Field | Description | | --------------------------------------------------------------------------------------- | ----------- | | `eq` - [`CollectionEntityRelationType`](#definition-CollectionEntityRelationType) | | | `gt` - [`CollectionEntityRelationType`](#definition-CollectionEntityRelationType) | | | `gte` - [`CollectionEntityRelationType`](#definition-CollectionEntityRelationType) | | | `iLike` - [`CollectionEntityRelationType`](#definition-CollectionEntityRelationType) | | | `in` - [`[CollectionEntityRelationType!]`](#definition-CollectionEntityRelationType) | | | `is` - [`Boolean`](#definition-Boolean) | | | `isNot` - [`Boolean`](#definition-Boolean) | | | `like` - [`CollectionEntityRelationType`](#definition-CollectionEntityRelationType) | | | `lt` - [`CollectionEntityRelationType`](#definition-CollectionEntityRelationType) | | | `lte` - [`CollectionEntityRelationType`](#definition-CollectionEntityRelationType) | | | `neq` - [`CollectionEntityRelationType`](#definition-CollectionEntityRelationType) | | | `notILike` - [`CollectionEntityRelationType`](#definition-CollectionEntityRelationType) | | | `notIn` - [`[CollectionEntityRelationType!]`](#definition-CollectionEntityRelationType) | | | `notLike` - [`CollectionEntityRelationType`](#definition-CollectionEntityRelationType) | | **Example** ```json { "eq": "ENTERPIRSE_ARTIST", "gt": "ENTERPIRSE_ARTIST", "gte": "ENTERPIRSE_ARTIST", "iLike": "ENTERPIRSE_ARTIST", "in": ["ENTERPIRSE_ARTIST"], "is": true, "isNot": true, "like": "ENTERPIRSE_ARTIST", "lt": "ENTERPIRSE_ARTIST", "lte": "ENTERPIRSE_ARTIST", "neq": "ENTERPIRSE_ARTIST", "notILike": "ENTERPIRSE_ARTIST", "notIn": ["ENTERPIRSE_ARTIST"], "notLike": "ENTERPIRSE_ARTIST" } ``` [Types](#group-Types) ### CollectionEntitySort **Fields** | Input Field | Description | | --------------------------------------------------------------------------------- | ----------- | | `direction` - [`SortDirection!`](#definition-SortDirection) | | | `field` - [`CollectionEntitySortFields!`](#definition-CollectionEntitySortFields) | | | `nulls` - [`SortNulls`](#definition-SortNulls) | | **Example** ```json {"direction": "ASC", "field": "avatarUrl", "nulls": "NULLS_FIRST"} ``` [Types](#group-Types) ### CollectionEntitySortFields **Values** | Enum Value | Description | | ------------- | ----------- | | `avatarUrl` | | | `bannerUrl` | | | `createdAt` | | | `description` | | | `email` | | | `entityUri` | | | `id` | | | `name` | | | `tenantId` | | | `type` | | | `updatedAt` | | **Example** ```gql "avatarUrl" ``` [Types](#group-Types) ### CollectionEntityType **Values** | Enum Value | Description | | ------------ | ----------- | | `ARTIST` | | | `ENTERPRISE` | | | `LABEL` | | **Example** ```gql "ARTIST" ``` [Types](#group-Types) ### CollectionEntityTypeFilterComparison **Fields** | Input Field | Description | | ----------------------------------------------------------------------- | ----------- | | `eq` - [`CollectionEntityType`](#definition-CollectionEntityType) | | | `gt` - [`CollectionEntityType`](#definition-CollectionEntityType) | | | `gte` - [`CollectionEntityType`](#definition-CollectionEntityType) | | | `iLike` - [`CollectionEntityType`](#definition-CollectionEntityType) | | | `in` - [`[CollectionEntityType!]`](#definition-CollectionEntityType) | | | `is` - [`Boolean`](#definition-Boolean) | | | `isNot` - [`Boolean`](#definition-Boolean) | | | `like` - [`CollectionEntityType`](#definition-CollectionEntityType) | | | `lt` - [`CollectionEntityType`](#definition-CollectionEntityType) | | | `lte` - [`CollectionEntityType`](#definition-CollectionEntityType) | | | `neq` - [`CollectionEntityType`](#definition-CollectionEntityType) | | | `notILike` - [`CollectionEntityType`](#definition-CollectionEntityType) | | | `notIn` - [`[CollectionEntityType!]`](#definition-CollectionEntityType) | | | `notLike` - [`CollectionEntityType`](#definition-CollectionEntityType) | | **Example** ```json { "eq": "ARTIST", "gt": "ARTIST", "gte": "ARTIST", "iLike": "ARTIST", "in": ["ARTIST"], "is": true, "isNot": true, "like": "ARTIST", "lt": "ARTIST", "lte": "ARTIST", "neq": "ARTIST", "notILike": "ARTIST", "notIn": ["ARTIST"], "notLike": "ARTIST" } ``` [Types](#group-Types) ### CollectionEntityUpdateFilter **Fields** | Input Field | Description | | --------------------------------------------------------------------------------------------------- | ----------- | | `and` - [`[CollectionEntityUpdateFilter!]`](#definition-CollectionEntityUpdateFilter) | | | `avatarUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `bannerUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `createdAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | | `description` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `email` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `entityUri` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `id` - [`IDFilterComparison`](#definition-IDFilterComparison) | | | `name` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `or` - [`[CollectionEntityUpdateFilter!]`](#definition-CollectionEntityUpdateFilter) | | | `tenantId` - [`IDFilterComparison`](#definition-IDFilterComparison) | | | `type` - [`CollectionEntityTypeFilterComparison`](#definition-CollectionEntityTypeFilterComparison) | | | `updatedAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | **Example** ```json { "and": [CollectionEntityUpdateFilter], "avatarUrl": StringFieldComparison, "bannerUrl": StringFieldComparison, "createdAt": DateFieldComparison, "description": StringFieldComparison, "email": StringFieldComparison, "entityUri": StringFieldComparison, "id": IDFilterComparison, "name": StringFieldComparison, "or": [CollectionEntityUpdateFilter], "tenantId": IDFilterComparison, "type": CollectionEntityTypeFilterComparison, "updatedAt": DateFieldComparison } ``` [Types](#group-Types) ### ContactDto **Description** contact object **Fields** | Field Name | Description | | ------------------------------------------------- | ---------------------------------------------- | | `createdAt` - [`DateTime!`](#definition-DateTime) | Time at which the object was created. | | `id` - [`Float!`](#definition-Float) | Unique identifier for the contact. | | `nickName` - [`String!`](#definition-String) | Name of a contact. | | `ownerUri` - [`String!`](#definition-String) | Revelator unique identifier for an enterprise. | | `updatedAt` - [`DateTime!`](#definition-DateTime) | Time at which the object was last updated. | | `walletAddress` - [`String!`](#definition-String) | Wallet address of a contact. | **Example** ```json { "createdAt": "2007-12-03T10:15:30Z", "id": 123.45, "nickName": "xyz789", "ownerUri": "abc123", "updatedAt": "2007-12-03T10:15:30Z", "walletAddress": "abc123" } ``` [Types](#group-Types) ### ContactsDto **Fields** | Field Name | Description | | ---------------------------------------------------- | ----------- | | `count` - [`Float!`](#definition-Float) | | | `items` - [`[ContactDto!]!`](#definition-ContactDto) | | **Example** ```json {"count": 987.65, "items": [ContactDto]} ``` [Types](#group-Types) ### CreateCollectionEntity **Fields** | Input Field | Description | | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `avatarUrl` - [`String`](#definition-String) | avatar url, displayed on the storefront. | | `bannerUrl` - [`String`](#definition-String) | banner url, displayed on the storefront. | | `description` - [`String`](#definition-String) | Entity description. | | `email` - [`String`](#definition-String) | collection entity email. | | `entityUri` - [`String`](#definition-String) | Identifier of the entity. This value corresponds to the ID from the revelator database. | | `name` - [`String!`](#definition-String) | Entity name. | | `networkNames` - [`[NetworkName!]!`](#definition-NetworkName) | | | `type` - [`CollectionEntityType!`](#definition-CollectionEntityType) | Specifies the type of entry. Represents the hierarchy level within the enterprise. | **Example** ```json { "avatarUrl": "xyz789", "bannerUrl": "xyz789", "description": "xyz789", "email": "abc123", "entityUri": "xyz789", "name": "xyz789", "networkNames": ["amoy"], "type": "ARTIST" } ``` [Types](#group-Types) ### CreateCollectionEntityRelation **Fields** | Input Field | Description | | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | `childEntityId` - [`String!`](#definition-String) | Relationship child ID. | | `parentEntityId` - [`String!`](#definition-String) | Relationship parent ID. | | `relationType` - [`CollectionEntityRelationType!`](#definition-CollectionEntityRelationType) | Specifies the type of the relation. For example: LABEL -> ARTIST. | **Example** ```json { "childEntityId": "abc123", "parentEntityId": "xyz789", "relationType": "ENTERPIRSE_ARTIST" } ``` [Types](#group-Types) ### CreateOneCollectionEntityInput **Fields** | Input Field | Description | | ------------------------------------------------------------------------------------ | -------------------- | | `collectionEntity` - [`CreateCollectionEntity!`](#definition-CreateCollectionEntity) | The record to create | **Example** ```json {"collectionEntity": CreateCollectionEntity} ``` [Types](#group-Types) ### CurrenciesModel **Fields** | Field Name | Description | | -------------------------------------------------------------------- | ----------- | | `lendingToken` - [`CurrencyModel!`](#definition-CurrencyModel) | | | `nativeCoin` - [`CurrencyModel!`](#definition-CurrencyModel) | | | `otherCurrencies` - [`[CurrencyModel!]!`](#definition-CurrencyModel) | | **Example** ```json { "lendingToken": CurrencyModel, "nativeCoin": CurrencyModel, "otherCurrencies": [CurrencyModel] } ``` [Types](#group-Types) ### CurrencyModel **Fields** | Field Name | Description | | ------------------------------------------- | ----------- | | `address` - [`String!`](#definition-String) | | | `decimals` - [`Float!`](#definition-Float) | | | `symbol` - [`String!`](#definition-String) | | **Example** ```json { "address": "xyz789", "decimals": 987.65, "symbol": "abc123" } ``` [Types](#group-Types) ### DateFieldComparison **Fields** | Input Field | Description | | ------------------------------------------------------------------------------------- | ----------- | | `between` - [`DateFieldComparisonBetween`](#definition-DateFieldComparisonBetween) | | | `eq` - [`DateTime`](#definition-DateTime) | | | `gt` - [`DateTime`](#definition-DateTime) | | | `gte` - [`DateTime`](#definition-DateTime) | | | `in` - [`[DateTime!]`](#definition-DateTime) | | | `is` - [`Boolean`](#definition-Boolean) | | | `isNot` - [`Boolean`](#definition-Boolean) | | | `lt` - [`DateTime`](#definition-DateTime) | | | `lte` - [`DateTime`](#definition-DateTime) | | | `neq` - [`DateTime`](#definition-DateTime) | | | `notBetween` - [`DateFieldComparisonBetween`](#definition-DateFieldComparisonBetween) | | | `notIn` - [`[DateTime!]`](#definition-DateTime) | | **Example** ```json { "between": DateFieldComparisonBetween, "eq": "2007-12-03T10:15:30Z", "gt": "2007-12-03T10:15:30Z", "gte": "2007-12-03T10:15:30Z", "in": ["2007-12-03T10:15:30Z"], "is": false, "isNot": true, "lt": "2007-12-03T10:15:30Z", "lte": "2007-12-03T10:15:30Z", "neq": "2007-12-03T10:15:30Z", "notBetween": DateFieldComparisonBetween, "notIn": ["2007-12-03T10:15:30Z"] } ``` [Types](#group-Types) ### DateFieldComparisonBetween **Fields** | Input Field | Description | | --------------------------------------------- | ----------- | | `lower` - [`DateTime!`](#definition-DateTime) | | | `upper` - [`DateTime!`](#definition-DateTime) | | **Example** ```json { "lower": "2007-12-03T10:15:30Z", "upper": "2007-12-03T10:15:30Z" } ``` [Types](#group-Types) ### DateTime **Description** A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format. **Example** ```gql "2007-12-03T10:15:30Z" ``` [Types](#group-Types) ### DeleteManyCollectionEntitiesInput **Fields** | Input Field | Description | | -------------------------------------------------------------------------------------- | -------------------------------- | | `filter` - [`CollectionEntityDeleteFilter!`](#definition-CollectionEntityDeleteFilter) | Filter to find records to delete | **Example** ```json {"filter": CollectionEntityDeleteFilter} ``` [Types](#group-Types) ### DeleteManyCollectionEntityRelationsInput **Fields** | Input Field | Description | | ------------------------------------------------------------------------------------------------------ | -------------------------------- | | `filter` - [`CollectionEntityRelationDeleteFilter!`](#definition-CollectionEntityRelationDeleteFilter) | Filter to find records to delete | **Example** ```json {"filter": CollectionEntityRelationDeleteFilter} ``` [Types](#group-Types) ### DeleteManyResponse **Fields** | Field Name | Description | | ------------------------------------------ | ------------------------------ | | `deletedCount` - [`Int!`](#definition-Int) | The number of records deleted. | **Example** ```json {"deletedCount": 987} ``` [Types](#group-Types) ### DeleteOneCollectionEntityInput **Fields** | Input Field | Description | | ------------------------------ | ------------------------------- | | `id` - [`ID!`](#definition-ID) | The id of the record to delete. | **Example** ```json {"id": 4} ``` [Types](#group-Types) ### DeleteOneCollectionEntityRelationInput **Fields** | Input Field | Description | | ------------------------------ | ------------------------------- | | `id` - [`ID!`](#definition-ID) | The id of the record to delete. | **Example** ```json {"id": 4} ``` [Types](#group-Types) ### FileType **Values** | Enum Value | Description | | --------------- | ----------- | | `ENTITY_AVATAR` | | | `ENTITY_BANNER` | | **Example** ```gql "ENTITY_AVATAR" ``` [Types](#group-Types) ### Float **Description** The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). **Example** ```json 987.65 ``` [Types](#group-Types) ### ID **Description** The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID. **Example** ```json 4 ``` [Types](#group-Types) ### IDFilterComparison **Fields** | Input Field | Description | | ------------------------------------------ | ----------- | | `eq` - [`ID`](#definition-ID) | | | `gt` - [`ID`](#definition-ID) | | | `gte` - [`ID`](#definition-ID) | | | `iLike` - [`ID`](#definition-ID) | | | `in` - [`[ID!]`](#definition-ID) | | | `is` - [`Boolean`](#definition-Boolean) | | | `isNot` - [`Boolean`](#definition-Boolean) | | | `like` - [`ID`](#definition-ID) | | | `lt` - [`ID`](#definition-ID) | | | `lte` - [`ID`](#definition-ID) | | | `neq` - [`ID`](#definition-ID) | | | `notILike` - [`ID`](#definition-ID) | | | `notIn` - [`[ID!]`](#definition-ID) | | | `notLike` - [`ID`](#definition-ID) | | **Example** ```json { "eq": "4", "gt": 4, "gte": "4", "iLike": "4", "in": ["4"], "is": true, "isNot": false, "like": 4, "lt": "4", "lte": 4, "neq": 4, "notILike": 4, "notIn": ["4"], "notLike": 4 } ``` [Types](#group-Types) ### Int **Description** The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. **Example** ```json 123 ``` [Types](#group-Types) ### IntFieldComparison **Fields** | Input Field | Description | | ----------------------------------------------------------------------------------- | ----------- | | `between` - [`IntFieldComparisonBetween`](#definition-IntFieldComparisonBetween) | | | `eq` - [`Int`](#definition-Int) | | | `gt` - [`Int`](#definition-Int) | | | `gte` - [`Int`](#definition-Int) | | | `in` - [`[Int!]`](#definition-Int) | | | `is` - [`Boolean`](#definition-Boolean) | | | `isNot` - [`Boolean`](#definition-Boolean) | | | `lt` - [`Int`](#definition-Int) | | | `lte` - [`Int`](#definition-Int) | | | `neq` - [`Int`](#definition-Int) | | | `notBetween` - [`IntFieldComparisonBetween`](#definition-IntFieldComparisonBetween) | | | `notIn` - [`[Int!]`](#definition-Int) | | **Example** ```json { "between": IntFieldComparisonBetween, "eq": 987, "gt": 987, "gte": 123, "in": [987], "is": false, "isNot": true, "lt": 987, "lte": 987, "neq": 987, "notBetween": IntFieldComparisonBetween, "notIn": [123] } ``` [Types](#group-Types) ### IntFieldComparisonBetween **Fields** | Input Field | Description | | ----------------------------------- | ----------- | | `lower` - [`Int!`](#definition-Int) | | | `upper` - [`Int!`](#definition-Int) | | **Example** ```json {"lower": 123, "upper": 123} ``` [Types](#group-Types) ### NetworkCapabilities **Values** | Enum Value | Description | | ------------ | ----------- | | `Agreements` | | | `NFT` | | **Example** ```gql "Agreements" ``` [Types](#group-Types) ### NetworkCapabilitiesFilterComparison **Fields** | Input Field | Description | | --------------------------------------------------------------------- | ----------- | | `eq` - [`NetworkCapabilities`](#definition-NetworkCapabilities) | | | `gt` - [`NetworkCapabilities`](#definition-NetworkCapabilities) | | | `gte` - [`NetworkCapabilities`](#definition-NetworkCapabilities) | | | `iLike` - [`NetworkCapabilities`](#definition-NetworkCapabilities) | | | `in` - [`[NetworkCapabilities!]`](#definition-NetworkCapabilities) | | | `is` - [`Boolean`](#definition-Boolean) | | | `isNot` - [`Boolean`](#definition-Boolean) | | | `like` - [`NetworkCapabilities`](#definition-NetworkCapabilities) | | | `lt` - [`NetworkCapabilities`](#definition-NetworkCapabilities) | | | `lte` - [`NetworkCapabilities`](#definition-NetworkCapabilities) | | | `neq` - [`NetworkCapabilities`](#definition-NetworkCapabilities) | | | `notILike` - [`NetworkCapabilities`](#definition-NetworkCapabilities) | | | `notIn` - [`[NetworkCapabilities!]`](#definition-NetworkCapabilities) | | | `notLike` - [`NetworkCapabilities`](#definition-NetworkCapabilities) | | **Example** ```json { "eq": "Agreements", "gt": "Agreements", "gte": "Agreements", "iLike": "Agreements", "in": ["Agreements"], "is": false, "isNot": false, "like": "Agreements", "lt": "Agreements", "lte": "Agreements", "neq": "Agreements", "notILike": "Agreements", "notIn": ["Agreements"], "notLike": "Agreements" } ``` [Types](#group-Types) ### NetworkCapabilitiesModel **Fields** | Field Name | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------- | | `networkCapability` - [`NetworkCapabilities!`](#definition-NetworkCapabilities) | List of capabilities \| describe what can be done on a given chain. | **Example** ```json {"networkCapability": "Agreements"} ``` [Types](#group-Types) ### NetworkCapability **Description** Network capability **Fields** | Field Name | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------- | | `networkCapability` - [`NetworkCapabilities!`](#definition-NetworkCapabilities) | List of capabilities \| describe what can be done on a given chain. | **Example** ```json {"networkCapability": "Agreements"} ``` [Types](#group-Types) ### NetworkCapabilityFilter **Fields** | Input Field | Description | | -------------------------------------------------------------------------------------------------------------- | ----------- | | `and` - [`[NetworkCapabilityFilter!]`](#definition-NetworkCapabilityFilter) | | | `networkCapability` - [`NetworkCapabilitiesFilterComparison`](#definition-NetworkCapabilitiesFilterComparison) | | | `or` - [`[NetworkCapabilityFilter!]`](#definition-NetworkCapabilityFilter) | | **Example** ```json { "and": [NetworkCapabilityFilter], "networkCapability": NetworkCapabilitiesFilterComparison, "or": [NetworkCapabilityFilter] } ``` [Types](#group-Types) ### NetworkCapabilitySort **Fields** | Input Field | Description | | ----------------------------------------------------------------------------------- | ----------- | | `direction` - [`SortDirection!`](#definition-SortDirection) | | | `field` - [`NetworkCapabilitySortFields!`](#definition-NetworkCapabilitySortFields) | | | `nulls` - [`SortNulls`](#definition-SortNulls) | | **Example** ```json {"direction": "ASC", "field": "networkCapability", "nulls": "NULLS_FIRST"} ``` [Types](#group-Types) ### NetworkCapabilitySortFields **Values** | Enum Value | Description | | ------------------- | ----------- | | `networkCapability` | | **Example** ```gql "networkCapability" ``` [Types](#group-Types) ### NetworkConfig **Description** Network configuration object **Fields** | Field Name | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | | `activitiesSubgraphUrl` - [`String!`](#definition-String) | activities subgraph url address | | `agreementFactoryAddress` - [`String!`](#definition-String) | agreement factory eth address | | `agreementSubgraphUrl` - [`String!`](#definition-String) | agreements subgraph url address | | `alchemyApiKey` - [`String!`](#definition-String) | Alchemy API key | | `capabilities` - [`[NetworkCapability!]!`](#definition-NetworkCapability) | | |

Arguments

filter - NetworkCapabilityFilter!

Specify to filter the records returned.

sorting - \[NetworkCapabilitySort!]!

Specify to sort results.

| | | `chainId` - [`Int!`](#definition-Int) | blockchain identifier | | `createdAt` - [`DateTime!`](#definition-DateTime) | Time at which the object was created. | | `defaultStripeFeeInPercent` - [`Int!`](#definition-Int) | Default stripe fee % | | `dmmAddress` - [`String`](#definition-String) | Dynamic Modular Metadata contract address | | `feeManagerAddress` - [`String!`](#definition-String) | fee manager contract eth address | | `id` - [`ID!`](#definition-ID) | Auto-incrementing identifier. | | `jsonRpcUrl` - [`String!`](#definition-String) | json rpc url address use to connect to the node | | `lendingContractAddress` - [`String!`](#definition-String) | lending contract eth address | | `marketAddress` - [`String`](#definition-String) | Nft-market eth contract address | | `marketOwner` - [`String`](#definition-String) | Nft-market owner eth address | | `nativeCoin` - [`String!`](#definition-String) | Native currency code | | `nativeCoinDecimals` - [`Int!`](#definition-Int) | Native currency decimal value | | `networkName` - [`NetworkName!`](#definition-NetworkName) | Name of the blockchain network on which the transaction occurs | | `nftSubgraphUrl` - [`String`](#definition-String) | Nft-subgraph url address | | `payeeVaultFactoryAddress` - [`String`](#definition-String) | Address of Payment Batcher Factory contract | | `paymentBatcherFactoryAddress` - [`String`](#definition-String) | Address of Payment Batcher Factory contract | | `royaltyLoanFactoryAddress` - [`String`](#definition-String) | Address of Royalty Loan Factory contract | | `studioPublicJsonRpcUrl` - [`String!`](#definition-String) | json rpc url address for studio frontend app use to connect to the node | | `updatedAt` - [`DateTime!`](#definition-DateTime) | Time at which the object was last updated. | **Example** ```json { "activitiesSubgraphUrl": "abc123", "agreementFactoryAddress": "abc123", "agreementSubgraphUrl": "abc123", "alchemyApiKey": "abc123", "capabilities": [NetworkCapability], "chainId": 987, "createdAt": "2007-12-03T10:15:30Z", "defaultStripeFeeInPercent": 123, "dmmAddress": "xyz789", "feeManagerAddress": "xyz789", "id": "4", "jsonRpcUrl": "abc123", "lendingContractAddress": "xyz789", "marketAddress": "xyz789", "marketOwner": "xyz789", "nativeCoin": "abc123", "nativeCoinDecimals": 987, "networkName": "amoy", "nftSubgraphUrl": "xyz789", "payeeVaultFactoryAddress": "xyz789", "paymentBatcherFactoryAddress": "abc123", "royaltyLoanFactoryAddress": "xyz789", "studioPublicJsonRpcUrl": "xyz789", "updatedAt": "2007-12-03T10:15:30Z" } ``` [Types](#group-Types) ### NetworkConfigConnection **Fields** | Field Name | Description | | ------------------------------------------------------------ | ---------------------------- | | `nodes` - [`[NetworkConfig!]!`](#definition-NetworkConfig) | Array of nodes. | | `pageInfo` - [`OffsetPageInfo!`](#definition-OffsetPageInfo) | Paging information | | `totalCount` - [`Int!`](#definition-Int) | Fetch total count of records | **Example** ```json { "nodes": [NetworkConfig], "pageInfo": OffsetPageInfo, "totalCount": 987 } ``` [Types](#group-Types) ### NetworkConfigFilter **Fields** | Input Field | Description | | ----------------------------------------------------------------------------------------------------------------------- | ----------- | | `activitiesSubgraphUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `agreementFactoryAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `agreementSubgraphUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `alchemyApiKey` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `and` - [`[NetworkConfigFilter!]`](#definition-NetworkConfigFilter) | | | `capabilities` - [`NetworkConfigFilterNetworkCapabilityFilter`](#definition-NetworkConfigFilterNetworkCapabilityFilter) | | | `chainId` - [`IntFieldComparison`](#definition-IntFieldComparison) | | | `createdAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | | `defaultStripeFeeInPercent` - [`IntFieldComparison`](#definition-IntFieldComparison) | | | `dmmAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `feeManagerAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `id` - [`IDFilterComparison`](#definition-IDFilterComparison) | | | `jsonRpcUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `lendingContractAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `marketAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `marketOwner` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `nativeCoin` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `nativeCoinDecimals` - [`IntFieldComparison`](#definition-IntFieldComparison) | | | `networkName` - [`NetworkNameFilterComparison`](#definition-NetworkNameFilterComparison) | | | `nftSubgraphUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `or` - [`[NetworkConfigFilter!]`](#definition-NetworkConfigFilter) | | | `payeeVaultFactoryAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `paymentBatcherFactoryAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `royaltyLoanFactoryAddress` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `studioPublicJsonRpcUrl` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `updatedAt` - [`DateFieldComparison`](#definition-DateFieldComparison) | | **Example** ```json { "activitiesSubgraphUrl": StringFieldComparison, "agreementFactoryAddress": StringFieldComparison, "agreementSubgraphUrl": StringFieldComparison, "alchemyApiKey": StringFieldComparison, "and": [NetworkConfigFilter], "capabilities": NetworkConfigFilterNetworkCapabilityFilter, "chainId": IntFieldComparison, "createdAt": DateFieldComparison, "defaultStripeFeeInPercent": IntFieldComparison, "dmmAddress": StringFieldComparison, "feeManagerAddress": StringFieldComparison, "id": IDFilterComparison, "jsonRpcUrl": StringFieldComparison, "lendingContractAddress": StringFieldComparison, "marketAddress": StringFieldComparison, "marketOwner": StringFieldComparison, "nativeCoin": StringFieldComparison, "nativeCoinDecimals": IntFieldComparison, "networkName": NetworkNameFilterComparison, "nftSubgraphUrl": StringFieldComparison, "or": [NetworkConfigFilter], "payeeVaultFactoryAddress": StringFieldComparison, "paymentBatcherFactoryAddress": StringFieldComparison, "royaltyLoanFactoryAddress": StringFieldComparison, "studioPublicJsonRpcUrl": StringFieldComparison, "updatedAt": DateFieldComparison } ``` [Types](#group-Types) ### NetworkConfigFilterNetworkCapabilityFilter **Fields** | Input Field | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------- | | `and` - [`[NetworkConfigFilterNetworkCapabilityFilter!]`](#definition-NetworkConfigFilterNetworkCapabilityFilter) | | | `networkCapability` - [`NetworkCapabilitiesFilterComparison`](#definition-NetworkCapabilitiesFilterComparison) | | | `or` - [`[NetworkConfigFilterNetworkCapabilityFilter!]`](#definition-NetworkConfigFilterNetworkCapabilityFilter) | | **Example** ```json { "and": [NetworkConfigFilterNetworkCapabilityFilter], "networkCapability": NetworkCapabilitiesFilterComparison, "or": [NetworkConfigFilterNetworkCapabilityFilter] } ``` [Types](#group-Types) ### NetworkConfigPublicModel **Fields** | Field Name | Description | | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | | `capabilities` - [`[NetworkCapabilitiesModel!]!`](#definition-NetworkCapabilitiesModel) | List of capabilities \| describe what can be done on a given chain. | | `chainId` - [`Float!`](#definition-Float) | blockchain identifier | | `isTestNet` - [`Boolean!`](#definition-Boolean) | is blockchain a testnet | | `networkName` - [`NetworkName!`](#definition-NetworkName) | Name of the blockchain network on which the transaction occurs | | `studioPublicJsonRpcUrl` - [`String!`](#definition-String) | json rpc url address for studio frontend app use to connect to the node | **Example** ```json { "capabilities": [NetworkCapabilitiesModel], "chainId": 123.45, "isTestNet": false, "networkName": "amoy", "studioPublicJsonRpcUrl": "xyz789" } ``` [Types](#group-Types) ### NetworkConfigSort **Fields** | Input Field | Description | | --------------------------------------------------------------------------- | ----------- | | `direction` - [`SortDirection!`](#definition-SortDirection) | | | `field` - [`NetworkConfigSortFields!`](#definition-NetworkConfigSortFields) | | | `nulls` - [`SortNulls`](#definition-SortNulls) | | **Example** ```json {"direction": "ASC", "field": "activitiesSubgraphUrl", "nulls": "NULLS_FIRST"} ``` [Types](#group-Types) ### NetworkConfigSortFields **Values** | Enum Value | Description | | ------------------------------ | ----------- | | `activitiesSubgraphUrl` | | | `agreementFactoryAddress` | | | `agreementSubgraphUrl` | | | `alchemyApiKey` | | | `chainId` | | | `createdAt` | | | `defaultStripeFeeInPercent` | | | `dmmAddress` | | | `feeManagerAddress` | | | `id` | | | `jsonRpcUrl` | | | `lendingContractAddress` | | | `marketAddress` | | | `marketOwner` | | | `nativeCoin` | | | `nativeCoinDecimals` | | | `networkName` | | | `nftSubgraphUrl` | | | `payeeVaultFactoryAddress` | | | `paymentBatcherFactoryAddress` | | | `royaltyLoanFactoryAddress` | | | `studioPublicJsonRpcUrl` | | | `updatedAt` | | **Example** ```gql "activitiesSubgraphUrl" ``` [Types](#group-Types) ### NetworkConfigV2Model **Fields** | Field Name | Description | | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | | `agreementFactoryAddress` - [`String!`](#definition-String) | agreement factory eth address | | `agreementSubgraphUrl` - [`String!`](#definition-String) | agreements subgraph url address | | `capabilities` - [`[NetworkCapabilitiesModel!]!`](#definition-NetworkCapabilitiesModel) | List of capabilities \| describe what can be done on a given chain. | | `chainId` - [`Float!`](#definition-Float) | blockchain identifier | | `createdAt` - [`DateTime!`](#definition-DateTime) | Time at which the object was created. | | `currencies` - [`CurrenciesModel`](#definition-CurrenciesModel) | | | `explorer` - [`String!`](#definition-String) | blockchain explorer for review transactions | | `feeManagerAddress` - [`String!`](#definition-String) | fee manager contract eth address | | `id` - [`String!`](#definition-String) | Auto-incrementing identifier. | | `ipfsEndpoint` - [`String!`](#definition-String) | ipfs endpoint url use to upload files and factsheets | | `isTestNet` - [`Boolean!`](#definition-Boolean) | is blockchain a testnet | | `jsonRpcUrl` - [`String!`](#definition-String) | json rpc url address use to connect to the node | | `lendingContractAddress` - [`String!`](#definition-String) | lending contract eth address | | `marketAddress` - [`String`](#definition-String) | Nft-market eth contract address | | `marketOwner` - [`String`](#definition-String) | Nft-market owner eth address | | `networkName` - [`NetworkName!`](#definition-NetworkName) | Name of the blockchain network on which the transaction occurs | | `nftSubgraphUrl` - [`String`](#definition-String) | Nft-subgraph url address | | `updatedAt` - [`DateTime!`](#definition-DateTime) | Time at which the object was last updated. | **Example** ```json { "agreementFactoryAddress": "xyz789", "agreementSubgraphUrl": "xyz789", "capabilities": [NetworkCapabilitiesModel], "chainId": 987.65, "createdAt": "2007-12-03T10:15:30Z", "currencies": CurrenciesModel, "explorer": "xyz789", "feeManagerAddress": "xyz789", "id": "xyz789", "ipfsEndpoint": "xyz789", "isTestNet": false, "jsonRpcUrl": "xyz789", "lendingContractAddress": "xyz789", "marketAddress": "abc123", "marketOwner": "abc123", "networkName": "amoy", "nftSubgraphUrl": "xyz789", "updatedAt": "2007-12-03T10:15:30Z" } ``` [Types](#group-Types) ### NetworkName **Values** | Enum Value | Description | | ------------- | ----------- | | `amoy` | | | `base` | | | `baseSepolia` | | | `binance` | | | `bnbtest` | | | `ethereum` | | | `goerli` | | | `kovan` | | | `local` | | | `mainnet` | | | `mumbai` | | | `ownet` | | | `polygon` | | | `ropsten` | | | `sepolia` | | | `shibuya` | | | `test` | | **Example** ```gql "amoy" ``` [Types](#group-Types) ### NetworkNameFilterComparison **Fields** | Input Field | Description | | ----------------------------------------------------- | ----------- | | `eq` - [`NetworkName`](#definition-NetworkName) | | | `gt` - [`NetworkName`](#definition-NetworkName) | | | `gte` - [`NetworkName`](#definition-NetworkName) | | | `iLike` - [`NetworkName`](#definition-NetworkName) | | | `in` - [`[NetworkName!]`](#definition-NetworkName) | | | `is` - [`Boolean`](#definition-Boolean) | | | `isNot` - [`Boolean`](#definition-Boolean) | | | `like` - [`NetworkName`](#definition-NetworkName) | | | `lt` - [`NetworkName`](#definition-NetworkName) | | | `lte` - [`NetworkName`](#definition-NetworkName) | | | `neq` - [`NetworkName`](#definition-NetworkName) | | | `notILike` - [`NetworkName`](#definition-NetworkName) | | | `notIn` - [`[NetworkName!]`](#definition-NetworkName) | | | `notLike` - [`NetworkName`](#definition-NetworkName) | | **Example** ```json { "eq": "amoy", "gt": "amoy", "gte": "amoy", "iLike": "amoy", "in": ["amoy"], "is": true, "isNot": true, "like": "amoy", "lt": "amoy", "lte": "amoy", "neq": "amoy", "notILike": "amoy", "notIn": ["amoy"], "notLike": "amoy" } ``` [Types](#group-Types) ### NumberFieldComparison **Fields** | Input Field | Description | | ----------------------------------------------------------------------------------------- | ----------- | | `between` - [`NumberFieldComparisonBetween`](#definition-NumberFieldComparisonBetween) | | | `eq` - [`Float`](#definition-Float) | | | `gt` - [`Float`](#definition-Float) | | | `gte` - [`Float`](#definition-Float) | | | `in` - [`[Float!]`](#definition-Float) | | | `is` - [`Boolean`](#definition-Boolean) | | | `isNot` - [`Boolean`](#definition-Boolean) | | | `lt` - [`Float`](#definition-Float) | | | `lte` - [`Float`](#definition-Float) | | | `neq` - [`Float`](#definition-Float) | | | `notBetween` - [`NumberFieldComparisonBetween`](#definition-NumberFieldComparisonBetween) | | | `notIn` - [`[Float!]`](#definition-Float) | | **Example** ```json { "between": NumberFieldComparisonBetween, "eq": 987.65, "gt": 987.65, "gte": 123.45, "in": [987.65], "is": true, "isNot": false, "lt": 123.45, "lte": 987.65, "neq": 987.65, "notBetween": NumberFieldComparisonBetween, "notIn": [987.65] } ``` [Types](#group-Types) ### NumberFieldComparisonBetween **Fields** | Input Field | Description | | --------------------------------------- | ----------- | | `lower` - [`Float!`](#definition-Float) | | | `upper` - [`Float!`](#definition-Float) | | **Example** ```json {"lower": 123.45, "upper": 987.65} ``` [Types](#group-Types) ### OffsetPageInfo **Fields** | Field Name | Description | | ---------------------------------------------------- | ---------------------------------------------------- | | `hasNextPage` - [`Boolean`](#definition-Boolean) | true if paging forward and there are more records. | | `hasPreviousPage` - [`Boolean`](#definition-Boolean) | true if paging backwards and there are more records. | **Example** ```json {"hasNextPage": true, "hasPreviousPage": false} ``` [Types](#group-Types) ### OffsetPaging **Fields** | Input Field | Description | | ----------------------------------- | -------------------------------------- | | `limit` - [`Int`](#definition-Int) | Limit the number of records returned | | `offset` - [`Int`](#definition-Int) | Offset to start returning records from | **Example** ```json {"limit": 987, "offset": 123} ``` [Types](#group-Types) ### RedirectDomain **Fields** | Field Name | Description | | ------------------------------------------ | ----------- | | `domain` - [`String!`](#definition-String) | | **Example** ```json {"domain": "abc123"} ``` [Types](#group-Types) ### RedirectDomainFilter **Fields** | Input Field | Description | | ----------------------------------------------------------------------- | ----------- | | `and` - [`[RedirectDomainFilter!]`](#definition-RedirectDomainFilter) | | | `domain` - [`StringFieldComparison`](#definition-StringFieldComparison) | | | `or` - [`[RedirectDomainFilter!]`](#definition-RedirectDomainFilter) | | **Example** ```json { "and": [RedirectDomainFilter], "domain": StringFieldComparison, "or": [RedirectDomainFilter] } ``` [Types](#group-Types) ### RedirectDomainSort **Fields** | Input Field | Description | | ----------------------------------------------------------------------------- | ----------- | | `direction` - [`SortDirection!`](#definition-SortDirection) | | | `field` - [`RedirectDomainSortFields!`](#definition-RedirectDomainSortFields) | | | `nulls` - [`SortNulls`](#definition-SortNulls) | | **Example** ```json {"direction": "ASC", "field": "domain", "nulls": "NULLS_FIRST"} ``` [Types](#group-Types) ### RedirectDomainSortFields **Values** | Enum Value | Description | | ---------- | ----------- | | `domain` | | **Example** ```gql "domain" ``` [Types](#group-Types) ### S3LinkReq **Fields** | Input Field | Description | | ------------------------------------------------- | -------------------------------------------------------- | | `contentType` - [`String!`](#definition-String) | mime type of the file -> image/jpeg | | `entityId` - [`String!`](#definition-String) | The ID of the record to update | | `fileName` - [`String!`](#definition-String) | the file name must contain its extension -> \[name].jpg | | `imageType` - [`FileType!`](#definition-FileType) | indicates the type of image uploaded (banner or avatar). | **Example** ```json { "contentType": "abc123", "entityId": "abc123", "fileName": "xyz789", "imageType": "ENTITY_AVATAR" } ``` [Types](#group-Types) ### S3LinkRes **Fields** | Field Name | Description | | --------------------------------------------- | ----------- | | `uploadUrl` - [`String!`](#definition-String) | | **Example** ```json {"uploadUrl": "abc123"} ``` [Types](#group-Types) ### SortDirection **Description** Sort Directions **Values** | Enum Value | Description | | ---------- | ----------- | | `ASC` | | | `DESC` | | **Example** ```gql "ASC" ``` [Types](#group-Types) ### SortNulls **Description** Sort Nulls Options **Values** | Enum Value | Description | | ------------- | ----------- | | `NULLS_FIRST` | | | `NULLS_LAST` | | **Example** ```gql "NULLS_FIRST" ``` [Types](#group-Types) ### String **Description** The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. **Example** ```gql "abc123" ``` [Types](#group-Types) ### StringFieldComparison **Fields** | Input Field | Description | | ------------------------------------------- | ----------- | | `eq` - [`String`](#definition-String) | | | `gt` - [`String`](#definition-String) | | | `gte` - [`String`](#definition-String) | | | `iLike` - [`String`](#definition-String) | | | `in` - [`[String!]`](#definition-String) | | | `is` - [`Boolean`](#definition-Boolean) | | | `isNot` - [`Boolean`](#definition-Boolean) | | | `like` - [`String`](#definition-String) | | | `lt` - [`String`](#definition-String) | | | `lte` - [`String`](#definition-String) | | | `neq` - [`String`](#definition-String) | | | `notILike` - [`String`](#definition-String) | | | `notIn` - [`[String!]`](#definition-String) | | | `notLike` - [`String`](#definition-String) | | **Example** ```json { "eq": "abc123", "gt": "xyz789", "gte": "xyz789", "iLike": "abc123", "in": ["xyz789"], "is": false, "isNot": true, "like": "xyz789", "lt": "abc123", "lte": "xyz789", "neq": "xyz789", "notILike": "xyz789", "notIn": ["xyz789"], "notLike": "xyz789" } ``` [Types](#group-Types) ### Tenant **Description** Tenant ID to which artists, enterprise and labels belong. **Fields** | Field Name | Description | | --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `createdAt` - [`DateTime!`](#definition-DateTime) | Time at which the object was created. | | `id` - [`ID!`](#definition-ID) | Auto-incrementing identifier. | | `minPaymentBatcherBalanceInUSDC` - [`Float`](#definition-Float) | Min payment batcher balance value | | `name` - [`String!`](#definition-String) | Tenant name. | | `paymentBatcherAddress` - [`String`](#definition-String) | Address of the contract user by tenant to make royalty payments. | | `tenantUri` - [`String!`](#definition-String) | Identifier of the tenant. This value corresponds to the tenant ID from the revelator database. | | `updatedAt` - [`DateTime!`](#definition-DateTime) | Time at which the object was last updated. | **Example** ```json { "createdAt": "2007-12-03T10:15:30Z", "id": 4, "minPaymentBatcherBalanceInUSDC": 987.65, "name": "abc123", "paymentBatcherAddress": "abc123", "tenantUri": "xyz789", "updatedAt": "2007-12-03T10:15:30Z" } ``` [Types](#group-Types) ### UpdateCollectionEntity **Fields** | Input Field | Description | | ---------------------------------------------- | --------------------------------------------------------------------------------------- | | `avatarUrl` - [`String`](#definition-String) | avatar url, displayed on the storefront. | | `bannerUrl` - [`String`](#definition-String) | banner url, displayed on the storefront. | | `description` - [`String`](#definition-String) | Entity description. | | `email` - [`String`](#definition-String) | collection entity email. | | `entityUri` - [`String`](#definition-String) | Identifier of the entity. This value corresponds to the ID from the revelator database. | | `name` - [`String`](#definition-String) | Entity name. | **Example** ```json { "avatarUrl": "xyz789", "bannerUrl": "abc123", "description": "xyz789", "email": "abc123", "entityUri": "xyz789", "name": "xyz789" } ``` [Types](#group-Types) ### UpdateManyCollectionEntitiesInput **Fields** | Input Field | Description | | -------------------------------------------------------------------------------------- | --------------------------------------------------------- | | `filter` - [`CollectionEntityUpdateFilter!`](#definition-CollectionEntityUpdateFilter) | Filter used to find fields to update | | `update` - [`UpdateCollectionEntity!`](#definition-UpdateCollectionEntity) | The update to apply to all records found using the filter | **Example** ```json { "filter": CollectionEntityUpdateFilter, "update": UpdateCollectionEntity } ``` [Types](#group-Types) ### UpdateManyResponse **Fields** | Field Name | Description | | ------------------------------------------ | ------------------------------ | | `updatedCount` - [`Int!`](#definition-Int) | The number of records updated. | **Example** ```json {"updatedCount": 123} ``` [Types](#group-Types) ### UpdateOneCollectionEntityInput **Fields** | Input Field | Description | | -------------------------------------------------------------------------- | ------------------------------ | | `id` - [`ID!`](#definition-ID) | The id of the record to update | | `update` - [`UpdateCollectionEntity!`](#definition-UpdateCollectionEntity) | The update to apply. | **Example** ```json { "id": "4", "update": UpdateCollectionEntity } ``` [Documentation by Anvil SpectaQL](https://github.com/anvilco/spectaql) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.revelator.com/pro/resources/web3/production/storefront-service-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.