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!

Arguments

Name	Description
filter - CollectionEntityFilter!	Specify to filter the records returned. Default = {}
paging - OffsetPaging!	Limit or page results. Default = {limit: 10}
sorting - [CollectionEntitySort!]!	Specify to sort results. Default = []

Example

Query

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

{"filter": {}, "paging": {"limit": 10}, "sorting": [""]}

Response

{
  "data": {
    "collectionEntities": {
      "nodes": [CollectionEntity],
      "pageInfo": OffsetPageInfo,
      "totalCount": 123
    }
  }
}

Queries

collectionEntity

Response

Returns a CollectionEntity!

Arguments

Name	Description
id - ID!	The id of the record to find.

Example

Query

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
      studioPublicJsonRpcUrl
      updatedAt
    }
    redirectDomains {
      domain
    }
    tenant {
      createdAt
      id
      minPaymentBatcherBalanceInUSDC
      name
      paymentBatcherAddress
      tenantUri
      updatedAt
    }
    tenantId
    type
    updatedAt
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "collectionEntity": {
      "avatarUrl": "abc123",
      "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"
    }
  }
}

Queries

collectionEntityRelation

Response

Returns a CollectionEntityRelation!

Arguments

Name	Description
id - ID!	The id of the record to find.

Example

Query

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
      studioPublicJsonRpcUrl
      updatedAt
    }
    parentEntityId
    relationType
    tenant {
      createdAt
      id
      minPaymentBatcherBalanceInUSDC
      name
      paymentBatcherAddress
      tenantUri
      updatedAt
    }
    tenantId
    updatedAt
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "collectionEntityRelation": {
      "childEntityId": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "id": "4",
      "network": NetworkConfig,
      "parentEntityId": "xyz789",
      "relationType": "ENTERPIRSE_ARTIST",
      "tenant": Tenant,
      "tenantId": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

collectionEntityRelations

Response

Returns a CollectionEntityRelationConnection!

Arguments

Name	Description
filter - CollectionEntityRelationFilter!	Specify to filter the records returned. Default = {}
paging - OffsetPaging!	Limit or page results. Default = {limit: 10}
sorting - [CollectionEntityRelationSort!]!	Specify to sort results. Default = []

Example

Query

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

{"filter": {}, "paging": {"limit": 10}, "sorting": [""]}

Response

{
  "data": {
    "collectionEntityRelations": {
      "nodes": [CollectionEntityRelation],
      "pageInfo": OffsetPageInfo,
      "totalCount": 987
    }
  }
}

Queries

contactByNickName

Description

Returns a contact by nickname.

Response

Returns a ContactDto!

Arguments

Name	Description
nickName - String!	nick name of a contact

Example

Query

query ContactByNickName($nickName: String!) {
  contactByNickName(nickName: $nickName) {
    createdAt
    id
    nickName
    ownerUri
    updatedAt
    walletAddress
  }
}

Variables

{"nickName": "xyz789"}

Response

{
  "data": {
    "contactByNickName": {
      "createdAt": "2007-12-03T10:15:30Z",
      "id": 987.65,
      "nickName": "xyz789",
      "ownerUri": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z",
      "walletAddress": "abc123"
    }
  }
}

Queries

contactByWalletAddress

Description

Returns a contact by wallet address.

Response

Returns a ContactDto!

Arguments

Name	Description
walletAddress - String!	wallet address of a contact

Example

Query

query ContactByWalletAddress($walletAddress: String!) {
  contactByWalletAddress(walletAddress: $walletAddress) {
    createdAt
    id
    nickName
    ownerUri
    updatedAt
    walletAddress
  }
}

Variables

{"walletAddress": "abc123"}

Response

{
  "data": {
    "contactByWalletAddress": {
      "createdAt": "2007-12-03T10:15:30Z",
      "id": 987.65,
      "nickName": "xyz789",
      "ownerUri": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z",
      "walletAddress": "abc123"
    }
  }
}

Queries

contacts

Description

Returns contacts of a contactBook entity.

Response

Returns a ContactsDto!

Example

Query

query Contacts {
  contacts {
    count
    items {
      createdAt
      id
      nickName
      ownerUri
      updatedAt
      walletAddress
    }
  }
}

Response

{
  "data": {
    "contacts": {"count": 987.65, "items": [ContactDto]}
  }
}

Queries

getEntityByTokenPayload

Response

Returns a CollectionEntity!

Example

Query

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
      studioPublicJsonRpcUrl
      updatedAt
    }
    redirectDomains {
      domain
    }
    tenant {
      createdAt
      id
      minPaymentBatcherBalanceInUSDC
      name
      paymentBatcherAddress
      tenantUri
      updatedAt
    }
    tenantId
    type
    updatedAt
  }
}

Response

