GraphQL API Reference
GraphQl endpoints for storefront-service!
API Endpoints
Copy # 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
Example
Query
Copy 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
Copy { "filter" : {} , "paging" : { "limit" : 10 } , "sorting" : [ "" ]}
Response
Copy {
"data" : {
"collectionEntities" : {
"nodes" : [CollectionEntity] ,
"pageInfo" : OffsetPageInfo ,
"totalCount" : 123
}
}
}
Queries
collectionEntity
Response
Returns a CollectionEntity!
Arguments
Example
Query
Copy 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
paymentBatcherFactoryAddress
studioPublicJsonRpcUrl
updatedAt
}
redirectDomains {
domain
}
tenant {
createdAt
id
minPaymentBatcherBalanceInUSDC
name
paymentBatcherAddress
tenantUri
updatedAt
}
tenantId
type
updatedAt
}
}
Variables
Response
Copy {
"data" : {
"collectionEntity" : {
"avatarUrl" : "abc123" ,
"bannerUrl" : "xyz789" ,
"createdAt" : "2007-12-03T10:15:30Z" ,
"description" : "abc123" ,
"email" : "abc123" ,
"entityUri" : "abc123" ,
"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
Example
Query
Copy 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
paymentBatcherFactoryAddress
studioPublicJsonRpcUrl
updatedAt
}
parentEntityId
relationType
tenant {
createdAt
id
minPaymentBatcherBalanceInUSDC
name
paymentBatcherAddress
tenantUri
updatedAt
}
tenantId
updatedAt
}
}
Variables
Response
Copy {
"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
collectionEntityRelations
Response
Returns a CollectionEntityRelationConnection!
Arguments
Example
Query
Copy 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
Copy { "filter" : {} , "paging" : { "limit" : 10 } , "sorting" : [ "" ]}
Response
Copy {
"data" : {
"collectionEntityRelations" : {
"nodes" : [CollectionEntityRelation] ,
"pageInfo" : OffsetPageInfo ,
"totalCount" : 123
}
}
}
Queries
contactByNickName
Description
Returns a contact by nickname.
Response
Returns a ContactDto!
Arguments
Example
Query
Copy query ContactByNickName ($nickName: String ! ) {
contactByNickName(nickName: $nickName) {
createdAt
id
nickName
ownerUri
updatedAt
walletAddress
}
}
Variables
Copy { "nickName" : "xyz789" }
Response
Copy {
"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
Example
Query
Copy query ContactByWalletAddress ($walletAddress: String ! ) {
contactByWalletAddress(walletAddress: $walletAddress) {
createdAt
id
nickName
ownerUri
updatedAt
walletAddress
}
}
Variables
Copy { "walletAddress" : "xyz789" }
Response
Copy {
"data" : {
"contactByWalletAddress" : {
"createdAt" : "2007-12-03T10:15:30Z" ,
"id" : 987.65 ,
"nickName" : "abc123" ,
"ownerUri" : "xyz789" ,
"updatedAt" : "2007-12-03T10:15:30Z" ,
"walletAddress" : "xyz789"
}
}
}
Queries
contacts
Description
Returns contacts of a contactBook entity.
Response
Returns a ContactsDto!
Example
Query
Copy query Contacts {
contacts {
count
items {
createdAt
id
nickName
ownerUri
updatedAt
walletAddress
}
}
}
Response
Copy {
"data" : {
"contacts" : { "count" : 987.65 , "items" : [ContactDto]}
}
}
Queries
getEntityByTokenPayload
Response
Returns a CollectionEntity!
Example
Query
Copy 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
paymentBatcherFactoryAddress
studioPublicJsonRpcUrl
updatedAt
}
redirectDomains {
domain
}
tenant {
createdAt
id
minPaymentBatcherBalanceInUSDC
name
paymentBatcherAddress
tenantUri
updatedAt
}
tenantId
type
updatedAt
}
}
Response
Copy {
"data" : {
"getEntityByTokenPayload" : {
"avatarUrl" : "abc123" ,
"bannerUrl" : "abc123" ,
"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
Example
Query
Copy 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
Copy { "networkName" : "amoy" }
Response
Copy {
"data" : {
"networkConfigByNameV2" : {
"agreementFactoryAddress" : "xyz789" ,
"agreementSubgraphUrl" : "xyz789" ,
"capabilities" : [NetworkCapabilitiesModel] ,
"chainId" : 123.45 ,
"createdAt" : "2007-12-03T10:15:30Z" ,
"currencies" : CurrenciesModel ,
"explorer" : "xyz789" ,
"feeManagerAddress" : "xyz789" ,
"id" : "xyz789" ,
"ipfsEndpoint" : "xyz789" ,
"isTestNet" : true ,
"jsonRpcUrl" : "xyz789" ,
"lendingContractAddress" : "xyz789" ,
"marketAddress" : "abc123" ,
"marketOwner" : "xyz789" ,
"networkName" : "amoy" ,
"nftSubgraphUrl" : "xyz789" ,
"updatedAt" : "2007-12-03T10:15:30Z"
}
}
}
Queries
networkConfigs
Response
Returns a NetworkConfigConnection!
Arguments
Example
Query
Copy 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
paymentBatcherFactoryAddress
studioPublicJsonRpcUrl
updatedAt
}
pageInfo {
hasNextPage
hasPreviousPage
}
totalCount
}
}
Variables
Copy { "filter" : {} , "paging" : { "limit" : 10 } , "sorting" : [ "" ]}
Response
Copy {
"data" : {
"networkConfigs" : {
"nodes" : [NetworkConfig] ,
"pageInfo" : OffsetPageInfo ,
"totalCount" : 987
}
}
}
Queries
networkConfigsV2
Description
Returns list of networkConfigs
Response
Returns [NetworkConfigV2Model!]!
Example
Query
Copy 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
Copy {
"data" : {
"networkConfigsV2" : [
{
"agreementFactoryAddress" : "xyz789" ,
"agreementSubgraphUrl" : "abc123" ,
"capabilities" : [NetworkCapabilitiesModel] ,
"chainId" : 123.45 ,
"createdAt" : "2007-12-03T10:15:30Z" ,
"currencies" : CurrenciesModel ,
"explorer" : "xyz789" ,
"feeManagerAddress" : "xyz789" ,
"id" : "abc123" ,
"ipfsEndpoint" : "abc123" ,
"isTestNet" : true ,
"jsonRpcUrl" : "xyz789" ,
"lendingContractAddress" : "abc123" ,
"marketAddress" : "xyz789" ,
"marketOwner" : "xyz789" ,
"networkName" : "amoy" ,
"nftSubgraphUrl" : "xyz789" ,
"updatedAt" : "2007-12-03T10:15:30Z"
}
]
}
}
Queries
publicNetworkConfigsV2
Description
Returns list of networkConfigs without sensitive data
Response
Returns [NetworkConfigPublicModel!]!
Example
Query
Copy query PublicNetworkConfigsV2 {
publicNetworkConfigsV2 {
capabilities {
networkCapability
}
chainId
isTestNet
networkName
studioPublicJsonRpcUrl
}
}
Response
Copy {
"data" : {
"publicNetworkConfigsV2" : [
{
"capabilities" : [NetworkCapabilitiesModel] ,
"chainId" : 987.65 ,
"isTestNet" : false ,
"networkName" : "amoy" ,
"studioPublicJsonRpcUrl" : "abc123"
}
]
}
}
Queries
testConfig
Response
Returns a String!
Example
Query
Copy query TestConfig {
testConfig
}
Response
Copy { "data" : { "testConfig" : "xyz789" }}
Mutations
createContact
Description
Create contact record. Returns record of the contactBook entity.
Response
Returns a ContactDto!
Arguments
Example
Query
Copy mutation CreateContact (
$nickName: String ! ,
$walletAddress: String !
) {
createContact(
nickName: $nickName,
walletAddress: $walletAddress
) {
createdAt
id
nickName
ownerUri
updatedAt
walletAddress
}
}
Variables
Copy {
"nickName" : "xyz789" ,
"walletAddress" : "xyz789"
}
Response
Copy {
"data" : {
"createContact" : {
"createdAt" : "2007-12-03T10:15:30Z" ,
"id" : 987.65 ,
"nickName" : "abc123" ,
"ownerUri" : "xyz789" ,
"updatedAt" : "2007-12-03T10:15:30Z" ,
"walletAddress" : "abc123"
}
}
}
Mutations
createOneCollectionEntity
Response
Returns a CollectionEntity!
Arguments
Example
Query
Copy 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
paymentBatcherFactoryAddress
studioPublicJsonRpcUrl
updatedAt
}
redirectDomains {
domain
}
tenant {
createdAt
id
minPaymentBatcherBalanceInUSDC
name
paymentBatcherAddress
tenantUri
updatedAt
}
tenantId
type
updatedAt
}
}
Variables
Copy { "input" : CreateOneCollectionEntityInput}
Response
Copy {
"data" : {
"createOneCollectionEntity" : {
"avatarUrl" : "xyz789" ,
"bannerUrl" : "abc123" ,
"createdAt" : "2007-12-03T10:15:30Z" ,
"description" : "abc123" ,
"email" : "abc123" ,
"entityUri" : "abc123" ,
"id" : 4 ,
"name" : "xyz789" ,
"networkConfigs" : [NetworkConfig] ,
"redirectDomains" : [RedirectDomain] ,
"tenant" : Tenant ,
"tenantId" : "4" ,
"type" : "ARTIST" ,
"updatedAt" : "2007-12-03T10:15:30Z"
}
}
}
Mutations
createRelation
Response
Returns a CollectionEntityRelation!
Arguments
Example
Query
Copy 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
paymentBatcherFactoryAddress
studioPublicJsonRpcUrl
updatedAt
}
parentEntityId
relationType
tenant {
createdAt
id
minPaymentBatcherBalanceInUSDC
name
paymentBatcherAddress
tenantUri
updatedAt
}
tenantId
updatedAt
}
}
Variables
Copy { "createRelation" : CreateCollectionEntityRelation}
Response
Copy {
"data" : {
"createRelation" : {
"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"
}
}
}
Mutations
createS3Url
Description
🔒 JWT Token
Creates an s3 url for enterprise's avatar or banner
Response
Returns a S3LinkRes!
Arguments
Example
Query
Copy mutation CreateS3Url ($s3ReqDto: S3LinkReq ! ) {
createS3Url(s3ReqDto: $s3ReqDto) {
uploadUrl
}
}
Variables
Copy { "s3ReqDto" : S 3 LinkReq}
Response
Copy {
"data" : {
"createS3Url" : { "uploadUrl" : "xyz789" }
}
}
Mutations
deleteContact
Description
Delete contact record. Returns record of the contactBook entity.
Response
Returns a ContactDto!
Arguments
Example
Query
Copy mutation DeleteContact ($id: Float ! ) {
deleteContact(id: $id) {
createdAt
id
nickName
ownerUri
updatedAt
walletAddress
}
}
Variables
Response
Copy {
"data": {
"deleteContact": {
"createdAt": "2007-12-03T10:15:30Z",
"id": 123.45,
"nickName": "abc123",
"ownerUri": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"walletAddress": "xyz789"
}
}
}
Mutations
deleteManyCollectionEntities
Response
Returns a DeleteManyResponse!
Arguments
Example
Query
Copy mutation DeleteManyCollectionEntities($input: DeleteManyCollectionEntitiesInput!) {
deleteManyCollectionEntities(input: $input) {
deletedCount
}
}
Variables
Copy {"input": DeleteManyCollectionEntitiesInput}
Response
Copy {"data": {"deleteManyCollectionEntities": {"deletedCount": 987}}}
Mutations
deleteManyRelations
Response
Returns a DeleteManyResponse!
Arguments
Example
Query
Copy mutation DeleteManyRelations($input: DeleteManyCollectionEntityRelationsInput!) {
deleteManyRelations(input: $input) {
deletedCount
}
}
Variables
Copy {"input": DeleteManyCollectionEntityRelationsInput}
Response
Copy {"data": {"deleteManyRelations": {"deletedCount": 987}}}
Mutations
deleteOneCollectionEntity
Response
Returns a CollectionEntityDeleteResponse!
Arguments
Example
Query
Copy mutation DeleteOneCollectionEntity($input: DeleteOneCollectionEntityInput!) {
deleteOneCollectionEntity(input: $input) {
avatarUrl
bannerUrl
createdAt
description
email
entityUri
id
name
tenantId
type
updatedAt
}
}
Variables
Copy {"input": DeleteOneCollectionEntityInput}
Response
Copy {
"data": {
"deleteOneCollectionEntity": {
"avatarUrl": "xyz789",
"bannerUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"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
Example
Query
Copy mutation DeleteOneRelation($input: DeleteOneCollectionEntityRelationInput!) {
deleteOneRelation(input: $input) {
childEntityId
createdAt
id
parentEntityId
relationType
tenantId
updatedAt
}
}
Variables
Copy {"input": DeleteOneCollectionEntityRelationInput}
Response
Copy {
"data": {
"deleteOneRelation": {
"childEntityId": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"parentEntityId": "xyz789",
"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
Example
Query
Copy mutation UpdateContact(
$id: Float!,
$nickName: String,
$walletAddress: String
) {
updateContact(
id: $id,
nickName: $nickName,
walletAddress: $walletAddress
) {
createdAt
id
nickName
ownerUri
updatedAt
walletAddress
}
}
Variables
Copy {
"id": 123.45,
"nickName": "xyz789",
"walletAddress": "abc123"
}
Response
Copy {
"data": {
"updateContact": {
"createdAt": "2007-12-03T10:15:30Z",
"id": 987.65,
"nickName": "xyz789",
"ownerUri": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"walletAddress": "xyz789"
}
}
}
Mutations
updateManyCollectionEntities
Response
Returns an UpdateManyResponse!
Arguments
Example
Query
Copy mutation UpdateManyCollectionEntities($input: UpdateManyCollectionEntitiesInput!) {
updateManyCollectionEntities(input: $input) {
updatedCount
}
}
Variables
Copy {"input": UpdateManyCollectionEntitiesInput}
Response
Copy {"data": {"updateManyCollectionEntities": {"updatedCount": 987}}}
Mutations
updateOneCollectionEntity
Response
Returns a CollectionEntity!
Arguments
Example
Query
Copy 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
paymentBatcherFactoryAddress
studioPublicJsonRpcUrl
updatedAt
}
redirectDomains {
domain
}
tenant {
createdAt
id
minPaymentBatcherBalanceInUSDC
name
paymentBatcherAddress
tenantUri
updatedAt
}
tenantId
type
updatedAt
}
}
Variables
Copy {"input": UpdateOneCollectionEntityInput}
Response
Copy {
"data": {
"updateOneCollectionEntity": {
"avatarUrl": "xyz789",
"bannerUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"email": "xyz789",
"entityUri": "abc123",
"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
Types
CollectionEntity
Description
represents an element of the hierarchy within the enterprise.
Fields
Example
Copy {
"avatarUrl": "xyz789",
"bannerUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"email": "xyz789",
"entityUri": "xyz789",
"id": 4,
"name": "xyz789",
"networkConfigs": [NetworkConfig],
"redirectDomains": [RedirectDomain],
"tenant": Tenant,
"tenantId": 4,
"type": "ARTIST",
"updatedAt": "2007-12-03T10:15:30Z"
}
Types
CollectionEntityConnection
Fields
Example
Copy {
"nodes": [CollectionEntity],
"pageInfo": OffsetPageInfo,
"totalCount": 123
}
Types
CollectionEntityDeleteFilter
Fields
Example
Copy {
"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
Example
Copy {
"avatarUrl": "xyz789",
"bannerUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"email": "abc123",
"entityUri": "abc123",
"id": "4",
"name": "xyz789",
"tenantId": "4",
"type": "ARTIST",
"updatedAt": "2007-12-03T10:15:30Z"
}
Types
CollectionEntityFilter
Fields
Example
Copy {
"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
Example
Copy {
"and": [CollectionEntityFilterRedirectDomainFilter],
"domain": StringFieldComparison,
"or": [CollectionEntityFilterRedirectDomainFilter]
}
Types
CollectionEntityFilterTenantFilter
Fields
Example
Copy {
"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
Example
Copy {
"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"
}
Types
CollectionEntityRelationConnection
Fields
Example
Copy {
"nodes": [CollectionEntityRelation],
"pageInfo": OffsetPageInfo,
"totalCount": 987
}
Types
CollectionEntityRelationDeleteFilter
Fields
Example
Copy {
"and": [CollectionEntityRelationDeleteFilter],
"childEntityId": StringFieldComparison,
"createdAt": DateFieldComparison,
"id": IDFilterComparison,
"or": [CollectionEntityRelationDeleteFilter],
"parentEntityId": StringFieldComparison,
"relationType": CollectionEntityRelationTypeFilterComparison,
"tenantId": StringFieldComparison,
"updatedAt": DateFieldComparison
}
Types
CollectionEntityRelationDeleteResponse
Fields
Example
Copy {
"childEntityId": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"parentEntityId": "abc123",
"relationType": "ENTERPIRSE_ARTIST",
"tenantId": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
Types
CollectionEntityRelationFilter
Fields
Example
Copy {
"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
Example
Copy {
"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
],
"paymentBatcherFactoryAddress": StringFieldComparison,
"studioPublicJsonRpcUrl": StringFieldComparison,
"updatedAt": DateFieldComparison
}
Types
CollectionEntityRelationFilterTenantFilter
Fields
Example
Copy {
"and": [CollectionEntityRelationFilterTenantFilter],
"createdAt": DateFieldComparison,
"id": IDFilterComparison,
"minPaymentBatcherBalanceInUSDC": NumberFieldComparison,
"name": StringFieldComparison,
"or": [CollectionEntityRelationFilterTenantFilter],
"paymentBatcherAddress": StringFieldComparison,
"tenantUri": StringFieldComparison,
"updatedAt": DateFieldComparison
}
Types
CollectionEntityRelationSort
Fields
Example
Copy {"direction": "ASC", "field": "childEntityId", "nulls": "NULLS_FIRST"}
Types
CollectionEntityRelationSortFields
Values
Example
Types
CollectionEntityRelationType
Values
Example
Types
CollectionEntityRelationTypeFilterComparison
Fields
Example
Copy {
"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
Example
Copy {"direction": "ASC", "field": "avatarUrl", "nulls": "NULLS_FIRST"}
Types
CollectionEntitySortFields
Values
Example
Types
CollectionEntityType
Values
Example
Types
CollectionEntityTypeFilterComparison
Fields
Example
Copy {
"eq": "ARTIST",
"gt": "ARTIST",
"gte": "ARTIST",
"iLike": "ARTIST",
"in": ["ARTIST"],
"is": false,
"isNot": false,
"like": "ARTIST",
"lt": "ARTIST",
"lte": "ARTIST",
"neq": "ARTIST",
"notILike": "ARTIST",
"notIn": ["ARTIST"],
"notLike": "ARTIST"
}
Types
CollectionEntityUpdateFilter
Fields
Example
Copy {
"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
Example
Copy {
"createdAt": "2007-12-03T10:15:30Z",
"id": 123.45,
"nickName": "xyz789",
"ownerUri": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"walletAddress": "xyz789"
}
Types
ContactsDto
Fields
Example
Copy {"count": 123.45, "items": [ContactDto]}
Types
CreateCollectionEntity
Fields
Example
Copy {
"avatarUrl": "abc123",
"bannerUrl": "xyz789",
"description": "xyz789",
"email": "xyz789",
"entityUri": "xyz789",
"name": "xyz789",
"networkNames": ["amoy"],
"type": "ARTIST"
}
Types
CreateCollectionEntityRelation
Fields
Example
Copy {
"childEntityId": "abc123",
"parentEntityId": "abc123",
"relationType": "ENTERPIRSE_ARTIST"
}
Types
CreateOneCollectionEntityInput
Fields
Example
Copy {"collectionEntity": CreateCollectionEntity}
Types
CurrenciesModel
Fields
Example
Copy {
"lendingToken": CurrencyModel,
"nativeCoin": CurrencyModel,
"otherCurrencies": [CurrencyModel]
}
Types
CurrencyModel
Fields
Example
Copy {
"address": "xyz789",
"decimals": 987.65,
"symbol": "abc123"
}
Types
DateFieldComparison
Fields
Example
Copy {
"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": false,
"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
Example
Copy {
"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
Copy "2007-12-03T10:15:30Z"
Types
DeleteManyCollectionEntitiesInput
Fields
Example
Copy {"filter": CollectionEntityDeleteFilter}
Types
DeleteManyCollectionEntityRelationsInput
Fields
Example
Copy {"filter": CollectionEntityRelationDeleteFilter}
Types
DeleteManyResponse
Fields
Example
Copy {"deletedCount": 987}
Types
DeleteOneCollectionEntityInput
Fields
Example
Types
DeleteOneCollectionEntityRelationInput
Fields
Example
Types
FileType
Values
Example
Types
Float
Description
The Float
scalar type represents signed double-precision fractional values as specified by IEEE 754 .
Example
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
Types
IDFilterComparison
Fields
Example
Copy {
"eq": "4",
"gt": "4",
"gte": 4,
"iLike": "4",
"in": ["4"],
"is": true,
"isNot": true,
"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
Types
IntFieldComparison
Fields
Example
Copy {
"between": IntFieldComparisonBetween,
"eq": 987,
"gt": 123,
"gte": 987,
"in": [987],
"is": false,
"isNot": false,
"lt": 123,
"lte": 987,
"neq": 987,
"notBetween": IntFieldComparisonBetween,
"notIn": [123]
}
Types
IntFieldComparisonBetween
Fields
Example
Copy {"lower": 123, "upper": 987}
Types
NetworkCapabilities
Values
Example
Types
NetworkCapabilitiesFilterComparison
Fields
Example
Copy {
"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
NetworkCapabilitiesModel
Fields
Example
Copy {"networkCapability": "Agreements"}
Types
NetworkCapability
Description
Network capability
Fields
Example
Copy {"networkCapability": "Agreements"}
Types
NetworkCapabilityFilter
Fields
Example
Copy {
"and": [NetworkCapabilityFilter],
"networkCapability": NetworkCapabilitiesFilterComparison,
"or": [NetworkCapabilityFilter]
}
Types
NetworkCapabilitySort
Fields
Example
Copy {"direction": "ASC", "field": "networkCapability", "nulls": "NULLS_FIRST"}
Types
NetworkCapabilitySortFields
Values
Example
Types
NetworkConfig
Description
Network configuration object
Fields
Example
Copy {
"activitiesSubgraphUrl": "xyz789",
"agreementFactoryAddress": "xyz789",
"agreementSubgraphUrl": "abc123",
"alchemyApiKey": "xyz789",
"capabilities": [NetworkCapability],
"chainId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"defaultStripeFeeInPercent": 123,
"dmmAddress": "xyz789",
"feeManagerAddress": "abc123",
"id": 4,
"jsonRpcUrl": "xyz789",
"lendingContractAddress": "xyz789",
"marketAddress": "abc123",
"marketOwner": "abc123",
"nativeCoin": "abc123",
"nativeCoinDecimals": 123,
"networkName": "amoy",
"nftSubgraphUrl": "xyz789",
"paymentBatcherFactoryAddress": "abc123",
"studioPublicJsonRpcUrl": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
Types
NetworkConfigConnection
Fields
Example
Copy {
"nodes": [NetworkConfig],
"pageInfo": OffsetPageInfo,
"totalCount": 123
}
Types
NetworkConfigFilter
Fields
Example
Copy {
"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],
"paymentBatcherFactoryAddress": StringFieldComparison,
"studioPublicJsonRpcUrl": StringFieldComparison,
"updatedAt": DateFieldComparison
}
Types
NetworkConfigFilterNetworkCapabilityFilter
Fields
Example
Copy {
"and": [NetworkConfigFilterNetworkCapabilityFilter],
"networkCapability": NetworkCapabilitiesFilterComparison,
"or": [NetworkConfigFilterNetworkCapabilityFilter]
}
Types
NetworkConfigPublicModel
Fields
Example
Copy {
"capabilities": [NetworkCapabilitiesModel],
"chainId": 987.65,
"isTestNet": true,
"networkName": "amoy",
"studioPublicJsonRpcUrl": "xyz789"
}
Types
NetworkConfigSort
Fields
Example
Copy {"direction": "ASC", "field": "activitiesSubgraphUrl", "nulls": "NULLS_FIRST"}
Types
NetworkConfigSortFields
Values
Example
Copy "activitiesSubgraphUrl"
Types
NetworkConfigV2Model
Fields
Example
Copy {
"agreementFactoryAddress": "abc123",
"agreementSubgraphUrl": "xyz789",
"capabilities": [NetworkCapabilitiesModel],
"chainId": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"currencies": CurrenciesModel,
"explorer": "xyz789",
"feeManagerAddress": "xyz789",
"id": "abc123",
"ipfsEndpoint": "abc123",
"isTestNet": false,
"jsonRpcUrl": "abc123",
"lendingContractAddress": "xyz789",
"marketAddress": "xyz789",
"marketOwner": "abc123",
"networkName": "amoy",
"nftSubgraphUrl": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
Types
NetworkName
Values
Example
Types
NetworkNameFilterComparison
Fields
Example
Copy {
"eq": "amoy",
"gt": "amoy",
"gte": "amoy",
"iLike": "amoy",
"in": ["amoy"],
"is": true,
"isNot": false,
"like": "amoy",
"lt": "amoy",
"lte": "amoy",
"neq": "amoy",
"notILike": "amoy",
"notIn": ["amoy"],
"notLike": "amoy"
}
Types
NumberFieldComparison
Fields
Example
Copy {
"between": NumberFieldComparisonBetween,
"eq": 987.65,
"gt": 123.45,
"gte": 987.65,
"in": [987.65],
"is": true,
"isNot": false,
"lt": 123.45,
"lte": 123.45,
"neq": 987.65,
"notBetween": NumberFieldComparisonBetween,
"notIn": [987.65]
}
Types
NumberFieldComparisonBetween
Fields
Example
Copy {"lower": 123.45, "upper": 987.65}
Types
OffsetPageInfo
Fields
Example
Copy {"hasNextPage": false, "hasPreviousPage": false}
Types
OffsetPaging
Fields
Example
Copy {"limit": 123, "offset": 123}
Types
RedirectDomain
Fields
Example
Types
RedirectDomainFilter
Fields
Example
Copy {
"and": [RedirectDomainFilter],
"domain": StringFieldComparison,
"or": [RedirectDomainFilter]
}
Types
RedirectDomainSort
Fields
Example
Copy {"direction": "ASC", "field": "domain", "nulls": "NULLS_FIRST"}
Types
RedirectDomainSortFields
Values
Example
Types
S3LinkReq
Fields
Example
Copy {
"contentType": "xyz789",
"entityId": "abc123",
"fileName": "abc123",
"imageType": "ENTITY_AVATAR"
}
Types
S3LinkRes
Fields
Example
Copy {"uploadUrl": "xyz789"}
Types
SortDirection
Description
Sort Directions
Values
Example
Types
SortNulls
Description
Sort Nulls Options
Values
Example
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
Types
StringFieldComparison
Fields
Example
Copy {
"eq": "abc123",
"gt": "abc123",
"gte": "xyz789",
"iLike": "xyz789",
"in": ["abc123"],
"is": true,
"isNot": false,
"like": "xyz789",
"lt": "abc123",
"lte": "xyz789",
"neq": "abc123",
"notILike": "abc123",
"notIn": ["xyz789"],
"notLike": "abc123"
}
Types
Tenant
Description
Tenant ID to which artists, enterprise and labels belong.
Fields
Example
Copy {
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"minPaymentBatcherBalanceInUSDC": 123.45,
"name": "abc123",
"paymentBatcherAddress": "abc123",
"tenantUri": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
Types
UpdateCollectionEntity
Fields
Example
Copy {
"avatarUrl": "xyz789",
"bannerUrl": "abc123",
"description": "abc123",
"email": "xyz789",
"entityUri": "abc123",
"name": "abc123"
}
Types
UpdateManyCollectionEntitiesInput
Fields
Example
Copy {
"filter": CollectionEntityUpdateFilter,
"update": UpdateCollectionEntity
}
Types
UpdateManyResponse
Fields
Example
Copy {"updatedCount": 123}
Types
UpdateOneCollectionEntityInput
Fields
Example
Copy {"id": 4, "update": UpdateCollectionEntity}
Documentation by Anvil SpectaQL