{
  "data": {
    "getEntityByTokenPayload": {
      "avatarUrl": "xyz789",
      "bannerUrl": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "description": "abc123",
      "email": "xyz789",
      "entityUri": "abc123",
      "id": "4",
      "name": "xyz789",
      "networkConfigs": [NetworkConfig],
      "redirectDomains": [RedirectDomain],
      "tenant": Tenant,
      "tenantId": "4",
      "type": "ARTIST",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

networkConfigByNameV2

Description

Returns networkConfig for given network name

Response

Returns a NetworkConfigV2Model!

Arguments

Name	Description
networkName - NetworkName!

Example

Query

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

{"networkName": "amoy"}

Response

{
  "data": {
    "networkConfigByNameV2": {
      "agreementFactoryAddress": "xyz789",
      "agreementSubgraphUrl": "abc123",
      "capabilities": [NetworkCapabilitiesModel],
      "chainId": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "currencies": CurrenciesModel,
      "explorer": "abc123",
      "feeManagerAddress": "abc123",
      "id": "abc123",
      "ipfsEndpoint": "abc123",
      "isTestNet": true,
      "jsonRpcUrl": "xyz789",
      "lendingContractAddress": "xyz789",
      "marketAddress": "abc123",
      "marketOwner": "abc123",
      "networkName": "amoy",
      "nftSubgraphUrl": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

networkConfigs

Response

Returns a NetworkConfigConnection!

Arguments

Name	Description
filter - NetworkConfigFilter!	Specify to filter the records returned. Default = {}
paging - OffsetPaging!	Limit or page results. Default = {limit: 10}
sorting - [NetworkConfigSort!]!	Specify to sort results. Default = []

Example

Query

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
      studioPublicJsonRpcUrl
      updatedAt
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
    }
    totalCount
  }
}

Variables

{"filter": {}, "paging": {"limit": 10}, "sorting": [""]}

Response

{
  "data": {
    "networkConfigs": {
      "nodes": [NetworkConfig],
      "pageInfo": OffsetPageInfo,
      "totalCount": 987
    }
  }
}

Queries

networkConfigsV2

Description

Returns list of networkConfigs

Response

Returns [NetworkConfigV2Model!]!

Example

Query

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

{
  "data": {
    "networkConfigsV2": [
      {
        "agreementFactoryAddress": "xyz789",
        "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": "xyz789",
        "lendingContractAddress": "xyz789",
        "marketAddress": "xyz789",
        "marketOwner": "xyz789",
        "networkName": "amoy",
        "nftSubgraphUrl": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

Queries

publicNetworkConfigsV2

Description

Returns list of networkConfigs without sensitive data

Response

Returns [NetworkConfigPublicModel!]!

Example

Query

query PublicNetworkConfigsV2 {
  publicNetworkConfigsV2 {
    capabilities {
      networkCapability
    }
    chainId
    isTestNet
    networkName
    studioPublicJsonRpcUrl
  }
}

Response

{
  "data": {
    "publicNetworkConfigsV2": [
      {
        "capabilities": [NetworkCapabilitiesModel],
        "chainId": 123.45,
        "isTestNet": true,
        "networkName": "amoy",
        "studioPublicJsonRpcUrl": "abc123"
      }
    ]
  }
}

Queries

testConfig

Response

Returns a String!

Example

Query

query TestConfig {
  testConfig
}

Response

{"data": {"testConfig": "abc123"}}

Mutations

createContact

Description

Create contact record. Returns record of the contactBook entity.

Response

Returns a ContactDto!

Arguments

Name	Description
nickName - String!	nick name of a contact
walletAddress - String!	wallet address of a contact

Example

Query

mutation CreateContact(
  $nickName: String!,
  $walletAddress: String!
) {
  createContact(
    nickName: $nickName,
    walletAddress: $walletAddress
  ) {
    createdAt
    id
    nickName
    ownerUri
    updatedAt
    walletAddress
  }
}

Variables

{
  "nickName": "xyz789",
  "walletAddress": "abc123"
}

Response

{
  "data": {
    "createContact": {
      "createdAt": "2007-12-03T10:15:30Z",
      "id": 987.65,
      "nickName": "xyz789",
      "ownerUri": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z",
      "walletAddress": "xyz789"
    }
  }
}

Mutations

createOneCollectionEntity

Response

Returns a CollectionEntity!

Arguments

Name	Description
input - CreateOneCollectionEntityInput!

Example

Query

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
      studioPublicJsonRpcUrl
      updatedAt
    }
    redirectDomains {
      domain
    }
    tenant {
      createdAt
      id
      minPaymentBatcherBalanceInUSDC
      name
      paymentBatcherAddress
      tenantUri
      updatedAt
    }
    tenantId
    type
    updatedAt
  }
}

Variables

{"input": CreateOneCollectionEntityInput}

Response

{
  "data": {
    "createOneCollectionEntity": {
      "avatarUrl": "abc123",
      "bannerUrl": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "description": "abc123",
      "email": "abc123",
      "entityUri": "abc123",
      "id": "4",
      "name": "abc123",
      "networkConfigs": [NetworkConfig],
      "redirectDomains": [RedirectDomain],
      "tenant": Tenant,
      "tenantId": "4",
      "type": "ARTIST",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

createRelation

Response

Returns a CollectionEntityRelation!

Arguments

Name	Description
createRelation - CreateCollectionEntityRelation!

Example

Query

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
      studioPublicJsonRpcUrl
      updatedAt
    }
    parentEntityId
    relationType
    tenant {
      createdAt
      id
      minPaymentBatcherBalanceInUSDC
      name
      paymentBatcherAddress
      tenantUri
      updatedAt
    }
    tenantId
    updatedAt
  }
}

Variables

{"createRelation": CreateCollectionEntityRelation}

Response

{
  "data": {
    "createRelation": {
      "childEntityId": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "id": "4",
      "network": NetworkConfig,
      "parentEntityId": "xyz789",
      "relationType": "ENTERPIRSE_ARTIST",
      "tenant": Tenant,
      "tenantId": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

createS3Url

Description

🔒 JWT Token

Creates an s3 url for enterprise's avatar or banner

Response

Returns a S3LinkRes!

Arguments

Name	Description
s3ReqDto - S3LinkReq!	🔒 JWT Token defines fileName and contentType

Example

Query

mutation CreateS3Url($s3ReqDto: S3LinkReq!) {
  createS3Url(s3ReqDto: $s3ReqDto) {
    uploadUrl
  }
}

Variables

{"s3ReqDto": S3LinkReq}

Response

{
  "data": {
    "createS3Url": {"uploadUrl": "xyz789"}
  }
}

Mutations

deleteContact

Description

Delete contact record. Returns record of the contactBook entity.

Response

Returns a ContactDto!

Arguments

Name	Description
id - Float!	id of a contact

Example

Query

mutation DeleteContact($id: Float!) {
  deleteContact(id: $id) {
    createdAt
    id
    nickName
    ownerUri
    updatedAt
    walletAddress
  }
}

Variables

{"id": 987.65}

Response

{
  "data": {
    "deleteContact": {
      "createdAt": "2007-12-03T10:15:30Z",
      "id": 987.65,
      "nickName": "xyz789",
      "ownerUri": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z",
      "walletAddress": "abc123"
    }
  }
}

Mutations

deleteManyCollectionEntities

Response

Returns a DeleteManyResponse!

Arguments

Name	Description
input - DeleteManyCollectionEntitiesInput!

Example

Query

mutation DeleteManyCollectionEntities($input: DeleteManyCollectionEntitiesInput!) {
  deleteManyCollectionEntities(input: $input) {
    deletedCount
  }
}

Variables

{"input": DeleteManyCollectionEntitiesInput}

Response

{"data": {"deleteManyCollectionEntities": {"deletedCount": 123}}}

Mutations

deleteManyRelations

Response

Returns a DeleteManyResponse!

Arguments

Name	Description
input - DeleteManyCollectionEntityRelationsInput!

Example

Query

mutation DeleteManyRelations($input: DeleteManyCollectionEntityRelationsInput!) {
  deleteManyRelations(input: $input) {
    deletedCount
  }
}

Variables

{"input": DeleteManyCollectionEntityRelationsInput}

Response

{"data": {"deleteManyRelations": {"deletedCount": 987}}}

Mutations

deleteOneCollectionEntity

Response

Returns a CollectionEntityDeleteResponse!

Arguments

Name	Description
input - DeleteOneCollectionEntityInput!

Example

Query

mutation DeleteOneCollectionEntity($input: DeleteOneCollectionEntityInput!) {
  deleteOneCollectionEntity(input: $input) {
    avatarUrl
    bannerUrl
    createdAt
    description
    email
    entityUri
    id
    name
    tenantId
    type
    updatedAt
  }
}

Variables

{"input": DeleteOneCollectionEntityInput}

Response

{
  "data": {
    "deleteOneCollectionEntity": {
      "avatarUrl": "xyz789",
      "bannerUrl": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "description": "abc123",
      "email": "abc123",
      "entityUri": "xyz789",
      "id": "4",
      "name": "abc123",
      "tenantId": 4,
      "type": "ARTIST",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

deleteOneRelation

Response

Returns a CollectionEntityRelationDeleteResponse!

Arguments

Name	Description
input - DeleteOneCollectionEntityRelationInput!

Example

Query

mutation DeleteOneRelation($input: DeleteOneCollectionEntityRelationInput!) {
  deleteOneRelation(input: $input) {
    childEntityId
    createdAt
    id
    parentEntityId
    relationType
    tenantId
    updatedAt
  }
}

Variables

{"input": DeleteOneCollectionEntityRelationInput}

Response

{
  "data": {
    "deleteOneRelation": {
      "childEntityId": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "id": "4",
      "parentEntityId": "abc123",
      "relationType": "ENTERPIRSE_ARTIST",
      "tenantId": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

updateContact

Description

Update contact record. Returns record of the contactBook entity.

Response

Returns a ContactDto!

Arguments

Name	Description
id - Float!	id of a contact
nickName - String	nick name of a contact
walletAddress - String	wallet address of a contact

Example

Query

mutation UpdateContact(
  $id: Float!,
  $nickName: String,
  $walletAddress: String
) {
  updateContact(
    id: $id,
    nickName: $nickName,
    walletAddress: $walletAddress
  ) {
    createdAt
    id
    nickName
    ownerUri
    updatedAt
    walletAddress
  }
}

Variables

{
  "id": 987.65,
  "nickName": "abc123",
  "walletAddress": "abc123"
}

Response

{
  "data": {
    "updateContact": {
      "createdAt": "2007-12-03T10:15:30Z",
      "id": 123.45,
      "nickName": "abc123",
      "ownerUri": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z",
      "walletAddress": "xyz789"
    }
  }
}

Mutations

updateManyCollectionEntities

Response

Returns an UpdateManyResponse!

Arguments

Name	Description
input - UpdateManyCollectionEntitiesInput!

Example

Query

mutation UpdateManyCollectionEntities($input: UpdateManyCollectionEntitiesInput!) {
  updateManyCollectionEntities(input: $input) {
    updatedCount
  }
}

Variables

{"input": UpdateManyCollectionEntitiesInput}

Response

{"data": {"updateManyCollectionEntities": {"updatedCount": 987}}}

Mutations

updateOneCollectionEntity

Response

Returns a CollectionEntity!

Arguments

Name	Description
input - UpdateOneCollectionEntityInput!

Example

Query

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
      studioPublicJsonRpcUrl
      updatedAt
    }
    redirectDomains {
      domain
    }
    tenant {
      createdAt
      id
      minPaymentBatcherBalanceInUSDC
      name
      paymentBatcherAddress
      tenantUri
      updatedAt
    }
    tenantId
    type
    updatedAt
  }
}

Variables

{"input": UpdateOneCollectionEntityInput}

Response

{
  "data": {
    "updateOneCollectionEntity": {
      "avatarUrl": "xyz789",
      "bannerUrl": "abc123",
      "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"
    }
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example

true

Types

CollectionEntity

Description

represents an element of the hierarchy within the enterprise.

Fields

Field Name	Description
avatarUrl - String	avatar url, displayed on the storefront.
bannerUrl - String	banner url, displayed on the storefront.
createdAt - DateTime!	Time at which the object was created.
description - String	Entity description.
email - String	collection entity email.
entityUri - String	Identifier of the entity. This value corresponds to the ID from the revelator database.
id - ID!	Auto-incrementing identifier.
name - String!	Entity name.
networkConfigs - [NetworkConfig!]!
Arguments filter - NetworkConfigFilter! Specify to filter the records returned. sorting - [NetworkConfigSort!]! Specify to sort results.
redirectDomains - [RedirectDomain!]!
Arguments filter - RedirectDomainFilter! Specify to filter the records returned. sorting - [RedirectDomainSort!]! Specify to sort results.
tenant - Tenant!
tenantId - ID!	Tenant ID to which artists, enterprise and labels belong.
type - CollectionEntityType!	Specifies the type of entry. Represents the hierarchy level within the enterprise.
updatedAt - DateTime!	Time at which the object was last updated.

Example

{
  "avatarUrl": "abc123",
  "bannerUrl": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "description": "xyz789",
  "email": "abc123",
  "entityUri": "xyz789",
  "id": "4",
  "name": "abc123",
  "networkConfigs": [NetworkConfig],
  "redirectDomains": [RedirectDomain],
  "tenant": Tenant,
  "tenantId": 4,
  "type": "ARTIST",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

CollectionEntityConnection

Fields

Field Name	Description
nodes - [CollectionEntity!]!	Array of nodes.
pageInfo - OffsetPageInfo!	Paging information
totalCount - Int!	Fetch total count of records

Example

{
  "nodes": [CollectionEntity],
  "pageInfo": OffsetPageInfo,
  "totalCount": 987
}

Types

CollectionEntityDeleteFilter

Fields

Input Field	Description
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

Example

{
  "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

CollectionEntityDeleteResponse

Fields

Field Name	Description
avatarUrl - String	avatar url, displayed on the storefront.
bannerUrl - String	banner url, displayed on the storefront.
createdAt - DateTime	Time at which the object was created.
description - String	Entity description.
email - String	collection entity email.
entityUri - String	Identifier of the entity. This value corresponds to the ID from the revelator database.
id - ID	Auto-incrementing identifier.
name - String	Entity name.
tenantId - ID	Tenant ID to which artists, enterprise and labels belong.
type - CollectionEntityType	Specifies the type of entry. Represents the hierarchy level within the enterprise.
updatedAt - DateTime	Time at which the object was last updated.

Example

{
  "avatarUrl": "xyz789",
  "bannerUrl": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "description": "xyz789",
  "email": "abc123",
  "entityUri": "abc123",
  "id": 4,
  "name": "abc123",
  "tenantId": "4",
  "type": "ARTIST",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

CollectionEntityFilter

Fields

Input Field	Description
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

Example

{
  "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

CollectionEntityFilterRedirectDomainFilter

Fields

Input Field	Description
and - [CollectionEntityFilterRedirectDomainFilter!]
domain - StringFieldComparison
or - [CollectionEntityFilterRedirectDomainFilter!]

Example

{
  "and": [CollectionEntityFilterRedirectDomainFilter],
  "domain": StringFieldComparison,
  "or": [CollectionEntityFilterRedirectDomainFilter]
}

Types

CollectionEntityFilterTenantFilter

Fields

Input Field	Description
and - [CollectionEntityFilterTenantFilter!]
createdAt - DateFieldComparison
id - IDFilterComparison
minPaymentBatcherBalanceInUSDC - NumberFieldComparison
name - StringFieldComparison
or - [CollectionEntityFilterTenantFilter!]
paymentBatcherAddress - StringFieldComparison
tenantUri - StringFieldComparison
updatedAt - DateFieldComparison

Example

{
  "and": [CollectionEntityFilterTenantFilter],
  "createdAt": DateFieldComparison,
  "id": IDFilterComparison,
  "minPaymentBatcherBalanceInUSDC": NumberFieldComparison,
  "name": StringFieldComparison,
  "or": [CollectionEntityFilterTenantFilter],
  "paymentBatcherAddress": StringFieldComparison,
  "tenantUri": StringFieldComparison,
  "updatedAt": DateFieldComparison
}

Types

CollectionEntityRelation

Description

represents a relationship between two entities.

Fields

Field Name	Description
childEntityId - String!	Relationship child ID.
createdAt - DateTime!	Time at which the object was created.
id - ID!	Auto-incrementing identifier.
network - NetworkConfig!
parentEntityId - String!	Relationship parent ID.
relationType - CollectionEntityRelationType!	Specifies the type of the relation. For example: LABEL -> ARTIST.
tenant - Tenant!
tenantId - String!	Tenant ID to which artists, enterprise and labels belong.
updatedAt - DateTime!	Time at which the object was last updated.

Example

{
  "childEntityId": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "id": 4,
  "network": NetworkConfig,
  "parentEntityId": "xyz789",
  "relationType": "ENTERPIRSE_ARTIST",
  "tenant": Tenant,
  "tenantId": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

CollectionEntityRelationConnection

Fields

Field Name	Description
nodes - [CollectionEntityRelation!]!	Array of nodes.
pageInfo - OffsetPageInfo!	Paging information
totalCount - Int!	Fetch total count of records

Example

{
  "nodes": [CollectionEntityRelation],
  "pageInfo": OffsetPageInfo,
  "totalCount": 123
}

Types

CollectionEntityRelationDeleteFilter

Fields

Input Field	Description
and - [CollectionEntityRelationDeleteFilter!]
childEntityId - StringFieldComparison
createdAt - DateFieldComparison
id - IDFilterComparison
or - [CollectionEntityRelationDeleteFilter!]
parentEntityId - StringFieldComparison
relationType - CollectionEntityRelationTypeFilterComparison
tenantId - StringFieldComparison
updatedAt - DateFieldComparison

Example

{
  "and": [CollectionEntityRelationDeleteFilter],
  "childEntityId": StringFieldComparison,
  "createdAt": DateFieldComparison,
  "id": IDFilterComparison,
  "or": [CollectionEntityRelationDeleteFilter],
  "parentEntityId": StringFieldComparison,
  "relationType": CollectionEntityRelationTypeFilterComparison,
  "tenantId": StringFieldComparison,
  "updatedAt": DateFieldComparison
}

Types

CollectionEntityRelationDeleteResponse

Fields

Field Name	Description
childEntityId - String	Relationship child ID.
createdAt - DateTime	Time at which the object was created.
id - ID	Auto-incrementing identifier.
parentEntityId - String	Relationship parent ID.
relationType - CollectionEntityRelationType	Specifies the type of the relation. For example: LABEL -> ARTIST.
tenantId - String	Tenant ID to which artists, enterprise and labels belong.
updatedAt - DateTime	Time at which the object was last updated.

Example

{
  "childEntityId": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "parentEntityId": "xyz789",
  "relationType": "ENTERPIRSE_ARTIST",
  "tenantId": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

CollectionEntityRelationFilter

Fields

Input Field	Description
and - [CollectionEntityRelationFilter!]
childEntityId - StringFieldComparison
createdAt - DateFieldComparison
id - IDFilterComparison
network - CollectionEntityRelationFilterNetworkConfigFilter
or - [CollectionEntityRelationFilter!]
parentEntityId - StringFieldComparison
relationType - CollectionEntityRelationTypeFilterComparison
tenant - CollectionEntityRelationFilterTenantFilter
tenantId - StringFieldComparison
updatedAt - DateFieldComparison

Example

{
  "and": [CollectionEntityRelationFilter],
  "childEntityId": StringFieldComparison,
  "createdAt": DateFieldComparison,
  "id": IDFilterComparison,
  "network": CollectionEntityRelationFilterNetworkConfigFilter,
  "or": [CollectionEntityRelationFilter],
  "parentEntityId": StringFieldComparison,
  "relationType": CollectionEntityRelationTypeFilterComparison,
  "tenant": CollectionEntityRelationFilterTenantFilter,
  "tenantId": StringFieldComparison,
  "updatedAt": DateFieldComparison
}

Types

CollectionEntityRelationFilterNetworkConfigFilter

Fields

Input Field	Description
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
studioPublicJsonRpcUrl - StringFieldComparison
updatedAt - DateFieldComparison

Example

{
  "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,
  "studioPublicJsonRpcUrl": StringFieldComparison,
  "updatedAt": DateFieldComparison
}

Types

CollectionEntityRelationFilterTenantFilter

Fields

Input Field	Description
and - [CollectionEntityRelationFilterTenantFilter!]
createdAt - DateFieldComparison
id - IDFilterComparison
minPaymentBatcherBalanceInUSDC - NumberFieldComparison
name - StringFieldComparison
or - [CollectionEntityRelationFilterTenantFilter!]
paymentBatcherAddress - StringFieldComparison
tenantUri - StringFieldComparison
updatedAt - DateFieldComparison

Example

{
  "and": [CollectionEntityRelationFilterTenantFilter],
  "createdAt": DateFieldComparison,
  "id": IDFilterComparison,
  "minPaymentBatcherBalanceInUSDC": NumberFieldComparison,
  "name": StringFieldComparison,
  "or": [CollectionEntityRelationFilterTenantFilter],
  "paymentBatcherAddress": StringFieldComparison,
  "tenantUri": StringFieldComparison,
  "updatedAt": DateFieldComparison
}

Types

CollectionEntityRelationSort

Fields

Input Field	Description
direction - SortDirection!
field - CollectionEntityRelationSortFields!
nulls - SortNulls

Example

{"direction": "ASC", "field": "childEntityId", "nulls": "NULLS_FIRST"}

Types

CollectionEntityRelationSortFields

Values

Enum Value	Description
childEntityId
createdAt
id
parentEntityId
relationType
tenantId
updatedAt

Example

"childEntityId"

Types

CollectionEntityRelationType

Values

Enum Value	Description
ENTERPIRSE_ARTIST
ENTERPIRSE_LABEL
LABEL_ARTIST
TENANT_ENTERPRISE

Example

"ENTERPIRSE_ARTIST"

Types

CollectionEntityRelationTypeFilterComparison

Fields

Input Field	Description
eq - CollectionEntityRelationType
gt - CollectionEntityRelationType
gte - CollectionEntityRelationType
iLike - CollectionEntityRelationType
in - [CollectionEntityRelationType!]
is - Boolean
isNot - Boolean
like - CollectionEntityRelationType
lt - CollectionEntityRelationType
lte - CollectionEntityRelationType
neq - CollectionEntityRelationType
notILike - CollectionEntityRelationType
notIn - [CollectionEntityRelationType!]
notLike - CollectionEntityRelationType

Example

{
  "eq": "ENTERPIRSE_ARTIST",
  "gt": "ENTERPIRSE_ARTIST",
  "gte": "ENTERPIRSE_ARTIST",
  "iLike": "ENTERPIRSE_ARTIST",
  "in": ["ENTERPIRSE_ARTIST"],
  "is": false,
  "isNot": true,
  "like": "ENTERPIRSE_ARTIST",
  "lt": "ENTERPIRSE_ARTIST",
  "lte": "ENTERPIRSE_ARTIST",
  "neq": "ENTERPIRSE_ARTIST",
  "notILike": "ENTERPIRSE_ARTIST",
  "notIn": ["ENTERPIRSE_ARTIST"],
  "notLike": "ENTERPIRSE_ARTIST"
}

Types

CollectionEntitySort

Fields

Input Field	Description
direction - SortDirection!
field - CollectionEntitySortFields!
nulls - SortNulls

Example

{"direction": "ASC", "field": "avatarUrl", "nulls": "NULLS_FIRST"}

Types

CollectionEntitySortFields

Values

Enum Value	Description
avatarUrl
bannerUrl
createdAt
description
email
entityUri
id
name
tenantId
type
updatedAt

Example

"avatarUrl"

Types

CollectionEntityType

Values

Enum Value	Description
ARTIST
ENTERPRISE
LABEL

Example

"ARTIST"

Types

CollectionEntityTypeFilterComparison

Fields

Input Field	Description
eq - CollectionEntityType
gt - CollectionEntityType
gte - CollectionEntityType
iLike - CollectionEntityType
in - [CollectionEntityType!]
is - Boolean
isNot - Boolean
like - CollectionEntityType
lt - CollectionEntityType
lte - CollectionEntityType
neq - CollectionEntityType
notILike - CollectionEntityType
notIn - [CollectionEntityType!]
notLike - CollectionEntityType

Example

{
  "eq": "ARTIST",
  "gt": "ARTIST",
  "gte": "ARTIST",
  "iLike": "ARTIST",
  "in": ["ARTIST"],
  "is": false,
  "isNot": true,
  "like": "ARTIST",
  "lt": "ARTIST",
  "lte": "ARTIST",
  "neq": "ARTIST",
  "notILike": "ARTIST",
  "notIn": ["ARTIST"],
  "notLike": "ARTIST"
}

Types

CollectionEntityUpdateFilter

Fields

Input Field	Description
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

Example

{
  "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

ContactDto

Description

contact object

Fields

Field Name	Description
createdAt - DateTime!	Time at which the object was created.
id - Float!	Unique identifier for the contact.
nickName - String!	Name of a contact.
ownerUri - String!	Revelator unique identifier for an enterprise.
updatedAt - DateTime!	Time at which the object was last updated.
walletAddress - String!	Wallet address of a contact.

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "id": 123.45,
  "nickName": "abc123",
  "ownerUri": "abc123",
  "updatedAt": "2007-12-03T10:15:30Z",
  "walletAddress": "abc123"
}

Types

ContactsDto

Fields

Field Name	Description
count - Float!
items - [ContactDto!]!

Example

{"count": 987.65, "items": [ContactDto]}

Types

CreateCollectionEntity

Fields

Input Field	Description
avatarUrl - String	avatar url, displayed on the storefront.
bannerUrl - String	banner url, displayed on the storefront.
description - String	Entity description.
email - String	collection entity email.
entityUri - String	Identifier of the entity. This value corresponds to the ID from the revelator database.
name - String!	Entity name.
networkNames - [NetworkName!]!
type - CollectionEntityType!	Specifies the type of entry. Represents the hierarchy level within the enterprise.

Example

{
  "avatarUrl": "abc123",
  "bannerUrl": "abc123",
  "description": "xyz789",
  "email": "abc123",
  "entityUri": "abc123",
  "name": "abc123",
  "networkNames": ["amoy"],
  "type": "ARTIST"
}

Types

CreateCollectionEntityRelation

Fields

Input Field	Description
childEntityId - String!	Relationship child ID.
parentEntityId - String!	Relationship parent ID.
relationType - CollectionEntityRelationType!	Specifies the type of the relation. For example: LABEL -> ARTIST.

Example

{
  "childEntityId": "abc123",
  "parentEntityId": "xyz789",
  "relationType": "ENTERPIRSE_ARTIST"
}

Types

CreateOneCollectionEntityInput

Fields

Input Field	Description
collectionEntity - CreateCollectionEntity!	The record to create

Example

{"collectionEntity": CreateCollectionEntity}

Types

CurrenciesModel

Fields

Field Name	Description
lendingToken - CurrencyModel!
nativeCoin - CurrencyModel!
otherCurrencies - [CurrencyModel!]!

Example

{
  "lendingToken": CurrencyModel,
  "nativeCoin": CurrencyModel,
  "otherCurrencies": [CurrencyModel]
}

Types

CurrencyModel

Fields

Field Name	Description
address - String!
decimals - Float!
symbol - String!

Example

{
  "address": "xyz789",
  "decimals": 123.45,
  "symbol": "abc123"
}

Types

DateFieldComparison

Fields

Input Field	Description
between - DateFieldComparisonBetween
eq - DateTime
gt - DateTime
gte - DateTime
in - [DateTime!]
is - Boolean
isNot - Boolean
lt - DateTime
lte - DateTime
neq - DateTime
notBetween - DateFieldComparisonBetween
notIn - [DateTime!]

Example

{
  "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

DateFieldComparisonBetween

Fields

Input Field	Description
lower - DateTime!
upper - DateTime!

Example

{
  "lower": "2007-12-03T10:15:30Z",
  "upper": "2007-12-03T10:15:30Z"
}

Types

DateTime

Description

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

Example

"2007-12-03T10:15:30Z"

Types

DeleteManyCollectionEntitiesInput

Fields

Input Field	Description
filter - CollectionEntityDeleteFilter!	Filter to find records to delete

Example

{"filter": CollectionEntityDeleteFilter}

Types

DeleteManyCollectionEntityRelationsInput

Fields

Input Field	Description
filter - CollectionEntityRelationDeleteFilter!	Filter to find records to delete

Example

{"filter": CollectionEntityRelationDeleteFilter}

Types

DeleteManyResponse

Fields

Field Name	Description
deletedCount - Int!	The number of records deleted.

Example

{"deletedCount": 987}

Types

DeleteOneCollectionEntityInput

Fields

Input Field	Description
id - ID!	The id of the record to delete.

Example

{"id": "4"}

Types

DeleteOneCollectionEntityRelationInput

Fields

Input Field	Description
id - ID!	The id of the record to delete.

Example

{"id": "4"}

Types

FileType

Values

Enum Value	Description
ENTITY_AVATAR
ENTITY_BANNER

Example

"ENTITY_AVATAR"

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

987.65

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

"4"

Types

IDFilterComparison

Fields

Input Field	Description
eq - ID
gt - ID
gte - ID
iLike - ID
in - [ID!]
is - Boolean
isNot - Boolean
like - ID
lt - ID
lte - ID
neq - ID
notILike - ID
notIn - [ID!]
notLike - ID

Example

{
  "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

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

987

Types

IntFieldComparison

Fields

Input Field	Description
between - IntFieldComparisonBetween
eq - Int
gt - Int
gte - Int
in - [Int!]
is - Boolean
isNot - Boolean
lt - Int
lte - Int
neq - Int
notBetween - IntFieldComparisonBetween
notIn - [Int!]

Example

{
  "between": IntFieldComparisonBetween,
  "eq": 123,
  "gt": 123,
  "gte": 987,
  "in": [123],
  "is": false,
  "isNot": false,
  "lt": 123,
  "lte": 987,
  "neq": 123,
  "notBetween": IntFieldComparisonBetween,
  "notIn": [987]
}

Types

IntFieldComparisonBetween

Fields

Input Field	Description
lower - Int!
upper - Int!

Example

{"lower": 123, "upper": 987}

Types

NetworkCapabilities

Values

Enum Value	Description
Agreements
NFT

Example

"Agreements"

Types

NetworkCapabilitiesFilterComparison

Fields

Input Field	Description
eq - NetworkCapabilities
gt - NetworkCapabilities
gte - NetworkCapabilities
iLike - NetworkCapabilities
in - [NetworkCapabilities!]
is - Boolean
isNot - Boolean
like - NetworkCapabilities
lt - NetworkCapabilities
lte - NetworkCapabilities
neq - NetworkCapabilities
notILike - NetworkCapabilities
notIn - [NetworkCapabilities!]
notLike - NetworkCapabilities

Example

{
  "eq": "Agreements",
  "gt": "Agreements",
  "gte": "Agreements",
  "iLike": "Agreements",
  "in": ["Agreements"],
  "is": true,
  "isNot": true,
  "like": "Agreements",
  "lt": "Agreements",
  "lte": "Agreements",
  "neq": "Agreements",
  "notILike": "Agreements",
  "notIn": ["Agreements"],
  "notLike": "Agreements"
}

Types

NetworkCapabilitiesModel

Fields

Field Name	Description
networkCapability - NetworkCapabilities!	List of capabilities | describe what can be done on a given chain.

Example

{"networkCapability": "Agreements"}

Types

NetworkCapability

Description

Network capability

Fields

Field Name	Description
networkCapability - NetworkCapabilities!	List of capabilities | describe what can be done on a given chain.

Example

{"networkCapability": "Agreements"}

Types

NetworkCapabilityFilter

Fields

Input Field	Description
and - [NetworkCapabilityFilter!]
networkCapability - NetworkCapabilitiesFilterComparison
or - [NetworkCapabilityFilter!]

Example

{
  "and": [NetworkCapabilityFilter],
  "networkCapability": NetworkCapabilitiesFilterComparison,
  "or": [NetworkCapabilityFilter]
}

Types

NetworkCapabilitySort

Fields

Input Field	Description
direction - SortDirection!
field - NetworkCapabilitySortFields!
nulls - SortNulls

Example

{"direction": "ASC", "field": "networkCapability", "nulls": "NULLS_FIRST"}

Types

NetworkCapabilitySortFields

Values

Enum Value	Description
networkCapability

Example

"networkCapability"

Types

NetworkConfig

Description

Network configuration object

Fields

Field Name	Description
activitiesSubgraphUrl - String!	activities subgraph url address
agreementFactoryAddress - String!	agreement factory eth address
agreementSubgraphUrl - String!	agreements subgraph url address
alchemyApiKey - String!	Alchemy API key
capabilities - [NetworkCapability!]!
Arguments filter - NetworkCapabilityFilter! Specify to filter the records returned. sorting - [NetworkCapabilitySort!]! Specify to sort results.
chainId - Int!	blockchain identifier
createdAt - DateTime!	Time at which the object was created.
defaultStripeFeeInPercent - Int!	Default stripe fee %
dmmAddress - String	Dynamic Modular Metadata contract address
feeManagerAddress - String!	fee manager contract eth address
id - ID!	Auto-incrementing identifier.
jsonRpcUrl - String!	json rpc url address use to connect to the node
lendingContractAddress - String!	lending contract eth address
marketAddress - String	Nft-market eth contract address
marketOwner - String	Nft-market owner eth address
nativeCoin - String!	Native currency code
nativeCoinDecimals - Int!	Native currency decimal value
networkName - NetworkName!	Name of the blockchain network on which the transaction occurs
nftSubgraphUrl - String	Nft-subgraph url address
payeeVaultFactoryAddress - String	Address of Payment Batcher Factory contract
paymentBatcherFactoryAddress - String	Address of Payment Batcher Factory contract
studioPublicJsonRpcUrl - String!	json rpc url address for studio frontend app use to connect to the node
updatedAt - DateTime!	Time at which the object was last updated.

Example

{
  "activitiesSubgraphUrl": "xyz789",
  "agreementFactoryAddress": "abc123",
  "agreementSubgraphUrl": "xyz789",
  "alchemyApiKey": "xyz789",
  "capabilities": [NetworkCapability],
  "chainId": 123,
  "createdAt": "2007-12-03T10:15:30Z",
  "defaultStripeFeeInPercent": 987,
  "dmmAddress": "abc123",
  "feeManagerAddress": "abc123",
  "id": "4",
  "jsonRpcUrl": "xyz789",
  "lendingContractAddress": "xyz789",
  "marketAddress": "xyz789",
  "marketOwner": "xyz789",
  "nativeCoin": "xyz789",
  "nativeCoinDecimals": 123,
  "networkName": "amoy",
  "nftSubgraphUrl": "abc123",
  "payeeVaultFactoryAddress": "abc123",
  "paymentBatcherFactoryAddress": "xyz789",
  "studioPublicJsonRpcUrl": "abc123",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

NetworkConfigConnection

Fields

Field Name	Description
nodes - [NetworkConfig!]!	Array of nodes.
pageInfo - OffsetPageInfo!	Paging information
totalCount - Int!	Fetch total count of records

Example

{
  "nodes": [NetworkConfig],
  "pageInfo": OffsetPageInfo,
  "totalCount": 123
}

Types

NetworkConfigFilter

Fields

Input Field	Description
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
studioPublicJsonRpcUrl - StringFieldComparison
updatedAt - DateFieldComparison

Example

{
  "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,
  "studioPublicJsonRpcUrl": StringFieldComparison,
  "updatedAt": DateFieldComparison
}

Types

NetworkConfigFilterNetworkCapabilityFilter

Fields

Input Field	Description
and - [NetworkConfigFilterNetworkCapabilityFilter!]
networkCapability - NetworkCapabilitiesFilterComparison
or - [NetworkConfigFilterNetworkCapabilityFilter!]

Example

{
  "and": [NetworkConfigFilterNetworkCapabilityFilter],
  "networkCapability": NetworkCapabilitiesFilterComparison,
  "or": [NetworkConfigFilterNetworkCapabilityFilter]
}

Types

NetworkConfigPublicModel

Fields

Field Name	Description
capabilities - [NetworkCapabilitiesModel!]!	List of capabilities | describe what can be done on a given chain.
chainId - Float!	blockchain identifier
isTestNet - Boolean!	is blockchain a testnet
networkName - NetworkName!	Name of the blockchain network on which the transaction occurs
studioPublicJsonRpcUrl - String!	json rpc url address for studio frontend app use to connect to the node

Example

{
  "capabilities": [NetworkCapabilitiesModel],
  "chainId": 123.45,
  "isTestNet": false,
  "networkName": "amoy",
  "studioPublicJsonRpcUrl": "abc123"
}

Types

NetworkConfigSort

Fields

Input Field	Description
direction - SortDirection!
field - NetworkConfigSortFields!
nulls - SortNulls

Example

{"direction": "ASC", "field": "activitiesSubgraphUrl", "nulls": "NULLS_FIRST"}

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
studioPublicJsonRpcUrl
updatedAt

Example

"activitiesSubgraphUrl"

Types

NetworkConfigV2Model

Fields

Field Name	Description
agreementFactoryAddress - String!	agreement factory eth address
agreementSubgraphUrl - String!	agreements subgraph url address
capabilities - [NetworkCapabilitiesModel!]!	List of capabilities | describe what can be done on a given chain.
chainId - Float!	blockchain identifier
createdAt - DateTime!	Time at which the object was created.
currencies - CurrenciesModel
explorer - String!	blockchain explorer for review transactions
feeManagerAddress - String!	fee manager contract eth address
id - String!	Auto-incrementing identifier.
ipfsEndpoint - String!	ipfs endpoint url use to upload files and factsheets
isTestNet - Boolean!	is blockchain a testnet
jsonRpcUrl - String!	json rpc url address use to connect to the node
lendingContractAddress - String!	lending contract eth address
marketAddress - String	Nft-market eth contract address
marketOwner - String	Nft-market owner eth address
networkName - NetworkName!	Name of the blockchain network on which the transaction occurs
nftSubgraphUrl - String	Nft-subgraph url address
updatedAt - DateTime!	Time at which the object was last updated.

Example

{
  "agreementFactoryAddress": "abc123",
  "agreementSubgraphUrl": "abc123",
  "capabilities": [NetworkCapabilitiesModel],
  "chainId": 987.65,
  "createdAt": "2007-12-03T10:15:30Z",
  "currencies": CurrenciesModel,
  "explorer": "xyz789",
  "feeManagerAddress": "xyz789",
  "id": "xyz789",
  "ipfsEndpoint": "abc123",
  "isTestNet": false,
  "jsonRpcUrl": "abc123",
  "lendingContractAddress": "abc123",
  "marketAddress": "abc123",
  "marketOwner": "abc123",
  "networkName": "amoy",
  "nftSubgraphUrl": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

NetworkName

Values

Enum Value	Description
amoy
base
baseSepolia
binance
bnbtest
ethereum
goerli
kovan
local
mainnet
mumbai
ownet
polygon
ropsten
sepolia
shibuya
test

Example

"amoy"

Types

NetworkNameFilterComparison

Fields

Input Field	Description
eq - NetworkName
gt - NetworkName
gte - NetworkName
iLike - NetworkName
in - [NetworkName!]
is - Boolean
isNot - Boolean
like - NetworkName
lt - NetworkName
lte - NetworkName
neq - NetworkName
notILike - NetworkName
notIn - [NetworkName!]
notLike - NetworkName

Example

{
  "eq": "amoy",
  "gt": "amoy",
  "gte": "amoy",
  "iLike": "amoy",
  "in": ["amoy"],
  "is": false,
  "isNot": false,
  "like": "amoy",
  "lt": "amoy",
  "lte": "amoy",
  "neq": "amoy",
  "notILike": "amoy",
  "notIn": ["amoy"],
  "notLike": "amoy"
}

Types

NumberFieldComparison

Fields

Input Field	Description
between - NumberFieldComparisonBetween
eq - Float
gt - Float
gte - Float
in - [Float!]
is - Boolean
isNot - Boolean
lt - Float
lte - Float
neq - Float
notBetween - NumberFieldComparisonBetween
notIn - [Float!]

Example

{
  "between": NumberFieldComparisonBetween,
  "eq": 123.45,
  "gt": 987.65,
  "gte": 123.45,
  "in": [123.45],
  "is": true,
  "isNot": true,
  "lt": 987.65,
  "lte": 123.45,
  "neq": 123.45,
  "notBetween": NumberFieldComparisonBetween,
  "notIn": [123.45]
}

Types

NumberFieldComparisonBetween

Fields

Input Field	Description
lower - Float!
upper - Float!

Example

{"lower": 123.45, "upper": 123.45}

Types

OffsetPageInfo

Fields

Field Name	Description
hasNextPage - Boolean	true if paging forward and there are more records.
hasPreviousPage - Boolean	true if paging backwards and there are more records.

Example

{"hasNextPage": true, "hasPreviousPage": false}

Types

OffsetPaging

Fields

Input Field	Description
limit - Int	Limit the number of records returned
offset - Int	Offset to start returning records from

Example

{"limit": 987, "offset": 987}

Types

RedirectDomain

Fields

Field Name	Description
domain - String!

Example

{"domain": "xyz789"}

Types

RedirectDomainFilter

Fields

Input Field	Description
and - [RedirectDomainFilter!]
domain - StringFieldComparison
or - [RedirectDomainFilter!]

Example

{
  "and": [RedirectDomainFilter],
  "domain": StringFieldComparison,
  "or": [RedirectDomainFilter]
}

Types

RedirectDomainSort

Fields

Input Field	Description
direction - SortDirection!
field - RedirectDomainSortFields!
nulls - SortNulls

Example

{"direction": "ASC", "field": "domain", "nulls": "NULLS_FIRST"}

Types

RedirectDomainSortFields

Values

Enum Value	Description
domain

Example

"domain"

Types

S3LinkReq

Fields

Input Field	Description
contentType - String!	mime type of the file -> image/jpeg
entityId - String!	The ID of the record to update
fileName - String!	the file name must contain its extension -> [name].jpg
imageType - FileType!	indicates the type of image uploaded (banner or avatar).

Example

{
  "contentType": "abc123",
  "entityId": "abc123",
  "fileName": "abc123",
  "imageType": "ENTITY_AVATAR"
}

Types

S3LinkRes

Fields

Field Name	Description
uploadUrl - String!

Example

{"uploadUrl": "xyz789"}

Types

SortDirection

Description

Sort Directions

Values

Enum Value	Description
ASC
DESC

Example

"ASC"

Types

SortNulls

Description

Sort Nulls Options

Values

Enum Value	Description
NULLS_FIRST
NULLS_LAST

Example

"NULLS_FIRST"

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

"abc123"

Types

StringFieldComparison

Fields

Input Field	Description
eq - String
gt - String
gte - String
iLike - String
in - [String!]
is - Boolean
isNot - Boolean
like - String
lt - String
lte - String
neq - String
notILike - String
notIn - [String!]
notLike - String

Example

{
  "eq": "xyz789",
  "gt": "abc123",
  "gte": "abc123",
  "iLike": "xyz789",
  "in": ["abc123"],
  "is": true,
  "isNot": true,
  "like": "abc123",
  "lt": "xyz789",
  "lte": "abc123",
  "neq": "xyz789",
  "notILike": "abc123",
  "notIn": ["abc123"],
  "notLike": "abc123"
}

Types

Tenant

Description

Tenant ID to which artists, enterprise and labels belong.

Fields

Field Name	Description
createdAt - DateTime!	Time at which the object was created.
id - ID!	Auto-incrementing identifier.
minPaymentBatcherBalanceInUSDC - Float	Min payment batcher balance value
name - String!	Tenant name.
paymentBatcherAddress - String	Address of the contract user by tenant to make royalty payments.
tenantUri - String!	Identifier of the tenant. This value corresponds to the tenant ID from the revelator database.
updatedAt - DateTime!	Time at which the object was last updated.

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "minPaymentBatcherBalanceInUSDC": 123.45,
  "name": "xyz789",
  "paymentBatcherAddress": "xyz789",
  "tenantUri": "abc123",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

UpdateCollectionEntity

Fields

Input Field	Description
avatarUrl - String	avatar url, displayed on the storefront.
bannerUrl - String	banner url, displayed on the storefront.
description - String	Entity description.
email - String	collection entity email.
entityUri - String	Identifier of the entity. This value corresponds to the ID from the revelator database.
name - String	Entity name.

Example

{
  "avatarUrl": "abc123",
  "bannerUrl": "abc123",
  "description": "abc123",
  "email": "xyz789",
  "entityUri": "abc123",
  "name": "xyz789"
}

Types

UpdateManyCollectionEntitiesInput

Fields

Input Field	Description
filter - CollectionEntityUpdateFilter!	Filter used to find fields to update
update - UpdateCollectionEntity!	The update to apply to all records found using the filter

Example

{
  "filter": CollectionEntityUpdateFilter,
  "update": UpdateCollectionEntity
}

Types

UpdateManyResponse

Fields

Field Name	Description
updatedCount - Int!	The number of records updated.

Example

{"updatedCount": 987}

Types

UpdateOneCollectionEntityInput

Fields

Input Field	Description
id - ID!	The id of the record to update
update - UpdateCollectionEntity!	The update to apply.

Example

{
  "id": "4",
  "update": UpdateCollectionEntity
}

Documentation by Anvil SpectaQL