Ember Hub API
Everything provided by Ember/Hive services
Terms of Service
API Endpoints
https://dev-hive-swarmio-cicd.swarmio.gg/graphqlQueries
InGameResults
Description
Retrieve in game results
Response
Returns
[InGameResult!]!
Arguments
| Name | Description |
|---|---|
matchIds -
[String!]!
|
Multiple match IDs within a competition |
Example
Query
query InGameResults($matchIds: [String!]!) {
InGameResults(matchIds: $matchIds) {
id
matchId
scores {
...ParticipantScoreFragment
}
}
}
Variables
{"matchIds": ["xyz789"]}
Response
{
"data": {
"InGameResults": [
{
"id": "abc123",
"matchId": "xyz789",
"scores": [ParticipantScore]
}
]
}
}
account
Description
Returns an account with specific id.
Example
Query
query account($id: String!) {
account(id: $id) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"account": {
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "xyz789",
"isSupplier": true,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
accountByPublicURL
Description
Returns an account with the specific publicURL
Example
Query
query accountByPublicURL($publicURL: String!) {
accountByPublicURL(publicURL: $publicURL) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"publicURL": "abc123"}
Response
{
"data": {
"accountByPublicURL": {
"accountType": "xyz789",
"avatarURL": "xyz789",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "xyz789",
"isSupplier": false,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
accounts
Description
Account data
Response
Returns
[Account!]!
Arguments
| Name | Description |
|---|---|
ids -
[String!]!
|
Example
Query
query accounts($ids: [String!]!) {
accounts(ids: $ids) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"ids": ["xyz789"]}
Response
{
"data": {
"accounts": [
{
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "xyz789",
"isSupplier": false,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
]
}
}
allActivePublicServers
Description
Get all active servers
Response
Returns
[PublicGameServer!]!
Arguments
| Name | Description |
|---|---|
featured -
Boolean
|
Optionally, whether the object in question should be featured. (Typically a competition or server) |
Example
Query
query allActivePublicServers($featured: Boolean) {
allActivePublicServers(featured: $featured) {
connectString
description
featured
id
imageURL
ip
maxNumberOfPlayers
name
port
rconPassword
region
serverType
status
steamURL
timeAcquired
timeDestroyed
timeRequested
}
}
Variables
{"featured": false}
Response
{
"data": {
"allActivePublicServers": [
{
"connectString": "abc123",
"description": "xyz789",
"featured": true,
"id": "abc123",
"imageURL": "xyz789",
"ip": "abc123",
"maxNumberOfPlayers": 123,
"name": "abc123",
"port": 123,
"rconPassword": "abc123",
"region": "xyz789",
"serverType": "xyz789",
"status": "Creating",
"steamURL": "xyz789",
"timeAcquired": "2007-12-03",
"timeDestroyed": "2007-12-03",
"timeRequested": "2007-12-03"
}
]
}
}
allEventGames
Description
Retrieve all supported event games on the platform
Response
Returns
[Game!]!
Example
Query
query allEventGames {
allEventGames {
bufferTime
description
estimatedRoundLength
gameAccountTypeIds
gameAccountTypes {
...GameAccountTypeFragment
}
id
image
integrated
maxParticipantsPerRound
prettyName
supportedCompetitionFormats
supportedParticipantTypes
typicalPlacingStrategyForRounds
weight
}
}
Response
{
"data": {
"allEventGames": [
{
"bufferTime": DurationInMilliseconds,
"description": "xyz789",
"estimatedRoundLength": DurationInMilliseconds,
"gameAccountTypeIds": ["xyz789"],
"gameAccountTypes": [GameAccountType],
"id": "abc123",
"image": "xyz789",
"integrated": false,
"maxParticipantsPerRound": 987.65,
"prettyName": "abc123",
"supportedCompetitionFormats": ["Basic"],
"supportedParticipantTypes": ["IndividualParticipantType"],
"typicalPlacingStrategyForRounds": "HighestAverageScore",
"weight": 123.45
}
]
}
}
allEvents
Description
Retrieve all events
Response
Returns a
PaginatedEvent!
Arguments
| Name | Description |
|---|---|
eventSortField -
EventSortField!
|
Default = Default |
eventsQuery -
EventsQuery!
|
|
limit -
Int!
|
Default = 50 |
offset -
Int!
|
Default = 0 |
sortOrder -
SortOrder!
|
Default = Ascending |
Example
Query
query allEvents(
$eventSortField: EventSortField!,
$eventsQuery: EventsQuery!,
$limit: Int!,
$offset: Int!,
$sortOrder: SortOrder!
) {
allEvents(
eventSortField: $eventSortField,
eventsQuery: $eventsQuery,
limit: $limit,
offset: $offset,
sortOrder: $sortOrder
) {
hasNextPage
nodes {
...EventFragment
}
totalCount
}
}
Variables
{
"eventSortField": "Default",
"eventsQuery": EventsQuery,
"limit": 50,
"offset": 0,
"sortOrder": "Ascending"
}
Response
{
"data": {
"allEvents": {
"hasNextPage": true,
"nodes": [Event],
"totalCount": 987
}
}
}
allGameAccountTypes
Description
Retrieve all supported game account types on the platform
Response
Returns
[GameAccountType!]!
Example
Query
query allGameAccountTypes {
allGameAccountTypes {
accountIDLabel
accountNameLabel
games {
...GameFragment
}
iconUrl
id
imageUrl
implicitGameIds
integrated
prettyName
requiresExternalAccountId
requiresExternalAccountName
}
}
Response
{
"data": {
"allGameAccountTypes": [
{
"accountIDLabel": "xyz789",
"accountNameLabel": "abc123",
"games": [Game],
"iconUrl": "xyz789",
"id": "xyz789",
"imageUrl": "abc123",
"implicitGameIds": ["abc123"],
"integrated": true,
"prettyName": "xyz789",
"requiresExternalAccountId": false,
"requiresExternalAccountName": false
}
]
}
}
allServers
Description
Get all servers
Response
Returns
[Server!]!
Example
Query
query allServers {
allServers {
id
ip
maxNumberOfPlayers
port
rconPassword
region
serverType
status
timeAcquired
timeDestroyed
timeRequested
}
}
Response
{
"data": {
"allServers": [
{
"id": "xyz789",
"ip": "abc123",
"maxNumberOfPlayers": 123,
"port": 987,
"rconPassword": "xyz789",
"region": "abc123",
"serverType": "abc123",
"status": "Creating",
"timeAcquired": "2007-12-03",
"timeDestroyed": "2007-12-03",
"timeRequested": "2007-12-03"
}
]
}
}
allUsers
Description
Retrieve all registered users
Response
Returns a
PaginatedUser!
Example
Query
query allUsers(
$limit: Int!,
$offset: Int!
) {
allUsers(
limit: $limit,
offset: $offset
) {
hasNextPage
nodes {
...UserFragment
}
totalCount
}
}
Variables
{"limit": 50, "offset": 0}
Response
{
"data": {
"allUsers": {
"hasNextPage": false,
"nodes": [User],
"totalCount": 123
}
}
}
automaticallyVerifiedResultsForRoundAndFromParticipantId
Response
Returns an
AutomaticallyVerifiedResultsForRoundFromParticipant
Example
Query
query automaticallyVerifiedResultsForRoundAndFromParticipantId(
$participantId: String!,
$roundId: String!
) {
automaticallyVerifiedResultsForRoundAndFromParticipantId(
participantId: $participantId,
roundId: $roundId
) {
competitionId
created
fromParticipantId
plzDelete
roundId
unverifiedResults {
...BasicAutomaticallyVerifiedResultFragment
}
}
}
Variables
{
"participantId": "xyz789",
"roundId": "xyz789"
}
Response
{
"data": {
"automaticallyVerifiedResultsForRoundAndFromParticipantId": {
"competitionId": "xyz789",
"created": "2007-12-03",
"fromParticipantId": "abc123",
"plzDelete": false,
"roundId": "xyz789",
"unverifiedResults": [
BasicAutomaticallyVerifiedResult
]
}
}
}
automaticallyVerifiedResultsForRoundId
Response
Returns
[AutomaticallyVerifiedResultsForRoundFromParticipant!]!
Arguments
| Name | Description |
|---|---|
roundId -
String!
|
The round ID within a competition |
Example
Query
query automaticallyVerifiedResultsForRoundId($roundId: String!) {
automaticallyVerifiedResultsForRoundId(roundId: $roundId) {
competitionId
created
fromParticipantId
plzDelete
roundId
unverifiedResults {
...BasicAutomaticallyVerifiedResultFragment
}
}
}
Variables
{"roundId": "xyz789"}
Response
{
"data": {
"automaticallyVerifiedResultsForRoundId": [
{
"competitionId": "abc123",
"created": "2007-12-03",
"fromParticipantId": "abc123",
"plzDelete": true,
"roundId": "abc123",
"unverifiedResults": [
BasicAutomaticallyVerifiedResult
]
}
]
}
}
catalog
Example
Query
query catalog($catalogId: ID!) {
catalog(catalogId: $catalogId) {
catalogId
catalogName
createdBy
createdDate
partner {
...PartnerFragment
}
}
}
Variables
{"catalogId": 4}
Response
{
"data": {
"catalog": {
"catalogId": "4",
"catalogName": "xyz789",
"createdBy": 987,
"createdDate": "xyz789",
"partner": Partner
}
}
}
catalogItem
Response
Returns a
CatalogItem
Example
Query
query catalogItem(
$itemId: ID!,
$partnerId: ID!
) {
catalogItem(
itemId: $itemId,
partnerId: $partnerId
) {
isActive
itemDescBrief
itemDescDetail
itemGalleryUrls
itemId
itemImageUrl
itemName
itemType
pointsValue
stock
tagId
}
}
Variables
{"itemId": 4, "partnerId": "4"}
Response
{
"data": {
"catalogItem": {
"isActive": false,
"itemDescBrief": "xyz789",
"itemDescDetail": "xyz789",
"itemGalleryUrls": ["xyz789"],
"itemId": "4",
"itemImageUrl": "abc123",
"itemName": "xyz789",
"itemType": "PHYSICAL",
"pointsValue": 123.45,
"stock": 123,
"tagId": "4"
}
}
}
catalogItems
Response
Returns a
PaginatedCatalogItems
Arguments
| Name | Description |
|---|---|
filter -
CatalogFilterInput
|
|
limit -
Int!
|
Default = 50 |
offset -
Int!
|
Default = 0 |
partnerId -
ID!
|
|
sort -
CatalogSortInput
|
Example
Query
query catalogItems(
$filter: CatalogFilterInput,
$limit: Int!,
$offset: Int!,
$partnerId: ID!,
$sort: CatalogSortInput
) {
catalogItems(
filter: $filter,
limit: $limit,
offset: $offset,
partnerId: $partnerId,
sort: $sort
) {
currentPage
items {
...CatalogItemFragment
}
totalItems
totalPages
}
}
Variables
{
"filter": CatalogFilterInput,
"limit": 50,
"offset": 0,
"partnerId": "4",
"sort": CatalogSortInput
}
Response
{
"data": {
"catalogItems": {
"currentPage": 123,
"items": [CatalogItem],
"totalItems": 123,
"totalPages": 123
}
}
}
catalogs
Response
Returns
[Catalog]
Example
Query
query catalogs {
catalogs {
catalogId
catalogName
createdBy
createdDate
partner {
...PartnerFragment
}
}
}
Response
{
"data": {
"catalogs": [
{
"catalogId": "4",
"catalogName": "abc123",
"createdBy": 987,
"createdDate": "xyz789",
"partner": Partner
}
]
}
}
categories
Response
Returns
[Category]
Example
Query
query categories {
categories {
categoryCoverImage
categoryDescription
categoryIcon
categoryId
categoryImage
categoryName
id
isActive
isDeleted
itemCatalogCategory {
...ItemCatalogCategoryFragment
}
parentCategory
}
}
Response
{
"data": {
"categories": [
{
"categoryCoverImage": "xyz789",
"categoryDescription": "abc123",
"categoryIcon": "abc123",
"categoryId": "abc123",
"categoryImage": "abc123",
"categoryName": "xyz789",
"id": "4",
"isActive": false,
"isDeleted": false,
"itemCatalogCategory": [ItemCatalogCategory],
"parentCategory": 123
}
]
}
}
category
Example
Query
query category($categoryId: ID!) {
category(categoryId: $categoryId) {
categoryCoverImage
categoryDescription
categoryIcon
categoryId
categoryImage
categoryName
id
isActive
isDeleted
itemCatalogCategory {
...ItemCatalogCategoryFragment
}
parentCategory
}
}
Variables
{"categoryId": 4}
Response
{
"data": {
"category": {
"categoryCoverImage": "xyz789",
"categoryDescription": "xyz789",
"categoryIcon": "xyz789",
"categoryId": "xyz789",
"categoryImage": "abc123",
"categoryName": "abc123",
"id": "4",
"isActive": true,
"isDeleted": true,
"itemCatalogCategory": [ItemCatalogCategory],
"parentCategory": 123
}
}
}
categoryCatalog
Response
Returns
[CategoryCatalog]
Arguments
| Name | Description |
|---|---|
partnerId -
ID!
|
Example
Query
query categoryCatalog($partnerId: ID!) {
categoryCatalog(partnerId: $partnerId) {
categoryCoverImage
categoryIcon
categoryImage
categoryName
id
}
}
Variables
{"partnerId": 4}
Response
{
"data": {
"categoryCatalog": [
{
"categoryCoverImage": "xyz789",
"categoryIcon": "abc123",
"categoryImage": "xyz789",
"categoryName": "xyz789",
"id": "4"
}
]
}
}
categoryItems
Response
Returns a
PaginatedCategoryItems
Example
Query
query categoryItems(
$categoryId: ID!,
$limit: Int!,
$offset: Int!,
$partnerId: ID!
) {
categoryItems(
categoryId: $categoryId,
limit: $limit,
offset: $offset,
partnerId: $partnerId
) {
currentPage
items {
...CatalogItemFragment
}
totalItems
totalPages
}
}
Variables
{
"categoryId": 4,
"limit": 50,
"offset": 0,
"partnerId": "4"
}
Response
{
"data": {
"categoryItems": {
"currentPage": 123,
"items": [CatalogItem],
"totalItems": 987,
"totalPages": 123
}
}
}
csvFiles
Response
Returns an
PaginatedCSVFiles
Example
Query
query csvFiles(
$filter: FilterInput,
$limit: Int!,
$offset: Int!,
$order: SortOrder,
$searchText: String,
$sort: String
) {
csvFiles(
filter: $filter,
limit: $limit,
offset: $offset,
order: $order,
searchText: $searchText,
sort: $sort
) {
currentPage
files {
...CSVFileFragment
}
totalFiles
totalPages
}
}
Variables
{
"filter": FilterInput,
"limit": 50,
"offset": 0,
"order": "Ascending",
"searchText": "abc123",
"sort": "xyz789"
}
Response
{
"data": {
"csvFiles": {
"currentPage": 123,
"files": [CSVFile],
"totalFiles": 123,
"totalPages": 123
}
}
}
embeddedGame
Description
Retrieve all embedded games on the platform
Response
Returns an
EmbeddedGame
Arguments
| Name | Description |
|---|---|
embeddedGameId -
String!
|
The ID of an Embedded Game |
Example
Query
query embeddedGame($embeddedGameId: String!) {
embeddedGame(embeddedGameId: $embeddedGameId) {
availability
desc
embeddedGameURL
id
thumbnailURL
title
}
}
Variables
{"embeddedGameId": "xyz789"}
Response
{
"data": {
"embeddedGame": {
"availability": "Free",
"desc": "abc123",
"embeddedGameURL": "abc123",
"id": "xyz789",
"thumbnailURL": "abc123",
"title": "xyz789"
}
}
}
event
Description
Get event by Id
Example
Query
query event($eventId: String!) {
event(eventId: $eventId) {
category
created
defaultLocale
description
eventCurrencyExchanges {
...EventCurrencyExchangesFragment
}
eventLimitations {
...EventLimitationsFragment
}
eventStages {
...EventStageFragment
}
eventState
eventTeam {
...EventTeamMemberFragment
}
eventTiming {
...EventTimingFragment
}
featured
game {
...GameFragment
}
gameAccountTypeIds
gameAccountTypes {
...GameAccountTypeFragment
}
gameId
id
isSimulated
localizedDescriptions {
...LocalizedOptionalStringFragment
}
localizedMediaContentDetails {
...LocalizedMediaContentDetailsFragment
}
localizedNames {
...LocalizedStringFragment
}
mediaContentDetails {
...MediaContentDetailsFragment
}
name
ownerId
participantCount
participantType
participants {
...ParticipantFragment
}
region
tags {
...TagFragment
}
unlisted
}
}
Variables
{"eventId": "xyz789"}
Response
{
"data": {
"event": {
"category": "Challenge",
"created": "2007-12-03",
"defaultLocale": "ar_BH",
"description": "abc123",
"eventCurrencyExchanges": EventCurrencyExchanges,
"eventLimitations": EventLimitations,
"eventStages": [EventStage],
"eventState": "ARCHIVED",
"eventTeam": [EventTeamMember],
"eventTiming": EventTiming,
"featured": false,
"game": Game,
"gameAccountTypeIds": ["abc123"],
"gameAccountTypes": [GameAccountType],
"gameId": "xyz789",
"id": "abc123",
"isSimulated": true,
"localizedDescriptions": [LocalizedOptionalString],
"localizedMediaContentDetails": [
LocalizedMediaContentDetails
],
"localizedNames": [LocalizedString],
"mediaContentDetails": MediaContentDetails,
"name": "abc123",
"ownerId": "xyz789",
"participantCount": 987,
"participantType": "IndividualParticipantType",
"participants": [Participant],
"region": "APAC",
"tags": [Tag],
"unlisted": false
}
}
}
eventMatch
Description
Retrieve a Match
Response
Returns an
OutOfContextCompetitionMatches
Arguments
| Name | Description |
|---|---|
matchId -
String!
|
The match ID within a competition |
Example
Query
query eventMatch($matchId: String!) {
eventMatch(matchId: $matchId) {
competitionId
competitionType
isSimulated
matches {
...CompetitionMatchFragment
}
}
}
Variables
{"matchId": "abc123"}
Response
{
"data": {
"eventMatch": {
"competitionId": "abc123",
"competitionType": "xyz789",
"isSimulated": true,
"matches": [CompetitionMatch]
}
}
}
eventParticipant
Description
Retrieve an EventParticipant
Response
Returns a
Participant
Arguments
| Name | Description |
|---|---|
participantId -
String!
|
The ID of the event specific participant |
Example
Query
query eventParticipant($participantId: String!) {
eventParticipant(participantId: $participantId) {
accountId
confirmed
participantType
result {
...ResultFragment
}
}
}
Variables
{"participantId": "abc123"}
Response
{
"data": {
"eventParticipant": {
"accountId": "xyz789",
"confirmed": true,
"participantType": "IndividualParticipantType",
"result": Result
}
}
}
eventsByTags
Description
Filter events by tags
Response
Returns
[Event!]!
Arguments
| Name | Description |
|---|---|
eventTagsFilter -
EventTagsFilterQuery!
|
Example
Query
query eventsByTags($eventTagsFilter: EventTagsFilterQuery!) {
eventsByTags(eventTagsFilter: $eventTagsFilter) {
category
created
defaultLocale
description
eventCurrencyExchanges {
...EventCurrencyExchangesFragment
}
eventLimitations {
...EventLimitationsFragment
}
eventStages {
...EventStageFragment
}
eventState
eventTeam {
...EventTeamMemberFragment
}
eventTiming {
...EventTimingFragment
}
featured
game {
...GameFragment
}
gameAccountTypeIds
gameAccountTypes {
...GameAccountTypeFragment
}
gameId
id
isSimulated
localizedDescriptions {
...LocalizedOptionalStringFragment
}
localizedMediaContentDetails {
...LocalizedMediaContentDetailsFragment
}
localizedNames {
...LocalizedStringFragment
}
mediaContentDetails {
...MediaContentDetailsFragment
}
name
ownerId
participantCount
participantType
participants {
...ParticipantFragment
}
region
tags {
...TagFragment
}
unlisted
}
}
Variables
{"eventTagsFilter": EventTagsFilterQuery}
Response
{
"data": {
"eventsByTags": [
{
"category": "Challenge",
"created": "2007-12-03",
"defaultLocale": "ar_BH",
"description": "abc123",
"eventCurrencyExchanges": EventCurrencyExchanges,
"eventLimitations": EventLimitations,
"eventStages": [EventStage],
"eventState": "ARCHIVED",
"eventTeam": [EventTeamMember],
"eventTiming": EventTiming,
"featured": false,
"game": Game,
"gameAccountTypeIds": ["xyz789"],
"gameAccountTypes": [GameAccountType],
"gameId": "xyz789",
"id": "xyz789",
"isSimulated": true,
"localizedDescriptions": [
LocalizedOptionalString
],
"localizedMediaContentDetails": [
LocalizedMediaContentDetails
],
"localizedNames": [LocalizedString],
"mediaContentDetails": MediaContentDetails,
"name": "abc123",
"ownerId": "xyz789",
"participantCount": 123,
"participantType": "IndividualParticipantType",
"participants": [Participant],
"region": "APAC",
"tags": [Tag],
"unlisted": true
}
]
}
}
exportItems
Response
Returns an
ExportedItemsCSV
Arguments
| Name | Description |
|---|---|
filter -
ItemFilterInput
|
|
limit -
Int
|
|
offset -
Int!
|
Default = 0 |
order -
SortOrder
|
|
sort -
String
|
Example
Query
query exportItems(
$filter: ItemFilterInput,
$limit: Int,
$offset: Int!,
$order: SortOrder,
$sort: String
) {
exportItems(
filter: $filter,
limit: $limit,
offset: $offset,
order: $order,
sort: $sort
) {
filePath
}
}
Variables
{
"filter": ItemFilterInput,
"limit": 987,
"offset": 0,
"order": "Ascending",
"sort": "abc123"
}
Response
{
"data": {
"exportItems": {"filePath": "xyz789"}
}
}
getActiveMatches
Description
Retrieves all the active matches in an Event
Response
Arguments
| Name | Description |
|---|---|
maybeAccountId -
String
|
The top level accountId for a participant in a competition |
Example
Query
query getActiveMatches($maybeAccountId: String) {
getActiveMatches(maybeAccountId: $maybeAccountId) {
competitionId
competitionType
isSimulated
matches {
...CompetitionMatchFragment
}
}
}
Variables
{"maybeAccountId": "xyz789"}
Response
{
"data": {
"getActiveMatches": [
{
"competitionId": "abc123",
"competitionType": "abc123",
"isSimulated": true,
"matches": [CompetitionMatch]
}
]
}
}
getAllEventsWithCategory
Description
Retrieve all events with Category
Response
Returns
[Event!]!
Arguments
| Name | Description |
|---|---|
eventCategory -
EventCategory!
|
The category of an event element (Such as channel or Tournament |
eventSortField -
EventSortField!
|
Default = Default |
sortOrder -
SortOrder!
|
Default = Ascending |
Example
Query
query getAllEventsWithCategory(
$eventCategory: EventCategory!,
$eventSortField: EventSortField!,
$sortOrder: SortOrder!
) {
getAllEventsWithCategory(
eventCategory: $eventCategory,
eventSortField: $eventSortField,
sortOrder: $sortOrder
) {
category
created
defaultLocale
description
eventCurrencyExchanges {
...EventCurrencyExchangesFragment
}
eventLimitations {
...EventLimitationsFragment
}
eventStages {
...EventStageFragment
}
eventState
eventTeam {
...EventTeamMemberFragment
}
eventTiming {
...EventTimingFragment
}
featured
game {
...GameFragment
}
gameAccountTypeIds
gameAccountTypes {
...GameAccountTypeFragment
}
gameId
id
isSimulated
localizedDescriptions {
...LocalizedOptionalStringFragment
}
localizedMediaContentDetails {
...LocalizedMediaContentDetailsFragment
}
localizedNames {
...LocalizedStringFragment
}
mediaContentDetails {
...MediaContentDetailsFragment
}
name
ownerId
participantCount
participantType
participants {
...ParticipantFragment
}
region
tags {
...TagFragment
}
unlisted
}
}
Variables
{
"eventCategory": "Challenge",
"eventSortField": "Default",
"sortOrder": "Ascending"
}
Response
{
"data": {
"getAllEventsWithCategory": [
{
"category": "Challenge",
"created": "2007-12-03",
"defaultLocale": "ar_BH",
"description": "xyz789",
"eventCurrencyExchanges": EventCurrencyExchanges,
"eventLimitations": EventLimitations,
"eventStages": [EventStage],
"eventState": "ARCHIVED",
"eventTeam": [EventTeamMember],
"eventTiming": EventTiming,
"featured": false,
"game": Game,
"gameAccountTypeIds": ["xyz789"],
"gameAccountTypes": [GameAccountType],
"gameId": "abc123",
"id": "xyz789",
"isSimulated": false,
"localizedDescriptions": [
LocalizedOptionalString
],
"localizedMediaContentDetails": [
LocalizedMediaContentDetails
],
"localizedNames": [LocalizedString],
"mediaContentDetails": MediaContentDetails,
"name": "xyz789",
"ownerId": "xyz789",
"participantCount": 987,
"participantType": "IndividualParticipantType",
"participants": [Participant],
"region": "APAC",
"tags": [Tag],
"unlisted": true
}
]
}
}
getAllSubscriptionTypes
Description
Return all subscriptionTypes defined in the database
Response
Returns
[SubscriptionType!]!
Example
Query
query getAllSubscriptionTypes {
getAllSubscriptionTypes {
conflictSubscriptionTypeIds
defaultLocale
description
enrollable
explicitEnrollment {
...ExplicitEnrollmentFragment
}
id
implicitEnrollments {
...ImplicitEnrollmentFragment
}
initialSwarmioCurrencyReward {
...SwarmioCurrencyRewardFragment
}
localizedDescriptions {
...LocalizedOptionalStringFragment
}
localizedNames {
...LocalizedStringFragment
}
name
recurringPayoutBonus {
...RecurringRewardFragment
}
weight
}
}
Response
{
"data": {
"getAllSubscriptionTypes": [
{
"conflictSubscriptionTypeIds": [
"xyz789"
],
"defaultLocale": "ar_BH",
"description": "abc123",
"enrollable": false,
"explicitEnrollment": ExplicitEnrollment,
"id": "xyz789",
"implicitEnrollments": [ImplicitEnrollment],
"initialSwarmioCurrencyReward": SwarmioCurrencyReward,
"localizedDescriptions": [
LocalizedOptionalString
],
"localizedNames": [LocalizedString],
"name": "abc123",
"recurringPayoutBonus": RecurringReward,
"weight": 123.45
}
]
}
}
getAllSwarmioCurrencies
Response
Returns
[SwarmioCurrency!]!
Example
Query
query getAllSwarmioCurrencies {
getAllSwarmioCurrencies {
active
cashable
id
name
prettyName
}
}
Response
{
"data": {
"getAllSwarmioCurrencies": [
{
"active": true,
"cashable": false,
"id": "abc123",
"name": "abc123",
"prettyName": "abc123"
}
]
}
}
getAllSwarmioCurrencyItems
Response
Returns
[SwarmioCurrencyItem!]!
Example
Query
query getAllSwarmioCurrencyItems {
getAllSwarmioCurrencyItems {
active
amount
costs {
...CurrencyItemCostFragment
}
created
dealTagline
id
name
swarmioCurrency {
...SwarmioCurrencyFragment
}
swarmioCurrencyId
}
}
Response
{
"data": {
"getAllSwarmioCurrencyItems": [
{
"active": true,
"amount": 123.45,
"costs": [CurrencyItemCost],
"created": "2007-12-03",
"dealTagline": "xyz789",
"id": "abc123",
"name": "abc123",
"swarmioCurrency": SwarmioCurrency,
"swarmioCurrencyId": "abc123"
}
]
}
}
getAllSwarmioCurrencyPayouts
Description
Get all currently active Swarmio Currency Payouts
Response
Returns
[SwarmioCurrencyPayout!]!
Arguments
| Name | Description |
|---|---|
swarmioCurrencyId -
String!
|
Example
Query
query getAllSwarmioCurrencyPayouts($swarmioCurrencyId: String!) {
getAllSwarmioCurrencyPayouts(swarmioCurrencyId: $swarmioCurrencyId) {
active
amount
costs {
...SwarmioCurrencyPayoutCostFragment
}
created
id
name
swarmioCurrency {
...SwarmioCurrencyFragment
}
swarmioCurrencyId
}
}
Variables
{"swarmioCurrencyId": "abc123"}
Response
{
"data": {
"getAllSwarmioCurrencyPayouts": [
{
"active": true,
"amount": 123.45,
"costs": [SwarmioCurrencyPayoutCost],
"created": "2007-12-03",
"id": "abc123",
"name": "abc123",
"swarmioCurrency": SwarmioCurrency,
"swarmioCurrencyId": "xyz789"
}
]
}
}
getCurrencyPurchaseHistoryByOwnerId
Response
Returns
[SwarmioPayPayment!]!
Arguments
| Name | Description |
|---|---|
ownerId -
String!
|
|
paymentSortField -
PaymentSortField!
|
Default = DateReceived |
sortOrder -
SortOrder!
|
Default = Ascending |
Example
Query
query getCurrencyPurchaseHistoryByOwnerId(
$ownerId: String!,
$paymentSortField: PaymentSortField!,
$sortOrder: SortOrder!
) {
getCurrencyPurchaseHistoryByOwnerId(
ownerId: $ownerId,
paymentSortField: $paymentSortField,
sortOrder: $sortOrder
) {
dateReceived
destinationService
id
internalTransactionId
isValid
itemId
paymentProviderTransactionId
paymentStatus
paymentType
receivedAmount
receivedCurrency
requestedAmount
requestedCurrency
}
}
Variables
{
"ownerId": "xyz789",
"paymentSortField": "DateReceived",
"sortOrder": "Ascending"
}
Response
{
"data": {
"getCurrencyPurchaseHistoryByOwnerId": [
{
"dateReceived": "2007-12-03",
"destinationService": "xyz789",
"id": "xyz789",
"internalTransactionId": "abc123",
"isValid": false,
"itemId": "xyz789",
"paymentProviderTransactionId": "abc123",
"paymentStatus": "Cancelled",
"paymentType": "Skrill",
"receivedAmount": 123.45,
"receivedCurrency": "AED",
"requestedAmount": 123.45,
"requestedCurrency": "AED"
}
]
}
}
getEmbeddedGames
Description
Retrieve all embedded games on the platform
Response
Returns a
PaginatedEmbeddedGame!
Example
Query
query getEmbeddedGames(
$limit: Int!,
$offset: Int!
) {
getEmbeddedGames(
limit: $limit,
offset: $offset
) {
hasNextPage
nodes {
...EmbeddedGameFragment
}
totalCount
}
}
Variables
{"limit": 50, "offset": 0}
Response
{
"data": {
"getEmbeddedGames": {
"hasNextPage": false,
"nodes": [EmbeddedGame],
"totalCount": 123
}
}
}
getExternalSubscriptionPackagesBySubscriptionPartner
Description
Return all external subscription package details for a target subscriptionPartner
Response
Returns
[ExternalSubscriptionPackage!]!
Arguments
| Name | Description |
|---|---|
subscriptionPartnerType -
SubscriptionPartner!
|
Example
Query
query getExternalSubscriptionPackagesBySubscriptionPartner($subscriptionPartnerType: SubscriptionPartner!) {
getExternalSubscriptionPackagesBySubscriptionPartner(subscriptionPartnerType: $subscriptionPartnerType) {
active
costs {
...CostFragment
}
description
id
name
providerSubscriptionId
subscriptionPartner
subscriptionProvider
subscriptionType {
...SubscriptionTypeFragment
}
subscriptionTypeId
}
}
Variables
{"subscriptionPartnerType": "D11"}
Response
{
"data": {
"getExternalSubscriptionPackagesBySubscriptionPartner": [
{
"active": false,
"costs": [Cost],
"description": "xyz789",
"id": "abc123",
"name": "xyz789",
"providerSubscriptionId": "xyz789",
"subscriptionPartner": "D11",
"subscriptionProvider": "PayPal",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "xyz789"
}
]
}
}
getMatchUpsAndTournamentsRequiringScoreAttention
Description
Retrieve match-ups and tournaments that need score attention
Response
Returns
[Competition!]!
Example
Query
query getMatchUpsAndTournamentsRequiringScoreAttention {
getMatchUpsAndTournamentsRequiringScoreAttention {
competitionState
competitionType
created
event {
...EventFragment
}
eventId
eventStageId
game {
...GameFragment
}
gameId
id
participantType
participants {
...CompetitionParticipantReferenceFragment
}
startTime
}
}
Response
{
"data": {
"getMatchUpsAndTournamentsRequiringScoreAttention": [
{
"competitionState": "ARCHIVED",
"competitionType": "CHALLENGE",
"created": "2007-12-03",
"event": Event,
"eventId": "abc123",
"eventStageId": "xyz789",
"game": Game,
"gameId": "xyz789",
"id": "abc123",
"participantType": "IndividualParticipantType",
"participants": [CompetitionParticipantReference],
"startTime": "2007-12-03"
}
]
}
}
getSubscriptionsByIds
Description
Return all subscriptions matching the IDs submitted
Response
Returns
[SwarmioSubscription!]!
Arguments
| Name | Description |
|---|---|
subscriptionIds -
[String!]!
|
Example
Query
query getSubscriptionsByIds($subscriptionIds: [String!]!) {
getSubscriptionsByIds(subscriptionIds: $subscriptionIds) {
expiry
id
isUsable
subscriptionImplementation
subscriptionState
subscriptionType {
...SubscriptionTypeFragment
}
subscriptionTypeId
}
}
Variables
{"subscriptionIds": ["xyz789"]}
Response
{
"data": {
"getSubscriptionsByIds": [
{
"expiry": "2007-12-03T10:15:30Z",
"id": "abc123",
"isUsable": true,
"subscriptionImplementation": "ImplicitSubscriptionImplementation",
"subscriptionState": "Active",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "xyz789"
}
]
}
}
getSubscriptionsForAccountId
Description
Return all implicitSubscriptions attached to a target account, refreshing them from the provider if their cacheExpiry has expired
Example
Query
query getSubscriptionsForAccountId($accountId: String!) {
getSubscriptionsForAccountId(accountId: $accountId) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"accountId": "abc123"}
Response
{
"data": {
"getSubscriptionsForAccountId": {
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "xyz789",
"isSupplier": false,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
getSubscriptionsForAccountIds
Description
Return all implicitSubscriptions (as a list) attached to a target account list, refreshing them from the provider if their cacheExpiry has expired
Response
Returns
[Account!]
Arguments
| Name | Description |
|---|---|
accountIds -
[String!]!
|
Example
Query
query getSubscriptionsForAccountIds($accountIds: [String!]!) {
getSubscriptionsForAccountIds(accountIds: $accountIds) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"accountIds": ["xyz789"]}
Response
{
"data": {
"getSubscriptionsForAccountIds": [
{
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "xyz789",
"isSupplier": true,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
]
}
}
getSwarmioCurrencies
Response
Returns a
PaginatedSwarmioCurrency!
Example
Query
query getSwarmioCurrencies(
$limit: Int!,
$offset: Int!
) {
getSwarmioCurrencies(
limit: $limit,
offset: $offset
) {
hasNextPage
nodes {
...SwarmioCurrencyFragment
}
totalCount
}
}
Variables
{"limit": 50, "offset": 0}
Response
{
"data": {
"getSwarmioCurrencies": {
"hasNextPage": true,
"nodes": [SwarmioCurrency],
"totalCount": 123
}
}
}
getSwarmioCurrencyExchangeBlocks
Response
Returns a
PaginatedSwarmioCurrencyExchangeBlock!
Example
Query
query getSwarmioCurrencyExchangeBlocks(
$limit: Int!,
$offset: Int!
) {
getSwarmioCurrencyExchangeBlocks(
limit: $limit,
offset: $offset
) {
hasNextPage
nodes {
...SwarmioCurrencyExchangeBlockFragment
}
totalCount
}
}
Variables
{"limit": 50, "offset": 0}
Response
{
"data": {
"getSwarmioCurrencyExchangeBlocks": {
"hasNextPage": true,
"nodes": [SwarmioCurrencyExchangeBlock],
"totalCount": 123
}
}
}
getSwarmioCurrencyItems
Response
Returns a
PaginatedSwarmioCurrencyItem!
Example
Query
query getSwarmioCurrencyItems(
$limit: Int!,
$offset: Int!
) {
getSwarmioCurrencyItems(
limit: $limit,
offset: $offset
) {
hasNextPage
nodes {
...SwarmioCurrencyItemFragment
}
totalCount
}
}
Variables
{"limit": 50, "offset": 0}
Response
{
"data": {
"getSwarmioCurrencyItems": {
"hasNextPage": false,
"nodes": [SwarmioCurrencyItem],
"totalCount": 987
}
}
}
getSwarmioCurrencyPayouts
Response
Returns a
PaginatedSwarmioCurrencyPayout!
Example
Query
query getSwarmioCurrencyPayouts(
$limit: Int!,
$offset: Int!
) {
getSwarmioCurrencyPayouts(
limit: $limit,
offset: $offset
) {
hasNextPage
nodes {
...SwarmioCurrencyPayoutFragment
}
totalCount
}
}
Variables
{"limit": 50, "offset": 0}
Response
{
"data": {
"getSwarmioCurrencyPayouts": {
"hasNextPage": false,
"nodes": [SwarmioCurrencyPayout],
"totalCount": 123
}
}
}
getWallet
Description
Returns a SwarmioWallet with specific walletId.
Response
Returns a
SwarmioWallet
Arguments
| Name | Description |
|---|---|
walletId -
String!
|
Example
Query
query getWallet($walletId: String!) {
getWallet(walletId: $walletId) {
balance
boughtTransactions {
...PaginatedBoughtTransactionFragment
}
cashOutTransactions {
...PaginatedCashOutTransactionFragment
}
created
exchangedTransactions {
...PaginatedExchangedTransactionFragment
}
freebieTransactions {
...PaginatedFreebieTransactionFragment
}
id
ownerId
swarmioCurrency {
...SwarmioCurrencyFragment
}
swarmioCurrencyId
transactions {
...PaginatedSwarmioWalletTransactionWithMetadataFragment
}
transferTransactions {
...PaginatedTransferTransactionFragment
}
}
}
Variables
{"walletId": "abc123"}
Response
{
"data": {
"getWallet": {
"balance": 987.65,
"boughtTransactions": PaginatedBoughtTransaction,
"cashOutTransactions": PaginatedCashOutTransaction,
"created": "2007-12-03",
"exchangedTransactions": PaginatedExchangedTransaction,
"freebieTransactions": PaginatedFreebieTransaction,
"id": "xyz789",
"ownerId": "xyz789",
"swarmioCurrency": SwarmioCurrency,
"swarmioCurrencyId": "xyz789",
"transactions": PaginatedSwarmioWalletTransactionWithMetadata,
"transferTransactions": PaginatedTransferTransaction
}
}
}
getWalletsForOwner
Description
Returns all SwarmioWallets for a specific ownerId.
Response
Returns
[SwarmioWallet!]!
Example
Query
query getWalletsForOwner(
$ownerId: String!,
$swarmioCurrencyId: String
) {
getWalletsForOwner(
ownerId: $ownerId,
swarmioCurrencyId: $swarmioCurrencyId
) {
balance
boughtTransactions {
...PaginatedBoughtTransactionFragment
}
cashOutTransactions {
...PaginatedCashOutTransactionFragment
}
created
exchangedTransactions {
...PaginatedExchangedTransactionFragment
}
freebieTransactions {
...PaginatedFreebieTransactionFragment
}
id
ownerId
swarmioCurrency {
...SwarmioCurrencyFragment
}
swarmioCurrencyId
transactions {
...PaginatedSwarmioWalletTransactionWithMetadataFragment
}
transferTransactions {
...PaginatedTransferTransactionFragment
}
}
}
Variables
{
"ownerId": "abc123",
"swarmioCurrencyId": "abc123"
}
Response
{
"data": {
"getWalletsForOwner": [
{
"balance": 123.45,
"boughtTransactions": PaginatedBoughtTransaction,
"cashOutTransactions": PaginatedCashOutTransaction,
"created": "2007-12-03",
"exchangedTransactions": PaginatedExchangedTransaction,
"freebieTransactions": PaginatedFreebieTransaction,
"id": "xyz789",
"ownerId": "xyz789",
"swarmioCurrency": SwarmioCurrency,
"swarmioCurrencyId": "xyz789",
"transactions": PaginatedSwarmioWalletTransactionWithMetadata,
"transferTransactions": PaginatedTransferTransaction
}
]
}
}
globalPoints
Example
Query
query globalPoints($globalPointsId: ID!) {
globalPoints(globalPointsId: $globalPointsId) {
archive {
...PointsArchiveFragment
}
createdDate
defaultValue
id
modifiedDate
overriddenValue
partner {
...PartnerFragment
}
supplier {
...SupplierFragment
}
}
}
Variables
{"globalPointsId": "4"}
Response
{
"data": {
"globalPoints": {
"archive": [PointsArchive],
"createdDate": "xyz789",
"defaultValue": 123.45,
"id": 4,
"modifiedDate": "xyz789",
"overriddenValue": 987.65,
"partner": Partner,
"supplier": Supplier
}
}
}
globalPointsList
Response
Returns
[Points]
Example
Query
query globalPointsList {
globalPointsList {
archive {
...PointsArchiveFragment
}
createdDate
defaultValue
id
modifiedDate
overriddenValue
partner {
...PartnerFragment
}
supplier {
...SupplierFragment
}
}
}
Response
{
"data": {
"globalPointsList": [
{
"archive": [PointsArchive],
"createdDate": "abc123",
"defaultValue": 987.65,
"id": "4",
"modifiedDate": "xyz789",
"overriddenValue": 987.65,
"partner": Partner,
"supplier": Supplier
}
]
}
}
groupTrait
Description
Returns a GroupTrait with specific id.
Response
Returns a
GroupTrait
Arguments
| Name | Description |
|---|---|
id -
String!
|
Example
Query
query groupTrait($id: String!) {
groupTrait(id: $id) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
name
ownerId
publicURL
socialLinks {
...SocialLinkFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"groupTrait": {
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "abc123",
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"name": "xyz789",
"ownerId": "xyz789",
"publicURL": "xyz789",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
groupTraitNameIsUnique
Description
Returns whether or not the given GroupTrait name is unique
groupTraits
Description
GroupTrait data
Response
Returns
[GroupTrait!]!
Arguments
| Name | Description |
|---|---|
ids -
[String!]!
|
Example
Query
query groupTraits($ids: [String!]!) {
groupTraits(ids: $ids) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
name
ownerId
publicURL
socialLinks {
...SocialLinkFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"ids": ["xyz789"]}
Response
{
"data": {
"groupTraits": [
{
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "abc123",
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"name": "abc123",
"ownerId": "xyz789",
"publicURL": "xyz789",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
]
}
}
item
Example
Query
query item($itemId: ID!) {
item(itemId: $itemId) {
createdBy
createdDate
currencyConversionRate
deliveryMethod
id
isActive
isDeleted
isStockAvailable
itemCatalogCategory {
...ItemCatalogCategoryFragment
}
itemDescBrief
itemDescDetail
itemGalleryUrls
itemId
itemImageUrl
itemName
itemPartnerPoints {
...ItemPointsFragment
}
itemStatus
itemType
product {
...ProductFragment
}
supplier {
...SupplierFragment
}
unitPrice
}
}
Variables
{"itemId": 4}
Response
{
"data": {
"item": {
"createdBy": 123,
"createdDate": "xyz789",
"currencyConversionRate": 987.65,
"deliveryMethod": "REDEEM",
"id": 4,
"isActive": true,
"isDeleted": false,
"isStockAvailable": false,
"itemCatalogCategory": [ItemCatalogCategory],
"itemDescBrief": "abc123",
"itemDescDetail": "abc123",
"itemGalleryUrls": ["xyz789"],
"itemId": "abc123",
"itemImageUrl": "xyz789",
"itemName": "xyz789",
"itemPartnerPoints": [ItemPoints],
"itemStatus": "DELETED",
"itemType": "PHYSICAL",
"product": Product,
"supplier": Supplier,
"unitPrice": 123.45
}
}
}
itemSearchSuggestions
items
Response
Returns a
PaginatedItems
Example
Query
query items(
$filter: ItemFilterInput,
$limit: Int!,
$offset: Int!,
$order: SortOrder,
$searchText: String,
$sort: String
) {
items(
filter: $filter,
limit: $limit,
offset: $offset,
order: $order,
searchText: $searchText,
sort: $sort
) {
currentPage
items {
...ItemFragment
}
totalDeletedItems
totalItems
totalPages
totalPublishedItems
totalUnpublishedItems
}
}
Variables
{
"filter": ItemFilterInput,
"limit": 50,
"offset": 0,
"order": "Ascending",
"searchText": "xyz789",
"sort": "xyz789"
}
Response
{
"data": {
"items": {
"currentPage": 987,
"items": [Item],
"totalDeletedItems": 123,
"totalItems": 123,
"totalPages": 987,
"totalPublishedItems": 987,
"totalUnpublishedItems": 987
}
}
}
manuallyVerifiedResultsForCompetitionId
Response
Returns
[ManuallyVerifiedResult!]!
Arguments
| Name | Description |
|---|---|
competitionId -
String!
|
The ID of a competition |
Example
Query
query manuallyVerifiedResultsForCompetitionId($competitionId: String!) {
manuallyVerifiedResultsForCompetitionId(competitionId: $competitionId) {
competitionId
created
id
participantId
plzDelete
roundId
unverifiedResult {
...ResultFragment
}
}
}
Variables
{"competitionId": "abc123"}
Response
{
"data": {
"manuallyVerifiedResultsForCompetitionId": [
{
"competitionId": "abc123",
"created": "2007-12-03",
"id": "abc123",
"participantId": "abc123",
"plzDelete": false,
"roundId": "abc123",
"unverifiedResult": Result
}
]
}
}
manuallyVerifiedResultsForRoundId
Response
Returns
[ManuallyVerifiedResult!]!
Arguments
| Name | Description |
|---|---|
roundId -
String!
|
The round ID within a competition |
Example
Query
query manuallyVerifiedResultsForRoundId($roundId: String!) {
manuallyVerifiedResultsForRoundId(roundId: $roundId) {
competitionId
created
id
participantId
plzDelete
roundId
unverifiedResult {
...ResultFragment
}
}
}
Variables
{"roundId": "abc123"}
Response
{
"data": {
"manuallyVerifiedResultsForRoundId": [
{
"competitionId": "abc123",
"created": "2007-12-03",
"id": "xyz789",
"participantId": "abc123",
"plzDelete": true,
"roundId": "xyz789",
"unverifiedResult": Result
}
]
}
}
manuallyVerifiedResultsForRoundIdAndParticipantId
Response
Returns
[ManuallyVerifiedResult!]!
Example
Query
query manuallyVerifiedResultsForRoundIdAndParticipantId(
$participantId: String!,
$roundId: String!
) {
manuallyVerifiedResultsForRoundIdAndParticipantId(
participantId: $participantId,
roundId: $roundId
) {
competitionId
created
id
participantId
plzDelete
roundId
unverifiedResult {
...ResultFragment
}
}
}
Variables
{
"participantId": "abc123",
"roundId": "abc123"
}
Response
{
"data": {
"manuallyVerifiedResultsForRoundIdAndParticipantId": [
{
"competitionId": "xyz789",
"created": "2007-12-03",
"id": "xyz789",
"participantId": "abc123",
"plzDelete": false,
"roundId": "xyz789",
"unverifiedResult": Result
}
]
}
}
me
Response
Returns an
Account!
Example
Query
query me {
me {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Response
{
"data": {
"me": {
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "xyz789",
"isSupplier": true,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
order
Example
Query
query order($orderId: ID!) {
order(orderId: $orderId) {
billingAddress
cancellationNote
createdBy
createdDate
formattedItemId
gamerEmail
gamerId
gamerName
id
isActive
item {
...ItemFragment
}
itemName
modifiedBy
modifiedDate
orderDate
orderId
orderStatus
orderTransaction {
...OrderTransactionFragment
}
partner {
...PartnerFragment
}
payment {
...PaymentFragment
}
pointsValue
quantity
shipment {
...ShipmentFragment
}
totalPoints
transactionId
vouchers {
...ProductVoucherFragment
}
}
}
Variables
{"orderId": 4}
Response
{
"data": {
"order": {
"billingAddress": "abc123",
"cancellationNote": "xyz789",
"createdBy": 987,
"createdDate": "xyz789",
"formattedItemId": "abc123",
"gamerEmail": "abc123",
"gamerId": "xyz789",
"gamerName": "xyz789",
"id": "4",
"isActive": true,
"item": Item,
"itemName": "abc123",
"modifiedBy": 123,
"modifiedDate": "abc123",
"orderDate": "xyz789",
"orderId": "abc123",
"orderStatus": "CANCELLED",
"orderTransaction": OrderTransaction,
"partner": Partner,
"payment": Payment,
"pointsValue": 987.65,
"quantity": 123,
"shipment": Shipment,
"totalPoints": 123.45,
"transactionId": "abc123",
"vouchers": [ProductVoucher]
}
}
}
orderByTransactionId
Example
Query
query orderByTransactionId($transactionId: ID!) {
orderByTransactionId(transactionId: $transactionId) {
billingAddress
cancellationNote
createdBy
createdDate
formattedItemId
gamerEmail
gamerId
gamerName
id
isActive
item {
...ItemFragment
}
itemName
modifiedBy
modifiedDate
orderDate
orderId
orderStatus
orderTransaction {
...OrderTransactionFragment
}
partner {
...PartnerFragment
}
payment {
...PaymentFragment
}
pointsValue
quantity
shipment {
...ShipmentFragment
}
totalPoints
transactionId
vouchers {
...ProductVoucherFragment
}
}
}
Variables
{"transactionId": 4}
Response
{
"data": {
"orderByTransactionId": {
"billingAddress": "xyz789",
"cancellationNote": "xyz789",
"createdBy": 987,
"createdDate": "abc123",
"formattedItemId": "abc123",
"gamerEmail": "abc123",
"gamerId": "abc123",
"gamerName": "xyz789",
"id": 4,
"isActive": true,
"item": Item,
"itemName": "abc123",
"modifiedBy": 123,
"modifiedDate": "xyz789",
"orderDate": "abc123",
"orderId": "abc123",
"orderStatus": "CANCELLED",
"orderTransaction": OrderTransaction,
"partner": Partner,
"payment": Payment,
"pointsValue": 123.45,
"quantity": 987,
"shipment": Shipment,
"totalPoints": 123.45,
"transactionId": "xyz789",
"vouchers": [ProductVoucher]
}
}
}
orderSearchSuggestions
orders
Response
Returns a
PaginatedOrder
Example
Query
query orders(
$filter: OrderFilterInput,
$limit: Int!,
$offset: Int!,
$order: SortOrder,
$searchText: String,
$sort: String
) {
orders(
filter: $filter,
limit: $limit,
offset: $offset,
order: $order,
searchText: $searchText,
sort: $sort
) {
currentPage
orders {
...OrderFragment
}
totalCancelledOrders
totalCompletedOrders
totalDeletedOrders
totalOrders
totalPages
totalProcessingOrders
totalRefundedOrders
}
}
Variables
{
"filter": OrderFilterInput,
"limit": 50,
"offset": 0,
"order": "Ascending",
"searchText": "xyz789",
"sort": "xyz789"
}
Response
{
"data": {
"orders": {
"currentPage": 123,
"orders": [Order],
"totalCancelledOrders": 987,
"totalCompletedOrders": 123,
"totalDeletedOrders": 987,
"totalOrders": 987,
"totalPages": 987,
"totalProcessingOrders": 987,
"totalRefundedOrders": 987
}
}
}
ordersByGamer
Response
Returns a
PaginatedOrder
Example
Query
query ordersByGamer(
$gamerEmail: ID,
$gamerId: ID,
$limit: Int!,
$offset: Int!,
$order: SortOrder,
$sort: String
) {
ordersByGamer(
gamerEmail: $gamerEmail,
gamerId: $gamerId,
limit: $limit,
offset: $offset,
order: $order,
sort: $sort
) {
currentPage
orders {
...OrderFragment
}
totalCancelledOrders
totalCompletedOrders
totalDeletedOrders
totalOrders
totalPages
totalProcessingOrders
totalRefundedOrders
}
}
Variables
{
"gamerEmail": "4",
"gamerId": "4",
"limit": 50,
"offset": 0,
"order": "Ascending",
"sort": "abc123"
}
Response
{
"data": {
"ordersByGamer": {
"currentPage": 987,
"orders": [Order],
"totalCancelledOrders": 987,
"totalCompletedOrders": 123,
"totalDeletedOrders": 987,
"totalOrders": 987,
"totalPages": 123,
"totalProcessingOrders": 123,
"totalRefundedOrders": 123
}
}
}
prize
Description
Premade prize package
Example
Query
query prize($prizeId: String!) {
prize(prizeId: $prizeId) {
id
prizeTiers {
...PrizeTierFragment
}
}
}
Variables
{"prizeId": "xyz789"}
Response
{
"data": {
"prize": {
"id": "abc123",
"prizeTiers": [PrizeTier]
}
}
}
prizes
Description
Premade prize packages
Response
Returns
[PrizeList!]!
Example
Query
query prizes {
prizes {
id
prizeTiers {
...PrizeTierFragment
}
}
}
Response
{
"data": {
"prizes": [
{
"id": "xyz789",
"prizeTiers": [PrizeTier]
}
]
}
}
product
Example
Query
query product($productId: ID!) {
product(productId: $productId) {
availableStock
createdDate
currency
currencySymbol
id
item {
...ItemFragment
}
manufacturerBrandId
manufacturerBrandName
manufacturerBrandProductFields
manufacturerBrandProductFormatDesc
manufacturerBrandProductFormatId
manufacturerId
manufacturerName
modifiedDate
productId
productImageUrl
productName
productRedemptionInstructions
productVouchers {
...ProductVoucherFragment
}
productVvssku
purchaseNote
sellPrice
totalStock
unitPrice
voucherInventories {
...VoucherInventoryFragment
}
}
}
Variables
{"productId": "4"}
Response
{
"data": {
"product": {
"availableStock": 123,
"createdDate": "abc123",
"currency": "abc123",
"currencySymbol": "xyz789",
"id": 4,
"item": Item,
"manufacturerBrandId": 987,
"manufacturerBrandName": "xyz789",
"manufacturerBrandProductFields": "abc123",
"manufacturerBrandProductFormatDesc": "abc123",
"manufacturerBrandProductFormatId": 123,
"manufacturerId": "4",
"manufacturerName": "xyz789",
"modifiedDate": "abc123",
"productId": 4,
"productImageUrl": "xyz789",
"productName": "xyz789",
"productRedemptionInstructions": "xyz789",
"productVouchers": [ProductVoucher],
"productVvssku": "abc123",
"purchaseNote": "abc123",
"sellPrice": 123.45,
"totalStock": 123,
"unitPrice": 123.45,
"voucherInventories": [VoucherInventory]
}
}
}
products
Response
Returns
[Product]
Example
Query
query products {
products {
availableStock
createdDate
currency
currencySymbol
id
item {
...ItemFragment
}
manufacturerBrandId
manufacturerBrandName
manufacturerBrandProductFields
manufacturerBrandProductFormatDesc
manufacturerBrandProductFormatId
manufacturerId
manufacturerName
modifiedDate
productId
productImageUrl
productName
productRedemptionInstructions
productVouchers {
...ProductVoucherFragment
}
productVvssku
purchaseNote
sellPrice
totalStock
unitPrice
voucherInventories {
...VoucherInventoryFragment
}
}
}
Response
{
"data": {
"products": [
{
"availableStock": 123,
"createdDate": "abc123",
"currency": "abc123",
"currencySymbol": "abc123",
"id": 4,
"item": Item,
"manufacturerBrandId": 987,
"manufacturerBrandName": "xyz789",
"manufacturerBrandProductFields": "abc123",
"manufacturerBrandProductFormatDesc": "xyz789",
"manufacturerBrandProductFormatId": 987,
"manufacturerId": 4,
"manufacturerName": "xyz789",
"modifiedDate": "abc123",
"productId": "4",
"productImageUrl": "xyz789",
"productName": "xyz789",
"productRedemptionInstructions": "xyz789",
"productVouchers": [ProductVoucher],
"productVvssku": "abc123",
"purchaseNote": "abc123",
"sellPrice": 987.65,
"totalStock": 123,
"unitPrice": 123.45,
"voucherInventories": [VoucherInventory]
}
]
}
}
productsBySupplier
Response
Returns a
PaginatedProducts
Example
Query
query productsBySupplier(
$filter: ProductsFilterInput,
$limit: Int!,
$offset: Int!,
$order: SortOrder,
$searchText: String,
$sort: String,
$supplierId: ID!
) {
productsBySupplier(
filter: $filter,
limit: $limit,
offset: $offset,
order: $order,
searchText: $searchText,
sort: $sort,
supplierId: $supplierId
) {
currentPage
products {
...ProductFragment
}
totalPages
totalProducts
}
}
Variables
{
"filter": ProductsFilterInput,
"limit": 50,
"offset": 0,
"order": "Ascending",
"searchText": "abc123",
"sort": "abc123",
"supplierId": "4"
}
Response
{
"data": {
"productsBySupplier": {
"currentPage": 987,
"products": [Product],
"totalPages": 123,
"totalProducts": 987
}
}
}
purchaseTransaction
Description
Get a purchase transaction by id
Response
Returns an
OutOfContextPurchaseTransaction
Arguments
| Name | Description |
|---|---|
transactionId -
String!
|
Example
Query
query purchaseTransaction($transactionId: String!) {
purchaseTransaction(transactionId: $transactionId) {
account {
...AccountFragment
}
accountId
created
order {
...RootCode_OrderFragment
}
purchaseTransactionId
status
}
}
Variables
{"transactionId": "abc123"}
Response
{
"data": {
"purchaseTransaction": {
"account": Account,
"accountId": "xyz789",
"created": "2007-12-03",
"order": RootCode_Order,
"purchaseTransactionId": "abc123",
"status": "Error"
}
}
}
purchaseTransactions
Description
Get a list purchase transactions
Response
Arguments
| Name | Description |
|---|---|
transactionStatus -
PurchaseTransactionStatus
|
Example
Query
query purchaseTransactions($transactionStatus: PurchaseTransactionStatus) {
purchaseTransactions(transactionStatus: $transactionStatus) {
account {
...AccountFragment
}
accountId
created
order {
...RootCode_OrderFragment
}
purchaseTransactionId
status
}
}
Variables
{"transactionStatus": "Error"}
Response
{
"data": {
"purchaseTransactions": [
{
"account": Account,
"accountId": "xyz789",
"created": "2007-12-03",
"order": RootCode_Order,
"purchaseTransactionId": "abc123",
"status": "Error"
}
]
}
}
server
Description
Get Server by Id
Example
Query
query server($serverId: String!) {
server(serverId: $serverId) {
id
ip
maxNumberOfPlayers
port
rconPassword
region
serverType
status
timeAcquired
timeDestroyed
timeRequested
}
}
Variables
{"serverId": "abc123"}
Response
{
"data": {
"server": {
"id": "xyz789",
"ip": "xyz789",
"maxNumberOfPlayers": 123,
"port": 123,
"rconPassword": "xyz789",
"region": "xyz789",
"serverType": "abc123",
"status": "Creating",
"timeAcquired": "2007-12-03",
"timeDestroyed": "2007-12-03",
"timeRequested": "2007-12-03"
}
}
}
supplier
Example
Query
query supplier($supplierId: ID!) {
supplier(supplierId: $supplierId) {
contact {
...ContactFragment
}
createdBy
createdDate
creditLimit
endpointUrl
id
isActive
isDeleted
products {
...ProductFragment
}
supplierId
supplierName
}
}
Variables
{"supplierId": "4"}
Response
{
"data": {
"supplier": {
"contact": Contact,
"createdBy": 987,
"createdDate": "xyz789",
"creditLimit": "abc123",
"endpointUrl": "abc123",
"id": 4,
"isActive": false,
"isDeleted": false,
"products": [Product],
"supplierId": "abc123",
"supplierName": "abc123"
}
}
}
suppliers
Response
Returns
[Supplier]
Example
Query
query suppliers {
suppliers {
contact {
...ContactFragment
}
createdBy
createdDate
creditLimit
endpointUrl
id
isActive
isDeleted
products {
...ProductFragment
}
supplierId
supplierName
}
}
Response
{
"data": {
"suppliers": [
{
"contact": Contact,
"createdBy": 987,
"createdDate": "abc123",
"creditLimit": "xyz789",
"endpointUrl": "abc123",
"id": "4",
"isActive": false,
"isDeleted": true,
"products": [Product],
"supplierId": "xyz789",
"supplierName": "abc123"
}
]
}
}
user
Description
Returns a user with specific id.
Example
Query
query user($id: String!) {
user(id: $id) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
socialLinks {
...SocialLinkFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"user": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "xyz789",
"displayName": "abc123",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": false,
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": true,
"publicURL": "abc123",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"userType": "abc123",
"wallets": [SwarmioWallet]
}
}
}
userByDisplayName
Description
Returns a user with the specific displayName
Example
Query
query userByDisplayName($displayName: String!) {
userByDisplayName(displayName: $displayName) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
socialLinks {
...SocialLinkFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"displayName": "abc123"}
Response
{
"data": {
"userByDisplayName": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "abc123",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": false,
"id": "abc123",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "xyz789",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"userType": "abc123",
"wallets": [SwarmioWallet]
}
}
}
userByEmail
Description
Returns a user with the specific email
Example
Query
query userByEmail($email: String!) {
userByEmail(email: $email) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
socialLinks {
...SocialLinkFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"email": "abc123"}
Response
{
"data": {
"userByEmail": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "abc123",
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "xyz789",
"displayName": "abc123",
"email": StringAttributeWithPossibleError,
"emailVerified": false,
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": true,
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "abc123",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"userType": "xyz789",
"wallets": [SwarmioWallet]
}
}
}
userSuggestions
Description
Returns a list of account projections that match the given display name prefix
Response
Returns
[AccountProjection!]!
Arguments
| Name | Description |
|---|---|
displayNamePrefix -
String!
|
Example
Query
query userSuggestions($displayNamePrefix: String!) {
userSuggestions(displayNamePrefix: $displayNamePrefix) {
accountManagers {
...AccountManagerFragment
}
avatarURL
birthday {
...DateAttributeWithPossibleErrorFragment
}
created
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
linkedAccounts {
...IdentityProviderWithPossibleErrorFragment
}
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
msisdn
publicURL
realName {
...StringAttributeWithPossibleErrorFragment
}
updated
userType
}
}
Variables
{"displayNamePrefix": "abc123"}
Response
{
"data": {
"userSuggestions": [
{
"accountManagers": [AccountManager],
"avatarURL": "abc123",
"birthday": DateAttributeWithPossibleError,
"created": "2007-12-03",
"displayName": "abc123",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "abc123",
"linkedAccounts": [
IdentityProviderWithPossibleError
],
"managedAccounts": [
ManagedAccountWithPossibleError
],
"msisdn": "xyz789",
"publicURL": "abc123",
"realName": StringAttributeWithPossibleError,
"updated": "2007-12-03",
"userType": "xyz789"
}
]
}
}
users
Description
User data
Response
Returns
[User!]!
Arguments
| Name | Description |
|---|---|
ids -
[String!]!
|
Example
Query
query users($ids: [String!]!) {
users(ids: $ids) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
socialLinks {
...SocialLinkFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"ids": ["xyz789"]}
Response
{
"data": {
"users": [
{
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "abc123",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": false,
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": false,
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": true,
"publicURL": "abc123",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"userType": "abc123",
"wallets": [SwarmioWallet]
}
]
}
}
validateSLTAccount
Description
Validate an SLT partner account request without actually adding it to an account
Response
Returns a
Boolean!
Arguments
| Name | Description |
|---|---|
accountId -
String!
|
|
sltAccountCreationRequest -
SLTAccountCreationRequest!
|
A request to add an SLT partner account |
Example
Query
query validateSLTAccount(
$accountId: String!,
$sltAccountCreationRequest: SLTAccountCreationRequest!
) {
validateSLTAccount(
accountId: $accountId,
sltAccountCreationRequest: $sltAccountCreationRequest
)
}
Variables
{
"accountId": "xyz789",
"sltAccountCreationRequest": SLTAccountCreationRequest
}
Response
{"data": {"validateSLTAccount": false}}
voucherCodesBySupplier
Response
Returns a
PaginatedVouchers
Example
Query
query voucherCodesBySupplier(
$filter: VoucherFilterInput,
$limit: Int!,
$offset: Int!,
$order: SortOrder,
$searchText: String,
$sort: String,
$supplierId: ID!
) {
voucherCodesBySupplier(
filter: $filter,
limit: $limit,
offset: $offset,
order: $order,
searchText: $searchText,
sort: $sort,
supplierId: $supplierId
) {
currentPage
totalPages
totalVouchers
vouchers {
...ProductVoucherFragment
}
}
}
Variables
{
"filter": VoucherFilterInput,
"limit": 50,
"offset": 0,
"order": "Ascending",
"searchText": "abc123",
"sort": "abc123",
"supplierId": "4"
}
Response
{
"data": {
"voucherCodesBySupplier": {
"currentPage": 987,
"totalPages": 123,
"totalVouchers": 987,
"vouchers": [ProductVoucher]
}
}
}
Mutations
acceptAllGroupInvitations
Description
Accept the Group Invitation Where the group id exists, and if not included accepts all invitations for this account.
Example
Query
mutation acceptAllGroupInvitations($accountId: String!) {
acceptAllGroupInvitations(accountId: $accountId) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"accountId": "xyz789"}
Response
{
"data": {
"acceptAllGroupInvitations": {
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "xyz789",
"isSupplier": true,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
acceptGroupInvitation
Description
Accept the Group Invitation Where the group id exists, and if not included accepts all invitations for this account.
Example
Query
mutation acceptGroupInvitation(
$accountId: String!,
$groupId: String!
) {
acceptGroupInvitation(
accountId: $accountId,
groupId: $groupId
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"accountId": "xyz789",
"groupId": "xyz789"
}
Response
{
"data": {
"acceptGroupInvitation": {
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "abc123",
"isSupplier": false,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
addAutomaticallyVerifiedResultForRoundId
Description
Update the result for a participant in a given match
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
accountId -
String!
|
The account ID from the user service |
automaticallyVerifiedResultsForRoundFromParticipant -
AutomaticallyVerifiedResultsForRoundFromParticipantInput!
|
Example
Query
mutation addAutomaticallyVerifiedResultForRoundId(
$accountId: String!,
$automaticallyVerifiedResultsForRoundFromParticipant: AutomaticallyVerifiedResultsForRoundFromParticipantInput!
) {
addAutomaticallyVerifiedResultForRoundId(
accountId: $accountId,
automaticallyVerifiedResultsForRoundFromParticipant: $automaticallyVerifiedResultsForRoundFromParticipant
)
}
Variables
{
"accountId": "xyz789",
"automaticallyVerifiedResultsForRoundFromParticipant": AutomaticallyVerifiedResultsForRoundFromParticipantInput
}
Response
{"data": {"addAutomaticallyVerifiedResultForRoundId": 123}}
addGameToGameAccount
Description
Link a manual game account
Response
Returns a
Person!
Example
Query
mutation addGameToGameAccount(
$gameAccountTypeId: String!,
$gameId: String!,
$personId: String!
) {
addGameToGameAccount(
gameAccountTypeId: $gameAccountTypeId,
gameId: $gameId,
personId: $personId
) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
birthday {
...DateAttributeWithPossibleErrorFragment
}
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
eventParticipations {
...EventFragment
}
gameAccounts {
...GameAccountFragment
}
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
isSupplier
isVIP
lastUpdated
linkedAccounts {
...IdentityProviderWithPossibleErrorFragment
}
managedAccounts {
...ManagedAccountFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
realName {
...StringAttributeWithPossibleErrorFragment
}
servers {
...ServerFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"gameAccountTypeId": "abc123",
"gameId": "abc123",
"personId": "xyz789"
}
Response
{
"data": {
"addGameToGameAccount": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "abc123",
"birthday": DateAttributeWithPossibleError,
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "xyz789",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": false,
"eventParticipations": [Event],
"gameAccounts": [GameAccount],
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": false,
"id": "xyz789",
"isSupplier": true,
"isVIP": false,
"lastUpdated": "2007-12-03T10:15:30Z",
"linkedAccounts": [
IdentityProviderWithPossibleError
],
"managedAccounts": [ManagedAccount],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"realName": StringAttributeWithPossibleError,
"servers": [Server],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"userType": "xyz789",
"wallets": [SwarmioWallet]
}
}
}
addMultiDimensionalBucketBasedResultForVerification
Description
Update the result for a participant in a given match
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
manuallyVerifiedResultWithMultiDimensionalBucketBasedResultRequest -
ManuallyVerifiedResultWithMultiDimensionalBucketBasedResultRequest!
|
Example
Query
mutation addMultiDimensionalBucketBasedResultForVerification($manuallyVerifiedResultWithMultiDimensionalBucketBasedResultRequest: ManuallyVerifiedResultWithMultiDimensionalBucketBasedResultRequest!) {
addMultiDimensionalBucketBasedResultForVerification(manuallyVerifiedResultWithMultiDimensionalBucketBasedResultRequest: $manuallyVerifiedResultWithMultiDimensionalBucketBasedResultRequest)
}
Variables
{
"manuallyVerifiedResultWithMultiDimensionalBucketBasedResultRequest": ManuallyVerifiedResultWithMultiDimensionalBucketBasedResultRequest
}
Response
{"data": {"addMultiDimensionalBucketBasedResultForVerification": 987}}
addPayPalAccount
Example
Query
mutation addPayPalAccount($accountId: String!) {
addPayPalAccount(accountId: $accountId) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"accountId": "abc123"}
Response
{
"data": {
"addPayPalAccount": {
"accountType": "xyz789",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "abc123",
"isSupplier": false,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
addSLTAccount
Description
Add a SubscriptionPartner to the given account ID
Response
Returns an
Account!
Arguments
| Name | Description |
|---|---|
accountId -
String!
|
|
sltAccountCreationRequest -
SLTAccountCreationRequest!
|
A request to add an SLT partner account |
Example
Query
mutation addSLTAccount(
$accountId: String!,
$sltAccountCreationRequest: SLTAccountCreationRequest!
) {
addSLTAccount(
accountId: $accountId,
sltAccountCreationRequest: $sltAccountCreationRequest
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"accountId": "abc123",
"sltAccountCreationRequest": SLTAccountCreationRequest
}
Response
{
"data": {
"addSLTAccount": {
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "abc123",
"isSupplier": true,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
addTeamParticipant
Description
Add TeamParticipant to Event
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
joinEventRequest -
JoinTeamEventRequest!
|
Example
Query
mutation addTeamParticipant($joinEventRequest: JoinTeamEventRequest!) {
addTeamParticipant(joinEventRequest: $joinEventRequest)
}
Variables
{"joinEventRequest": JoinTeamEventRequest}
Response
{"data": {"addTeamParticipant": 123}}
addTimweAccount
Response
Returns an
Account!
Arguments
| Name | Description |
|---|---|
accountId -
String!
|
|
timweAccountCreationRequest -
TIMWEAccountCreationRequest!
|
A request to add an TIMWE partner account |
Example
Query
mutation addTimweAccount(
$accountId: String!,
$timweAccountCreationRequest: TIMWEAccountCreationRequest!
) {
addTimweAccount(
accountId: $accountId,
timweAccountCreationRequest: $timweAccountCreationRequest
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"accountId": "xyz789",
"timweAccountCreationRequest": TIMWEAccountCreationRequest
}
Response
{
"data": {
"addTimweAccount": {
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "abc123",
"isSupplier": true,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
advancePhasedCompetition
Description
Advance competition if able
Response
Returns a
Competition!
Arguments
| Name | Description |
|---|---|
competitionId -
String!
|
The ID of a competition |
Example
Query
mutation advancePhasedCompetition($competitionId: String!) {
advancePhasedCompetition(competitionId: $competitionId) {
competitionState
competitionType
created
event {
...EventFragment
}
eventId
eventStageId
game {
...GameFragment
}
gameId
id
participantType
participants {
...CompetitionParticipantReferenceFragment
}
startTime
}
}
Variables
{"competitionId": "abc123"}
Response
{
"data": {
"advancePhasedCompetition": {
"competitionState": "ARCHIVED",
"competitionType": "CHALLENGE",
"created": "2007-12-03",
"event": Event,
"eventId": "xyz789",
"eventStageId": "abc123",
"game": Game,
"gameId": "xyz789",
"id": "xyz789",
"participantType": "IndividualParticipantType",
"participants": [CompetitionParticipantReference],
"startTime": "2007-12-03"
}
}
}
cancelEvents
Description
Cancel events
Response
Returns
[Event!]!
Arguments
| Name | Description |
|---|---|
eventIds -
[String!]!
|
The IDs of events |
Example
Query
mutation cancelEvents($eventIds: [String!]!) {
cancelEvents(eventIds: $eventIds) {
category
created
defaultLocale
description
eventCurrencyExchanges {
...EventCurrencyExchangesFragment
}
eventLimitations {
...EventLimitationsFragment
}
eventStages {
...EventStageFragment
}
eventState
eventTeam {
...EventTeamMemberFragment
}
eventTiming {
...EventTimingFragment
}
featured
game {
...GameFragment
}
gameAccountTypeIds
gameAccountTypes {
...GameAccountTypeFragment
}
gameId
id
isSimulated
localizedDescriptions {
...LocalizedOptionalStringFragment
}
localizedMediaContentDetails {
...LocalizedMediaContentDetailsFragment
}
localizedNames {
...LocalizedStringFragment
}
mediaContentDetails {
...MediaContentDetailsFragment
}
name
ownerId
participantCount
participantType
participants {
...ParticipantFragment
}
region
tags {
...TagFragment
}
unlisted
}
}
Variables
{"eventIds": ["xyz789"]}
Response
{
"data": {
"cancelEvents": [
{
"category": "Challenge",
"created": "2007-12-03",
"defaultLocale": "ar_BH",
"description": "xyz789",
"eventCurrencyExchanges": EventCurrencyExchanges,
"eventLimitations": EventLimitations,
"eventStages": [EventStage],
"eventState": "ARCHIVED",
"eventTeam": [EventTeamMember],
"eventTiming": EventTiming,
"featured": true,
"game": Game,
"gameAccountTypeIds": ["abc123"],
"gameAccountTypes": [GameAccountType],
"gameId": "abc123",
"id": "abc123",
"isSimulated": false,
"localizedDescriptions": [
LocalizedOptionalString
],
"localizedMediaContentDetails": [
LocalizedMediaContentDetails
],
"localizedNames": [LocalizedString],
"mediaContentDetails": MediaContentDetails,
"name": "xyz789",
"ownerId": "xyz789",
"participantCount": 987,
"participantType": "IndividualParticipantType",
"participants": [Participant],
"region": "APAC",
"tags": [Tag],
"unlisted": true
}
]
}
}
cancelPendingSubscription
Description
If a target explicit subscription is in the AwaitingPayment state, change it to Cancelled state
Response
Returns a
SwarmioSubscription!
Example
Query
mutation cancelPendingSubscription(
$accountId: String!,
$subscriptionId: String!
) {
cancelPendingSubscription(
accountId: $accountId,
subscriptionId: $subscriptionId
) {
expiry
id
isUsable
subscriptionImplementation
subscriptionState
subscriptionType {
...SubscriptionTypeFragment
}
subscriptionTypeId
}
}
Variables
{
"accountId": "abc123",
"subscriptionId": "abc123"
}
Response
{
"data": {
"cancelPendingSubscription": {
"expiry": "2007-12-03T10:15:30Z",
"id": "xyz789",
"isUsable": true,
"subscriptionImplementation": "ImplicitSubscriptionImplementation",
"subscriptionState": "Active",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "abc123"
}
}
}
cancelScheduledSubscription
Description
Attempt to cancel a scheduled payment setup for an explicit subscription package
Response
Returns a
SwarmioSubscription!
Example
Query
mutation cancelScheduledSubscription(
$accountId: String!,
$subscriptionTypeCostId: String!
) {
cancelScheduledSubscription(
accountId: $accountId,
subscriptionTypeCostId: $subscriptionTypeCostId
) {
expiry
id
isUsable
subscriptionImplementation
subscriptionState
subscriptionType {
...SubscriptionTypeFragment
}
subscriptionTypeId
}
}
Variables
{
"accountId": "abc123",
"subscriptionTypeCostId": "abc123"
}
Response
{
"data": {
"cancelScheduledSubscription": {
"expiry": "2007-12-03T10:15:30Z",
"id": "xyz789",
"isUsable": true,
"subscriptionImplementation": "ImplicitSubscriptionImplementation",
"subscriptionState": "Active",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "xyz789"
}
}
}
changeMatchStartTimes
Description
Update individual event
Response
Returns a
Competition!
Arguments
| Name | Description |
|---|---|
competitionId -
String!
|
The ID of a competition |
matchStartTimeChanges -
[MatchStartTimeChange!]!
|
Using the match ID, indicate a new start time |
Example
Query
mutation changeMatchStartTimes(
$competitionId: String!,
$matchStartTimeChanges: [MatchStartTimeChange!]!
) {
changeMatchStartTimes(
competitionId: $competitionId,
matchStartTimeChanges: $matchStartTimeChanges
) {
competitionState
competitionType
created
event {
...EventFragment
}
eventId
eventStageId
game {
...GameFragment
}
gameId
id
participantType
participants {
...CompetitionParticipantReferenceFragment
}
startTime
}
}
Variables
{
"competitionId": "abc123",
"matchStartTimeChanges": [MatchStartTimeChange]
}
Response
{
"data": {
"changeMatchStartTimes": {
"competitionState": "ARCHIVED",
"competitionType": "CHALLENGE",
"created": "2007-12-03",
"event": Event,
"eventId": "abc123",
"eventStageId": "xyz789",
"game": Game,
"gameId": "abc123",
"id": "xyz789",
"participantType": "IndividualParticipantType",
"participants": [CompetitionParticipantReference],
"startTime": "2007-12-03"
}
}
}
completeCompetition
Description
Complete competition if able
Response
Returns a
Competition!
Arguments
| Name | Description |
|---|---|
competitionId -
String!
|
The ID of a competition |
Example
Query
mutation completeCompetition($competitionId: String!) {
completeCompetition(competitionId: $competitionId) {
competitionState
competitionType
created
event {
...EventFragment
}
eventId
eventStageId
game {
...GameFragment
}
gameId
id
participantType
participants {
...CompetitionParticipantReferenceFragment
}
startTime
}
}
Variables
{"competitionId": "abc123"}
Response
{
"data": {
"completeCompetition": {
"competitionState": "ARCHIVED",
"competitionType": "CHALLENGE",
"created": "2007-12-03",
"event": Event,
"eventId": "xyz789",
"eventStageId": "xyz789",
"game": Game,
"gameId": "abc123",
"id": "abc123",
"participantType": "IndividualParticipantType",
"participants": [CompetitionParticipantReference],
"startTime": "2007-12-03"
}
}
}
completePayoutRequest
Response
Returns a
SwarmioCurrencyPayoutRequest!
Arguments
| Name | Description |
|---|---|
swarmioCurrencyPayoutRequestId -
String!
|
Example
Query
mutation completePayoutRequest($swarmioCurrencyPayoutRequestId: String!) {
completePayoutRequest(swarmioCurrencyPayoutRequestId: $swarmioCurrencyPayoutRequestId) {
completed
completedBy
dateCompleted
dateRequested
id
requesterId
swarmioCurrencyPayoutArchiveCost {
...SwarmioCurrencyPayoutCostArchiveFragment
}
swarmioCurrencyPayoutCostArchiveId
}
}
Variables
{"swarmioCurrencyPayoutRequestId": "abc123"}
Response
{
"data": {
"completePayoutRequest": {
"completed": true,
"completedBy": "xyz789",
"dateCompleted": "2007-12-03",
"dateRequested": "2007-12-03",
"id": "xyz789",
"requesterId": "abc123",
"swarmioCurrencyPayoutArchiveCost": SwarmioCurrencyPayoutCostArchive,
"swarmioCurrencyPayoutCostArchiveId": "abc123"
}
}
}
createEmbeddedGame
Response
Returns an
EmbeddedGame!
Arguments
| Name | Description |
|---|---|
embeddedGamesCreationRequest -
EmbeddedGamesCreationRequest!
|
Example
Query
mutation createEmbeddedGame($embeddedGamesCreationRequest: EmbeddedGamesCreationRequest!) {
createEmbeddedGame(embeddedGamesCreationRequest: $embeddedGamesCreationRequest) {
availability
desc
embeddedGameURL
id
thumbnailURL
title
}
}
Variables
{
"embeddedGamesCreationRequest": EmbeddedGamesCreationRequest
}
Response
{
"data": {
"createEmbeddedGame": {
"availability": "Free",
"desc": "xyz789",
"embeddedGameURL": "abc123",
"id": "xyz789",
"thumbnailURL": "abc123",
"title": "xyz789"
}
}
}
createExchangedTransaction
Response
Returns an
ExchangedTransaction!
Example
Query
mutation createExchangedTransaction(
$ownerId: String!,
$swarmioCurrencyExchangeBlockId: String!
) {
createExchangedTransaction(
ownerId: $ownerId,
swarmioCurrencyExchangeBlockId: $swarmioCurrencyExchangeBlockId
) {
amount
created
id
otherWallet {
...SwarmioWalletFragment
}
otherWalletId
swarmioCurrencyExchangeRateArchiveId
transactionType
wallet {
...SwarmioWalletFragment
}
walletId
}
}
Variables
{
"ownerId": "xyz789",
"swarmioCurrencyExchangeBlockId": "abc123"
}
Response
{
"data": {
"createExchangedTransaction": {
"amount": 987.65,
"created": "2007-12-03",
"id": "abc123",
"otherWallet": SwarmioWallet,
"otherWalletId": "abc123",
"swarmioCurrencyExchangeRateArchiveId": "xyz789",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "abc123"
}
}
}
createFreebieTransaction
Response
Returns a
FreebieTransaction!
Example
Query
mutation createFreebieTransaction(
$amount: Float!,
$notes: String,
$ownerId: String!,
$swarmioCurrencyId: String!
) {
createFreebieTransaction(
amount: $amount,
notes: $notes,
ownerId: $ownerId,
swarmioCurrencyId: $swarmioCurrencyId
) {
amount
approvedBy
created
id
notes
transactionType
wallet {
...SwarmioWalletFragment
}
walletId
}
}
Variables
{
"amount": 987.65,
"notes": "xyz789",
"ownerId": "abc123",
"swarmioCurrencyId": "abc123"
}
Response
{
"data": {
"createFreebieTransaction": {
"amount": 123.45,
"approvedBy": "xyz789",
"created": "2007-12-03",
"id": "abc123",
"notes": "abc123",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "xyz789"
}
}
}
createGroup
Response
Returns a
Group!
Arguments
| Name | Description |
|---|---|
createGroupRequest -
GroupCreationRequest!
|
Example
Query
mutation createGroup($createGroupRequest: GroupCreationRequest!) {
createGroup(createGroupRequest: $createGroupRequest) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
isSupplier
lastUpdated
managedAccounts {
...ManagedAccountFragment
}
name
ownerId
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"createGroupRequest": GroupCreationRequest}
Response
{
"data": {
"createGroup": {
"accountType": "xyz789",
"avatarURL": "xyz789",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "abc123",
"id": "xyz789",
"isSupplier": false,
"lastUpdated": "2007-12-03T10:15:30Z",
"managedAccounts": [ManagedAccount],
"name": "xyz789",
"ownerId": "abc123",
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
createNonIntegratedEventsGame
Response
Returns a
Game!
Arguments
| Name | Description |
|---|---|
nonIntegratedGameCreationRequest -
NonIntegratedGameCreationRequest!
|
Example
Query
mutation createNonIntegratedEventsGame($nonIntegratedGameCreationRequest: NonIntegratedGameCreationRequest!) {
createNonIntegratedEventsGame(nonIntegratedGameCreationRequest: $nonIntegratedGameCreationRequest) {
bufferTime
description
estimatedRoundLength
gameAccountTypeIds
gameAccountTypes {
...GameAccountTypeFragment
}
id
image
integrated
maxParticipantsPerRound
prettyName
supportedCompetitionFormats
supportedParticipantTypes
typicalPlacingStrategyForRounds
weight
}
}
Variables
{
"nonIntegratedGameCreationRequest": NonIntegratedGameCreationRequest
}
Response
{
"data": {
"createNonIntegratedEventsGame": {
"bufferTime": DurationInMilliseconds,
"description": "abc123",
"estimatedRoundLength": DurationInMilliseconds,
"gameAccountTypeIds": ["abc123"],
"gameAccountTypes": [GameAccountType],
"id": "abc123",
"image": "abc123",
"integrated": true,
"maxParticipantsPerRound": 987.65,
"prettyName": "abc123",
"supportedCompetitionFormats": ["Basic"],
"supportedParticipantTypes": ["IndividualParticipantType"],
"typicalPlacingStrategyForRounds": "HighestAverageScore",
"weight": 123.45
}
}
}
createNonIntegratedGameAccountType
Description
Creates a non-integrated Game Account Type(it assumes the user to add in the correct details)
Response
Returns a
GameAccountType!
Arguments
| Name | Description |
|---|---|
nonIntegratedGameAccountTypeCreationRequest -
NonIntegratedGameAccountTypeCreationRequest!
|
Example
Query
mutation createNonIntegratedGameAccountType($nonIntegratedGameAccountTypeCreationRequest: NonIntegratedGameAccountTypeCreationRequest!) {
createNonIntegratedGameAccountType(nonIntegratedGameAccountTypeCreationRequest: $nonIntegratedGameAccountTypeCreationRequest) {
accountIDLabel
accountNameLabel
games {
...GameFragment
}
iconUrl
id
imageUrl
implicitGameIds
integrated
prettyName
requiresExternalAccountId
requiresExternalAccountName
}
}
Variables
{
"nonIntegratedGameAccountTypeCreationRequest": NonIntegratedGameAccountTypeCreationRequest
}
Response
{
"data": {
"createNonIntegratedGameAccountType": {
"accountIDLabel": "abc123",
"accountNameLabel": "abc123",
"games": [Game],
"iconUrl": "abc123",
"id": "xyz789",
"imageUrl": "abc123",
"implicitGameIds": ["xyz789"],
"integrated": false,
"prettyName": "xyz789",
"requiresExternalAccountId": false,
"requiresExternalAccountName": false
}
}
}
createPrivateServer
Description
Create a new private server
Response
Returns a
PrivateGameServer!
Arguments
| Name | Description |
|---|---|
serverCreationRequest -
PrivateServerCreationRequest!
|
Example
Query
mutation createPrivateServer($serverCreationRequest: PrivateServerCreationRequest!) {
createPrivateServer(serverCreationRequest: $serverCreationRequest) {
autoKick
bots {
...BotsFragment
}
friendlyFire
gameId
gameMode
id
ip
maps
maxNumberOfPlayers
numberOfPlayers
ownerId
password
port
rconPassword
region
serverType
status
timeAcquired
timeDestroyed
timeRequested
}
}
Variables
{"serverCreationRequest": PrivateServerCreationRequest}
Response
{
"data": {
"createPrivateServer": {
"autoKick": true,
"bots": Bots,
"friendlyFire": true,
"gameId": "abc123",
"gameMode": "Casual",
"id": "xyz789",
"ip": "abc123",
"maps": ["xyz789"],
"maxNumberOfPlayers": 123,
"numberOfPlayers": 987,
"ownerId": "xyz789",
"password": "xyz789",
"port": 123,
"rconPassword": "abc123",
"region": "abc123",
"serverType": "xyz789",
"status": "Creating",
"timeAcquired": "2007-12-03",
"timeDestroyed": "2007-12-03",
"timeRequested": "2007-12-03"
}
}
}
createPrizeList
Description
Create a new prize list
Response
Returns a
PrizeList!
Arguments
| Name | Description |
|---|---|
prizeListCreationRequest -
PrizeListCreationRequest!
|
Example
Query
mutation createPrizeList($prizeListCreationRequest: PrizeListCreationRequest!) {
createPrizeList(prizeListCreationRequest: $prizeListCreationRequest) {
id
prizeTiers {
...PrizeTierFragment
}
}
}
Variables
{"prizeListCreationRequest": PrizeListCreationRequest}
Response
{
"data": {
"createPrizeList": {
"id": "abc123",
"prizeTiers": [PrizeTier]
}
}
}
createPublicServer
Description
Create a new public server
Response
Returns a
PublicGameServer!
Arguments
| Name | Description |
|---|---|
serverCreationRequest -
PublicServerCreationRequest!
|
Example
Query
mutation createPublicServer($serverCreationRequest: PublicServerCreationRequest!) {
createPublicServer(serverCreationRequest: $serverCreationRequest) {
connectString
description
featured
id
imageURL
ip
maxNumberOfPlayers
name
port
rconPassword
region
serverType
status
steamURL
timeAcquired
timeDestroyed
timeRequested
}
}
Variables
{"serverCreationRequest": PublicServerCreationRequest}
Response
{
"data": {
"createPublicServer": {
"connectString": "abc123",
"description": "xyz789",
"featured": false,
"id": "xyz789",
"imageURL": "abc123",
"ip": "abc123",
"maxNumberOfPlayers": 987,
"name": "abc123",
"port": 987,
"rconPassword": "xyz789",
"region": "abc123",
"serverType": "abc123",
"status": "Creating",
"steamURL": "abc123",
"timeAcquired": "2007-12-03",
"timeDestroyed": "2007-12-03",
"timeRequested": "2007-12-03"
}
}
}
createSubscriptionType
Description
Create a new SubscriptionType
Response
Returns a
SubscriptionType!
Arguments
| Name | Description |
|---|---|
subscriptionTypeCreationRequest -
SubscriptionTypeCreationRequest!
|
Example
Query
mutation createSubscriptionType($subscriptionTypeCreationRequest: SubscriptionTypeCreationRequest!) {
createSubscriptionType(subscriptionTypeCreationRequest: $subscriptionTypeCreationRequest) {
conflictSubscriptionTypeIds
defaultLocale
description
enrollable
explicitEnrollment {
...ExplicitEnrollmentFragment
}
id
implicitEnrollments {
...ImplicitEnrollmentFragment
}
initialSwarmioCurrencyReward {
...SwarmioCurrencyRewardFragment
}
localizedDescriptions {
...LocalizedOptionalStringFragment
}
localizedNames {
...LocalizedStringFragment
}
name
recurringPayoutBonus {
...RecurringRewardFragment
}
weight
}
}
Variables
{
"subscriptionTypeCreationRequest": SubscriptionTypeCreationRequest
}
Response
{
"data": {
"createSubscriptionType": {
"conflictSubscriptionTypeIds": [
"xyz789"
],
"defaultLocale": "ar_BH",
"description": "xyz789",
"enrollable": false,
"explicitEnrollment": ExplicitEnrollment,
"id": "xyz789",
"implicitEnrollments": [ImplicitEnrollment],
"initialSwarmioCurrencyReward": SwarmioCurrencyReward,
"localizedDescriptions": [LocalizedOptionalString],
"localizedNames": [LocalizedString],
"name": "abc123",
"recurringPayoutBonus": RecurringReward,
"weight": 123.45
}
}
}
createSwarmioCurrencyExchangeBlock
Response
Returns a
SwarmioCurrencyExchangeBlock!
Example
Query
mutation createSwarmioCurrencyExchangeBlock(
$active: Boolean!,
$amount: Float!,
$forSwarmioCurrencyId: String!,
$maybeDescription: String,
$maybeName: String,
$thisSwarmioCurrencyId: String!
) {
createSwarmioCurrencyExchangeBlock(
active: $active,
amount: $amount,
forSwarmioCurrencyId: $forSwarmioCurrencyId,
maybeDescription: $maybeDescription,
maybeName: $maybeName,
thisSwarmioCurrencyId: $thisSwarmioCurrencyId
) {
active
created
description
forThisAmount
forThisSwarmioCurrency {
...SwarmioCurrencyFragment
}
forThisSwarmioCurrencyId
id
name
thisAmount
thisSwarmioCurrency {
...SwarmioCurrencyFragment
}
thisSwarmioCurrencyId
}
}
Variables
{
"active": true,
"amount": 987.65,
"forSwarmioCurrencyId": "abc123",
"maybeDescription": "abc123",
"maybeName": "abc123",
"thisSwarmioCurrencyId": "abc123"
}
Response
{
"data": {
"createSwarmioCurrencyExchangeBlock": {
"active": false,
"created": "2007-12-03",
"description": "xyz789",
"forThisAmount": 123.45,
"forThisSwarmioCurrency": SwarmioCurrency,
"forThisSwarmioCurrencyId": "abc123",
"id": "abc123",
"name": "xyz789",
"thisAmount": 123.45,
"thisSwarmioCurrency": SwarmioCurrency,
"thisSwarmioCurrencyId": "xyz789"
}
}
}
createSwarmioCurrencyItem
Response
Returns a
SwarmioCurrencyItem!
Arguments
| Name | Description |
|---|---|
amount -
Float!
|
|
dealTagline -
String
|
|
maybeName -
String
|
|
swarmioCurrencyId -
String!
|
|
swarmioCurrencyItemCostRequests -
[SwarmioCurrencyItemCostRequest!]!
|
Example
Query
mutation createSwarmioCurrencyItem(
$amount: Float!,
$dealTagline: String,
$maybeName: String,
$swarmioCurrencyId: String!,
$swarmioCurrencyItemCostRequests: [SwarmioCurrencyItemCostRequest!]!
) {
createSwarmioCurrencyItem(
amount: $amount,
dealTagline: $dealTagline,
maybeName: $maybeName,
swarmioCurrencyId: $swarmioCurrencyId,
swarmioCurrencyItemCostRequests: $swarmioCurrencyItemCostRequests
) {
active
amount
costs {
...CurrencyItemCostFragment
}
created
dealTagline
id
name
swarmioCurrency {
...SwarmioCurrencyFragment
}
swarmioCurrencyId
}
}
Variables
{
"amount": 987.65,
"dealTagline": "abc123",
"maybeName": "abc123",
"swarmioCurrencyId": "abc123",
"swarmioCurrencyItemCostRequests": [
SwarmioCurrencyItemCostRequest
]
}
Response
{
"data": {
"createSwarmioCurrencyItem": {
"active": true,
"amount": 987.65,
"costs": [CurrencyItemCost],
"created": "2007-12-03",
"dealTagline": "abc123",
"id": "abc123",
"name": "abc123",
"swarmioCurrency": SwarmioCurrency,
"swarmioCurrencyId": "xyz789"
}
}
}
createSwarmioCurrencyPayout
Response
Returns a
SwarmioCurrencyPayout!
Arguments
| Name | Description |
|---|---|
amount -
Float!
|
|
maybeName -
String
|
|
swarmioCurrencyId -
String!
|
|
swarmioCurrencyPayoutCostRequests -
[SwarmioCurrencyPayoutCostRequest!]!
|
Example
Query
mutation createSwarmioCurrencyPayout(
$amount: Float!,
$maybeName: String,
$swarmioCurrencyId: String!,
$swarmioCurrencyPayoutCostRequests: [SwarmioCurrencyPayoutCostRequest!]!
) {
createSwarmioCurrencyPayout(
amount: $amount,
maybeName: $maybeName,
swarmioCurrencyId: $swarmioCurrencyId,
swarmioCurrencyPayoutCostRequests: $swarmioCurrencyPayoutCostRequests
) {
active
amount
costs {
...SwarmioCurrencyPayoutCostFragment
}
created
id
name
swarmioCurrency {
...SwarmioCurrencyFragment
}
swarmioCurrencyId
}
}
Variables
{
"amount": 123.45,
"maybeName": "abc123",
"swarmioCurrencyId": "xyz789",
"swarmioCurrencyPayoutCostRequests": [
SwarmioCurrencyPayoutCostRequest
]
}
Response
{
"data": {
"createSwarmioCurrencyPayout": {
"active": false,
"amount": 987.65,
"costs": [SwarmioCurrencyPayoutCost],
"created": "2007-12-03",
"id": "abc123",
"name": "abc123",
"swarmioCurrency": SwarmioCurrency,
"swarmioCurrencyId": "abc123"
}
}
}
createTeam
Response
Returns a
Team!
Arguments
| Name | Description |
|---|---|
createTeamRequest -
TeamCreationRequest!
|
Example
Query
mutation createTeam($createTeamRequest: TeamCreationRequest!) {
createTeam(createTeamRequest: $createTeamRequest) {
accountType
avatarURL
bannerURL
created
description
eventParticipations {
...EventFragment
}
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
isSupplier
lastUpdated
managedAccounts {
...ManagedAccountFragment
}
name
ownerId
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"createTeamRequest": TeamCreationRequest}
Response
{
"data": {
"createTeam": {
"accountType": "xyz789",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"eventParticipations": [Event],
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "xyz789",
"id": "xyz789",
"isSupplier": false,
"lastUpdated": "2007-12-03T10:15:30Z",
"managedAccounts": [ManagedAccount],
"name": "xyz789",
"ownerId": "abc123",
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
createTeamEvent
Description
Create a new team event
Response
Returns an
Event!
Arguments
| Name | Description |
|---|---|
createEventRequest -
TeamEventCreationRequest!
|
Example
Query
mutation createTeamEvent($createEventRequest: TeamEventCreationRequest!) {
createTeamEvent(createEventRequest: $createEventRequest) {
category
created
defaultLocale
description
eventCurrencyExchanges {
...EventCurrencyExchangesFragment
}
eventLimitations {
...EventLimitationsFragment
}
eventStages {
...EventStageFragment
}
eventState
eventTeam {
...EventTeamMemberFragment
}
eventTiming {
...EventTimingFragment
}
featured
game {
...GameFragment
}
gameAccountTypeIds
gameAccountTypes {
...GameAccountTypeFragment
}
gameId
id
isSimulated
localizedDescriptions {
...LocalizedOptionalStringFragment
}
localizedMediaContentDetails {
...LocalizedMediaContentDetailsFragment
}
localizedNames {
...LocalizedStringFragment
}
mediaContentDetails {
...MediaContentDetailsFragment
}
name
ownerId
participantCount
participantType
participants {
...ParticipantFragment
}
region
tags {
...TagFragment
}
unlisted
}
}
Variables
{"createEventRequest": TeamEventCreationRequest}
Response
{
"data": {
"createTeamEvent": {
"category": "Challenge",
"created": "2007-12-03",
"defaultLocale": "ar_BH",
"description": "xyz789",
"eventCurrencyExchanges": EventCurrencyExchanges,
"eventLimitations": EventLimitations,
"eventStages": [EventStage],
"eventState": "ARCHIVED",
"eventTeam": [EventTeamMember],
"eventTiming": EventTiming,
"featured": false,
"game": Game,
"gameAccountTypeIds": ["xyz789"],
"gameAccountTypes": [GameAccountType],
"gameId": "xyz789",
"id": "xyz789",
"isSimulated": false,
"localizedDescriptions": [LocalizedOptionalString],
"localizedMediaContentDetails": [
LocalizedMediaContentDetails
],
"localizedNames": [LocalizedString],
"mediaContentDetails": MediaContentDetails,
"name": "xyz789",
"ownerId": "abc123",
"participantCount": 123,
"participantType": "IndividualParticipantType",
"participants": [Participant],
"region": "APAC",
"tags": [Tag],
"unlisted": true
}
}
}
createWallet
Response
Returns a
SwarmioWallet!
Example
Query
mutation createWallet(
$ownerId: String!,
$swarmioCurrencyId: String!
) {
createWallet(
ownerId: $ownerId,
swarmioCurrencyId: $swarmioCurrencyId
) {
balance
boughtTransactions {
...PaginatedBoughtTransactionFragment
}
cashOutTransactions {
...PaginatedCashOutTransactionFragment
}
created
exchangedTransactions {
...PaginatedExchangedTransactionFragment
}
freebieTransactions {
...PaginatedFreebieTransactionFragment
}
id
ownerId
swarmioCurrency {
...SwarmioCurrencyFragment
}
swarmioCurrencyId
transactions {
...PaginatedSwarmioWalletTransactionWithMetadataFragment
}
transferTransactions {
...PaginatedTransferTransactionFragment
}
}
}
Variables
{
"ownerId": "abc123",
"swarmioCurrencyId": "abc123"
}
Response
{
"data": {
"createWallet": {
"balance": 987.65,
"boughtTransactions": PaginatedBoughtTransaction,
"cashOutTransactions": PaginatedCashOutTransaction,
"created": "2007-12-03",
"exchangedTransactions": PaginatedExchangedTransaction,
"freebieTransactions": PaginatedFreebieTransaction,
"id": "abc123",
"ownerId": "xyz789",
"swarmioCurrency": SwarmioCurrency,
"swarmioCurrencyId": "xyz789",
"transactions": PaginatedSwarmioWalletTransactionWithMetadata,
"transferTransactions": PaginatedTransferTransaction
}
}
}
createWalletsForUser
Response
Returns
[SwarmioWallet!]!
Arguments
| Name | Description |
|---|---|
ownerId -
String!
|
|
swarmioCurrencyIds -
[String!]!
|
Example
Query
mutation createWalletsForUser(
$ownerId: String!,
$swarmioCurrencyIds: [String!]!
) {
createWalletsForUser(
ownerId: $ownerId,
swarmioCurrencyIds: $swarmioCurrencyIds
) {
balance
boughtTransactions {
...PaginatedBoughtTransactionFragment
}
cashOutTransactions {
...PaginatedCashOutTransactionFragment
}
created
exchangedTransactions {
...PaginatedExchangedTransactionFragment
}
freebieTransactions {
...PaginatedFreebieTransactionFragment
}
id
ownerId
swarmioCurrency {
...SwarmioCurrencyFragment
}
swarmioCurrencyId
transactions {
...PaginatedSwarmioWalletTransactionWithMetadataFragment
}
transferTransactions {
...PaginatedTransferTransactionFragment
}
}
}
Variables
{
"ownerId": "abc123",
"swarmioCurrencyIds": ["xyz789"]
}
Response
{
"data": {
"createWalletsForUser": [
{
"balance": 987.65,
"boughtTransactions": PaginatedBoughtTransaction,
"cashOutTransactions": PaginatedCashOutTransaction,
"created": "2007-12-03",
"exchangedTransactions": PaginatedExchangedTransaction,
"freebieTransactions": PaginatedFreebieTransaction,
"id": "abc123",
"ownerId": "xyz789",
"swarmioCurrency": SwarmioCurrency,
"swarmioCurrencyId": "xyz789",
"transactions": PaginatedSwarmioWalletTransactionWithMetadata,
"transferTransactions": PaginatedTransferTransaction
}
]
}
}
declineAllGroupInvitations
Description
Decline the Group Invitation Where the group id exists, and if not included declines all invitations for this account.
Example
Query
mutation declineAllGroupInvitations($accountId: String!) {
declineAllGroupInvitations(accountId: $accountId) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"accountId": "abc123"}
Response
{
"data": {
"declineAllGroupInvitations": {
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "xyz789",
"isSupplier": false,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
declineGroupInvitation
Description
Decline the Group Invitation Where the group id exists, and if not included declines all invitations for this account.
Example
Query
mutation declineGroupInvitation(
$accountId: String!,
$groupId: String!
) {
declineGroupInvitation(
accountId: $accountId,
groupId: $groupId
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"accountId": "abc123",
"groupId": "abc123"
}
Response
{
"data": {
"declineGroupInvitation": {
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "abc123",
"isSupplier": false,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
deleteEmbeddedGame
Description
Marking Embedded Game for deletion
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
embeddedGameIds -
[String!]!
|
The IDs of embedded games |
Example
Query
mutation deleteEmbeddedGame($embeddedGameIds: [String!]!) {
deleteEmbeddedGame(embeddedGameIds: $embeddedGameIds)
}
Variables
{"embeddedGameIds": ["abc123"]}
Response
{"data": {"deleteEmbeddedGame": 123}}
deleteGroupAvatar
Response
Returns a
GroupTrait!
Arguments
| Name | Description |
|---|---|
groupId -
String!
|
Example
Query
mutation deleteGroupAvatar($groupId: String!) {
deleteGroupAvatar(groupId: $groupId) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
name
ownerId
publicURL
socialLinks {
...SocialLinkFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"groupId": "xyz789"}
Response
{
"data": {
"deleteGroupAvatar": {
"accountType": "xyz789",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "xyz789",
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"name": "abc123",
"ownerId": "abc123",
"publicURL": "xyz789",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
deleteGroupBanner
Response
Returns a
GroupTrait!
Arguments
| Name | Description |
|---|---|
groupId -
String!
|
Example
Query
mutation deleteGroupBanner($groupId: String!) {
deleteGroupBanner(groupId: $groupId) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
name
ownerId
publicURL
socialLinks {
...SocialLinkFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"groupId": "xyz789"}
Response
{
"data": {
"deleteGroupBanner": {
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "abc123",
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"name": "xyz789",
"ownerId": "xyz789",
"publicURL": "abc123",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
deleteProductByID
Response
Returns a
ProductDelete
Arguments
| Name | Description |
|---|---|
productId -
ID!
|
Example
Query
mutation deleteProductByID($productId: ID!) {
deleteProductByID(productId: $productId) {
itemsUnpublishedTotal
voucherDeletedTotal
}
}
Variables
{"productId": "4"}
Response
{
"data": {
"deleteProductByID": {
"itemsUnpublishedTotal": 123,
"voucherDeletedTotal": 987
}
}
}
deleteProductsByFileId
Response
Returns a
ProductDelete
Arguments
| Name | Description |
|---|---|
fileId -
ID!
|
Example
Query
mutation deleteProductsByFileId($fileId: ID!) {
deleteProductsByFileId(fileId: $fileId) {
itemsUnpublishedTotal
voucherDeletedTotal
}
}
Variables
{"fileId": 4}
Response
{
"data": {
"deleteProductsByFileId": {
"itemsUnpublishedTotal": 123,
"voucherDeletedTotal": 123
}
}
}
deletePublicServer
Description
marking public server for deletion
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
serverIds -
[String!]!
|
The ID of a GameServer |
Example
Query
mutation deletePublicServer($serverIds: [String!]!) {
deletePublicServer(serverIds: $serverIds)
}
Variables
{"serverIds": ["xyz789"]}
Response
{"data": {"deletePublicServer": 987}}
deleteSupplier
deleteUserAvatar
Example
Query
mutation deleteUserAvatar($userId: String!) {
deleteUserAvatar(userId: $userId) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
socialLinks {
...SocialLinkFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"userId": "xyz789"}
Response
{
"data": {
"deleteUserAvatar": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "abc123",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": false,
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "xyz789",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"userType": "abc123",
"wallets": [SwarmioWallet]
}
}
}
deleteUserBanner
Example
Query
mutation deleteUserBanner($userId: String!) {
deleteUserBanner(userId: $userId) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
socialLinks {
...SocialLinkFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"userId": "xyz789"}
Response
{
"data": {
"deleteUserBanner": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "xyz789",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "xyz789",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": true,
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "abc123",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"userType": "abc123",
"wallets": [SwarmioWallet]
}
}
}
deleteVoucherByID
Response
Returns a
ProductVoucher
Arguments
| Name | Description |
|---|---|
voucherId -
ID!
|
Example
Query
mutation deleteVoucherByID($voucherId: ID!) {
deleteVoucherByID(voucherId: $voucherId) {
createdDate
id
status
voucherCode
voucherExpiry
voucherPin
voucherSerial
}
}
Variables
{"voucherId": 4}
Response
{
"data": {
"deleteVoucherByID": {
"createdDate": "xyz789",
"id": 4,
"status": "DELETED",
"voucherCode": "abc123",
"voucherExpiry": "xyz789",
"voucherPin": "abc123",
"voucherSerial": "abc123"
}
}
}
editSwarmioCurrencyItem
Response
Returns a
SwarmioCurrencyItem!
Example
Query
mutation editSwarmioCurrencyItem(
$dealTagline: String,
$maybeActive: Boolean,
$maybeAmount: Float,
$maybeName: String,
$swarmioCurrencyItemCostRequests: [SwarmioCurrencyItemCostRequest!]!,
$swarmioCurrencyItemId: String!
) {
editSwarmioCurrencyItem(
dealTagline: $dealTagline,
maybeActive: $maybeActive,
maybeAmount: $maybeAmount,
maybeName: $maybeName,
swarmioCurrencyItemCostRequests: $swarmioCurrencyItemCostRequests,
swarmioCurrencyItemId: $swarmioCurrencyItemId
) {
active
amount
costs {
...CurrencyItemCostFragment
}
created
dealTagline
id
name
swarmioCurrency {
...SwarmioCurrencyFragment
}
swarmioCurrencyId
}
}
Variables
{
"dealTagline": "xyz789",
"maybeActive": false,
"maybeAmount": 987.65,
"maybeName": "abc123",
"swarmioCurrencyItemCostRequests": [
SwarmioCurrencyItemCostRequest
],
"swarmioCurrencyItemId": "xyz789"
}
Response
{
"data": {
"editSwarmioCurrencyItem": {
"active": true,
"amount": 987.65,
"costs": [CurrencyItemCost],
"created": "2007-12-03",
"dealTagline": "xyz789",
"id": "abc123",
"name": "xyz789",
"swarmioCurrency": SwarmioCurrency,
"swarmioCurrencyId": "abc123"
}
}
}
enrollExplicitSubscription
Description
Create an explicit subscription for the target account, and create the session for explicit payment through the payment gateway (Swarmio Pay)
Response
Returns a
String!
Example
Query
mutation enrollExplicitSubscription(
$accountId: String!,
$subscriptionTypeCostId: String!
) {
enrollExplicitSubscription(
accountId: $accountId,
subscriptionTypeCostId: $subscriptionTypeCostId
)
}
Variables
{
"accountId": "xyz789",
"subscriptionTypeCostId": "abc123"
}
Response
{
"data": {
"enrollExplicitSubscription": "xyz789"
}
}
enrollExternalSubscriptionPackage
Description
Attempt to enroll an account in a target external (implicit) subscription package through the provider API
Response
Returns an
Account!
Example
Query
mutation enrollExternalSubscriptionPackage(
$accountId: String!,
$externalSubscriptionPackageId: String!
) {
enrollExternalSubscriptionPackage(
accountId: $accountId,
externalSubscriptionPackageId: $externalSubscriptionPackageId
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"accountId": "abc123",
"externalSubscriptionPackageId": "abc123"
}
Response
{
"data": {
"enrollExternalSubscriptionPackage": {
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "abc123",
"isSupplier": false,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
exchangeCustomSwarmioCurrencyAmount
Response
Returns an
ExchangedTransaction!
Example
Query
mutation exchangeCustomSwarmioCurrencyAmount(
$amount: Float!,
$fromSwarmioCurrencyId: String!,
$ownerId: String!,
$toSwarmioCurrencyId: String!
) {
exchangeCustomSwarmioCurrencyAmount(
amount: $amount,
fromSwarmioCurrencyId: $fromSwarmioCurrencyId,
ownerId: $ownerId,
toSwarmioCurrencyId: $toSwarmioCurrencyId
) {
amount
created
id
otherWallet {
...SwarmioWalletFragment
}
otherWalletId
swarmioCurrencyExchangeRateArchiveId
transactionType
wallet {
...SwarmioWalletFragment
}
walletId
}
}
Variables
{
"amount": 123.45,
"fromSwarmioCurrencyId": "abc123",
"ownerId": "xyz789",
"toSwarmioCurrencyId": "abc123"
}
Response
{
"data": {
"exchangeCustomSwarmioCurrencyAmount": {
"amount": 123.45,
"created": "2007-12-03",
"id": "abc123",
"otherWallet": SwarmioWallet,
"otherWalletId": "xyz789",
"swarmioCurrencyExchangeRateArchiveId": "xyz789",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "xyz789"
}
}
}
exchangeEntireSwarmioCurrencyWallet
Response
Returns an
ExchangedTransaction!
Example
Query
mutation exchangeEntireSwarmioCurrencyWallet(
$toSwarmioCurrencyId: String!,
$walletId: String!
) {
exchangeEntireSwarmioCurrencyWallet(
toSwarmioCurrencyId: $toSwarmioCurrencyId,
walletId: $walletId
) {
amount
created
id
otherWallet {
...SwarmioWalletFragment
}
otherWalletId
swarmioCurrencyExchangeRateArchiveId
transactionType
wallet {
...SwarmioWalletFragment
}
walletId
}
}
Variables
{
"toSwarmioCurrencyId": "abc123",
"walletId": "abc123"
}
Response
{
"data": {
"exchangeEntireSwarmioCurrencyWallet": {
"amount": 123.45,
"created": "2007-12-03",
"id": "abc123",
"otherWallet": SwarmioWallet,
"otherWalletId": "abc123",
"swarmioCurrencyExchangeRateArchiveId": "abc123",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "xyz789"
}
}
}
forceVerifyPersonEmail
Example
Query
mutation forceVerifyPersonEmail($email: String!) {
forceVerifyPersonEmail(email: $email) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
birthday {
...DateAttributeWithPossibleErrorFragment
}
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
eventParticipations {
...EventFragment
}
gameAccounts {
...GameAccountFragment
}
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
isSupplier
isVIP
lastUpdated
linkedAccounts {
...IdentityProviderWithPossibleErrorFragment
}
managedAccounts {
...ManagedAccountFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
realName {
...StringAttributeWithPossibleErrorFragment
}
servers {
...ServerFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"email": "abc123"}
Response
{
"data": {
"forceVerifyPersonEmail": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "xyz789",
"avatarURL": "xyz789",
"bannerURL": "xyz789",
"birthday": DateAttributeWithPossibleError,
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "abc123",
"displayName": "abc123",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"eventParticipations": [Event],
"gameAccounts": [GameAccount],
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": false,
"id": "abc123",
"isSupplier": false,
"isVIP": true,
"lastUpdated": "2007-12-03T10:15:30Z",
"linkedAccounts": [
IdentityProviderWithPossibleError
],
"managedAccounts": [ManagedAccount],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": true,
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"realName": StringAttributeWithPossibleError,
"servers": [Server],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"userType": "xyz789",
"wallets": [SwarmioWallet]
}
}
}
hardRefreshSubscriptionsForAccountId
Description
For a target account, refresh all of their attached implicit subscriptions from the subscriptionProvider
Example
Query
mutation hardRefreshSubscriptionsForAccountId($accountId: String!) {
hardRefreshSubscriptionsForAccountId(accountId: $accountId) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"accountId": "abc123"}
Response
{
"data": {
"hardRefreshSubscriptionsForAccountId": {
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "abc123",
"isSupplier": true,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
inviteToGroup
Description
Invite an Account as a regular group member
Response
Returns a
GroupTrait!
Example
Query
mutation inviteToGroup(
$accountId: String!,
$groupId: String!,
$roleAlias: String
) {
inviteToGroup(
accountId: $accountId,
groupId: $groupId,
roleAlias: $roleAlias
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
name
ownerId
publicURL
socialLinks {
...SocialLinkFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"accountId": "abc123",
"groupId": "xyz789",
"roleAlias": "xyz789"
}
Response
{
"data": {
"inviteToGroup": {
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "abc123",
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"name": "xyz789",
"ownerId": "xyz789",
"publicURL": "xyz789",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
linkNonIntegratedGameAccount
Description
Link a manual game account
Response
Returns a
Person!
Example
Query
mutation linkNonIntegratedGameAccount(
$gameAccountId: String,
$gameAccountName: String,
$gameAccountTypeId: String!,
$personId: String!
) {
linkNonIntegratedGameAccount(
gameAccountId: $gameAccountId,
gameAccountName: $gameAccountName,
gameAccountTypeId: $gameAccountTypeId,
personId: $personId
) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
birthday {
...DateAttributeWithPossibleErrorFragment
}
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
eventParticipations {
...EventFragment
}
gameAccounts {
...GameAccountFragment
}
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
isSupplier
isVIP
lastUpdated
linkedAccounts {
...IdentityProviderWithPossibleErrorFragment
}
managedAccounts {
...ManagedAccountFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
realName {
...StringAttributeWithPossibleErrorFragment
}
servers {
...ServerFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"gameAccountId": "xyz789",
"gameAccountName": "xyz789",
"gameAccountTypeId": "xyz789",
"personId": "abc123"
}
Response
{
"data": {
"linkNonIntegratedGameAccount": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "xyz789",
"birthday": DateAttributeWithPossibleError,
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "abc123",
"displayName": "abc123",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"eventParticipations": [Event],
"gameAccounts": [GameAccount],
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": false,
"id": "xyz789",
"isSupplier": true,
"isVIP": true,
"lastUpdated": "2007-12-03T10:15:30Z",
"linkedAccounts": [
IdentityProviderWithPossibleError
],
"managedAccounts": [ManagedAccount],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"realName": StringAttributeWithPossibleError,
"servers": [Server],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"userType": "abc123",
"wallets": [SwarmioWallet]
}
}
}
multipleSwarmioCurrencyTransfers
Response
Returns
[TransferTransaction!]!
Arguments
| Name | Description |
|---|---|
fromWalletId -
String!
|
|
transferTransactionRequests -
[TransferTransactionRequest!]!
|
Example
Query
mutation multipleSwarmioCurrencyTransfers(
$fromWalletId: String!,
$transferTransactionRequests: [TransferTransactionRequest!]!
) {
multipleSwarmioCurrencyTransfers(
fromWalletId: $fromWalletId,
transferTransactionRequests: $transferTransactionRequests
) {
amount
created
id
otherWalletId
transactionType
wallet {
...SwarmioWalletFragment
}
walletId
}
}
Variables
{
"fromWalletId": "xyz789",
"transferTransactionRequests": [
TransferTransactionRequest
]
}
Response
{
"data": {
"multipleSwarmioCurrencyTransfers": [
{
"amount": 123.45,
"created": "2007-12-03",
"id": "xyz789",
"otherWalletId": "xyz789",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "abc123"
}
]
}
}
paySubscriptionWithSwarmio
Description
For a target explicit subscription (already attached to an account), start a payment session with Swarmio Pay
Example
Query
mutation paySubscriptionWithSwarmio($subscriptionId: String!) {
paySubscriptionWithSwarmio(subscriptionId: $subscriptionId)
}
Variables
{"subscriptionId": "xyz789"}
Response
{
"data": {
"paySubscriptionWithSwarmio": "abc123"
}
}
payoutEventPrizes
Example
Query
mutation payoutEventPrizes($eventId: String!) {
payoutEventPrizes(eventId: $eventId) {
category
created
defaultLocale
description
eventCurrencyExchanges {
...EventCurrencyExchangesFragment
}
eventLimitations {
...EventLimitationsFragment
}
eventStages {
...EventStageFragment
}
eventState
eventTeam {
...EventTeamMemberFragment
}
eventTiming {
...EventTimingFragment
}
featured
game {
...GameFragment
}
gameAccountTypeIds
gameAccountTypes {
...GameAccountTypeFragment
}
gameId
id
isSimulated
localizedDescriptions {
...LocalizedOptionalStringFragment
}
localizedMediaContentDetails {
...LocalizedMediaContentDetailsFragment
}
localizedNames {
...LocalizedStringFragment
}
mediaContentDetails {
...MediaContentDetailsFragment
}
name
ownerId
participantCount
participantType
participants {
...ParticipantFragment
}
region
tags {
...TagFragment
}
unlisted
}
}
Variables
{"eventId": "abc123"}
Response
{
"data": {
"payoutEventPrizes": {
"category": "Challenge",
"created": "2007-12-03",
"defaultLocale": "ar_BH",
"description": "abc123",
"eventCurrencyExchanges": EventCurrencyExchanges,
"eventLimitations": EventLimitations,
"eventStages": [EventStage],
"eventState": "ARCHIVED",
"eventTeam": [EventTeamMember],
"eventTiming": EventTiming,
"featured": true,
"game": Game,
"gameAccountTypeIds": ["abc123"],
"gameAccountTypes": [GameAccountType],
"gameId": "xyz789",
"id": "abc123",
"isSimulated": false,
"localizedDescriptions": [LocalizedOptionalString],
"localizedMediaContentDetails": [
LocalizedMediaContentDetails
],
"localizedNames": [LocalizedString],
"mediaContentDetails": MediaContentDetails,
"name": "abc123",
"ownerId": "xyz789",
"participantCount": 123,
"participantType": "IndividualParticipantType",
"participants": [Participant],
"region": "APAC",
"tags": [Tag],
"unlisted": false
}
}
}
processCSVFile
Response
Returns
[DraftProduct]
Arguments
| Name | Description |
|---|---|
fileId -
ID!
|
Example
Query
mutation processCSVFile($fileId: ID!) {
processCSVFile(fileId: $fileId) {
additionalData
availableStock
costPrice
currency
id
productName
publisherName
sku
totalStock
voucherCode
voucherExpiry
voucherPin
voucherSerial
}
}
Variables
{"fileId": 4}
Response
{
"data": {
"processCSVFile": [
{
"additionalData": "xyz789",
"availableStock": 987,
"costPrice": "xyz789",
"currency": "xyz789",
"id": "4",
"productName": "xyz789",
"publisherName": "xyz789",
"sku": "xyz789",
"totalStock": 123,
"voucherCode": "abc123",
"voucherExpiry": "xyz789",
"voucherPin": "xyz789",
"voucherSerial": "abc123"
}
]
}
}
promoteToGroupAdmin
Description
Promote a group member to admin
Response
Returns a
GroupTrait!
Example
Query
mutation promoteToGroupAdmin(
$accountId: String!,
$groupId: String!,
$roleAlias: String
) {
promoteToGroupAdmin(
accountId: $accountId,
groupId: $groupId,
roleAlias: $roleAlias
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
name
ownerId
publicURL
socialLinks {
...SocialLinkFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"accountId": "abc123",
"groupId": "xyz789",
"roleAlias": "abc123"
}
Response
{
"data": {
"promoteToGroupAdmin": {
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "xyz789",
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"name": "xyz789",
"ownerId": "abc123",
"publicURL": "abc123",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
purchaseExternalItem
Description
Use swarmio currency to purchase an item provided by another service.
Response
Returns an
Account!
Example
Query
mutation purchaseExternalItem(
$currencyId: String!,
$gamerId: String,
$itemId: String!,
$quantity: Int!
) {
purchaseExternalItem(
currencyId: $currencyId,
gamerId: $gamerId,
itemId: $itemId,
quantity: $quantity
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"currencyId": "xyz789",
"gamerId": "abc123",
"itemId": "xyz789",
"quantity": 987
}
Response
{
"data": {
"purchaseExternalItem": {
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "abc123",
"isSupplier": true,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
purchaseItem
Response
Returns an
Order
Arguments
| Name | Description |
|---|---|
purchase -
purchaseItemInput
|
Example
Query
mutation purchaseItem($purchase: purchaseItemInput) {
purchaseItem(purchase: $purchase) {
billingAddress
cancellationNote
createdBy
createdDate
formattedItemId
gamerEmail
gamerId
gamerName
id
isActive
item {
...ItemFragment
}
itemName
modifiedBy
modifiedDate
orderDate
orderId
orderStatus
orderTransaction {
...OrderTransactionFragment
}
partner {
...PartnerFragment
}
payment {
...PaymentFragment
}
pointsValue
quantity
shipment {
...ShipmentFragment
}
totalPoints
transactionId
vouchers {
...ProductVoucherFragment
}
}
}
Variables
{"purchase": purchaseItemInput}
Response
{
"data": {
"purchaseItem": {
"billingAddress": "xyz789",
"cancellationNote": "xyz789",
"createdBy": 123,
"createdDate": "xyz789",
"formattedItemId": "xyz789",
"gamerEmail": "abc123",
"gamerId": "abc123",
"gamerName": "abc123",
"id": "4",
"isActive": false,
"item": Item,
"itemName": "xyz789",
"modifiedBy": 987,
"modifiedDate": "abc123",
"orderDate": "abc123",
"orderId": "abc123",
"orderStatus": "CANCELLED",
"orderTransaction": OrderTransaction,
"partner": Partner,
"payment": Payment,
"pointsValue": 987.65,
"quantity": 987,
"shipment": Shipment,
"totalPoints": 987.65,
"transactionId": "abc123",
"vouchers": [ProductVoucher]
}
}
}
purchaseSwarmioCurrencyItem
Response
Returns a
String!
Arguments
| Name | Description |
|---|---|
maybeEmail -
String
|
|
paymentType -
PaymentType!
|
|
swarmioCurrencyItemCostId -
String!
|
Example
Query
mutation purchaseSwarmioCurrencyItem(
$maybeEmail: String,
$paymentType: PaymentType!,
$swarmioCurrencyItemCostId: String!
) {
purchaseSwarmioCurrencyItem(
maybeEmail: $maybeEmail,
paymentType: $paymentType,
swarmioCurrencyItemCostId: $swarmioCurrencyItemCostId
)
}
Variables
{
"maybeEmail": "abc123",
"paymentType": "Skrill",
"swarmioCurrencyItemCostId": "xyz789"
}
Response
{
"data": {
"purchaseSwarmioCurrencyItem": "abc123"
}
}
refreshUsersSubscriptions
Description
Refresh all implicit subscriptions that have passed their expiry date from the linked providers (for all users)
Response
Returns an
Int!
Example
Query
mutation refreshUsersSubscriptions {
refreshUsersSubscriptions
}
Response
{"data": {"refreshUsersSubscriptions": 123}}
registerInternalService
Response
Returns an
InternalService!
Arguments
| Name | Description |
|---|---|
internalCreationRequest -
InternalServiceCreationRequest!
|
Example
Query
mutation registerInternalService($internalCreationRequest: InternalServiceCreationRequest!) {
registerInternalService(internalCreationRequest: $internalCreationRequest) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
isSupplier
lastUpdated
managedAccounts {
...ManagedAccountFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"internalCreationRequest": InternalServiceCreationRequest
}
Response
{
"data": {
"registerInternalService": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "abc123",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": false,
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": true,
"id": "xyz789",
"isSupplier": true,
"lastUpdated": "2007-12-03T10:15:30Z",
"managedAccounts": [ManagedAccount],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": true,
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"userType": "xyz789",
"wallets": [SwarmioWallet]
}
}
}
registerPerson
Response
Returns a
Person!
Arguments
| Name | Description |
|---|---|
acceptTerms -
Boolean!
|
|
personCreationRequest -
PersonCreationRequest!
|
Example
Query
mutation registerPerson(
$acceptTerms: Boolean!,
$personCreationRequest: PersonCreationRequest!
) {
registerPerson(
acceptTerms: $acceptTerms,
personCreationRequest: $personCreationRequest
) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
birthday {
...DateAttributeWithPossibleErrorFragment
}
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
eventParticipations {
...EventFragment
}
gameAccounts {
...GameAccountFragment
}
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
isSupplier
isVIP
lastUpdated
linkedAccounts {
...IdentityProviderWithPossibleErrorFragment
}
managedAccounts {
...ManagedAccountFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
realName {
...StringAttributeWithPossibleErrorFragment
}
servers {
...ServerFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"acceptTerms": false,
"personCreationRequest": PersonCreationRequest
}
Response
{
"data": {
"registerPerson": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "abc123",
"birthday": DateAttributeWithPossibleError,
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "xyz789",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": false,
"eventParticipations": [Event],
"gameAccounts": [GameAccount],
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": true,
"id": "abc123",
"isSupplier": true,
"isVIP": true,
"lastUpdated": "2007-12-03T10:15:30Z",
"linkedAccounts": [
IdentityProviderWithPossibleError
],
"managedAccounts": [ManagedAccount],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"realName": StringAttributeWithPossibleError,
"servers": [Server],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"userType": "xyz789",
"wallets": [SwarmioWallet]
}
}
}
registerPersonMSISDN
Example
Query
mutation registerPersonMSISDN($MSISDN: String!) {
registerPersonMSISDN(MSISDN: $MSISDN) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
birthday {
...DateAttributeWithPossibleErrorFragment
}
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
eventParticipations {
...EventFragment
}
gameAccounts {
...GameAccountFragment
}
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
isSupplier
isVIP
lastUpdated
linkedAccounts {
...IdentityProviderWithPossibleErrorFragment
}
managedAccounts {
...ManagedAccountFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
realName {
...StringAttributeWithPossibleErrorFragment
}
servers {
...ServerFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"MSISDN": "abc123"}
Response
{
"data": {
"registerPersonMSISDN": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "xyz789",
"birthday": DateAttributeWithPossibleError,
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "xyz789",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": false,
"eventParticipations": [Event],
"gameAccounts": [GameAccount],
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": true,
"id": "xyz789",
"isSupplier": false,
"isVIP": true,
"lastUpdated": "2007-12-03T10:15:30Z",
"linkedAccounts": [
IdentityProviderWithPossibleError
],
"managedAccounts": [ManagedAccount],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"realName": StringAttributeWithPossibleError,
"servers": [Server],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"userType": "abc123",
"wallets": [SwarmioWallet]
}
}
}
removeImagesFromResult
Description
Update the result images for a participant in a given match
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
urls -
[String!]!
|
List of URLs |
Example
Query
mutation removeImagesFromResult($urls: [String!]!) {
removeImagesFromResult(urls: $urls)
}
Variables
{"urls": ["abc123"]}
Response
{"data": {"removeImagesFromResult": 987}}
removeMemberFromGroup
Response
Returns a
GroupTrait!
Example
Query
mutation removeMemberFromGroup(
$accountId: String!,
$groupId: String!
) {
removeMemberFromGroup(
accountId: $accountId,
groupId: $groupId
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
name
ownerId
publicURL
socialLinks {
...SocialLinkFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"accountId": "xyz789",
"groupId": "xyz789"
}
Response
{
"data": {
"removeMemberFromGroup": {
"accountType": "xyz789",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "abc123",
"id": "abc123",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"name": "xyz789",
"ownerId": "xyz789",
"publicURL": "abc123",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
removeRolesFromGroupMember
Response
Returns a
GroupTrait!
Arguments
| Name | Description |
|---|---|
accountId -
String!
|
|
groupId -
String!
|
|
roleIds -
[String!]!
|
Example
Query
mutation removeRolesFromGroupMember(
$accountId: String!,
$groupId: String!,
$roleIds: [String!]!
) {
removeRolesFromGroupMember(
accountId: $accountId,
groupId: $groupId,
roleIds: $roleIds
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
name
ownerId
publicURL
socialLinks {
...SocialLinkFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"accountId": "xyz789",
"groupId": "xyz789",
"roleIds": ["xyz789"]
}
Response
{
"data": {
"removeRolesFromGroupMember": {
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "abc123",
"id": "abc123",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"name": "xyz789",
"ownerId": "abc123",
"publicURL": "xyz789",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
removeSubscriptionProviderAccount
Description
Remove a SubscriptionPartner with given ID from the given account ID
Response
Returns an
Account!
Arguments
| Name | Description |
|---|---|
accountId -
String!
|
|
subscriptionProvider -
SubscriptionProvider!
|
Example
Query
mutation removeSubscriptionProviderAccount(
$accountId: String!,
$subscriptionProvider: SubscriptionProvider!
) {
removeSubscriptionProviderAccount(
accountId: $accountId,
subscriptionProvider: $subscriptionProvider
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"accountId": "abc123",
"subscriptionProvider": "PayPal"
}
Response
{
"data": {
"removeSubscriptionProviderAccount": {
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "abc123",
"isSupplier": false,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
removeTeamParticipant
Description
Remove TeamParticipant from Event
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
leaveEventRequest -
LeaveEventRequest!
|
Example
Query
mutation removeTeamParticipant($leaveEventRequest: LeaveEventRequest!) {
removeTeamParticipant(leaveEventRequest: $leaveEventRequest)
}
Variables
{"leaveEventRequest": LeaveEventRequest}
Response
{"data": {"removeTeamParticipant": 987}}
replaceGroupOwner
Description
Replace group owner
Response
Returns a
GroupTrait!
Example
Query
mutation replaceGroupOwner(
$accountId: String!,
$groupId: String!,
$ownerId: String!,
$roleAlias: String
) {
replaceGroupOwner(
accountId: $accountId,
groupId: $groupId,
ownerId: $ownerId,
roleAlias: $roleAlias
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
name
ownerId
publicURL
socialLinks {
...SocialLinkFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"accountId": "xyz789",
"groupId": "xyz789",
"ownerId": "abc123",
"roleAlias": "abc123"
}
Response
{
"data": {
"replaceGroupOwner": {
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "abc123",
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"name": "abc123",
"ownerId": "abc123",
"publicURL": "abc123",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
requestCustomPayout
Response
Returns a
SwarmioCurrencyPayoutRequest!
Example
Query
mutation requestCustomPayout(
$amount: Float!,
$toOwnerId: String!
) {
requestCustomPayout(
amount: $amount,
toOwnerId: $toOwnerId
) {
completed
completedBy
dateCompleted
dateRequested
id
requesterId
swarmioCurrencyPayoutArchiveCost {
...SwarmioCurrencyPayoutCostArchiveFragment
}
swarmioCurrencyPayoutCostArchiveId
}
}
Variables
{"amount": 123.45, "toOwnerId": "xyz789"}
Response
{
"data": {
"requestCustomPayout": {
"completed": false,
"completedBy": "abc123",
"dateCompleted": "2007-12-03",
"dateRequested": "2007-12-03",
"id": "xyz789",
"requesterId": "abc123",
"swarmioCurrencyPayoutArchiveCost": SwarmioCurrencyPayoutCostArchive,
"swarmioCurrencyPayoutCostArchiveId": "xyz789"
}
}
}
requestPayout
Response
Returns a
SwarmioCurrencyPayoutRequest!
Example
Query
mutation requestPayout(
$ownerId: String!,
$swarmioCurrencyPayoutCostId: String!
) {
requestPayout(
ownerId: $ownerId,
swarmioCurrencyPayoutCostId: $swarmioCurrencyPayoutCostId
) {
completed
completedBy
dateCompleted
dateRequested
id
requesterId
swarmioCurrencyPayoutArchiveCost {
...SwarmioCurrencyPayoutCostArchiveFragment
}
swarmioCurrencyPayoutCostArchiveId
}
}
Variables
{
"ownerId": "abc123",
"swarmioCurrencyPayoutCostId": "abc123"
}
Response
{
"data": {
"requestPayout": {
"completed": true,
"completedBy": "xyz789",
"dateCompleted": "2007-12-03",
"dateRequested": "2007-12-03",
"id": "xyz789",
"requesterId": "xyz789",
"swarmioCurrencyPayoutArchiveCost": SwarmioCurrencyPayoutCostArchive,
"swarmioCurrencyPayoutCostArchiveId": "xyz789"
}
}
}
resendVerificationEmail
resendVerificationSMS
resetPassword
Response
Returns a
Boolean!
Example
Query
mutation resetPassword(
$ContactIdentifier: String!,
$password: String!,
$token: String!
) {
resetPassword(
ContactIdentifier: $ContactIdentifier,
password: $password,
token: $token
)
}
Variables
{
"ContactIdentifier": "xyz789",
"password": "abc123",
"token": "abc123"
}
Response
{"data": {"resetPassword": true}}
resetPasswordRequest
Example
Query
mutation resetPasswordRequest($ContactIdentifier: String!) {
resetPasswordRequest(ContactIdentifier: $ContactIdentifier)
}
Variables
{"ContactIdentifier": "xyz789"}
Response
{"data": {"resetPasswordRequest": false}}
saveCSVFile
Response
Returns an
CSVFile
Example
Query
mutation saveCSVFile(
$fileName: String,
$fileUrl: String,
$supplierId: ID!
) {
saveCSVFile(
fileName: $fileName,
fileUrl: $fileUrl,
supplierId: $supplierId
) {
createdBy
createdDate
fileName
fileStatus
fileUrl
id
modifiedBy
modifiedDate
supplier {
...SupplierFragment
}
totalProducts
totalVouchers
}
}
Variables
{
"fileName": "abc123",
"fileUrl": "xyz789",
"supplierId": "4"
}
Response
{
"data": {
"saveCSVFile": {
"createdBy": 987,
"createdDate": "xyz789",
"fileName": "xyz789",
"fileStatus": "COMPLETED",
"fileUrl": "xyz789",
"id": "4",
"modifiedBy": 123,
"modifiedDate": "xyz789",
"supplier": Supplier,
"totalProducts": 123,
"totalVouchers": 123
}
}
}
saveCategory
Response
Returns a
Category
Arguments
| Name | Description |
|---|---|
category -
categoryInput!
|
Example
Query
mutation saveCategory($category: categoryInput!) {
saveCategory(category: $category) {
categoryCoverImage
categoryDescription
categoryIcon
categoryId
categoryImage
categoryName
id
isActive
isDeleted
itemCatalogCategory {
...ItemCatalogCategoryFragment
}
parentCategory
}
}
Variables
{"category": categoryInput}
Response
{
"data": {
"saveCategory": {
"categoryCoverImage": "abc123",
"categoryDescription": "abc123",
"categoryIcon": "xyz789",
"categoryId": "xyz789",
"categoryImage": "abc123",
"categoryName": "abc123",
"id": 4,
"isActive": true,
"isDeleted": false,
"itemCatalogCategory": [ItemCatalogCategory],
"parentCategory": 123
}
}
}
saveGlobalPoints
Response
Returns a
Points
Arguments
| Name | Description |
|---|---|
globalPoints -
PointsInput!
|
Example
Query
mutation saveGlobalPoints($globalPoints: PointsInput!) {
saveGlobalPoints(globalPoints: $globalPoints) {
archive {
...PointsArchiveFragment
}
createdDate
defaultValue
id
modifiedDate
overriddenValue
partner {
...PartnerFragment
}
supplier {
...SupplierFragment
}
}
}
Variables
{"globalPoints": PointsInput}
Response
{
"data": {
"saveGlobalPoints": {
"archive": [PointsArchive],
"createdDate": "abc123",
"defaultValue": 123.45,
"id": "4",
"modifiedDate": "xyz789",
"overriddenValue": 123.45,
"partner": Partner,
"supplier": Supplier
}
}
}
saveItem
Response
Returns an
Item
Arguments
| Name | Description |
|---|---|
item -
ItemInput!
|
Example
Query
mutation saveItem($item: ItemInput!) {
saveItem(item: $item) {
createdBy
createdDate
currencyConversionRate
deliveryMethod
id
isActive
isDeleted
isStockAvailable
itemCatalogCategory {
...ItemCatalogCategoryFragment
}
itemDescBrief
itemDescDetail
itemGalleryUrls
itemId
itemImageUrl
itemName
itemPartnerPoints {
...ItemPointsFragment
}
itemStatus
itemType
product {
...ProductFragment
}
supplier {
...SupplierFragment
}
unitPrice
}
}
Variables
{"item": ItemInput}
Response
{
"data": {
"saveItem": {
"createdBy": 123,
"createdDate": "xyz789",
"currencyConversionRate": 123.45,
"deliveryMethod": "REDEEM",
"id": 4,
"isActive": true,
"isDeleted": false,
"isStockAvailable": true,
"itemCatalogCategory": [ItemCatalogCategory],
"itemDescBrief": "abc123",
"itemDescDetail": "abc123",
"itemGalleryUrls": ["abc123"],
"itemId": "abc123",
"itemImageUrl": "abc123",
"itemName": "abc123",
"itemPartnerPoints": [ItemPoints],
"itemStatus": "DELETED",
"itemType": "PHYSICAL",
"product": Product,
"supplier": Supplier,
"unitPrice": 987.65
}
}
}
saveItemPoints
Response
Returns an
ItemPoints
Arguments
| Name | Description |
|---|---|
itemPoints -
ItemPointsInput!
|
Example
Query
mutation saveItemPoints($itemPoints: ItemPointsInput!) {
saveItemPoints(itemPoints: $itemPoints) {
createdDate
id
item {
...ItemFragment
}
markedUpPrice
partner {
...PartnerFragment
}
pointsConversionRate
pointsValue
}
}
Variables
{"itemPoints": ItemPointsInput}
Response
{
"data": {
"saveItemPoints": {
"createdDate": "xyz789",
"id": "4",
"item": Item,
"markedUpPrice": 123.45,
"partner": Partner,
"pointsConversionRate": 123.45,
"pointsValue": 123.45
}
}
}
saveSupplier
Response
Returns a
Supplier
Arguments
| Name | Description |
|---|---|
supplier -
SupplierInput!
|
Example
Query
mutation saveSupplier($supplier: SupplierInput!) {
saveSupplier(supplier: $supplier) {
contact {
...ContactFragment
}
createdBy
createdDate
creditLimit
endpointUrl
id
isActive
isDeleted
products {
...ProductFragment
}
supplierId
supplierName
}
}
Variables
{"supplier": SupplierInput}
Response
{
"data": {
"saveSupplier": {
"contact": Contact,
"createdBy": 987,
"createdDate": "xyz789",
"creditLimit": "xyz789",
"endpointUrl": "abc123",
"id": 4,
"isActive": true,
"isDeleted": false,
"products": [Product],
"supplierId": "abc123",
"supplierName": "xyz789"
}
}
}
sendTemplateEmail
Response
Returns a
Boolean!
Example
Query
mutation sendTemplateEmail(
$argumentsJson: String!,
$templateId: String!,
$userId: String!
) {
sendTemplateEmail(
argumentsJson: $argumentsJson,
templateId: $templateId,
userId: $userId
)
}
Variables
{
"argumentsJson": "xyz789",
"templateId": "xyz789",
"userId": "xyz789"
}
Response
{"data": {"sendTemplateEmail": false}}
subscribeTIMWEExternalSubscriptionPackageCallback
Description
Validates the subscription to TIMWE External Subscription Package via an OTP
Example
Query
mutation subscribeTIMWEExternalSubscriptionPackageCallback(
$Otp: String!,
$accountId: String!
) {
subscribeTIMWEExternalSubscriptionPackageCallback(
Otp: $Otp,
accountId: $accountId
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"Otp": "abc123",
"accountId": "xyz789"
}
Response
{
"data": {
"subscribeTIMWEExternalSubscriptionPackageCallback": {
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "xyz789",
"isSupplier": false,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
transferAllWallets
Response
Returns
[TransferTransaction!]!
Example
Query
mutation transferAllWallets(
$ownerId: String!,
$toOwnerId: String!
) {
transferAllWallets(
ownerId: $ownerId,
toOwnerId: $toOwnerId
) {
amount
created
id
otherWalletId
transactionType
wallet {
...SwarmioWalletFragment
}
walletId
}
}
Variables
{
"ownerId": "xyz789",
"toOwnerId": "abc123"
}
Response
{
"data": {
"transferAllWallets": [
{
"amount": 987.65,
"created": "2007-12-03",
"id": "xyz789",
"otherWalletId": "xyz789",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "abc123"
}
]
}
}
transferSwarmioCurrency
Response
Returns a
TransferTransaction!
Example
Query
mutation transferSwarmioCurrency(
$amount: Float!,
$fromWalletId: String!,
$toOwnerId: String!
) {
transferSwarmioCurrency(
amount: $amount,
fromWalletId: $fromWalletId,
toOwnerId: $toOwnerId
) {
amount
created
id
otherWalletId
transactionType
wallet {
...SwarmioWalletFragment
}
walletId
}
}
Variables
{
"amount": 123.45,
"fromWalletId": "xyz789",
"toOwnerId": "abc123"
}
Response
{
"data": {
"transferSwarmioCurrency": {
"amount": 987.65,
"created": "2007-12-03",
"id": "xyz789",
"otherWalletId": "abc123",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "abc123"
}
}
}
unenrollExternalSubscriptionPackage
Description
Attempt to un-enroll an account in a target external (implicit) subscription package through the provider API
Response
Returns an
Account!
Example
Query
mutation unenrollExternalSubscriptionPackage(
$accountId: String!,
$externalSubscriptionPackageId: String!
) {
unenrollExternalSubscriptionPackage(
accountId: $accountId,
externalSubscriptionPackageId: $externalSubscriptionPackageId
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"accountId": "abc123",
"externalSubscriptionPackageId": "abc123"
}
Response
{
"data": {
"unenrollExternalSubscriptionPackage": {
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "abc123",
"isSupplier": true,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
unlinkGameAccount
Description
Unlink an external game account
Response
Returns a
Person!
Arguments
| Name | Description |
|---|---|
gameAccountId -
String!
|
The internal ID of a GameAccount |
Example
Query
mutation unlinkGameAccount($gameAccountId: String!) {
unlinkGameAccount(gameAccountId: $gameAccountId) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
birthday {
...DateAttributeWithPossibleErrorFragment
}
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
eventParticipations {
...EventFragment
}
gameAccounts {
...GameAccountFragment
}
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
isSupplier
isVIP
lastUpdated
linkedAccounts {
...IdentityProviderWithPossibleErrorFragment
}
managedAccounts {
...ManagedAccountFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
realName {
...StringAttributeWithPossibleErrorFragment
}
servers {
...ServerFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"gameAccountId": "abc123"}
Response
{
"data": {
"unlinkGameAccount": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "xyz789",
"birthday": DateAttributeWithPossibleError,
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "xyz789",
"displayName": "abc123",
"email": StringAttributeWithPossibleError,
"emailVerified": false,
"eventParticipations": [Event],
"gameAccounts": [GameAccount],
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": true,
"id": "abc123",
"isSupplier": true,
"isVIP": true,
"lastUpdated": "2007-12-03T10:15:30Z",
"linkedAccounts": [
IdentityProviderWithPossibleError
],
"managedAccounts": [ManagedAccount],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"realName": StringAttributeWithPossibleError,
"servers": [Server],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"userType": "abc123",
"wallets": [SwarmioWallet]
}
}
}
unlinkIdentityProvider
Response
Returns a
User!
Arguments
| Name | Description |
|---|---|
IdentityProviderType -
IdentityProviderType!
|
|
userId -
String!
|
Example
Query
mutation unlinkIdentityProvider(
$IdentityProviderType: IdentityProviderType!,
$userId: String!
) {
unlinkIdentityProvider(
IdentityProviderType: $IdentityProviderType,
userId: $userId
) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
socialLinks {
...SocialLinkFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"IdentityProviderType": "DISCORD",
"userId": "xyz789"
}
Response
{
"data": {
"unlinkIdentityProvider": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "abc123",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": true,
"id": "xyz789",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "abc123",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"userType": "abc123",
"wallets": [SwarmioWallet]
}
}
}
unlinkIdentityProviderByEmail
Example
Query
mutation unlinkIdentityProviderByEmail($email: String!) {
unlinkIdentityProviderByEmail(email: $email) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
socialLinks {
...SocialLinkFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{"email": "xyz789"}
Response
{
"data": {
"unlinkIdentityProviderByEmail": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "abc123",
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "xyz789",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": false,
"id": "abc123",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": true,
"publicURL": "abc123",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"userType": "abc123",
"wallets": [SwarmioWallet]
}
}
}
updateCategoryList
Response
Returns
[Category]
Arguments
| Name | Description |
|---|---|
categoryIds -
[ID]!
|
|
categoryListInput -
CategoryListInput!
|
Example
Query
mutation updateCategoryList(
$categoryIds: [ID]!,
$categoryListInput: CategoryListInput!
) {
updateCategoryList(
categoryIds: $categoryIds,
categoryListInput: $categoryListInput
) {
categoryCoverImage
categoryDescription
categoryIcon
categoryId
categoryImage
categoryName
id
isActive
isDeleted
itemCatalogCategory {
...ItemCatalogCategoryFragment
}
parentCategory
}
}
Variables
{
"categoryIds": ["4"],
"categoryListInput": CategoryListInput
}
Response
{
"data": {
"updateCategoryList": [
{
"categoryCoverImage": "abc123",
"categoryDescription": "abc123",
"categoryIcon": "xyz789",
"categoryId": "xyz789",
"categoryImage": "abc123",
"categoryName": "xyz789",
"id": 4,
"isActive": false,
"isDeleted": false,
"itemCatalogCategory": [ItemCatalogCategory],
"parentCategory": 123
}
]
}
}
updateDevcoProductList
Response
Returns
[Product]
Example
Query
mutation updateDevcoProductList {
updateDevcoProductList {
availableStock
createdDate
currency
currencySymbol
id
item {
...ItemFragment
}
manufacturerBrandId
manufacturerBrandName
manufacturerBrandProductFields
manufacturerBrandProductFormatDesc
manufacturerBrandProductFormatId
manufacturerId
manufacturerName
modifiedDate
productId
productImageUrl
productName
productRedemptionInstructions
productVouchers {
...ProductVoucherFragment
}
productVvssku
purchaseNote
sellPrice
totalStock
unitPrice
voucherInventories {
...VoucherInventoryFragment
}
}
}
Response
{
"data": {
"updateDevcoProductList": [
{
"availableStock": 123,
"createdDate": "abc123",
"currency": "abc123",
"currencySymbol": "xyz789",
"id": 4,
"item": Item,
"manufacturerBrandId": 123,
"manufacturerBrandName": "abc123",
"manufacturerBrandProductFields": "xyz789",
"manufacturerBrandProductFormatDesc": "xyz789",
"manufacturerBrandProductFormatId": 123,
"manufacturerId": 4,
"manufacturerName": "abc123",
"modifiedDate": "xyz789",
"productId": "4",
"productImageUrl": "abc123",
"productName": "xyz789",
"productRedemptionInstructions": "abc123",
"productVouchers": [ProductVoucher],
"productVvssku": "abc123",
"purchaseNote": "abc123",
"sellPrice": 987.65,
"totalStock": 987,
"unitPrice": 123.45,
"voucherInventories": [VoucherInventory]
}
]
}
}
updateEmbeddedGame
Response
Returns an
EmbeddedGame!
Arguments
| Name | Description |
|---|---|
embeddedGameId -
String!
|
The ID of an Embedded Game |
embeddedGamesUpdateRequest -
EmbeddedGamesUpdateRequest!
|
Example
Query
mutation updateEmbeddedGame(
$embeddedGameId: String!,
$embeddedGamesUpdateRequest: EmbeddedGamesUpdateRequest!
) {
updateEmbeddedGame(
embeddedGameId: $embeddedGameId,
embeddedGamesUpdateRequest: $embeddedGamesUpdateRequest
) {
availability
desc
embeddedGameURL
id
thumbnailURL
title
}
}
Variables
{
"embeddedGameId": "xyz789",
"embeddedGamesUpdateRequest": EmbeddedGamesUpdateRequest
}
Response
{
"data": {
"updateEmbeddedGame": {
"availability": "Free",
"desc": "xyz789",
"embeddedGameURL": "xyz789",
"id": "xyz789",
"thumbnailURL": "xyz789",
"title": "xyz789"
}
}
}
updateEventsGame
Response
Returns a
Game!
Arguments
| Name | Description |
|---|---|
gameId -
String!
|
The ID of a game |
gameUpdateRequest -
GameUpdateRequest!
|
Example
Query
mutation updateEventsGame(
$gameId: String!,
$gameUpdateRequest: GameUpdateRequest!
) {
updateEventsGame(
gameId: $gameId,
gameUpdateRequest: $gameUpdateRequest
) {
bufferTime
description
estimatedRoundLength
gameAccountTypeIds
gameAccountTypes {
...GameAccountTypeFragment
}
id
image
integrated
maxParticipantsPerRound
prettyName
supportedCompetitionFormats
supportedParticipantTypes
typicalPlacingStrategyForRounds
weight
}
}
Variables
{
"gameId": "xyz789",
"gameUpdateRequest": GameUpdateRequest
}
Response
{
"data": {
"updateEventsGame": {
"bufferTime": DurationInMilliseconds,
"description": "xyz789",
"estimatedRoundLength": DurationInMilliseconds,
"gameAccountTypeIds": ["xyz789"],
"gameAccountTypes": [GameAccountType],
"id": "xyz789",
"image": "xyz789",
"integrated": false,
"maxParticipantsPerRound": 123.45,
"prettyName": "xyz789",
"supportedCompetitionFormats": ["Basic"],
"supportedParticipantTypes": ["IndividualParticipantType"],
"typicalPlacingStrategyForRounds": "HighestAverageScore",
"weight": 123.45
}
}
}
updateGameAccountType
Description
Update a game
Response
Returns a
GameAccountType!
Arguments
| Name | Description |
|---|---|
gameAccountTypeId -
String!
|
|
gameAccountTypeUpdateRequest -
GameAccountTypeUpdateRequest!
|
Example
Query
mutation updateGameAccountType(
$gameAccountTypeId: String!,
$gameAccountTypeUpdateRequest: GameAccountTypeUpdateRequest!
) {
updateGameAccountType(
gameAccountTypeId: $gameAccountTypeId,
gameAccountTypeUpdateRequest: $gameAccountTypeUpdateRequest
) {
accountIDLabel
accountNameLabel
games {
...GameFragment
}
iconUrl
id
imageUrl
implicitGameIds
integrated
prettyName
requiresExternalAccountId
requiresExternalAccountName
}
}
Variables
{
"gameAccountTypeId": "xyz789",
"gameAccountTypeUpdateRequest": GameAccountTypeUpdateRequest
}
Response
{
"data": {
"updateGameAccountType": {
"accountIDLabel": "abc123",
"accountNameLabel": "abc123",
"games": [Game],
"iconUrl": "abc123",
"id": "xyz789",
"imageUrl": "abc123",
"implicitGameIds": ["xyz789"],
"integrated": true,
"prettyName": "xyz789",
"requiresExternalAccountId": false,
"requiresExternalAccountName": true
}
}
}
updateGroup
Response
Returns a
Group!
Arguments
| Name | Description |
|---|---|
id -
String!
|
|
updateGroupRequest -
GroupUpdateRequest!
|
Example
Query
mutation updateGroup(
$id: String!,
$updateGroupRequest: GroupUpdateRequest!
) {
updateGroup(
id: $id,
updateGroupRequest: $updateGroupRequest
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
isSupplier
lastUpdated
managedAccounts {
...ManagedAccountFragment
}
name
ownerId
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"id": "xyz789",
"updateGroupRequest": GroupUpdateRequest
}
Response
{
"data": {
"updateGroup": {
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "abc123",
"id": "xyz789",
"isSupplier": true,
"lastUpdated": "2007-12-03T10:15:30Z",
"managedAccounts": [ManagedAccount],
"name": "abc123",
"ownerId": "xyz789",
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
updateItemList
Response
Returns
[Item]
Arguments
| Name | Description |
|---|---|
itemListInput -
[ItemListInput!]
|
Example
Query
mutation updateItemList($itemListInput: [ItemListInput!]) {
updateItemList(itemListInput: $itemListInput) {
createdBy
createdDate
currencyConversionRate
deliveryMethod
id
isActive
isDeleted
isStockAvailable
itemCatalogCategory {
...ItemCatalogCategoryFragment
}
itemDescBrief
itemDescDetail
itemGalleryUrls
itemId
itemImageUrl
itemName
itemPartnerPoints {
...ItemPointsFragment
}
itemStatus
itemType
product {
...ProductFragment
}
supplier {
...SupplierFragment
}
unitPrice
}
}
Variables
{"itemListInput": [ItemListInput]}
Response
{
"data": {
"updateItemList": [
{
"createdBy": 987,
"createdDate": "xyz789",
"currencyConversionRate": 123.45,
"deliveryMethod": "REDEEM",
"id": 4,
"isActive": false,
"isDeleted": true,
"isStockAvailable": false,
"itemCatalogCategory": [ItemCatalogCategory],
"itemDescBrief": "abc123",
"itemDescDetail": "xyz789",
"itemGalleryUrls": ["xyz789"],
"itemId": "xyz789",
"itemImageUrl": "abc123",
"itemName": "abc123",
"itemPartnerPoints": [ItemPoints],
"itemStatus": "DELETED",
"itemType": "PHYSICAL",
"product": Product,
"supplier": Supplier,
"unitPrice": 987.65
}
]
}
}
updateManualGameAccount
Description
Update a manual game account
Response
Returns a
Person!
Arguments
| Name | Description |
|---|---|
gameAccountId -
String!
|
The internal ID of a GameAccount |
gameAccountUpdateRequest -
GameAccountUpdateRequest!
|
Example
Query
mutation updateManualGameAccount(
$gameAccountId: String!,
$gameAccountUpdateRequest: GameAccountUpdateRequest!
) {
updateManualGameAccount(
gameAccountId: $gameAccountId,
gameAccountUpdateRequest: $gameAccountUpdateRequest
) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
birthday {
...DateAttributeWithPossibleErrorFragment
}
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
eventParticipations {
...EventFragment
}
gameAccounts {
...GameAccountFragment
}
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
isSupplier
isVIP
lastUpdated
linkedAccounts {
...IdentityProviderWithPossibleErrorFragment
}
managedAccounts {
...ManagedAccountFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
realName {
...StringAttributeWithPossibleErrorFragment
}
servers {
...ServerFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"gameAccountId": "xyz789",
"gameAccountUpdateRequest": GameAccountUpdateRequest
}
Response
{
"data": {
"updateManualGameAccount": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "abc123",
"birthday": DateAttributeWithPossibleError,
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "abc123",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"eventParticipations": [Event],
"gameAccounts": [GameAccount],
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": true,
"id": "xyz789",
"isSupplier": true,
"isVIP": false,
"lastUpdated": "2007-12-03T10:15:30Z",
"linkedAccounts": [
IdentityProviderWithPossibleError
],
"managedAccounts": [ManagedAccount],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": true,
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"realName": StringAttributeWithPossibleError,
"servers": [Server],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"userType": "xyz789",
"wallets": [SwarmioWallet]
}
}
}
updateMatchUp
Description
Update Team event
Response
Returns a
Competition!
Arguments
| Name | Description |
|---|---|
competitionId -
String!
|
The ID of a competition |
matchUpUpdateRequest -
MatchUpUpdateRequestForCompetitionId!
|
Example
Query
mutation updateMatchUp(
$competitionId: String!,
$matchUpUpdateRequest: MatchUpUpdateRequestForCompetitionId!
) {
updateMatchUp(
competitionId: $competitionId,
matchUpUpdateRequest: $matchUpUpdateRequest
) {
competitionState
competitionType
created
event {
...EventFragment
}
eventId
eventStageId
game {
...GameFragment
}
gameId
id
participantType
participants {
...CompetitionParticipantReferenceFragment
}
startTime
}
}
Variables
{
"competitionId": "abc123",
"matchUpUpdateRequest": MatchUpUpdateRequestForCompetitionId
}
Response
{
"data": {
"updateMatchUp": {
"competitionState": "ARCHIVED",
"competitionType": "CHALLENGE",
"created": "2007-12-03",
"event": Event,
"eventId": "xyz789",
"eventStageId": "xyz789",
"game": Game,
"gameId": "abc123",
"id": "abc123",
"participantType": "IndividualParticipantType",
"participants": [CompetitionParticipantReference],
"startTime": "2007-12-03"
}
}
}
updateOrderList
Response
Returns
[Order]
Arguments
| Name | Description |
|---|---|
orderIds -
[ID]!
|
|
orderListInput -
OrderListInput!
|
Example
Query
mutation updateOrderList(
$orderIds: [ID]!,
$orderListInput: OrderListInput!
) {
updateOrderList(
orderIds: $orderIds,
orderListInput: $orderListInput
) {
billingAddress
cancellationNote
createdBy
createdDate
formattedItemId
gamerEmail
gamerId
gamerName
id
isActive
item {
...ItemFragment
}
itemName
modifiedBy
modifiedDate
orderDate
orderId
orderStatus
orderTransaction {
...OrderTransactionFragment
}
partner {
...PartnerFragment
}
payment {
...PaymentFragment
}
pointsValue
quantity
shipment {
...ShipmentFragment
}
totalPoints
transactionId
vouchers {
...ProductVoucherFragment
}
}
}
Variables
{
"orderIds": ["4"],
"orderListInput": OrderListInput
}
Response
{
"data": {
"updateOrderList": [
{
"billingAddress": "abc123",
"cancellationNote": "xyz789",
"createdBy": 987,
"createdDate": "xyz789",
"formattedItemId": "abc123",
"gamerEmail": "abc123",
"gamerId": "xyz789",
"gamerName": "abc123",
"id": 4,
"isActive": false,
"item": Item,
"itemName": "abc123",
"modifiedBy": 987,
"modifiedDate": "abc123",
"orderDate": "abc123",
"orderId": "abc123",
"orderStatus": "CANCELLED",
"orderTransaction": OrderTransaction,
"partner": Partner,
"payment": Payment,
"pointsValue": 123.45,
"quantity": 123,
"shipment": Shipment,
"totalPoints": 123.45,
"transactionId": "xyz789",
"vouchers": [ProductVoucher]
}
]
}
}
updatePassword
Response
Returns a
User!
Example
Query
mutation updatePassword(
$newPassword: String!,
$oldPassword: String!,
$userId: String!
) {
updatePassword(
newPassword: $newPassword,
oldPassword: $oldPassword,
userId: $userId
) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
socialLinks {
...SocialLinkFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"newPassword": "abc123",
"oldPassword": "xyz789",
"userId": "xyz789"
}
Response
{
"data": {
"updatePassword": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "abc123",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": false,
"id": "abc123",
"managedAccounts": [
ManagedAccountWithPossibleError
],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": true,
"publicURL": "abc123",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"userType": "xyz789",
"wallets": [SwarmioWallet]
}
}
}
updatePerson
Response
Returns a
Person!
Arguments
| Name | Description |
|---|---|
id -
String!
|
|
personUpdateRequest -
PersonUpdateRequest!
|
Example
Query
mutation updatePerson(
$id: String!,
$personUpdateRequest: PersonUpdateRequest!
) {
updatePerson(
id: $id,
personUpdateRequest: $personUpdateRequest
) {
accountManagers {
...AccountManagerWithPossibleErrorFragment
}
accountType
avatarURL
bannerURL
birthday {
...DateAttributeWithPossibleErrorFragment
}
contactIdentifier {
...StringAttributeWithPossibleErrorFragment
}
created
description
displayName
email {
...StringAttributeWithPossibleErrorFragment
}
emailVerified
eventParticipations {
...EventFragment
}
gameAccounts {
...GameAccountFragment
}
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
hasValidContact
id
isSupplier
isVIP
lastUpdated
linkedAccounts {
...IdentityProviderWithPossibleErrorFragment
}
managedAccounts {
...ManagedAccountFragment
}
msisdn {
...StringAttributeWithPossibleErrorFragment
}
msisdnVerified
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
realName {
...StringAttributeWithPossibleErrorFragment
}
servers {
...ServerFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
userType
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"id": "abc123",
"personUpdateRequest": PersonUpdateRequest
}
Response
{
"data": {
"updatePerson": {
"accountManagers": [
AccountManagerWithPossibleError
],
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"birthday": DateAttributeWithPossibleError,
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "abc123",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": false,
"eventParticipations": [Event],
"gameAccounts": [GameAccount],
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"hasValidContact": false,
"id": "abc123",
"isSupplier": false,
"isVIP": false,
"lastUpdated": "2007-12-03T10:15:30Z",
"linkedAccounts": [
IdentityProviderWithPossibleError
],
"managedAccounts": [ManagedAccount],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": true,
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"realName": StringAttributeWithPossibleError,
"servers": [Server],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"userType": "abc123",
"wallets": [SwarmioWallet]
}
}
}
updatePrizeList
Description
Create a new prize list
Response
Returns a
PrizeList!
Arguments
| Name | Description |
|---|---|
prizeListId -
String!
|
|
prizeListUpdateRequest -
PrizeListUpdateRequest!
|
Example
Query
mutation updatePrizeList(
$prizeListId: String!,
$prizeListUpdateRequest: PrizeListUpdateRequest!
) {
updatePrizeList(
prizeListId: $prizeListId,
prizeListUpdateRequest: $prizeListUpdateRequest
) {
id
prizeTiers {
...PrizeTierFragment
}
}
}
Variables
{
"prizeListId": "abc123",
"prizeListUpdateRequest": PrizeListUpdateRequest
}
Response
{
"data": {
"updatePrizeList": {
"id": "abc123",
"prizeTiers": [PrizeTier]
}
}
}
updatePublicServer
Description
update existing public server
Response
Returns a
PublicGameServer!
Arguments
| Name | Description |
|---|---|
serverId -
String!
|
The ID of a GameServer |
serverUpdateRequest -
PublicServerUpdateRequest!
|
Example
Query
mutation updatePublicServer(
$serverId: String!,
$serverUpdateRequest: PublicServerUpdateRequest!
) {
updatePublicServer(
serverId: $serverId,
serverUpdateRequest: $serverUpdateRequest
) {
connectString
description
featured
id
imageURL
ip
maxNumberOfPlayers
name
port
rconPassword
region
serverType
status
steamURL
timeAcquired
timeDestroyed
timeRequested
}
}
Variables
{
"serverId": "abc123",
"serverUpdateRequest": PublicServerUpdateRequest
}
Response
{
"data": {
"updatePublicServer": {
"connectString": "abc123",
"description": "xyz789",
"featured": false,
"id": "xyz789",
"imageURL": "xyz789",
"ip": "xyz789",
"maxNumberOfPlayers": 987,
"name": "xyz789",
"port": 987,
"rconPassword": "abc123",
"region": "abc123",
"serverType": "xyz789",
"status": "Creating",
"steamURL": "xyz789",
"timeAcquired": "2007-12-03",
"timeDestroyed": "2007-12-03",
"timeRequested": "2007-12-03"
}
}
}
updatePurchaseTransaction
Description
Update a purchase transaction's status and/or notes
Response
Returns an
Account!
Arguments
| Name | Description |
|---|---|
notes -
String
|
|
transactionId -
String!
|
|
transactionStatus -
PurchaseTransactionStatus
|
Example
Query
mutation updatePurchaseTransaction(
$notes: String,
$transactionId: String!,
$transactionStatus: PurchaseTransactionStatus
) {
updatePurchaseTransaction(
notes: $notes,
transactionId: $transactionId,
transactionStatus: $transactionStatus
) {
accountType
avatarURL
bannerURL
created
description
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupMemberships {
...GroupMembershipFragment
}
id
isSupplier
managedAccounts {
...ManagedAccountWithPossibleErrorFragment
}
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"notes": "abc123",
"transactionId": "abc123",
"transactionStatus": "Error"
}
Response
{
"data": {
"updatePurchaseTransaction": {
"accountType": "xyz789",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupMemberships": [GroupMembership],
"id": "abc123",
"isSupplier": false,
"managedAccounts": [
ManagedAccountWithPossibleError
],
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
updateResultForChallengeId
Description
Update the result for a participant in a given Challenge
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
challengeId -
String!
|
The challenge ID |
participantBasicResultSubmissions -
[ParticipantBasicResultSubmission!]!
|
Example
Query
mutation updateResultForChallengeId(
$challengeId: String!,
$participantBasicResultSubmissions: [ParticipantBasicResultSubmission!]!
) {
updateResultForChallengeId(
challengeId: $challengeId,
participantBasicResultSubmissions: $participantBasicResultSubmissions
)
}
Variables
{
"challengeId": "abc123",
"participantBasicResultSubmissions": [
ParticipantBasicResultSubmission
]
}
Response
{"data": {"updateResultForChallengeId": 123}}
updateResultForRoundId
Description
Update the result for a participant in a given round
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
participantId -
String!
|
The ID of the event specific participant |
placement -
Int
|
An optional placement for a participant |
roundId -
String!
|
The round ID within a competition |
score -
Float
|
An optional score for a participant |
showed -
Boolean
|
Whether the participant showed or not |
Example
Query
mutation updateResultForRoundId(
$participantId: String!,
$placement: Int,
$roundId: String!,
$score: Float,
$showed: Boolean
) {
updateResultForRoundId(
participantId: $participantId,
placement: $placement,
roundId: $roundId,
score: $score,
showed: $showed
)
}
Variables
{
"participantId": "abc123",
"placement": 987,
"roundId": "abc123",
"score": 987.65,
"showed": true
}
Response
{"data": {"updateResultForRoundId": 123}}
updateSubscriptionType
Description
Update a SubscriptionType
Response
Returns a
SubscriptionType!
Arguments
| Name | Description |
|---|---|
subscriptionTypeId -
String!
|
|
subscriptionTypeUpdateRequest -
SubscriptionTypeUpdateRequest!
|
Example
Query
mutation updateSubscriptionType(
$subscriptionTypeId: String!,
$subscriptionTypeUpdateRequest: SubscriptionTypeUpdateRequest!
) {
updateSubscriptionType(
subscriptionTypeId: $subscriptionTypeId,
subscriptionTypeUpdateRequest: $subscriptionTypeUpdateRequest
) {
conflictSubscriptionTypeIds
defaultLocale
description
enrollable
explicitEnrollment {
...ExplicitEnrollmentFragment
}
id
implicitEnrollments {
...ImplicitEnrollmentFragment
}
initialSwarmioCurrencyReward {
...SwarmioCurrencyRewardFragment
}
localizedDescriptions {
...LocalizedOptionalStringFragment
}
localizedNames {
...LocalizedStringFragment
}
name
recurringPayoutBonus {
...RecurringRewardFragment
}
weight
}
}
Variables
{
"subscriptionTypeId": "xyz789",
"subscriptionTypeUpdateRequest": SubscriptionTypeUpdateRequest
}
Response
{
"data": {
"updateSubscriptionType": {
"conflictSubscriptionTypeIds": [
"xyz789"
],
"defaultLocale": "ar_BH",
"description": "abc123",
"enrollable": true,
"explicitEnrollment": ExplicitEnrollment,
"id": "abc123",
"implicitEnrollments": [ImplicitEnrollment],
"initialSwarmioCurrencyReward": SwarmioCurrencyReward,
"localizedDescriptions": [LocalizedOptionalString],
"localizedNames": [LocalizedString],
"name": "abc123",
"recurringPayoutBonus": RecurringReward,
"weight": 123.45
}
}
}
updateTeam
Response
Returns a
Team!
Arguments
| Name | Description |
|---|---|
id -
String!
|
|
updateTeamRequest -
TeamUpdateRequest!
|
Example
Query
mutation updateTeam(
$id: String!,
$updateTeamRequest: TeamUpdateRequest!
) {
updateTeam(
id: $id,
updateTeamRequest: $updateTeamRequest
) {
accountType
avatarURL
bannerURL
created
description
eventParticipations {
...EventFragment
}
groupInvitations {
...GroupInvitationWithPossibleErrorFragment
}
groupInvites {
...GroupInviteWithPossibleErrorFragment
}
groupMembers {
...GroupMemberFragment
}
groupMemberships {
...GroupMembershipFragment
}
groupType
id
isSupplier
lastUpdated
managedAccounts {
...ManagedAccountFragment
}
name
ownerId
publicURL
purchaseTransactions {
...PurchaseTransactionFragment
}
socialLinks {
...SocialLinkFragment
}
subscriptionProviderAccounts {
...SubscriptionProviderAccountFragment
}
subscriptions {
...SwarmioSubscriptionFragment
}
updated
wallets {
...SwarmioWalletFragment
}
}
}
Variables
{
"id": "xyz789",
"updateTeamRequest": TeamUpdateRequest
}
Response
{
"data": {
"updateTeam": {
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "xyz789",
"eventParticipations": [Event],
"groupInvitations": [
GroupInvitationWithPossibleError
],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "abc123",
"id": "xyz789",
"isSupplier": false,
"lastUpdated": "2007-12-03T10:15:30Z",
"managedAccounts": [ManagedAccount],
"name": "xyz789",
"ownerId": "xyz789",
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
}
}
updateTeamEvent
Description
Update Team event
Response
Returns an
Event!
Arguments
| Name | Description |
|---|---|
eventId -
String!
|
The ID of an event |
updateEventRequest -
TeamEventUpdate!
|
Example
Query
mutation updateTeamEvent(
$eventId: String!,
$updateEventRequest: TeamEventUpdate!
) {
updateTeamEvent(
eventId: $eventId,
updateEventRequest: $updateEventRequest
) {
category
created
defaultLocale
description
eventCurrencyExchanges {
...EventCurrencyExchangesFragment
}
eventLimitations {
...EventLimitationsFragment
}
eventStages {
...EventStageFragment
}
eventState
eventTeam {
...EventTeamMemberFragment
}
eventTiming {
...EventTimingFragment
}
featured
game {
...GameFragment
}
gameAccountTypeIds
gameAccountTypes {
...GameAccountTypeFragment
}
gameId
id
isSimulated
localizedDescriptions {
...LocalizedOptionalStringFragment
}
localizedMediaContentDetails {
...LocalizedMediaContentDetailsFragment
}
localizedNames {
...LocalizedStringFragment
}
mediaContentDetails {
...MediaContentDetailsFragment
}
name
ownerId
participantCount
participantType
participants {
...ParticipantFragment
}
region
tags {
...TagFragment
}
unlisted
}
}
Variables
{
"eventId": "abc123",
"updateEventRequest": TeamEventUpdate
}
Response
{
"data": {
"updateTeamEvent": {
"category": "Challenge",
"created": "2007-12-03",
"defaultLocale": "ar_BH",
"description": "xyz789",
"eventCurrencyExchanges": EventCurrencyExchanges,
"eventLimitations": EventLimitations,
"eventStages": [EventStage],
"eventState": "ARCHIVED",
"eventTeam": [EventTeamMember],
"eventTiming": EventTiming,
"featured": false,
"game": Game,
"gameAccountTypeIds": ["xyz789"],
"gameAccountTypes": [GameAccountType],
"gameId": "abc123",
"id": "abc123",
"isSimulated": true,
"localizedDescriptions": [LocalizedOptionalString],
"localizedMediaContentDetails": [
LocalizedMediaContentDetails
],
"localizedNames": [LocalizedString],
"mediaContentDetails": MediaContentDetails,
"name": "xyz789",
"ownerId": "abc123",
"participantCount": 123,
"participantType": "IndividualParticipantType",
"participants": [Participant],
"region": "APAC",
"tags": [Tag],
"unlisted": false
}
}
}
updateTournament
Description
Update Team event
Response
Returns a
Competition!
Arguments
| Name | Description |
|---|---|
competitionId -
String!
|
The ID of a competition |
tournamentUpdateRequest -
TournamentUpdateRequestForCompetitionId!
|
Example
Query
mutation updateTournament(
$competitionId: String!,
$tournamentUpdateRequest: TournamentUpdateRequestForCompetitionId!
) {
updateTournament(
competitionId: $competitionId,
tournamentUpdateRequest: $tournamentUpdateRequest
) {
competitionState
competitionType
created
event {
...EventFragment
}
eventId
eventStageId
game {
...GameFragment
}
gameId
id
participantType
participants {
...CompetitionParticipantReferenceFragment
}
startTime
}
}
Variables
{
"competitionId": "abc123",
"tournamentUpdateRequest": TournamentUpdateRequestForCompetitionId
}
Response
{
"data": {
"updateTournament": {
"competitionState": "ARCHIVED",
"competitionType": "CHALLENGE",
"created": "2007-12-03",
"event": Event,
"eventId": "abc123",
"eventStageId": "abc123",
"game": Game,
"gameId": "abc123",
"id": "xyz789",
"participantType": "IndividualParticipantType",
"participants": [CompetitionParticipantReference],
"startTime": "2007-12-03"
}
}
}
uploadDraftProducts
Example
Query
mutation uploadDraftProducts($fileId: ID!) {
uploadDraftProducts(fileId: $fileId) {
availableStock
createdDate
currency
currencySymbol
id
item {
...ItemFragment
}
manufacturerBrandId
manufacturerBrandName
manufacturerBrandProductFields
manufacturerBrandProductFormatDesc
manufacturerBrandProductFormatId
manufacturerId
manufacturerName
modifiedDate
productId
productImageUrl
productName
productRedemptionInstructions
productVouchers {
...ProductVoucherFragment
}
productVvssku
purchaseNote
sellPrice
totalStock
unitPrice
voucherInventories {
...VoucherInventoryFragment
}
}
}
Variables
{"fileId": "4"}
Response
{
"data": {
"uploadDraftProducts": [
{
"availableStock": 123,
"createdDate": "xyz789",
"currency": "xyz789",
"currencySymbol": "xyz789",
"id": 4,
"item": Item,
"manufacturerBrandId": 987,
"manufacturerBrandName": "xyz789",
"manufacturerBrandProductFields": "abc123",
"manufacturerBrandProductFormatDesc": "abc123",
"manufacturerBrandProductFormatId": 987,
"manufacturerId": 4,
"manufacturerName": "xyz789",
"modifiedDate": "xyz789",
"productId": 4,
"productImageUrl": "xyz789",
"productName": "xyz789",
"productRedemptionInstructions": "abc123",
"productVouchers": [ProductVoucher],
"productVvssku": "abc123",
"purchaseNote": "abc123",
"sellPrice": 987.65,
"totalStock": 987,
"unitPrice": 123.45,
"voucherInventories": [VoucherInventory]
}
]
}
}
validateBulkEmails
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
emails -
[String!]!
|
Example
Query
mutation validateBulkEmails($emails: [String!]!) {
validateBulkEmails(emails: $emails)
}
Variables
{"emails": ["xyz789"]}
Response
{"data": {"validateBulkEmails": 987}}
verifyManuallyVerifiedResult
Description
Update the result for a participant in a given match
Example
Query
mutation verifyManuallyVerifiedResult($manuallyVerifiedResultId: String!) {
verifyManuallyVerifiedResult(manuallyVerifiedResultId: $manuallyVerifiedResultId)
}
Variables
{"manuallyVerifiedResultId": "abc123"}
Response
{"data": {"verifyManuallyVerifiedResult": 123}}
Types
Account
Description
An account
Fields
| Field Name | Description |
|---|---|
accountType -
String!
|
|
avatarURL -
String
|
|
bannerURL -
String
|
|
created -
Date!
|
|
description -
String
|
|
groupInvitations -
[GroupInvitationWithPossibleError!]!
|
|
groupMemberships -
[GroupMembership!]!
|
|
id -
String!
|
|
isSupplier -
Boolean!
|
|
managedAccounts -
[ManagedAccountWithPossibleError!]!
|
|
publicURL -
String
|
|
purchaseTransactions -
[PurchaseTransaction!]!
|
|
socialLinks -
[SocialLink!]!
|
|
subscriptionProviderAccounts -
[SubscriptionProviderAccount!]!
|
|
subscriptions -
[SwarmioSubscription!]!
|
|
updated -
Date!
|
|
wallets -
[SwarmioWallet!]!
|
Possible Types
| Account Types |
|---|
Example
{
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "abc123",
"groupInvitations": [GroupInvitationWithPossibleError],
"groupMemberships": [GroupMembership],
"id": "xyz789",
"isSupplier": false,
"managedAccounts": [ManagedAccountWithPossibleError],
"publicURL": "xyz789",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
AccountManager
AccountManagerWithPossibleError
Description
An AccountManager or an error
Fields
| Field Name | Description |
|---|---|
isError -
Boolean!
|
Possible Types
| AccountManagerWithPossibleError Types |
|---|
Example
{"isError": false}
AccountProjection
Fields
| Field Name | Description |
|---|---|
accountManagers -
[AccountManager!]
|
|
avatarURL -
String
|
|
birthday -
DateAttributeWithPossibleError
|
|
created -
Date
|
|
displayName -
String
|
|
email -
StringAttributeWithPossibleError
|
|
emailVerified -
Boolean
|
|
groupInvitations -
[GroupInvitationWithPossibleError!]
|
|
groupMemberships -
[GroupMembership!]
|
|
id -
String!
|
|
linkedAccounts -
[IdentityProviderWithPossibleError!]
|
|
managedAccounts -
[ManagedAccountWithPossibleError!]
|
|
msisdn -
String
|
|
publicURL -
String
|
|
realName -
StringAttributeWithPossibleError
|
|
updated -
Date
|
|
userType -
String
|
Example
{
"accountManagers": [AccountManager],
"avatarURL": "xyz789",
"birthday": DateAttributeWithPossibleError,
"created": "2007-12-03",
"displayName": "abc123",
"email": StringAttributeWithPossibleError,
"emailVerified": false,
"groupInvitations": [GroupInvitationWithPossibleError],
"groupMemberships": [GroupMembership],
"id": "xyz789",
"linkedAccounts": [IdentityProviderWithPossibleError],
"managedAccounts": [ManagedAccountWithPossibleError],
"msisdn": "xyz789",
"publicURL": "xyz789",
"realName": StringAttributeWithPossibleError,
"updated": "2007-12-03",
"userType": "xyz789"
}
ActionNotAllowedError
AutomaticallyVerifiedResultInput
AutomaticallyVerifiedResultsForRoundFromParticipant
Example
{
"competitionId": "xyz789",
"created": "2007-12-03",
"fromParticipantId": "abc123",
"plzDelete": true,
"roundId": "xyz789",
"unverifiedResults": [BasicAutomaticallyVerifiedResult]
}
AutomaticallyVerifiedResultsForRoundFromParticipantInput
Fields
| Input Field | Description |
|---|---|
competitionId -
String!
|
|
fromParticipantId -
String!
|
|
roundId -
String!
|
|
unverifiedResults -
[AutomaticallyVerifiedResultInput!]!
|
Example
{
"competitionId": "xyz789",
"fromParticipantId": "xyz789",
"roundId": "xyz789",
"unverifiedResults": [AutomaticallyVerifiedResultInput]
}
BaseEventTeamMember
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
id -
String!
|
|
roles -
[GamingRole!]!
|
Example
{
"accountId": "abc123",
"id": "abc123",
"roles": [GamingRole]
}
BasicAutomaticallyVerifiedResult
BasicPrizePayoutReceiptType
Description
The type of prize payout receipt
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CustomPrizePayoutReceiptType"
BasicResult
Example
{
"id": "abc123",
"maybeShowed": true,
"placement": 987,
"prizePayoutReceipt": PrizePayoutReceipt,
"resultImageURLs": ["xyz789"],
"score": 987.65,
"showed": false
}
BattleRoyaleFormatCreationDetailsRequest
Fields
| Input Field | Description |
|---|---|
advanceFraction -
Float!
|
|
bucketDimensionsMapId -
String
|
|
bucketDimensionsMapRequest -
BucketDimensionsMapRequest
|
|
maxParticipantsPerRound -
Int!
|
|
numberOfRoundsInPhaseRequests -
[NumberOfRoundsInPhaseRequest!]!
|
Example
{
"advanceFraction": 123.45,
"bucketDimensionsMapId": "xyz789",
"bucketDimensionsMapRequest": BucketDimensionsMapRequest,
"maxParticipantsPerRound": 987,
"numberOfRoundsInPhaseRequests": [
NumberOfRoundsInPhaseRequest
]
}
BattleRoyaleFormatUpdateDetailsRequest
Fields
| Input Field | Description |
|---|---|
advanceFraction -
Float
|
|
bucketDimensionsMapId -
String
|
|
bucketDimensionsMapRequest -
BucketDimensionsMapRequest
|
|
maxParticipantsPerRound -
Int
|
|
numberOfRoundsInPhaseRequests -
[NumberOfRoundsInPhaseRequest!]!
|
Example
{
"advanceFraction": 987.65,
"bucketDimensionsMapId": "abc123",
"bucketDimensionsMapRequest": BucketDimensionsMapRequest,
"maxParticipantsPerRound": 123,
"numberOfRoundsInPhaseRequests": [
NumberOfRoundsInPhaseRequest
]
}
BattleRoyaleSpecificDetails
Fields
| Field Name | Description |
|---|---|
advanceFraction -
Float!
|
|
definedBucketDimensionsMap -
BucketDimensionsMap!
|
|
id -
String!
|
|
matchUpFormat -
MatchUpFormat!
|
|
maxRoundParticipants -
Int!
|
|
maybeMaxRoundParticipants -
Int
|
|
maybeParticipantsInRound -
Int
|
|
numberOfRoundsInPhases -
[NumberOfRoundsInPhase!]!
|
Example
{
"advanceFraction": 123.45,
"definedBucketDimensionsMap": BucketDimensionsMap,
"id": "xyz789",
"matchUpFormat": "BattleRoyale",
"maxRoundParticipants": 123,
"maybeMaxRoundParticipants": 987,
"maybeParticipantsInRound": 987,
"numberOfRoundsInPhases": [NumberOfRoundsInPhase]
}
Boolean
Description
The Boolean scalar type represents true or false.
BotDifficultyType
Description
Bot difficulty type determines the skill level at which bots compete at
Values
| Enum Value | Description |
|---|---|
|
|
Sets bots to an easy level of competition |
|
|
Sets bots to an expert level of competition |
|
|
Sets bots to a hard level of competition |
|
|
Sets bots to a normal level of competition |
Example
"Easy"
Bots
Fields
| Field Name | Description |
|---|---|
difficulty -
BotDifficultyType!
|
|
quota -
Int!
|
Example
{"difficulty": "Easy", "quota": 987}
BoughtTransaction
Description
An Exchange of Real World Currency for Swarmio Currency
Fields
| Field Name | Description |
|---|---|
amount -
Float!
|
|
created -
Date!
|
|
id -
String!
|
|
swarmioCurrencyItemCostPurchaseRequest -
SwarmioCurrencyItemCostPurchaseRequest!
|
|
swarmioCurrencyItemCostPurchaseRequestId -
String!
|
|
transactionType -
SwarmioWalletTransactionType!
|
The type of transaction |
wallet -
SwarmioWallet!
|
|
walletId -
String!
|
Example
{
"amount": 987.65,
"created": "2007-12-03",
"id": "xyz789",
"swarmioCurrencyItemCostPurchaseRequest": SwarmioCurrencyItemCostPurchaseRequest,
"swarmioCurrencyItemCostPurchaseRequestId": "abc123",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "abc123"
}
BreakStrategy
Description
A generic event stage participant
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
breakStrategyType -
BreakStrategyType!
|
|
confirmed -
Boolean!
|
|
participantType -
ParticipantType!
|
|
result -
Result
|
Possible Types
| BreakStrategy Types |
|---|
Example
{
"accountId": "abc123",
"breakStrategyType": "MaximumParticipants",
"confirmed": true,
"participantType": "IndividualParticipantType",
"result": Result
}
BreakStrategyType
Description
The type of Break Strategy
Values
| Enum Value | Description |
|---|---|
|
|
Example
"MaximumParticipants"
BucketDimensionsMap
Fields
| Field Name | Description |
|---|---|
allBucketMultipliers -
[BucketMultipliers!]!
|
|
bucketLabel -
String!
|
|
id -
String!
|
Example
{
"allBucketMultipliers": [BucketMultipliers],
"bucketLabel": "xyz789",
"id": "abc123"
}
BucketDimensionsMapRequest
Fields
| Input Field | Description |
|---|---|
bucketLabel -
String!
|
|
bucketMultipliersRequests -
[BucketMultipliersRequest!]!
|
Example
{
"bucketLabel": "xyz789",
"bucketMultipliersRequests": [BucketMultipliersRequest]
}
BucketMultipliers
Fields
| Field Name | Description |
|---|---|
dimensionMultipliers -
[DimensionMultiplier!]!
|
|
id -
String!
|
|
resultBucket -
ResultBucket!
|
|
staticValue -
Float
|
Example
{
"dimensionMultipliers": [DimensionMultiplier],
"id": "xyz789",
"resultBucket": ResultBucket,
"staticValue": 987.65
}
BucketMultipliersRequest
Fields
| Input Field | Description |
|---|---|
dimensionMultiplierRequests -
[DimensionMultiplierRequest!]!
|
|
resultBucketRequest -
ResultBucketRequest!
|
|
staticValue -
Float
|
Example
{
"dimensionMultiplierRequests": [
DimensionMultiplierRequest
],
"resultBucketRequest": ResultBucketRequest,
"staticValue": 123.45
}
CSGOCompetitionDetails
CSGOMatchDetails
Fields
| Field Name | Description |
|---|---|
gameId -
String!
|
|
serverDetails -
ServerDetails!
|
Example
{
"gameId": "xyz789",
"serverDetails": ServerDetails
}
CSVFile
Example
{
"createdBy": 123,
"createdDate": "abc123",
"fileName": "xyz789",
"fileStatus": "COMPLETED",
"fileUrl": "abc123",
"id": "4",
"modifiedBy": 123,
"modifiedDate": "abc123",
"supplier": Supplier,
"totalProducts": 123,
"totalVouchers": 123
}
CashOutTransaction
Description
An Exchange of Swarmio Currency for Real World Currency
Fields
| Field Name | Description |
|---|---|
amount -
Float!
|
|
created -
Date!
|
|
id -
String!
|
|
swarmioCurrencyPayoutRequest -
SwarmioCurrencyPayoutRequest!
|
|
swarmioCurrencyPayoutRequestId -
String!
|
|
transactionType -
SwarmioWalletTransactionType!
|
The type of transaction |
wallet -
SwarmioWallet!
|
|
walletId -
String!
|
Example
{
"amount": 123.45,
"created": "2007-12-03",
"id": "abc123",
"swarmioCurrencyPayoutRequest": SwarmioCurrencyPayoutRequest,
"swarmioCurrencyPayoutRequestId": "abc123",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "abc123"
}
Catalog
CatalogFilterInput
Fields
| Input Field | Description |
|---|---|
categories -
[ID]
|
|
itemName -
String
|
|
itemStatus -
ItemStatus
|
|
itemType -
ItemType
|
Example
{
"categories": [4],
"itemName": "abc123",
"itemStatus": "DELETED",
"itemType": "PHYSICAL"
}
CatalogItem
Example
{
"isActive": false,
"itemDescBrief": "xyz789",
"itemDescDetail": "xyz789",
"itemGalleryUrls": ["xyz789"],
"itemId": "4",
"itemImageUrl": "abc123",
"itemName": "abc123",
"itemType": "PHYSICAL",
"pointsValue": 987.65,
"stock": 987,
"tagId": 4
}
CatalogSortInput
Category
Example
{
"categoryCoverImage": "xyz789",
"categoryDescription": "abc123",
"categoryIcon": "xyz789",
"categoryId": "xyz789",
"categoryImage": "xyz789",
"categoryName": "xyz789",
"id": 4,
"isActive": false,
"isDeleted": false,
"itemCatalogCategory": [ItemCatalogCategory],
"parentCategory": 123
}
CategoryCatalog
CategoryListInput
Fields
| Input Field | Description |
|---|---|
isDeleted -
Boolean
|
Example
{"isDeleted": false}
Challenge
Description
A challenge
Fields
| Field Name | Description |
|---|---|
challengeFormat -
ChallengeFormat!
|
|
competitionState -
EventElementState!
|
|
competitionType -
CompetitionType!
|
|
created -
Date!
|
|
event -
Event!
|
|
eventId -
String!
|
|
eventStageId -
String!
|
|
game -
Game!
|
|
gameId -
String!
|
|
id -
String!
|
|
manualAdvancement -
Boolean!
|
|
participantType -
ParticipantType!
|
|
participants -
[CompetitionParticipantReference!]!
|
|
startTime -
Date
|
Example
{
"challengeFormat": "Basic",
"competitionState": "ARCHIVED",
"competitionType": "CHALLENGE",
"created": "2007-12-03",
"event": Event,
"eventId": "abc123",
"eventStageId": "abc123",
"game": Game,
"gameId": "abc123",
"id": "xyz789",
"manualAdvancement": false,
"participantType": "IndividualParticipantType",
"participants": [CompetitionParticipantReference],
"startTime": "2007-12-03"
}
ChallengeCreationRequest
Fields
| Input Field | Description |
|---|---|
challengeFormat -
ChallengeFormat!
|
|
manualAdvancement -
Boolean!
|
|
startTime -
Date
|
Example
{
"challengeFormat": "Basic",
"manualAdvancement": true,
"startTime": "2007-12-03"
}
ChallengeFormat
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Basic"
ClientVisibleError
Possible Types
| ClientVisibleError Types |
|---|
Example
{"isError": false, "message": "abc123"}
Competition
Description
A generic competition
Fields
| Field Name | Description |
|---|---|
competitionState -
EventElementState!
|
|
competitionType -
CompetitionType!
|
|
created -
Date!
|
|
event -
Event!
|
|
eventId -
String!
|
|
eventStageId -
String!
|
|
game -
Game!
|
|
gameId -
String!
|
|
id -
String!
|
|
participantType -
ParticipantType!
|
|
participants -
[CompetitionParticipantReference!]!
|
|
startTime -
Date
|
Possible Types
| Competition Types |
|---|
Example
{
"competitionState": "ARCHIVED",
"competitionType": "CHALLENGE",
"created": "2007-12-03",
"event": Event,
"eventId": "abc123",
"eventStageId": "xyz789",
"game": Game,
"gameId": "xyz789",
"id": "xyz789",
"participantType": "IndividualParticipantType",
"participants": [CompetitionParticipantReference],
"startTime": "2007-12-03"
}
CompetitionFormat
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Basic"
CompetitionMatch
Description
Matches matches within a competition
Fields
| Field Name | Description |
|---|---|
gameSpecificDetails -
GameSpecificCompetitionDetails
|
|
id -
String!
|
|
isComplete -
Boolean!
|
|
startTime -
Date
|
Possible Types
| CompetitionMatch Types |
|---|
Example
{
"gameSpecificDetails": GameSpecificCompetitionDetails,
"id": "abc123",
"isComplete": true,
"startTime": "2007-12-03"
}
CompetitionParticipantReference
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
participant -
Participant!
|
|
participantId -
String!
|
|
result -
Result
|
Example
{
"accountId": "abc123",
"participant": Participant,
"participantId": "xyz789",
"result": Result
}
CompetitionParticipantReferenceWithRoster
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
participant -
Participant!
|
|
participantId -
String!
|
|
result -
Result
|
|
roster -
[String!]!
|
|
seededFromCompetitionMatchId -
String
|
Example
{
"accountId": "abc123",
"participant": Participant,
"participantId": "abc123",
"result": Result,
"roster": ["abc123"],
"seededFromCompetitionMatchId": "abc123"
}
CompetitionSpecificDetails
Fields
| Field Name | Description |
|---|---|
id -
String!
|
Possible Types
| CompetitionSpecificDetails Types |
|---|
Example
{"id": "xyz789"}
CompetitionType
Description
The type of competition
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CHALLENGE"
Contact
ContactInput
Cost
Fields
| Field Name | Description |
|---|---|
amount -
Float!
|
|
costType -
CostType!
|
|
created -
DateTime!
|
|
frequency -
PaymentFrequency!
|
|
id -
String!
|
Possible Types
| Cost Types |
|---|
Example
{
"amount": 987.65,
"costType": "RealWorldCurrencyCostType",
"created": "2007-12-03T10:15:30Z",
"frequency": "Annual",
"id": "xyz789"
}
CostType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"RealWorldCurrencyCostType"
CurrencyItemCost
Fields
| Field Name | Description |
|---|---|
cost -
Float!
|
|
created -
Date!
|
|
currencyItem -
SwarmioCurrencyItem!
|
Swarmio Currency Item |
currencyItemCostType -
CurrencyItemCostType!
|
|
id -
String!
|
|
realWorldCurrencyType -
RealWorldCurrency!
|
|
swarmioCurrencyItemId -
String!
|
|
version -
Int!
|
Possible Types
| CurrencyItemCost Types |
|---|
Example
{
"cost": 987.65,
"created": "2007-12-03",
"currencyItem": SwarmioCurrencyItem,
"currencyItemCostType": "ExternalCurrencyItemCost",
"id": "xyz789",
"realWorldCurrencyType": "AED",
"swarmioCurrencyItemId": "xyz789",
"version": 123
}
CurrencyItemCostArchive
Fields
| Field Name | Description |
|---|---|
cost -
Float!
|
|
created -
Date!
|
|
currencyItem -
SwarmioCurrencyItem!
|
Swarmio Currency Item |
currencyItemCostType -
CurrencyItemCostType!
|
|
id -
String!
|
|
realWorldCurrencyType -
RealWorldCurrency!
|
|
swarmioCurrencyItemId -
String!
|
|
version -
Int!
|
Possible Types
| CurrencyItemCostArchive Types |
|---|
Example
{
"cost": 987.65,
"created": "2007-12-03",
"currencyItem": SwarmioCurrencyItem,
"currencyItemCostType": "ExternalCurrencyItemCost",
"id": "xyz789",
"realWorldCurrencyType": "AED",
"swarmioCurrencyItemId": "abc123",
"version": 123
}
CurrencyItemCostType
Description
The type of item cost
Values
| Enum Value | Description |
|---|---|
|
|
Swarmio does not process the payment |
|
|
Swarmio processes the payment |
Example
"ExternalCurrencyItemCost"
CustomPrize
Fields
| Field Name | Description |
|---|---|
description -
String!
|
|
id -
String!
|
|
localizedDescriptions -
[LocalizedString!]!
|
|
prizeType -
PrizeType!
|
Example
{
"description": "abc123",
"id": "abc123",
"localizedDescriptions": [LocalizedString],
"prizeType": "CustomPrizeType"
}
CustomPrizeCreationRequest
Fields
| Input Field | Description |
|---|---|
localizedDescriptions -
[LocalizedStringInput!]!
|
Example
{"localizedDescriptions": [LocalizedStringInput]}
CustomPrizePayoutReceipt
Example
{
"accountId": "abc123",
"created": "2007-12-03",
"description": "xyz789",
"id": "xyz789",
"notes": "xyz789",
"prizePayoutReceiptType": "CustomPrizePayoutReceiptType",
"prizeTierId": "abc123",
"successful": false
}
D11ExternalSubscriptionPackage
Fields
| Field Name | Description |
|---|---|
active -
Boolean!
|
|
costs -
[Cost!]!
|
|
description -
String
|
|
id -
String!
|
|
name -
String!
|
|
providerSubscriptionId -
String!
|
|
subscriptionPartner -
SubscriptionPartner!
|
|
subscriptionProvider -
SubscriptionProvider!
|
|
subscriptionType -
SubscriptionType!
|
|
subscriptionTypeId -
String!
|
Possible Types
| D11ExternalSubscriptionPackage Types |
|---|
Example
{
"active": true,
"costs": [Cost],
"description": "abc123",
"id": "xyz789",
"name": "abc123",
"providerSubscriptionId": "abc123",
"subscriptionPartner": "D11",
"subscriptionProvider": "PayPal",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "abc123"
}
D11PayPalExternalSubscriptionPackage
Fields
| Field Name | Description |
|---|---|
active -
Boolean!
|
|
costs -
[Cost!]!
|
|
defaultLocale -
Locale!
|
|
description -
String
|
|
id -
String!
|
|
localizedDescriptions -
[LocalizedOptionalString!]!
|
|
localizedNames -
[LocalizedString!]!
|
|
name -
String!
|
|
planId -
String!
|
|
providerSubscriptionId -
String!
|
Used for identifying a SubscriptionProvider uniquely |
subscriptionPartner -
SubscriptionPartner!
|
|
subscriptionProvider -
SubscriptionProvider!
|
Type of Implicit Subscription Providers |
subscriptionType -
SubscriptionType!
|
Subscription Type this package belongs to |
subscriptionTypeId -
String!
|
Example
{
"active": true,
"costs": [Cost],
"defaultLocale": "ar_BH",
"description": "abc123",
"id": "abc123",
"localizedDescriptions": [LocalizedOptionalString],
"localizedNames": [LocalizedString],
"name": "xyz789",
"planId": "xyz789",
"providerSubscriptionId": "xyz789",
"subscriptionPartner": "D11",
"subscriptionProvider": "PayPal",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "abc123"
}
D11TIMWEExternalSubscriptionPackage
Fields
| Field Name | Description |
|---|---|
active -
Boolean!
|
|
costs -
[Cost!]!
|
|
defaultLocale -
Locale!
|
|
description -
String
|
|
id -
String!
|
|
largeAccount -
String!
|
|
localizedDescriptions -
[LocalizedOptionalString!]!
|
|
localizedNames -
[LocalizedString!]!
|
|
mcc -
String!
|
|
mnc -
String!
|
|
name -
String!
|
|
productId -
Int!
|
|
providerSubscriptionId -
String!
|
|
subKeyword -
String!
|
|
subscriptionPartner -
SubscriptionPartner!
|
|
subscriptionProvider -
SubscriptionProvider!
|
|
subscriptionType -
SubscriptionType!
|
|
subscriptionTypeId -
String!
|
Example
{
"active": true,
"costs": [Cost],
"defaultLocale": "ar_BH",
"description": "abc123",
"id": "abc123",
"largeAccount": "abc123",
"localizedDescriptions": [LocalizedOptionalString],
"localizedNames": [LocalizedString],
"mcc": "abc123",
"mnc": "abc123",
"name": "xyz789",
"productId": 123,
"providerSubscriptionId": "abc123",
"subKeyword": "abc123",
"subscriptionPartner": "D11",
"subscriptionProvider": "PayPal",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "abc123"
}
Date
Example
"2007-12-03"
DateAttribute
DateAttributeWithPossibleError
Description
A DateAttribute or an error
Fields
| Field Name | Description |
|---|---|
isError -
Boolean!
|
Possible Types
| DateAttributeWithPossibleError Types |
|---|
Example
{"isError": false}
DateTime
Example
"2007-12-03T10:15:30Z"
DimensionMultiplier
DimensionMultiplierRequest
DraftProduct
Example
{
"additionalData": "abc123",
"availableStock": 123,
"costPrice": "abc123",
"currency": "xyz789",
"id": "4",
"productName": "xyz789",
"publisherName": "xyz789",
"sku": "abc123",
"totalStock": 987,
"voucherCode": "xyz789",
"voucherExpiry": "abc123",
"voucherPin": "xyz789",
"voucherSerial": "abc123"
}
DurationInMilliseconds
Example
DurationInMilliseconds
DurationInSeconds
Example
DurationInSeconds
EmbeddedGame
Example
{
"availability": "Free",
"desc": "xyz789",
"embeddedGameURL": "xyz789",
"id": "xyz789",
"thumbnailURL": "xyz789",
"title": "xyz789"
}
EmbeddedGameAvailabilityState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Free"
EmbeddedGamesCreationRequest
Fields
| Input Field | Description |
|---|---|
availability -
EmbeddedGameAvailabilityState!
|
|
desc -
String
|
|
embeddedGameURL -
String
|
|
thumbnailURL -
String
|
|
title -
String!
|
Example
{
"availability": "Free",
"desc": "abc123",
"embeddedGameURL": "abc123",
"thumbnailURL": "xyz789",
"title": "xyz789"
}
EmbeddedGamesUpdateRequest
Fields
| Input Field | Description |
|---|---|
availability -
EmbeddedGameAvailabilityState
|
|
desc -
String
|
|
embeddedGameURL -
String
|
|
thumbnailURL -
String
|
|
title -
String
|
Example
{
"availability": "Free",
"desc": "abc123",
"embeddedGameURL": "abc123",
"thumbnailURL": "xyz789",
"title": "abc123"
}
EntryLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Premium"
Event
Fields
| Field Name | Description |
|---|---|
category -
EventCategory!
|
|
created -
Date!
|
|
defaultLocale -
Locale!
|
|
description -
String
|
|
eventCurrencyExchanges -
EventCurrencyExchanges!
|
|
eventLimitations -
EventLimitations!
|
|
eventStages -
[EventStage!]!
|
|
eventState -
EventElementState!
|
|
eventTeam -
[EventTeamMember!]!
|
|
eventTiming -
EventTiming!
|
|
featured -
Boolean!
|
|
game -
Game!
|
|
gameAccountTypeIds -
[String!]!
|
|
gameAccountTypes -
[GameAccountType!]!
|
|
gameId -
String!
|
|
id -
String!
|
|
isSimulated -
Boolean!
|
|
localizedDescriptions -
[LocalizedOptionalString!]!
|
|
localizedMediaContentDetails -
[LocalizedMediaContentDetails!]!
|
|
localizedNames -
[LocalizedString!]!
|
|
mediaContentDetails -
MediaContentDetails
|
|
name -
String!
|
|
ownerId -
String!
|
|
participantCount -
Int!
|
|
participantType -
ParticipantType!
|
|
participants -
[Participant!]!
|
|
region -
Region
|
|
tags -
[Tag!]!
|
|
Arguments
|
|
unlisted -
Boolean!
|
|
Example
{
"category": "Challenge",
"created": "2007-12-03",
"defaultLocale": "ar_BH",
"description": "abc123",
"eventCurrencyExchanges": EventCurrencyExchanges,
"eventLimitations": EventLimitations,
"eventStages": [EventStage],
"eventState": "ARCHIVED",
"eventTeam": [EventTeamMember],
"eventTiming": EventTiming,
"featured": true,
"game": Game,
"gameAccountTypeIds": ["xyz789"],
"gameAccountTypes": [GameAccountType],
"gameId": "xyz789",
"id": "abc123",
"isSimulated": true,
"localizedDescriptions": [LocalizedOptionalString],
"localizedMediaContentDetails": [
LocalizedMediaContentDetails
],
"localizedNames": [LocalizedString],
"mediaContentDetails": MediaContentDetails,
"name": "abc123",
"ownerId": "xyz789",
"participantCount": 987,
"participantType": "IndividualParticipantType",
"participants": [Participant],
"region": "APAC",
"tags": [Tag],
"unlisted": false
}
EventCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Challenge"
EventCreationRequestGameDetails
Fields
| Input Field | Description |
|---|---|
gameAccountTypeIds -
[String!]!
|
|
gameId -
String!
|
Example
{
"gameAccountTypeIds": ["xyz789"],
"gameId": "xyz789"
}
EventCreationRequestModifiers
EventCurrencyExchanges
Fields
| Field Name | Description |
|---|---|
prizeList -
PrizeList
|
Example
{"prizeList": PrizeList}
EventElementState
Description
State the event (or competition, or...) is in
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ARCHIVED"
EventEntryRules
Description
A set of entry rules
Fields
| Field Name | Description |
|---|---|
id -
String!
|
Possible Types
| EventEntryRules Types |
|---|
Example
{"id": "xyz789"}
EventLimitations
Fields
| Field Name | Description |
|---|---|
entryLevel -
EntryLevel!
|
|
eventEntryRules -
EventEntryRules
|
|
joinInstructions -
String
|
|
localizedJoinInstructions -
[LocalizedOptionalString!]!
|
|
localizedWrittenRules -
[LocalizedOptionalString!]!
|
|
maximumParticipants -
Int
|
|
minimumParticipants -
Int
|
|
writtenRules -
String
|
Example
{
"entryLevel": "Premium",
"eventEntryRules": EventEntryRules,
"joinInstructions": "abc123",
"localizedJoinInstructions": [LocalizedOptionalString],
"localizedWrittenRules": [LocalizedOptionalString],
"maximumParticipants": 123,
"minimumParticipants": 123,
"writtenRules": "abc123"
}
EventSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Default"
EventStage
Fields
| Field Name | Description |
|---|---|
breakStrategy -
BreakStrategy
|
|
competitions -
[Competition!]!
|
|
created -
Date!
|
|
eventId -
String!
|
|
eventStageState -
EventElementState!
|
|
game -
Game!
|
|
gameId -
String!
|
|
id -
String!
|
|
isComplete -
Boolean!
|
|
isSimulated -
Boolean!
|
|
participantType -
ParticipantType!
|
|
participants -
[EventStageParticipantReference!]!
|
|
stageNumber -
Int!
|
|
startTime -
Date
|
Example
{
"breakStrategy": BreakStrategy,
"competitions": [Competition],
"created": "2007-12-03",
"eventId": "xyz789",
"eventStageState": "ARCHIVED",
"game": Game,
"gameId": "xyz789",
"id": "abc123",
"isComplete": true,
"isSimulated": true,
"participantType": "IndividualParticipantType",
"participants": [EventStageParticipantReference],
"stageNumber": 987,
"startTime": "2007-12-03"
}
EventStageCreationRequest
Fields
| Input Field | Description |
|---|---|
challenge -
ChallengeCreationRequest
|
|
matchUp -
MatchUpCreationRequest
|
|
stageNumber -
Int!
|
|
startTime -
Date
|
|
tournament -
TournamentCreationRequest
|
Example
{
"challenge": ChallengeCreationRequest,
"matchUp": MatchUpCreationRequest,
"stageNumber": 987,
"startTime": "2007-12-03",
"tournament": TournamentCreationRequest
}
EventStageParticipantReference
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
participant -
Participant!
|
|
participantId -
String!
|
|
result -
Result
|
Example
{
"accountId": "abc123",
"participant": Participant,
"participantId": "abc123",
"result": Result
}
EventTagsFilterQuery
EventTeamMember
Description
A member of the event team
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
id -
String!
|
|
roles -
[GamingRole!]!
|
Possible Types
| EventTeamMember Types |
|---|
Example
{
"accountId": "abc123",
"id": "xyz789",
"roles": [GamingRole]
}
EventTiming
EventsQuery
Fields
| Input Field | Description |
|---|---|
categories -
[EventCategory!]
|
|
featured -
Boolean
|
|
gameIds -
[String!]
|
|
states -
[EventElementState!]
|
EventElementState |
Example
{
"categories": ["Challenge"],
"featured": true,
"gameIds": ["abc123"],
"states": ["ARCHIVED"]
}
ExchangedTransaction
Description
An Exchange of Swarmio Currency for various items
Fields
| Field Name | Description |
|---|---|
amount -
Float!
|
|
created -
Date!
|
|
id -
String!
|
|
otherWallet -
SwarmioWallet!
|
|
otherWalletId -
String!
|
|
swarmioCurrencyExchangeRateArchiveId -
String!
|
|
transactionType -
SwarmioWalletTransactionType!
|
The type of transaction |
wallet -
SwarmioWallet!
|
|
walletId -
String!
|
Example
{
"amount": 987.65,
"created": "2007-12-03",
"id": "xyz789",
"otherWallet": SwarmioWallet,
"otherWalletId": "xyz789",
"swarmioCurrencyExchangeRateArchiveId": "abc123",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "abc123"
}
ExplicitEnrollment
Fields
| Field Name | Description |
|---|---|
costs -
[Cost!]!
|
|
costsArchive -
[Cost!]!
|
|
externalField -
ExternalField
|
|
id -
String!
|
Example
{
"costs": [Cost],
"costsArchive": [Cost],
"externalField": ExternalField,
"id": "xyz789"
}
ExplicitEnrollmentCreationRequest
Fields
| Input Field | Description |
|---|---|
externalField -
ExternalFieldInput
|
|
realWorldCurrencyCosts -
[RealWorldCurrencyCostCreationRequest!]!
|
Example
{
"externalField": ExternalFieldInput,
"realWorldCurrencyCosts": [
RealWorldCurrencyCostCreationRequest
]
}
ExplicitEnrollmentUpdateRequest
Fields
| Input Field | Description |
|---|---|
externalField -
ExternalFieldInput
|
|
newRealWorldCurrencyCosts -
[RealWorldCurrencyCostCreationRequest!]!
|
|
removeCostIds -
[String!]!
|
Example
{
"externalField": ExternalFieldInput,
"newRealWorldCurrencyCosts": [
RealWorldCurrencyCostCreationRequest
],
"removeCostIds": ["abc123"]
}
ExplicitSubscription
Fields
| Field Name | Description |
|---|---|
expiry -
DateTime
|
|
id -
String!
|
|
isUsable -
Boolean!
|
|
lastPaymentDate -
Date
|
|
nextExpectedPayment -
Date
|
|
nextRewardDate -
DateTime
|
|
subscriptionImplementation -
SubscriptionImplementation!
|
|
subscriptionState -
SubscriptionState!
|
|
subscriptionType -
SubscriptionType!
|
|
subscriptionTypeCostId -
String!
|
|
subscriptionTypeId -
String!
|
|
unappliedPayments -
[UnappliedPayment!]!
|
Example
{
"expiry": "2007-12-03T10:15:30Z",
"id": "xyz789",
"isUsable": true,
"lastPaymentDate": "2007-12-03",
"nextExpectedPayment": "2007-12-03",
"nextRewardDate": "2007-12-03T10:15:30Z",
"subscriptionImplementation": "ImplicitSubscriptionImplementation",
"subscriptionState": "Active",
"subscriptionType": SubscriptionType,
"subscriptionTypeCostId": "abc123",
"subscriptionTypeId": "abc123",
"unappliedPayments": [UnappliedPayment]
}
ExportedItemsCSV
Fields
| Field Name | Description |
|---|---|
filePath -
String
|
Example
{"filePath": "xyz789"}
ExternalCurrencyItemCost
Fields
| Field Name | Description |
|---|---|
cost -
Float!
|
|
created -
Date!
|
|
currencyItem -
SwarmioCurrencyItem!
|
Swarmio Currency Item |
currencyItemCostType -
CurrencyItemCostType!
|
|
externalId -
String!
|
|
id -
String!
|
|
realWorldCurrencyType -
RealWorldCurrency!
|
|
swarmioCurrencyItemId -
String!
|
|
version -
Int!
|
Example
{
"cost": 987.65,
"created": "2007-12-03",
"currencyItem": SwarmioCurrencyItem,
"currencyItemCostType": "ExternalCurrencyItemCost",
"externalId": "xyz789",
"id": "xyz789",
"realWorldCurrencyType": "AED",
"swarmioCurrencyItemId": "abc123",
"version": 987
}
ExternalField
ExternalFieldInput
ExternalSubscriptionPackage
Fields
| Field Name | Description |
|---|---|
active -
Boolean!
|
Boolean to check if the ExternalSubscriptionPackage is currently active or not |
costs -
[Cost!]!
|
Type of Costs associated with this package |
description -
String
|
|
id -
String!
|
|
name -
String!
|
|
providerSubscriptionId -
String!
|
Used for identifying a SubscriptionProvider uniquely |
subscriptionPartner -
SubscriptionPartner!
|
Subscription Partner of this External Subscription Package |
subscriptionProvider -
SubscriptionProvider!
|
Type of Implicit Subscription Providers |
subscriptionType -
SubscriptionType!
|
Subscription Type this package belongs to |
subscriptionTypeId -
String!
|
Possible Types
| ExternalSubscriptionPackage Types |
|---|
Example
{
"active": false,
"costs": [Cost],
"description": "xyz789",
"id": "xyz789",
"name": "xyz789",
"providerSubscriptionId": "abc123",
"subscriptionPartner": "D11",
"subscriptionProvider": "PayPal",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "abc123"
}
FileStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPLETED"
FilterInput
Fields
| Input Field | Description |
|---|---|
fileStatus -
FileStatus
|
|
supplierId -
ID
|
Example
{
"fileStatus": "COMPLETED",
"supplierId": "4"
}
FixedPrize
Description
A fixed prize for a particular placement in an event
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
prizeType -
PrizeType!
|
Possible Types
| FixedPrize Types |
|---|
Example
{
"id": "xyz789",
"prizeType": "CustomPrizeType"
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
987.65
FreebieTransaction
Description
Freebie Transaction
Fields
| Field Name | Description |
|---|---|
amount -
Float!
|
|
approvedBy -
String!
|
|
created -
Date!
|
|
id -
String!
|
|
notes -
String
|
|
transactionType -
SwarmioWalletTransactionType!
|
The type of transaction |
wallet -
SwarmioWallet!
|
|
walletId -
String!
|
Example
{
"amount": 987.65,
"approvedBy": "xyz789",
"created": "2007-12-03",
"id": "abc123",
"notes": "xyz789",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "xyz789"
}
Game
Fields
| Field Name | Description |
|---|---|
bufferTime -
DurationInMilliseconds!
|
|
description -
String
|
|
estimatedRoundLength -
DurationInMilliseconds!
|
|
gameAccountTypeIds -
[String!]!
|
|
gameAccountTypes -
[GameAccountType!]!
|
|
id -
String!
|
|
image -
String
|
|
integrated -
Boolean!
|
|
maxParticipantsPerRound -
Float
|
|
prettyName -
String!
|
|
supportedCompetitionFormats -
[CompetitionFormat!]!
|
|
supportedParticipantTypes -
[ParticipantType!]!
|
|
typicalPlacingStrategyForRounds -
PlacingStrategy!
|
|
weight -
Float
|
Example
{
"bufferTime": DurationInMilliseconds,
"description": "xyz789",
"estimatedRoundLength": DurationInMilliseconds,
"gameAccountTypeIds": ["xyz789"],
"gameAccountTypes": [GameAccountType],
"id": "abc123",
"image": "abc123",
"integrated": true,
"maxParticipantsPerRound": 987.65,
"prettyName": "abc123",
"supportedCompetitionFormats": ["Basic"],
"supportedParticipantTypes": ["IndividualParticipantType"],
"typicalPlacingStrategyForRounds": "HighestAverageScore",
"weight": 987.65
}
GameAccount
Example
{
"created": "2007-12-03",
"externalAccountId": "xyz789",
"externalAccountName": "abc123",
"gameAccountTypeId": "xyz789",
"gameIds": ["xyz789"],
"games": [Game],
"id": "xyz789",
"updated": "2007-12-03",
"verified": false
}
GameAccountType
Example
{
"accountIDLabel": "abc123",
"accountNameLabel": "xyz789",
"games": [Game],
"iconUrl": "xyz789",
"id": "abc123",
"imageUrl": "xyz789",
"implicitGameIds": ["xyz789"],
"integrated": true,
"prettyName": "abc123",
"requiresExternalAccountId": false,
"requiresExternalAccountName": true
}
GameAccountTypeUpdateRequest
Example
{
"accountIDLabel": "abc123",
"accountNameLabel": "abc123",
"addImplicitGameIds": ["abc123"],
"iconUrl": "xyz789",
"imageUrl": "xyz789",
"prettyName": "xyz789",
"removeImplicitGameIds": ["xyz789"],
"requiresExternalAccountId": true,
"requiresExternalAccountName": true
}
GameAccountUpdateRequest
GameModeType
Description
GameMode determines the CSGO game mode
Values
| Enum Value | Description |
|---|---|
|
|
Sets CSGO GameMode to casual |
|
|
Sets CSGO GameMode to death match |
|
|
Sets CSGO GameMode ladder |
|
|
Sets CSGO GameMode retakes |
Example
"Casual"
GameSpecificCompetitionDetails
Fields
| Field Name | Description |
|---|---|
gameId -
String!
|
Possible Types
| GameSpecificCompetitionDetails Types |
|---|
Example
{"gameId": "xyz789"}
GameSpecificDetails
Fields
| Field Name | Description |
|---|---|
gameId -
String!
|
Possible Types
| GameSpecificDetails Types |
|---|
Example
{"gameId": "xyz789"}
GameUpdateRequest
Fields
| Input Field | Description |
|---|---|
addCompetitionFormats -
[CompetitionFormat!]
|
|
addGameAccountTypeIds -
[String!]
|
|
bufferTimeInSeconds -
Int!
|
|
description -
String
|
|
estimatedRoundLengthInSeconds -
Int!
|
|
image -
String
|
|
maxParticipantsPerRound -
Float
|
|
prettyName -
String
|
|
removeCompetitionFormats -
[CompetitionFormat!]
|
|
removeGameAccountTypeIds -
[String!]
|
|
supportedParticipantTypes -
[ParticipantType!]
|
|
typicalPlacingStrategyForRounds -
PlacingStrategy
|
|
weight -
Float
|
Example
{
"addCompetitionFormats": ["Basic"],
"addGameAccountTypeIds": ["xyz789"],
"bufferTimeInSeconds": 987,
"description": "xyz789",
"estimatedRoundLengthInSeconds": 123,
"image": "xyz789",
"maxParticipantsPerRound": 987.65,
"prettyName": "abc123",
"removeCompetitionFormats": ["Basic"],
"removeGameAccountTypeIds": ["abc123"],
"supportedParticipantTypes": ["IndividualParticipantType"],
"typicalPlacingStrategyForRounds": "HighestAverageScore",
"weight": 123.45
}
GamingAction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Create"
GamingActionable
Fields
| Field Name | Description |
|---|---|
action -
GamingAction!
|
|
id -
String!
|
|
scopeGroups -
[GamingScopeGroup!]!
|
|
target -
GamingPermissionTarget!
|
Example
{
"action": "Create",
"id": "xyz789",
"scopeGroups": [GamingScopeGroup],
"target": "Event"
}
GamingFullRole
Fields
| Field Name | Description |
|---|---|
businessScope -
[String!]!
|
|
id -
String!
|
|
permissions -
[GamingActionable!]!
|
|
prettyName -
String!
|
|
roleDisplayName -
String!
|
|
roleId -
String!
|
Example
{
"businessScope": ["abc123"],
"id": "abc123",
"permissions": [GamingActionable],
"prettyName": "abc123",
"roleDisplayName": "abc123",
"roleId": "xyz789"
}
GamingPermissionTarget
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Event"
GamingRole
Description
A gaming-related role
Fields
| Field Name | Description |
|---|---|
businessScope -
[String!]!
|
|
roleDisplayName -
String!
|
|
roleId -
String!
|
Possible Types
| GamingRole Types |
|---|
Example
{
"businessScope": ["xyz789"],
"roleDisplayName": "abc123",
"roleId": "xyz789"
}
GamingRoleFragment
Fields
| Field Name | Description |
|---|---|
businessScope -
[String!]!
|
|
roleDisplayName -
String!
|
|
roleId -
String!
|
Example
{
"businessScope": ["abc123"],
"roleDisplayName": "abc123",
"roleId": "xyz789"
}
GamingScope
Fields
| Field Name | Description |
|---|---|
scopeTarget -
GamingScopeTarget!
|
|
value -
String!
|
Example
{
"scopeTarget": "Location",
"value": "abc123"
}
GamingScopeGroup
Fields
| Field Name | Description |
|---|---|
scopes -
[GamingScope!]!
|
Example
{"scopes": [GamingScope]}
GamingScopeTarget
Values
| Enum Value | Description |
|---|---|
|
|
Example
"Location"
Group
Fields
| Field Name | Description |
|---|---|
accountType -
String!
|
|
avatarURL -
String
|
|
bannerURL -
String
|
|
created -
Date!
|
|
description -
String
|
|
groupInvitations -
[GroupInvitationWithPossibleError!]!
|
|
groupInvites -
[GroupInviteWithPossibleError!]!
|
|
groupMembers -
[GroupMember!]!
|
|
groupMemberships -
[GroupMembership!]!
|
|
groupType -
String!
|
|
id -
String!
|
|
isSupplier -
Boolean!
|
|
lastUpdated -
DateTime!
|
|
managedAccounts -
[ManagedAccount!]!
|
|
name -
String!
|
|
ownerId -
String!
|
|
publicURL -
String
|
|
purchaseTransactions -
[PurchaseTransaction!]!
|
|
socialLinks -
[SocialLink!]!
|
|
subscriptionProviderAccounts -
[SubscriptionProviderAccount!]!
|
|
subscriptions -
[SwarmioSubscription!]!
|
|
updated -
Date!
|
|
wallets -
[SwarmioWallet!]!
|
Example
{
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [GroupInvitationWithPossibleError],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "xyz789",
"id": "abc123",
"isSupplier": false,
"lastUpdated": "2007-12-03T10:15:30Z",
"managedAccounts": [ManagedAccount],
"name": "xyz789",
"ownerId": "abc123",
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
GroupCreationRequest
Example
{
"avatarURL": "xyz789",
"bannerURL": "abc123",
"description": "abc123",
"name": "xyz789",
"ownerId": "abc123",
"publicURL": "abc123",
"socialLinks": [SocialLinkInput]
}
GroupInvitation
GroupInvitationWithPossibleError
Description
A GroupInvitation or an error
Fields
| Field Name | Description |
|---|---|
isError -
Boolean!
|
Possible Types
| GroupInvitationWithPossibleError Types |
|---|
Example
{"isError": false}
GroupInvite
GroupInviteWithPossibleError
Description
A GroupInvite or an error
Fields
| Field Name | Description |
|---|---|
isError -
Boolean!
|
Possible Types
| GroupInviteWithPossibleError Types |
|---|
Example
{"isError": false}
GroupMember
GroupMembership
Fields
| Field Name | Description |
|---|---|
created -
Date!
|
|
group -
GroupTrait!
|
|
groupId -
String!
|
|
id -
String!
|
|
roles -
[Role!]!
|
Example
{
"created": "2007-12-03",
"group": GroupTrait,
"groupId": "xyz789",
"id": "xyz789",
"roles": [Role]
}
GroupTrait
Description
A group
Fields
| Field Name | Description |
|---|---|
accountType -
String!
|
|
avatarURL -
String
|
|
bannerURL -
String
|
|
created -
Date!
|
|
description -
String
|
|
groupInvitations -
[GroupInvitationWithPossibleError!]!
|
|
groupInvites -
[GroupInviteWithPossibleError!]!
|
|
groupMembers -
[GroupMember!]!
|
|
groupMemberships -
[GroupMembership!]!
|
|
groupType -
String!
|
|
id -
String!
|
|
managedAccounts -
[ManagedAccountWithPossibleError!]!
|
|
name -
String!
|
|
ownerId -
String!
|
|
publicURL -
String
|
|
socialLinks -
[SocialLink!]!
|
|
updated -
Date!
|
|
wallets -
[SwarmioWallet!]!
|
Example
{
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "xyz789",
"groupInvitations": [GroupInvitationWithPossibleError],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "abc123",
"id": "xyz789",
"managedAccounts": [ManagedAccountWithPossibleError],
"name": "abc123",
"ownerId": "abc123",
"publicURL": "xyz789",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
GroupUpdateRequest
Example
{
"avatarURL": "xyz789",
"bannerURL": "abc123",
"description": "abc123",
"name": "abc123",
"publicURL": "abc123",
"removePublicURL": true,
"socialLinks": [SocialLinkInput]
}
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
IdentityProvider
Fields
| Field Name | Description |
|---|---|
email -
String!
|
|
externalAccountId -
String!
|
|
isError -
Boolean!
|
|
providerType -
IdentityProviderType!
|
Example
{
"email": "abc123",
"externalAccountId": "xyz789",
"isError": false,
"providerType": "DISCORD"
}
IdentityProviderType
Description
Type of IdentityProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DISCORD"
IdentityProviderWithPossibleError
Description
An IdentityProvider or an error
Fields
| Field Name | Description |
|---|---|
isError -
Boolean!
|
Possible Types
| IdentityProviderWithPossibleError Types |
|---|
Example
{"isError": false}
ImplicitEnrollment
Fields
| Field Name | Description |
|---|---|
externalSubscriptionPackage -
ExternalSubscriptionPackage!
|
|
externalSubscriptionPackageId -
String!
|
|
id -
String!
|
|
invalidateCacheAt -
DurationInSeconds!
|
Example
{
"externalSubscriptionPackage": ExternalSubscriptionPackage,
"externalSubscriptionPackageId": "xyz789",
"id": "abc123",
"invalidateCacheAt": DurationInSeconds
}
ImplicitEnrollmentCreationRequest
Fields
| Input Field | Description |
|---|---|
externalSubscriptionPackageId -
String!
|
|
invalidateCacheAt -
DurationInSeconds!
|
Example
{
"externalSubscriptionPackageId": "xyz789",
"invalidateCacheAt": DurationInSeconds
}
ImplicitSubscription
Fields
| Field Name | Description |
|---|---|
cacheExpiry -
DateTime!
|
|
canUnsubscribe -
Boolean!
|
|
expiry -
DateTime
|
|
externalSubscriptionPackage -
ExternalSubscriptionPackage!
|
|
externalSubscriptionPackageId -
String!
|
|
id -
String!
|
|
isUsable -
Boolean!
|
|
lastVerified -
DateTime!
|
|
nextRewardDate -
DateTime
|
|
subscriptionImplementation -
SubscriptionImplementation!
|
|
subscriptionProviderAccountId -
String!
|
|
subscriptionState -
SubscriptionState!
|
|
subscriptionType -
SubscriptionType!
|
|
subscriptionTypeId -
String!
|
Example
{
"cacheExpiry": "2007-12-03T10:15:30Z",
"canUnsubscribe": false,
"expiry": "2007-12-03T10:15:30Z",
"externalSubscriptionPackage": ExternalSubscriptionPackage,
"externalSubscriptionPackageId": "xyz789",
"id": "xyz789",
"isUsable": true,
"lastVerified": "2007-12-03T10:15:30Z",
"nextRewardDate": "2007-12-03T10:15:30Z",
"subscriptionImplementation": "ImplicitSubscriptionImplementation",
"subscriptionProviderAccountId": "xyz789",
"subscriptionState": "Active",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "abc123"
}
InGameResult
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
matchId -
String!
|
|
scores -
[ParticipantScore!]!
|
Example
{
"id": "abc123",
"matchId": "abc123",
"scores": [ParticipantScore]
}
IndividualParticipant
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
confirmed -
Boolean!
|
|
created -
Date!
|
|
gameAccount -
GameAccount
|
|
gameAccountId -
String!
|
|
id -
String!
|
|
participantType -
ParticipantType!
|
|
person -
Person
|
|
result -
Result
|
Example
{
"accountId": "xyz789",
"confirmed": true,
"created": "2007-12-03",
"gameAccount": GameAccount,
"gameAccountId": "xyz789",
"id": "abc123",
"participantType": "IndividualParticipantType",
"person": Person,
"result": Result
}
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
InternalService
Fields
| Field Name | Description |
|---|---|
accountManagers -
[AccountManagerWithPossibleError!]!
|
|
accountType -
String!
|
|
avatarURL -
String
|
|
bannerURL -
String
|
|
contactIdentifier -
StringAttributeWithPossibleError!
|
|
created -
Date!
|
|
description -
String
|
|
displayName -
String
|
|
email -
StringAttributeWithPossibleError
|
|
emailVerified -
Boolean!
|
|
groupInvitations -
[GroupInvitationWithPossibleError!]!
|
|
groupMemberships -
[GroupMembership!]!
|
|
hasValidContact -
Boolean!
|
|
id -
String!
|
|
isSupplier -
Boolean!
|
|
lastUpdated -
DateTime!
|
|
managedAccounts -
[ManagedAccount!]!
|
|
msisdn -
StringAttributeWithPossibleError
|
|
msisdnVerified -
Boolean!
|
|
publicURL -
String
|
|
purchaseTransactions -
[PurchaseTransaction!]!
|
|
socialLinks -
[SocialLink!]!
|
|
subscriptionProviderAccounts -
[SubscriptionProviderAccount!]!
|
|
subscriptions -
[SwarmioSubscription!]!
|
|
updated -
Date!
|
|
userType -
String!
|
|
wallets -
[SwarmioWallet!]!
|
Example
{
"accountManagers": [AccountManagerWithPossibleError],
"accountType": "xyz789",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "xyz789",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"groupInvitations": [GroupInvitationWithPossibleError],
"groupMemberships": [GroupMembership],
"hasValidContact": true,
"id": "xyz789",
"isSupplier": true,
"lastUpdated": "2007-12-03T10:15:30Z",
"managedAccounts": [ManagedAccount],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"userType": "xyz789",
"wallets": [SwarmioWallet]
}
InternalServiceCreationRequest
Example
{
"avatarURL": "abc123",
"bannerURL": "abc123",
"description": "abc123",
"displayName": "xyz789",
"email": "xyz789",
"msisdn": "abc123",
"password": "abc123",
"publicURL": "xyz789",
"socialLinks": [SocialLinkInput]
}
InventoryStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AVAILABLE"
Item
Fields
| Field Name | Description |
|---|---|
createdBy -
Int
|
|
createdDate -
String
|
|
currencyConversionRate -
Float
|
|
deliveryMethod -
ItemDeliveryMethod
|
|
id -
ID
|
|
isActive -
Boolean
|
|
isDeleted -
Boolean
|
|
isStockAvailable -
Boolean
|
|
itemCatalogCategory -
[ItemCatalogCategory]
|
|
itemDescBrief -
String
|
|
itemDescDetail -
String
|
|
itemGalleryUrls -
[String]
|
|
itemId -
String
|
|
itemImageUrl -
String
|
|
itemName -
String
|
|
itemPartnerPoints -
[ItemPoints]
|
|
itemStatus -
ItemStatus
|
|
itemType -
ItemType
|
|
product -
Product
|
|
supplier -
Supplier
|
|
unitPrice -
Float
|
Example
{
"createdBy": 987,
"createdDate": "xyz789",
"currencyConversionRate": 123.45,
"deliveryMethod": "REDEEM",
"id": 4,
"isActive": true,
"isDeleted": true,
"isStockAvailable": true,
"itemCatalogCategory": [ItemCatalogCategory],
"itemDescBrief": "xyz789",
"itemDescDetail": "xyz789",
"itemGalleryUrls": ["abc123"],
"itemId": "abc123",
"itemImageUrl": "abc123",
"itemName": "xyz789",
"itemPartnerPoints": [ItemPoints],
"itemStatus": "DELETED",
"itemType": "PHYSICAL",
"product": Product,
"supplier": Supplier,
"unitPrice": 987.65
}
ItemCatalogCategory
ItemCatalogCategoryInput
ItemCost
Fields
| Field Name | Description |
|---|---|
amount -
Float!
|
|
currency -
SwarmioCurrency!
|
|
partnerId -
String
|
Example
{
"amount": 987.65,
"currency": SwarmioCurrency,
"partnerId": "abc123"
}
ItemDeliveryMethod
Values
| Enum Value | Description |
|---|---|
|
|
Example
"REDEEM"
ItemFilterInput
Example
{
"categories": [4],
"inStock": false,
"itemStatus": "DELETED",
"itemType": "PHYSICAL",
"partner": 4,
"partners": [4],
"suppliers": ["4"]
}
ItemIdInput
Fields
| Input Field | Description |
|---|---|
id -
ID
|
Example
{"id": 4}
ItemInput
Fields
| Input Field | Description |
|---|---|
createdBy -
Int
|
|
currencyConversionRate -
Float
|
|
deliveryMethod -
ItemDeliveryMethod
|
|
id -
ID
|
|
isActive -
Boolean
|
|
isDeleted -
Boolean
|
|
itemCatalogCategory -
[ItemCatalogCategoryInput]
|
|
itemDescBrief -
String
|
|
itemDescDetail -
String
|
|
itemGalleryUrls -
[String]
|
|
itemId -
String
|
|
itemImageUrl -
String
|
|
itemName -
String
|
|
itemStatus -
ItemStatus
|
|
itemType -
ItemType
|
|
product -
ProductIdInput
|
|
unitPrice -
Float
|
Example
{
"createdBy": 123,
"currencyConversionRate": 123.45,
"deliveryMethod": "REDEEM",
"id": "4",
"isActive": false,
"isDeleted": true,
"itemCatalogCategory": [ItemCatalogCategoryInput],
"itemDescBrief": "xyz789",
"itemDescDetail": "abc123",
"itemGalleryUrls": ["xyz789"],
"itemId": "abc123",
"itemImageUrl": "abc123",
"itemName": "xyz789",
"itemStatus": "DELETED",
"itemType": "PHYSICAL",
"product": ProductIdInput,
"unitPrice": 123.45
}
ItemListInput
Fields
| Input Field | Description |
|---|---|
itemCatalogCategory -
[ItemCatalogCategoryInput]
|
|
itemId -
ID!
|
|
itemStatus -
ItemStatus
|
Example
{
"itemCatalogCategory": [ItemCatalogCategoryInput],
"itemId": 4,
"itemStatus": "DELETED"
}
ItemPoints
Example
{
"createdDate": "xyz789",
"id": 4,
"item": Item,
"markedUpPrice": 987.65,
"partner": Partner,
"pointsConversionRate": 123.45,
"pointsValue": 123.45
}
ItemPointsInput
Fields
| Input Field | Description |
|---|---|
item -
ItemIdInput!
|
|
markedUpPrice -
Float
|
|
partner -
PartnerIdInput!
|
|
pointsConversionRate -
Float
|
|
pointsValue -
Float
|
Example
{
"item": ItemIdInput,
"markedUpPrice": 987.65,
"partner": PartnerIdInput,
"pointsConversionRate": 987.65,
"pointsValue": 123.45
}
ItemStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DELETED"
ItemType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PHYSICAL"
JoinTeamEventRequest
Fields
| Input Field | Description |
|---|---|
eventId -
String!
|
|
teamId -
String!
|
|
teamMembers -
[String!]!
|
Example
{
"eventId": "abc123",
"teamId": "xyz789",
"teamMembers": ["abc123"]
}
KingOfTheHillSpecificDetails
Fields
| Field Name | Description |
|---|---|
host -
Participant!
|
|
id -
String!
|
|
matchUpFormat -
MatchUpFormat!
|
|
maximumNumberOfPhases -
Int
|
|
maybeMaxRoundParticipants -
Int
|
|
maybeParticipantsInRound -
Int
|
|
numberOfRoundsInPhases -
[NumberOfRoundsInPhase!]!
|
|
remainingParticipants -
[UpcomingKingOfTheHillParticipant!]!
|
Example
{
"host": Participant,
"id": "abc123",
"matchUpFormat": "BattleRoyale",
"maximumNumberOfPhases": 987,
"maybeMaxRoundParticipants": 987,
"maybeParticipantsInRound": 123,
"numberOfRoundsInPhases": [NumberOfRoundsInPhase],
"remainingParticipants": [
UpcomingKingOfTheHillParticipant
]
}
LeaveEventRequest
Locale
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ar_BH"
LocalizedMediaContentDetails
Fields
| Field Name | Description |
|---|---|
locale -
Locale!
|
|
value -
MediaContentDetails!
|
Example
{"locale": "ar_BH", "value": MediaContentDetails}
LocalizedMediaContentDetailsRequest
Fields
| Input Field | Description |
|---|---|
locale -
Locale!
|
|
mediaContentDetailsRequest -
MediaContentDetailsRequest!
|
Example
{
"locale": "ar_BH",
"mediaContentDetailsRequest": MediaContentDetailsRequest
}
LocalizedOptionalString
LocalizedOptionalStringInput
LocalizedString
LocalizedStringInput
ManagedAccount
ManagedAccountWithPossibleError
Description
A ManagedAccount or an error
Fields
| Field Name | Description |
|---|---|
isError -
Boolean!
|
Possible Types
| ManagedAccountWithPossibleError Types |
|---|
Example
{"isError": false}
ManualResult
Example
{
"id": "abc123",
"placement": 123,
"prizePayoutReceipt": PrizePayoutReceipt,
"resultImageURLs": ["abc123"],
"score": 123.45,
"showed": false
}
ManuallyVerifiedResult
Example
{
"competitionId": "abc123",
"created": "2007-12-03",
"id": "xyz789",
"participantId": "xyz789",
"plzDelete": false,
"roundId": "abc123",
"unverifiedResult": Result
}
ManuallyVerifiedResultWithMultiDimensionalBucketBasedResultRequest
Fields
| Input Field | Description |
|---|---|
accountId -
String!
|
|
competitionId -
String!
|
|
roundId -
String
|
|
unverifiedResult -
MultiDimensionalBucketBasedResultForVerificationRequest!
|
Example
{
"accountId": "xyz789",
"competitionId": "abc123",
"roundId": "xyz789",
"unverifiedResult": MultiDimensionalBucketBasedResultForVerificationRequest
}
MappedStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
MatchStartTimeChange
MatchUp
Description
A MatchUp
Fields
| Field Name | Description |
|---|---|
competitionState -
EventElementState!
|
|
competitionType -
CompetitionType!
|
|
created -
Date!
|
|
event -
Event!
|
|
eventId -
String!
|
|
eventStageId -
String!
|
|
game -
Game!
|
|
gameId -
String!
|
|
gameSpecificDetails -
GameSpecificCompetitionDetails
|
|
id -
String!
|
|
isSimulated -
Boolean!
|
|
manualAdvancement -
Boolean!
|
|
matchUpFormat -
MatchUpFormat!
|
|
matchUpFormatSpecificDetails -
MatchUpFormatSpecificDetails
|
|
numberOfRounds -
Int!
|
|
participantType -
ParticipantType!
|
|
participants -
[CompetitionParticipantReference!]!
|
|
phaseBufferTime -
DurationInMilliseconds
|
|
phases -
[MatchUpPhase!]!
|
|
startTime -
Date
|
Example
{
"competitionState": "ARCHIVED",
"competitionType": "CHALLENGE",
"created": "2007-12-03",
"event": Event,
"eventId": "xyz789",
"eventStageId": "xyz789",
"game": Game,
"gameId": "abc123",
"gameSpecificDetails": GameSpecificCompetitionDetails,
"id": "abc123",
"isSimulated": false,
"manualAdvancement": true,
"matchUpFormat": "BattleRoyale",
"matchUpFormatSpecificDetails": MatchUpFormatSpecificDetails,
"numberOfRounds": 987,
"participantType": "IndividualParticipantType",
"participants": [CompetitionParticipantReference],
"phaseBufferTime": DurationInMilliseconds,
"phases": [MatchUpPhase],
"startTime": "2007-12-03"
}
MatchUpCreationRequest
Fields
| Input Field | Description |
|---|---|
battleRoyaleFormatDetailsRequest -
BattleRoyaleFormatCreationDetailsRequest
|
|
manualAdvancement -
Boolean!
|
|
numberOfRounds -
Int!
|
|
phaseBufferTime -
DurationInMilliseconds
|
|
startTime -
Date
|
|
teamKingOfTheHillFormatCreationDetails -
[TeamKingOfTheHillFormatDetailsCreationRequest!]
|
Example
{
"battleRoyaleFormatDetailsRequest": BattleRoyaleFormatCreationDetailsRequest,
"manualAdvancement": true,
"numberOfRounds": 123,
"phaseBufferTime": DurationInMilliseconds,
"startTime": "2007-12-03",
"teamKingOfTheHillFormatCreationDetails": [
TeamKingOfTheHillFormatDetailsCreationRequest
]
}
MatchUpFormat
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BattleRoyale"
MatchUpFormatSpecificDetails
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
matchUpFormat -
MatchUpFormat!
|
|
maybeMaxRoundParticipants -
Int
|
|
maybeParticipantsInRound -
Int
|
Possible Types
| MatchUpFormatSpecificDetails Types |
|---|
Example
{
"id": "abc123",
"matchUpFormat": "BattleRoyale",
"maybeMaxRoundParticipants": 987,
"maybeParticipantsInRound": 987
}
MatchUpMatch
Description
A MatchUp match
Fields
| Field Name | Description |
|---|---|
gameSpecificDetails -
GameSpecificCompetitionDetails
|
|
id -
String!
|
|
isComplete -
Boolean!
|
|
startTime -
Date
|
Possible Types
| MatchUpMatch Types |
|---|
Example
{
"gameSpecificDetails": GameSpecificCompetitionDetails,
"id": "abc123",
"isComplete": false,
"startTime": "2007-12-03"
}
MatchUpMatchBye
Fields
| Field Name | Description |
|---|---|
gameSpecificDetails -
GameSpecificCompetitionDetails
|
|
id -
String!
|
|
isComplete -
Boolean!
|
|
participants -
[CompetitionParticipantReferenceWithRoster!]!
|
|
startTime -
Date
|
Example
{
"gameSpecificDetails": GameSpecificCompetitionDetails,
"id": "xyz789",
"isComplete": false,
"participants": [
CompetitionParticipantReferenceWithRoster
],
"startTime": "2007-12-03"
}
MatchUpPhase
Description
A generic phase in a MatchUp
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
isComplete -
Boolean!
|
|
matches -
[MatchUpMatch!]!
|
|
phaseNumber -
Int!
|
Example
{
"id": "abc123",
"isComplete": true,
"matches": [MatchUpMatch],
"phaseNumber": 123
}
MatchUpRound
Description
A generic round in a MatchUp
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
isComplete -
Boolean!
|
|
participants -
[CompetitionParticipantReference!]!
|
|
roundNumber -
Int!
|
Example
{
"id": "abc123",
"isComplete": false,
"participants": [CompetitionParticipantReference],
"roundNumber": 987
}
MatchUpUpdateRequestForCompetitionId
Fields
| Input Field | Description |
|---|---|
battleRoyaleFormatDetailsRequest -
BattleRoyaleFormatUpdateDetailsRequest
|
|
manualAdvancement -
Boolean
|
|
phaseBufferTime -
DurationInMilliseconds
|
|
startTime -
Date
|
|
teamKingOfTheHillFormatUpdateDetails -
TeamKingOfTheHillFormatDetailsUpdateRequest
|
Example
{
"battleRoyaleFormatDetailsRequest": BattleRoyaleFormatUpdateDetailsRequest,
"manualAdvancement": true,
"phaseBufferTime": DurationInMilliseconds,
"startTime": "2007-12-03",
"teamKingOfTheHillFormatUpdateDetails": TeamKingOfTheHillFormatDetailsUpdateRequest
}
MaximumParticipantsBreakStrategy
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
breakStrategyType -
BreakStrategyType!
|
|
confirmed -
Boolean!
|
|
maxParticipants -
Int!
|
|
participantType -
ParticipantType!
|
|
result -
Result
|
Example
{
"accountId": "abc123",
"breakStrategyType": "MaximumParticipants",
"confirmed": false,
"maxParticipants": 123,
"participantType": "IndividualParticipantType",
"result": Result
}
MediaContentDetails
MediaContentDetailsRequest
Fields
| Input Field | Description |
|---|---|
avatarURL -
String
|
|
bannerURL -
String
|
|
descriptionImageURL -
String
|
|
streamsToDelete -
[String!]
|
|
twitchStreams -
[TwitchStreamCreationRequest!]
|
|
youtubeStreams -
[YouTubeStreamCreationRequest!]
|
|
youtubeVideos -
[YouTubeVideoCreationRequest!]
|
Example
{
"avatarURL": "abc123",
"bannerURL": "abc123",
"descriptionImageURL": "xyz789",
"streamsToDelete": ["xyz789"],
"twitchStreams": [TwitchStreamCreationRequest],
"youtubeStreams": [YouTubeStreamCreationRequest],
"youtubeVideos": [YouTubeVideoCreationRequest]
}
MultiDimensionalBucketBasedResult
Fields
| Field Name | Description |
|---|---|
bucketValue -
Float!
|
|
calculatedScore -
Float!
|
|
id -
String!
|
|
maybeShowed -
Boolean
|
|
multiDimensionalResults -
[SingleDimensionResult!]!
|
|
placement -
Int
|
|
prizePayoutReceipt -
PrizePayoutReceipt
|
|
resultImageURLs -
[String!]
|
|
score -
Float
|
|
showed -
Boolean!
|
Example
{
"bucketValue": 987.65,
"calculatedScore": 123.45,
"id": "xyz789",
"maybeShowed": false,
"multiDimensionalResults": [SingleDimensionResult],
"placement": 987,
"prizePayoutReceipt": PrizePayoutReceipt,
"resultImageURLs": ["xyz789"],
"score": 987.65,
"showed": false
}
MultiDimensionalBucketBasedResultForVerificationRequest
Fields
| Input Field | Description |
|---|---|
bucketValue -
Float!
|
|
multiDimensionalResults -
[SingleDimensionResultInput!]!
|
Example
{
"bucketValue": 987.65,
"multiDimensionalResults": [SingleDimensionResultInput]
}
NonIntegratedGameAccountTypeCreationRequest
Example
{
"accountIDLabel": "xyz789",
"accountNameLabel": "abc123",
"iconUrl": "abc123",
"imageUrl": "xyz789",
"implicitGameIds": ["xyz789"],
"prettyName": "xyz789",
"requiresExternalAccountId": true,
"requiresExternalAccountName": false
}
NonIntegratedGameCreationRequest
Fields
| Input Field | Description |
|---|---|
bufferTimeInSeconds -
Int!
|
|
description -
String
|
|
estimatedRoundLengthInSeconds -
Int!
|
|
gameAccountTypeIds -
[String!]!
|
|
image -
String
|
|
maxParticipantsPerRound -
Float
|
|
prettyName -
String!
|
|
supportedCompetitionFormats -
[CompetitionFormat!]!
|
|
supportedParticipantTypes -
[ParticipantType!]!
|
|
typicalPlacingStrategyForRounds -
PlacingStrategy!
|
|
weight -
Float
|
Example
{
"bufferTimeInSeconds": 123,
"description": "abc123",
"estimatedRoundLengthInSeconds": 987,
"gameAccountTypeIds": ["abc123"],
"image": "xyz789",
"maxParticipantsPerRound": 987.65,
"prettyName": "xyz789",
"supportedCompetitionFormats": ["Basic"],
"supportedParticipantTypes": ["IndividualParticipantType"],
"typicalPlacingStrategyForRounds": "HighestAverageScore",
"weight": 123.45
}
NumberOfRoundsInPhase
NumberOfRoundsInPhaseInBracket
Fields
| Field Name | Description |
|---|---|
bracketName -
TournamentBracketName!
|
|
numberOfRoundsInPhases -
[NumberOfRoundsInPhase!]!
|
Example
{
"bracketName": "SingleElimination",
"numberOfRoundsInPhases": [NumberOfRoundsInPhase]
}
NumberOfRoundsInPhaseInBracketRequest
Fields
| Input Field | Description |
|---|---|
bracketName -
TournamentBracketName!
|
|
numberOfRoundsInPhaseRequests -
[NumberOfRoundsInPhaseRequest!]!
|
Example
{
"bracketName": "SingleElimination",
"numberOfRoundsInPhaseRequests": [
NumberOfRoundsInPhaseRequest
]
}
NumberOfRoundsInPhaseRequest
ObjectRepresentation
Description
Generic object interface
Fields
| Field Name | Description |
|---|---|
id -
String!
|
Possible Types
| ObjectRepresentation Types |
|---|
Example
{"id": "xyz789"}
Order
Fields
| Field Name | Description |
|---|---|
billingAddress -
String
|
|
cancellationNote -
String
|
|
createdBy -
Int
|
|
createdDate -
String
|
|
formattedItemId -
String
|
|
gamerEmail -
String
|
|
gamerId -
String
|
|
gamerName -
String
|
|
id -
ID
|
|
isActive -
Boolean
|
|
item -
Item
|
|
itemName -
String
|
|
modifiedBy -
Int
|
|
modifiedDate -
String
|
|
orderDate -
String
|
|
orderId -
String
|
|
orderStatus -
OrderStatus
|
|
orderTransaction -
OrderTransaction
|
|
partner -
Partner
|
|
payment -
Payment
|
|
pointsValue -
Float
|
|
quantity -
Int
|
|
shipment -
Shipment
|
|
totalPoints -
Float
|
|
transactionId -
String
|
|
vouchers -
[ProductVoucher]
|
Example
{
"billingAddress": "abc123",
"cancellationNote": "abc123",
"createdBy": 123,
"createdDate": "xyz789",
"formattedItemId": "xyz789",
"gamerEmail": "abc123",
"gamerId": "abc123",
"gamerName": "xyz789",
"id": 4,
"isActive": false,
"item": Item,
"itemName": "xyz789",
"modifiedBy": 987,
"modifiedDate": "abc123",
"orderDate": "xyz789",
"orderId": "xyz789",
"orderStatus": "CANCELLED",
"orderTransaction": OrderTransaction,
"partner": Partner,
"payment": Payment,
"pointsValue": 123.45,
"quantity": 123,
"shipment": Shipment,
"totalPoints": 123.45,
"transactionId": "abc123",
"vouchers": [ProductVoucher]
}
OrderFilterInput
Fields
| Input Field | Description |
|---|---|
dateEndTimeMillis -
Float
|
|
dateStartTimeMillis -
Float
|
|
itemStatus -
ItemStatus
|
|
orderStatus -
OrderStatus
|
Example
{
"dateEndTimeMillis": 987.65,
"dateStartTimeMillis": 987.65,
"itemStatus": "DELETED",
"orderStatus": "CANCELLED"
}
OrderListInput
Fields
| Input Field | Description |
|---|---|
cancellationNote -
String
|
|
orderStatus -
OrderStatus
|
Example
{
"cancellationNote": "xyz789",
"orderStatus": "CANCELLED"
}
OrderStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELLED"
OrderTransaction
OutOfContextCompetitionMatches
Description
Matches out of the context of their phase and bracket
Fields
| Field Name | Description |
|---|---|
competitionId -
String!
|
|
competitionType -
String!
|
|
isSimulated -
Boolean!
|
|
matches -
[CompetitionMatch!]!
|
Possible Types
| OutOfContextCompetitionMatches Types |
|---|
Example
{
"competitionId": "xyz789",
"competitionType": "xyz789",
"isSimulated": false,
"matches": [CompetitionMatch]
}
OutOfContextMatchUpMatches
Fields
| Field Name | Description |
|---|---|
competitionId -
String!
|
|
competitionType -
String!
|
|
isSimulated -
Boolean!
|
|
matches -
[CompetitionMatch!]!
|
Example
{
"competitionId": "xyz789",
"competitionType": "abc123",
"isSimulated": false,
"matches": [CompetitionMatch]
}
OutOfContextPurchaseTransaction
Fields
| Field Name | Description |
|---|---|
account -
Account!
|
|
accountId -
String!
|
|
created -
Date!
|
|
order -
RootCode_Order
|
|
purchaseTransactionId -
String!
|
|
status -
PurchaseTransactionStatus!
|
Example
{
"account": Account,
"accountId": "xyz789",
"created": "2007-12-03",
"order": RootCode_Order,
"purchaseTransactionId": "xyz789",
"status": "Error"
}
OutOfContextTournamentMatches
Fields
| Field Name | Description |
|---|---|
competitionId -
String!
|
|
competitionType -
String!
|
|
isSimulated -
Boolean!
|
|
matches -
[CompetitionMatch!]!
|
Example
{
"competitionId": "abc123",
"competitionType": "abc123",
"isSimulated": false,
"matches": [CompetitionMatch]
}
PaginatedBoughtTransaction
Fields
| Field Name | Description |
|---|---|
hasNextPage -
Boolean!
|
|
nodes -
[BoughtTransaction!]!
|
|
totalCount -
Int!
|
Example
{
"hasNextPage": false,
"nodes": [BoughtTransaction],
"totalCount": 123
}
PaginatedCSVFiles
PaginatedCashOutTransaction
Fields
| Field Name | Description |
|---|---|
hasNextPage -
Boolean!
|
|
nodes -
[CashOutTransaction!]!
|
|
totalCount -
Int!
|
Example
{
"hasNextPage": true,
"nodes": [CashOutTransaction],
"totalCount": 123
}
PaginatedCatalogItems
Fields
| Field Name | Description |
|---|---|
currentPage -
Int
|
|
items -
[CatalogItem]
|
|
totalItems -
Int
|
|
totalPages -
Int
|
Example
{
"currentPage": 123,
"items": [CatalogItem],
"totalItems": 987,
"totalPages": 123
}
PaginatedCategoryItems
Fields
| Field Name | Description |
|---|---|
currentPage -
Int
|
|
items -
[CatalogItem]
|
|
totalItems -
Int
|
|
totalPages -
Int
|
Example
{
"currentPage": 987,
"items": [CatalogItem],
"totalItems": 123,
"totalPages": 123
}
PaginatedEmbeddedGame
Fields
| Field Name | Description |
|---|---|
hasNextPage -
Boolean!
|
|
nodes -
[EmbeddedGame!]!
|
|
totalCount -
Int!
|
Example
{
"hasNextPage": true,
"nodes": [EmbeddedGame],
"totalCount": 987
}
PaginatedEvent
PaginatedExchangedTransaction
Fields
| Field Name | Description |
|---|---|
hasNextPage -
Boolean!
|
|
nodes -
[ExchangedTransaction!]!
|
|
totalCount -
Int!
|
Example
{
"hasNextPage": false,
"nodes": [ExchangedTransaction],
"totalCount": 987
}
PaginatedFreebieTransaction
Fields
| Field Name | Description |
|---|---|
hasNextPage -
Boolean!
|
|
nodes -
[FreebieTransaction!]!
|
|
totalCount -
Int!
|
Example
{
"hasNextPage": true,
"nodes": [FreebieTransaction],
"totalCount": 987
}
PaginatedItems
Example
{
"currentPage": 123,
"items": [Item],
"totalDeletedItems": 987,
"totalItems": 987,
"totalPages": 123,
"totalPublishedItems": 123,
"totalUnpublishedItems": 123
}
PaginatedOrder
Example
{
"currentPage": 123,
"orders": [Order],
"totalCancelledOrders": 123,
"totalCompletedOrders": 123,
"totalDeletedOrders": 123,
"totalOrders": 987,
"totalPages": 987,
"totalProcessingOrders": 987,
"totalRefundedOrders": 123
}
PaginatedProducts
PaginatedSwarmioCurrency
Fields
| Field Name | Description |
|---|---|
hasNextPage -
Boolean!
|
|
nodes -
[SwarmioCurrency!]!
|
|
totalCount -
Int!
|
Example
{
"hasNextPage": false,
"nodes": [SwarmioCurrency],
"totalCount": 123
}
PaginatedSwarmioCurrencyExchangeBlock
Fields
| Field Name | Description |
|---|---|
hasNextPage -
Boolean!
|
|
nodes -
[SwarmioCurrencyExchangeBlock!]!
|
|
totalCount -
Int!
|
Example
{
"hasNextPage": false,
"nodes": [SwarmioCurrencyExchangeBlock],
"totalCount": 123
}
PaginatedSwarmioCurrencyItem
Fields
| Field Name | Description |
|---|---|
hasNextPage -
Boolean!
|
|
nodes -
[SwarmioCurrencyItem!]!
|
|
totalCount -
Int!
|
Example
{
"hasNextPage": false,
"nodes": [SwarmioCurrencyItem],
"totalCount": 987
}
PaginatedSwarmioCurrencyPayout
Fields
| Field Name | Description |
|---|---|
hasNextPage -
Boolean!
|
|
nodes -
[SwarmioCurrencyPayout!]!
|
|
totalCount -
Int!
|
Example
{
"hasNextPage": false,
"nodes": [SwarmioCurrencyPayout],
"totalCount": 987
}
PaginatedSwarmioWalletTransactionWithMetadata
Fields
| Field Name | Description |
|---|---|
hasNextPage -
Boolean!
|
|
nodes -
[SwarmioWalletTransactionWithMetadata!]!
|
|
totalCount -
Int!
|
Example
{
"hasNextPage": true,
"nodes": [SwarmioWalletTransactionWithMetadata],
"totalCount": 123
}
PaginatedTransferTransaction
Fields
| Field Name | Description |
|---|---|
hasNextPage -
Boolean!
|
|
nodes -
[TransferTransaction!]!
|
|
totalCount -
Int!
|
Example
{
"hasNextPage": true,
"nodes": [TransferTransaction],
"totalCount": 987
}
PaginatedUser
PaginatedVouchers
Fields
| Field Name | Description |
|---|---|
currentPage -
Int
|
|
totalPages -
Int
|
|
totalVouchers -
Int
|
|
vouchers -
[ProductVoucher]
|
Example
{
"currentPage": 987,
"totalPages": 987,
"totalVouchers": 123,
"vouchers": [ProductVoucher]
}
Participant
Description
A participant in an event or various parts of an event
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
confirmed -
Boolean!
|
|
participantType -
ParticipantType!
|
|
result -
Result
|
Possible Types
| Participant Types |
|---|
Example
{
"accountId": "xyz789",
"confirmed": true,
"participantType": "IndividualParticipantType",
"result": Result
}
ParticipantBasicResultSubmission
ParticipantReference
Description
A reference to a participant
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
participant -
Participant!
|
|
participantId -
String!
|
|
result -
Result
|
Possible Types
| ParticipantReference Types |
|---|
Example
{
"accountId": "abc123",
"participant": Participant,
"participantId": "abc123",
"result": Result
}
ParticipantScore
ParticipantType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IndividualParticipantType"
Partner
Example
{
"catalog": Catalog,
"createdBy": 123,
"createdDate": "xyz789",
"creditLimit": 123.45,
"id": 4,
"isActive": true,
"markedUpPercentage": 123.45,
"modifiedBy": 987,
"modifiedDate": "abc123",
"partnerId": "4",
"partnerName": "xyz789",
"partnerUrl": "abc123"
}
PartnerIdInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
Example
{"id": 4}
PayPalExternalSubscriptionPackage
Fields
| Field Name | Description |
|---|---|
active -
Boolean!
|
Boolean to check if the ExternalSubscriptionPackage is currently active or not |
costs -
[Cost!]!
|
Type of Costs associated with this package |
description -
String
|
|
id -
String!
|
|
name -
String!
|
|
planId -
String!
|
|
providerSubscriptionId -
String!
|
Used for identifying a SubscriptionProvider uniquely |
subscriptionPartner -
SubscriptionPartner!
|
Subscription Partner of this External Subscription Package |
subscriptionProvider -
SubscriptionProvider!
|
Type of Implicit Subscription Providers |
subscriptionType -
SubscriptionType!
|
Subscription Type this package belongs to |
subscriptionTypeId -
String!
|
Possible Types
| PayPalExternalSubscriptionPackage Types |
|---|
Example
{
"active": false,
"costs": [Cost],
"description": "xyz789",
"id": "abc123",
"name": "xyz789",
"planId": "abc123",
"providerSubscriptionId": "abc123",
"subscriptionPartner": "D11",
"subscriptionProvider": "PayPal",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "xyz789"
}
PayPalProviderAccount
Fields
| Field Name | Description |
|---|---|
customId -
String!
|
|
externalSubscriptionProviderAccountId -
String!
|
|
id -
String!
|
|
paypalSubscriptionId -
String
|
|
subscriptionProvider -
SubscriptionProvider!
|
|
subscriptionProviderAccountState -
SubscriptionProviderAccountState!
|
Example
{
"customId": "abc123",
"externalSubscriptionProviderAccountId": "xyz789",
"id": "abc123",
"paypalSubscriptionId": "xyz789",
"subscriptionProvider": "PayPal",
"subscriptionProviderAccountState": "AwaitingConfirmation"
}
Payment
PaymentFrequency
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Annual"
PaymentSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DateReceived"
PaymentStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Cancelled"
PaymentType
Description
The type of payment
Values
| Enum Value | Description |
|---|---|
|
|
Skrill |
|
|
SwarmioPay |
Example
"Skrill"
Person
Fields
| Field Name | Description |
|---|---|
accountManagers -
[AccountManagerWithPossibleError!]!
|
|
accountType -
String!
|
|
avatarURL -
String
|
|
bannerURL -
String
|
|
birthday -
DateAttributeWithPossibleError
|
|
contactIdentifier -
StringAttributeWithPossibleError!
|
|
created -
Date!
|
|
description -
String
|
|
displayName -
String
|
|
email -
StringAttributeWithPossibleError
|
|
emailVerified -
Boolean!
|
|
eventParticipations -
[Event!]!
|
|
gameAccounts -
[GameAccount!]!
|
|
groupInvitations -
[GroupInvitationWithPossibleError!]!
|
|
groupMemberships -
[GroupMembership!]!
|
|
hasValidContact -
Boolean!
|
|
id -
String!
|
|
isSupplier -
Boolean!
|
|
isVIP -
Boolean!
|
|
lastUpdated -
DateTime!
|
|
linkedAccounts -
[IdentityProviderWithPossibleError!]!
|
|
managedAccounts -
[ManagedAccount!]!
|
|
msisdn -
StringAttributeWithPossibleError
|
|
msisdnVerified -
Boolean!
|
|
publicURL -
String
|
|
purchaseTransactions -
[PurchaseTransaction!]!
|
|
realName -
StringAttributeWithPossibleError
|
|
servers -
[Server!]!
|
|
Arguments
|
|
socialLinks -
[SocialLink!]!
|
|
subscriptionProviderAccounts -
[SubscriptionProviderAccount!]!
|
|
subscriptions -
[SwarmioSubscription!]!
|
|
updated -
Date!
|
|
userType -
String!
|
|
wallets -
[SwarmioWallet!]!
|
|
Example
{
"accountManagers": [AccountManagerWithPossibleError],
"accountType": "abc123",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"birthday": DateAttributeWithPossibleError,
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "xyz789",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": true,
"eventParticipations": [Event],
"gameAccounts": [GameAccount],
"groupInvitations": [GroupInvitationWithPossibleError],
"groupMemberships": [GroupMembership],
"hasValidContact": true,
"id": "xyz789",
"isSupplier": true,
"isVIP": true,
"lastUpdated": "2007-12-03T10:15:30Z",
"linkedAccounts": [IdentityProviderWithPossibleError],
"managedAccounts": [ManagedAccount],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"realName": StringAttributeWithPossibleError,
"servers": [Server],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"userType": "abc123",
"wallets": [SwarmioWallet]
}
PersonCreationRequest
Example
{
"avatarURL": "abc123",
"bannerURL": "xyz789",
"birthday": "2007-12-03",
"description": "abc123",
"displayName": "xyz789",
"email": "xyz789",
"isVIP": false,
"msisdn": "abc123",
"password": "xyz789",
"publicURL": "xyz789",
"realName": "abc123",
"socialLinks": [SocialLinkInput]
}
PersonUpdateRequest
Fields
| Input Field | Description |
|---|---|
avatarURL -
String
|
|
bannerURL -
String
|
|
birthday -
Date
|
|
description -
String
|
|
displayName -
String
|
|
email -
String
|
|
isVIP -
Boolean
|
|
msisdn -
String
|
|
publicURL -
String
|
|
realName -
String
|
|
removeEmail -
Boolean
|
|
removeMsisdn -
Boolean
|
|
removePublicURL -
Boolean
|
|
socialLinks -
[SocialLinkInput!]
|
Example
{
"avatarURL": "abc123",
"bannerURL": "xyz789",
"birthday": "2007-12-03",
"description": "abc123",
"displayName": "xyz789",
"email": "abc123",
"isVIP": true,
"msisdn": "xyz789",
"publicURL": "xyz789",
"realName": "xyz789",
"removeEmail": false,
"removeMsisdn": true,
"removePublicURL": true,
"socialLinks": [SocialLinkInput]
}
PhasedCompetitionFormatSpecificDetails
PlacingStrategy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"HighestAverageScore"
PlayableMatchUpMatch
Fields
| Field Name | Description |
|---|---|
gameSpecificDetails -
GameSpecificCompetitionDetails
|
|
id -
String!
|
|
isComplete -
Boolean!
|
|
participants -
[CompetitionParticipantReferenceWithRoster!]!
|
|
rounds -
[MatchUpRound!]!
|
|
startTime -
Date
|
Example
{
"gameSpecificDetails": GameSpecificCompetitionDetails,
"id": "xyz789",
"isComplete": true,
"participants": [
CompetitionParticipantReferenceWithRoster
],
"rounds": [MatchUpRound],
"startTime": "2007-12-03"
}
PlayableTournamentMatch
Fields
| Field Name | Description |
|---|---|
gameSpecificDetails -
GameSpecificCompetitionDetails
|
|
id -
String!
|
|
isComplete -
Boolean!
|
|
participants -
[CompetitionParticipantReferenceWithRoster!]!
|
|
rounds -
[TournamentRound!]!
|
|
startTime -
Date
|
Example
{
"gameSpecificDetails": GameSpecificCompetitionDetails,
"id": "abc123",
"isComplete": true,
"participants": [
CompetitionParticipantReferenceWithRoster
],
"rounds": [TournamentRound],
"startTime": "2007-12-03"
}
Points
Example
{
"archive": [PointsArchive],
"createdDate": "xyz789",
"defaultValue": 123.45,
"id": 4,
"modifiedDate": "abc123",
"overriddenValue": 123.45,
"partner": Partner,
"supplier": Supplier
}
PointsArchive
PointsInput
Fields
| Input Field | Description |
|---|---|
defaultValue -
Float!
|
|
overriddenValue -
Float
|
|
partner -
PartnerIdInput
|
|
supplier -
SupplierIdInput
|
Example
{
"defaultValue": 123.45,
"overriddenValue": 123.45,
"partner": PartnerIdInput,
"supplier": SupplierIdInput
}
PrivateGameServer
Fields
| Field Name | Description |
|---|---|
autoKick -
Boolean!
|
|
bots -
Bots
|
|
friendlyFire -
Boolean!
|
|
gameId -
String!
|
|
gameMode -
GameModeType!
|
|
id -
String!
|
|
ip -
String
|
|
maps -
[String!]!
|
|
maxNumberOfPlayers -
Int!
|
|
numberOfPlayers -
Int!
|
|
ownerId -
String!
|
|
password -
String
|
|
port -
Int
|
|
rconPassword -
String
|
|
region -
String
|
|
serverType -
String!
|
|
status -
ServerStatusType!
|
|
timeAcquired -
Date
|
|
timeDestroyed -
Date
|
|
timeRequested -
Date!
|
Example
{
"autoKick": true,
"bots": Bots,
"friendlyFire": false,
"gameId": "xyz789",
"gameMode": "Casual",
"id": "xyz789",
"ip": "abc123",
"maps": ["abc123"],
"maxNumberOfPlayers": 987,
"numberOfPlayers": 987,
"ownerId": "abc123",
"password": "xyz789",
"port": 123,
"rconPassword": "xyz789",
"region": "abc123",
"serverType": "xyz789",
"status": "Creating",
"timeAcquired": "2007-12-03",
"timeDestroyed": "2007-12-03",
"timeRequested": "2007-12-03"
}
PrivateServerCreationRequest
Fields
| Input Field | Description |
|---|---|
autoKick -
Boolean!
|
|
botDifficulty -
BotDifficultyType!
|
|
botQuota -
Int!
|
|
friendlyFire -
Boolean!
|
|
gameId -
String!
|
|
gameMode -
GameModeType!
|
|
maps -
[String!]!
|
|
maxNumberOfPlayers -
Int!
|
|
ownerId -
String!
|
Example
{
"autoKick": true,
"botDifficulty": "Easy",
"botQuota": 987,
"friendlyFire": true,
"gameId": "abc123",
"gameMode": "Casual",
"maps": ["abc123"],
"maxNumberOfPlayers": 123,
"ownerId": "xyz789"
}
Prize
Description
The prize for a particular placement in an event
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
prizeType -
PrizeType!
|
Possible Types
| Prize Types |
|---|
Example
{
"id": "xyz789",
"prizeType": "CustomPrizeType"
}
PrizeList
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
prizeTiers -
[PrizeTier!]!
|
Example
{
"id": "xyz789",
"prizeTiers": [PrizeTier]
}
PrizeListCreationRequest
Fields
| Input Field | Description |
|---|---|
prizeTiers -
[PrizeTierCreationRequest!]!
|
Example
{"prizeTiers": [PrizeTierCreationRequest]}
PrizeListUpdateRequest
Fields
| Input Field | Description |
|---|---|
prizeTiers -
[PrizeTierCreationRequest!]!
|
|
prizeTiersToRemove -
[String!]!
|
Example
{
"prizeTiers": [PrizeTierCreationRequest],
"prizeTiersToRemove": ["xyz789"]
}
PrizePayoutReceipt
Description
A receipt for a prize payout
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
created -
Date!
|
|
id -
String!
|
|
notes -
String
|
|
prizePayoutReceiptType -
BasicPrizePayoutReceiptType!
|
|
prizeTierId -
String!
|
|
successful -
Boolean!
|
Possible Types
| PrizePayoutReceipt Types |
|---|
Example
{
"accountId": "xyz789",
"created": "2007-12-03",
"id": "abc123",
"notes": "xyz789",
"prizePayoutReceiptType": "CustomPrizePayoutReceiptType",
"prizeTierId": "xyz789",
"successful": true
}
PrizeTier
PrizeTierCreationRequest
Fields
| Input Field | Description |
|---|---|
customPrize -
CustomPrizeCreationRequest
|
|
placement -
Int!
|
|
placementRange -
Int
|
|
swarmioCurrencyPayoutPrize -
SwarmioCurrencyPayoutPrizeCreationRequest
|
|
variablePrize -
VariablePrizeCreationRequest
|
Example
{
"customPrize": CustomPrizeCreationRequest,
"placement": 123,
"placementRange": 987,
"swarmioCurrencyPayoutPrize": SwarmioCurrencyPayoutPrizeCreationRequest,
"variablePrize": VariablePrizeCreationRequest
}
PrizeType
Description
The type of prize
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CustomPrizeType"
Product
Fields
| Field Name | Description |
|---|---|
availableStock -
Int
|
|
createdDate -
String
|
|
currency -
String
|
|
currencySymbol -
String
|
|
id -
ID
|
|
item -
Item
|
|
manufacturerBrandId -
Int
|
|
manufacturerBrandName -
String
|
|
manufacturerBrandProductFields -
String
|
|
manufacturerBrandProductFormatDesc -
String
|
|
manufacturerBrandProductFormatId -
Int
|
|
manufacturerId -
ID
|
|
manufacturerName -
String
|
|
modifiedDate -
String
|
|
productId -
ID
|
|
productImageUrl -
String
|
|
productName -
String
|
|
productRedemptionInstructions -
String
|
|
productVouchers -
[ProductVoucher]
|
|
productVvssku -
String
|
|
purchaseNote -
String
|
|
sellPrice -
Float
|
|
totalStock -
Int
|
|
unitPrice -
Float
|
|
voucherInventories -
[VoucherInventory]
|
Example
{
"availableStock": 123,
"createdDate": "abc123",
"currency": "xyz789",
"currencySymbol": "abc123",
"id": "4",
"item": Item,
"manufacturerBrandId": 123,
"manufacturerBrandName": "abc123",
"manufacturerBrandProductFields": "xyz789",
"manufacturerBrandProductFormatDesc": "xyz789",
"manufacturerBrandProductFormatId": 123,
"manufacturerId": "4",
"manufacturerName": "xyz789",
"modifiedDate": "xyz789",
"productId": 4,
"productImageUrl": "abc123",
"productName": "abc123",
"productRedemptionInstructions": "xyz789",
"productVouchers": [ProductVoucher],
"productVvssku": "xyz789",
"purchaseNote": "abc123",
"sellPrice": 987.65,
"totalStock": 123,
"unitPrice": 987.65,
"voucherInventories": [VoucherInventory]
}
ProductDelete
ProductIdInput
Fields
| Input Field | Description |
|---|---|
id -
ID
|
Example
{"id": "4"}
ProductVoucher
Example
{
"createdDate": "abc123",
"id": 4,
"status": "DELETED",
"voucherCode": "xyz789",
"voucherExpiry": "xyz789",
"voucherPin": "abc123",
"voucherSerial": "xyz789"
}
ProductsFilterInput
Fields
| Input Field | Description |
|---|---|
csvFileId -
ID
|
|
productStatus -
ItemStatus
|
|
status -
MappedStatus
|
Example
{"csvFileId": 4, "productStatus": "DELETED", "status": "ALL"}
Provisioner
Description
Provisioner name
Values
| Enum Value | Description |
|---|---|
|
|
RootCode |
Example
"RootCode"
PrunedSingleEliminationDetailsRequest
Fields
| Input Field | Description |
|---|---|
accountIdsImmuneToPruning -
[String!]
|
|
numberOfRoundsInPhaseInBracketRequests -
[NumberOfRoundsInPhaseInBracketRequest!]!
|
Example
{
"accountIdsImmuneToPruning": ["xyz789"],
"numberOfRoundsInPhaseInBracketRequests": [
NumberOfRoundsInPhaseInBracketRequest
]
}
PrunedSingleEliminationSpecificDetails
Fields
| Field Name | Description |
|---|---|
accountsIdsWithPruningImmunity -
[String!]!
|
|
id -
String!
|
|
maybeMaxRoundParticipants -
Int
|
|
maybeParticipantsInRound -
Int
|
|
numberOfRoundsInPhaseInBracket -
[NumberOfRoundsInPhaseInBracket!]!
|
|
participantsInHold -
[CompetitionParticipantReferenceWithRoster!]!
|
|
tournamentFormat -
TournamentFormat!
|
Example
{
"accountsIdsWithPruningImmunity": [
"abc123"
],
"id": "xyz789",
"maybeMaxRoundParticipants": 123,
"maybeParticipantsInRound": 123,
"numberOfRoundsInPhaseInBracket": [
NumberOfRoundsInPhaseInBracket
],
"participantsInHold": [
CompetitionParticipantReferenceWithRoster
],
"tournamentFormat": "PrunedSingleElimination"
}
PublicGameServer
Fields
| Field Name | Description |
|---|---|
connectString -
String
|
|
description -
String!
|
|
featured -
Boolean!
|
|
id -
String!
|
|
imageURL -
String!
|
|
ip -
String
|
|
maxNumberOfPlayers -
Int!
|
|
name -
String!
|
|
port -
Int
|
|
rconPassword -
String
|
|
region -
String
|
|
serverType -
String!
|
|
status -
ServerStatusType!
|
|
steamURL -
String
|
|
timeAcquired -
Date
|
|
timeDestroyed -
Date
|
|
timeRequested -
Date!
|
Example
{
"connectString": "abc123",
"description": "abc123",
"featured": true,
"id": "xyz789",
"imageURL": "xyz789",
"ip": "xyz789",
"maxNumberOfPlayers": 987,
"name": "xyz789",
"port": 987,
"rconPassword": "abc123",
"region": "xyz789",
"serverType": "abc123",
"status": "Creating",
"steamURL": "abc123",
"timeAcquired": "2007-12-03",
"timeDestroyed": "2007-12-03",
"timeRequested": "2007-12-03"
}
PublicServerCreationRequest
Example
{
"connectString": "abc123",
"description": "abc123",
"featured": true,
"id": "abc123",
"imageURL": "abc123",
"ip": "abc123",
"maxNumberOfPlayers": 987,
"name": "xyz789",
"port": 123,
"region": "xyz789",
"steamURL": "xyz789"
}
PublicServerUpdateRequest
Example
{
"connectString": "xyz789",
"description": "xyz789",
"featured": false,
"imageURL": "xyz789",
"ip": "xyz789",
"maxNumberOfPlayers": 123,
"name": "xyz789",
"port": 987,
"region": "xyz789",
"steamURL": "abc123"
}
PurchaseTransaction
Fields
| Field Name | Description |
|---|---|
created -
Date!
|
|
id -
String!
|
|
item -
SwarmioItem!
|
|
itemId -
String!
|
|
notes -
[String!]!
|
|
order -
RootCode_Order
|
|
paymentTransactionId -
String!
|
|
status -
PurchaseTransactionStatus!
|
Example
{
"created": "2007-12-03",
"id": "xyz789",
"item": SwarmioItem,
"itemId": "xyz789",
"notes": ["abc123"],
"order": RootCode_Order,
"paymentTransactionId": "abc123",
"status": "Error"
}
PurchaseTransactionStatus
Description
Purchase Transaction status
Values
| Enum Value | Description |
|---|---|
|
|
A PurchaseTransaction could not be fulfilled due to some issue |
|
|
A PurchaseTransaction has been successfully fulfilled |
|
|
A PurchaseTransaction has been created |
|
|
A PurchaseTransaction is pending fulfillment |
Example
"Error"
RealWorldCurrency
Description
The type of currency
Values
| Enum Value | Description |
|---|---|
|
|
AED |
|
|
BHD |
|
|
CAD |
|
|
LKR |
|
|
MYR |
|
|
PHP |
|
|
SAR |
|
|
THB |
|
|
TND |
|
|
USD |
Example
"AED"
RealWorldCurrencyCost
Fields
| Field Name | Description |
|---|---|
amount -
Float!
|
|
costType -
CostType!
|
|
created -
DateTime!
|
|
currency -
RealWorldCurrencyTypeFinalMix!
|
|
frequency -
PaymentFrequency!
|
|
id -
String!
|
|
updated -
DateTime
|
Example
{
"amount": 123.45,
"costType": "RealWorldCurrencyCostType",
"created": "2007-12-03T10:15:30Z",
"currency": "AED",
"frequency": "Annual",
"id": "xyz789",
"updated": "2007-12-03T10:15:30Z"
}
RealWorldCurrencyCostCreationRequest
Fields
| Input Field | Description |
|---|---|
amount -
Float!
|
|
frequency -
PaymentFrequency!
|
|
realWorldCurrency -
RealWorldCurrencyTypeFinalMix!
|
Example
{"amount": 123.45, "frequency": "Annual", "realWorldCurrency": "AED"}
RealWorldCurrencyTypeFinalMix
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AED"
RecurringReward
Fields
| Field Name | Description |
|---|---|
amount -
Float!
|
|
id -
String!
|
|
paymentFrequency -
PaymentFrequency!
|
|
swarmioCurrencyId -
String!
|
Example
{
"amount": 123.45,
"id": "xyz789",
"paymentFrequency": "Annual",
"swarmioCurrencyId": "xyz789"
}
RecurringRewardCreationRequest
Fields
| Input Field | Description |
|---|---|
amount -
Float!
|
|
paymentFrequency -
PaymentFrequency!
|
|
swarmioCurrencyId -
String!
|
Example
{
"amount": 123.45,
"paymentFrequency": "Annual",
"swarmioCurrencyId": "xyz789"
}
Region
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APAC"
RegistrationDetails
Result
Possible Types
| Result Types |
|---|
Example
{"placement": 123, "score": 123.45, "showed": true}
ResultBucket
ResultBucketRequest
Role
RootCode_Order
Example
{
"createdDate": "xyz789",
"gamerId": "abc123",
"id": "abc123",
"orderDate": "abc123",
"orderStatus": "xyz789",
"quantity": 123,
"transactionId": "abc123",
"vouchers": [RootCode_ProductVoucher]
}
RootCode_ProductVoucher
SLTAccountCreationRequest
SLTExternalSubscriptionPackage
Fields
| Field Name | Description |
|---|---|
active -
Boolean!
|
Boolean to check if the ExternalSubscriptionPackage is currently active or not |
costs -
[Cost!]!
|
Type of Costs associated with this package |
dataQuota -
Float
|
|
description -
String
|
|
id -
String!
|
|
name -
String!
|
|
packageId -
String!
|
|
providerSubscriptionId -
String!
|
Used for identifying a SubscriptionProvider uniquely |
subscriptionPartner -
SubscriptionPartner!
|
Subscription Partner of this External Subscription Package |
subscriptionProvider -
SubscriptionProvider!
|
Type of Implicit Subscription Providers |
subscriptionType -
SubscriptionType!
|
Subscription Type this package belongs to |
subscriptionTypeId -
String!
|
Possible Types
| SLTExternalSubscriptionPackage Types |
|---|
Example
{
"active": true,
"costs": [Cost],
"dataQuota": 123.45,
"description": "xyz789",
"id": "xyz789",
"name": "abc123",
"packageId": "xyz789",
"providerSubscriptionId": "abc123",
"subscriptionPartner": "D11",
"subscriptionProvider": "PayPal",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "xyz789"
}
SLTProviderAccount
Fields
| Field Name | Description |
|---|---|
doNotRefreshUntil -
DateTime
|
|
externalSubscriptionProviderAccountId -
String!
|
|
id -
String!
|
|
sltAccountId -
String!
|
|
subscriptionProvider -
SubscriptionProvider!
|
|
subscriptionProviderAccountState -
SubscriptionProviderAccountState!
|
Example
{
"doNotRefreshUntil": "2007-12-03T10:15:30Z",
"externalSubscriptionProviderAccountId": "xyz789",
"id": "abc123",
"sltAccountId": "abc123",
"subscriptionProvider": "PayPal",
"subscriptionProviderAccountState": "AwaitingConfirmation"
}
SLTProviderExternalSubscriptionPackage
Fields
| Field Name | Description |
|---|---|
active -
Boolean!
|
|
costs -
[Cost!]!
|
|
dataQuota -
Float
|
|
defaultLocale -
Locale!
|
|
description -
String
|
|
id -
String!
|
|
localizedDescriptions -
[LocalizedOptionalString!]!
|
|
localizedNames -
[LocalizedString!]!
|
|
name -
String!
|
|
packageId -
String!
|
|
providerSubscriptionId -
String!
|
|
subscriptionPartner -
SubscriptionPartner!
|
Subscription Partner of this External Subscription Package |
subscriptionProvider -
SubscriptionProvider!
|
Type of Implicit Subscription Providers |
subscriptionType -
SubscriptionType!
|
Subscription Type this package belongs to |
subscriptionTypeId -
String!
|
Example
{
"active": false,
"costs": [Cost],
"dataQuota": 123.45,
"defaultLocale": "ar_BH",
"description": "xyz789",
"id": "abc123",
"localizedDescriptions": [LocalizedOptionalString],
"localizedNames": [LocalizedString],
"name": "xyz789",
"packageId": "abc123",
"providerSubscriptionId": "abc123",
"subscriptionPartner": "D11",
"subscriptionProvider": "PayPal",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "abc123"
}
Server
Description
A server
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
ip -
String
|
|
maxNumberOfPlayers -
Int!
|
|
port -
Int
|
|
rconPassword -
String
|
|
region -
String
|
|
serverType -
String!
|
|
status -
ServerStatusType!
|
|
timeAcquired -
Date
|
|
timeDestroyed -
Date
|
|
timeRequested -
Date!
|
Possible Types
| Server Types |
|---|
Example
{
"id": "xyz789",
"ip": "xyz789",
"maxNumberOfPlayers": 123,
"port": 987,
"rconPassword": "abc123",
"region": "abc123",
"serverType": "xyz789",
"status": "Creating",
"timeAcquired": "2007-12-03",
"timeDestroyed": "2007-12-03",
"timeRequested": "2007-12-03"
}
ServerDetails
ServerStatusType
Description
Server status
Values
| Enum Value | Description |
|---|---|
|
|
A server is being created |
|
|
A server has been deleted |
|
|
A server has players connected |
|
|
A server is ready |
|
|
A server has been requested |
Example
"Creating"
Shipment
SingleDimensionResult
SingleDimensionResultInput
SingleEliminationDetailsRequest
Fields
| Input Field | Description |
|---|---|
numberOfRoundsInPhaseInBracketRequests -
[NumberOfRoundsInPhaseInBracketRequest!]!
|
Example
{
"numberOfRoundsInPhaseInBracketRequests": [
NumberOfRoundsInPhaseInBracketRequest
]
}
SingleEliminationSpecificDetails
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
maybeMaxRoundParticipants -
Int
|
|
maybeParticipantsInRound -
Int
|
|
numberOfRoundsInPhaseInBracket -
[NumberOfRoundsInPhaseInBracket!]!
|
|
tournamentFormat -
TournamentFormat!
|
Example
{
"id": "xyz789",
"maybeMaxRoundParticipants": 987,
"maybeParticipantsInRound": 123,
"numberOfRoundsInPhaseInBracket": [
NumberOfRoundsInPhaseInBracket
],
"tournamentFormat": "PrunedSingleElimination"
}
SocialLink
Fields
| Field Name | Description |
|---|---|
link -
String!
|
|
socialLinkType -
SocialLinkType!
|
Example
{
"link": "abc123",
"socialLinkType": "FACEBOOK"
}
SocialLinkInput
Fields
| Input Field | Description |
|---|---|
link -
String!
|
|
socialLinkType -
SocialLinkType!
|
Example
{
"link": "abc123",
"socialLinkType": "FACEBOOK"
}
SocialLinkType
Description
Type of SocialLink
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FACEBOOK"
SortOrder
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Ascending"
SpecificSubscriptionPrizeCondition
Fields
| Field Name | Description |
|---|---|
description -
String!
|
|
id -
String!
|
|
order -
Int!
|
|
prize -
FixedPrize!
|
|
subscriptionTypeId -
String!
|
|
variablePrizeConditionType -
VariablePrizeConditionType!
|
Example
{
"description": "abc123",
"id": "xyz789",
"order": 123,
"prize": FixedPrize,
"subscriptionTypeId": "xyz789",
"variablePrizeConditionType": "SpecificSubscriptionPrizeConditionType"
}
SpecificSubscriptionPrizeConditionCreationRequest
Fields
| Input Field | Description |
|---|---|
customPrize -
CustomPrizeCreationRequest
|
|
order -
Int!
|
|
subscriptionTypeId -
String!
|
|
swarmioCurrencyPayoutPrize -
SwarmioCurrencyPayoutPrizeCreationRequest
|
Example
{
"customPrize": CustomPrizeCreationRequest,
"order": 123,
"subscriptionTypeId": "xyz789",
"swarmioCurrencyPayoutPrize": SwarmioCurrencyPayoutPrizeCreationRequest
}
Stream
Possible Types
| Stream Types |
|---|
Example
{
"id": "xyz789",
"url": "abc123"
}
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"
StringAttribute
StringAttributeWithPossibleError
Description
A StringAttribute or an error
Fields
| Field Name | Description |
|---|---|
isError -
Boolean!
|
Possible Types
| StringAttributeWithPossibleError Types |
|---|
Example
{"isError": false}
SubscriptionImplementation
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ImplicitSubscriptionImplementation"
SubscriptionPartner
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"D11"
SubscriptionPrizeCondition
Fields
| Field Name | Description |
|---|---|
description -
String!
|
|
id -
String!
|
|
order -
Int!
|
|
prize -
FixedPrize!
|
|
variablePrizeConditionType -
VariablePrizeConditionType!
|
Example
{
"description": "abc123",
"id": "abc123",
"order": 123,
"prize": FixedPrize,
"variablePrizeConditionType": "SpecificSubscriptionPrizeConditionType"
}
SubscriptionPrizeConditionCreationRequest
Fields
| Input Field | Description |
|---|---|
customPrize -
CustomPrizeCreationRequest
|
|
order -
Int!
|
|
swarmioCurrencyPayoutPrize -
SwarmioCurrencyPayoutPrizeCreationRequest
|
Example
{
"customPrize": CustomPrizeCreationRequest,
"order": 123,
"swarmioCurrencyPayoutPrize": SwarmioCurrencyPayoutPrizeCreationRequest
}
SubscriptionProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PayPal"
SubscriptionProviderAccount
Fields
| Field Name | Description |
|---|---|
externalSubscriptionProviderAccountId -
String!
|
|
id -
String!
|
|
subscriptionProvider -
SubscriptionProvider!
|
|
subscriptionProviderAccountState -
SubscriptionProviderAccountState!
|
Possible Types
| SubscriptionProviderAccount Types |
|---|
Example
{
"externalSubscriptionProviderAccountId": "abc123",
"id": "abc123",
"subscriptionProvider": "PayPal",
"subscriptionProviderAccountState": "AwaitingConfirmation"
}
SubscriptionProviderAccountState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AwaitingConfirmation"
SubscriptionState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Active"
SubscriptionType
Fields
| Field Name | Description |
|---|---|
conflictSubscriptionTypeIds -
[String!]!
|
|
defaultLocale -
Locale!
|
|
description -
String
|
|
enrollable -
Boolean!
|
|
explicitEnrollment -
ExplicitEnrollment
|
|
id -
String!
|
|
implicitEnrollments -
[ImplicitEnrollment!]!
|
|
initialSwarmioCurrencyReward -
SwarmioCurrencyReward
|
|
localizedDescriptions -
[LocalizedOptionalString!]!
|
|
localizedNames -
[LocalizedString!]!
|
|
name -
String!
|
|
recurringPayoutBonus -
RecurringReward
|
|
weight -
Float
|
Example
{
"conflictSubscriptionTypeIds": ["abc123"],
"defaultLocale": "ar_BH",
"description": "xyz789",
"enrollable": true,
"explicitEnrollment": ExplicitEnrollment,
"id": "abc123",
"implicitEnrollments": [ImplicitEnrollment],
"initialSwarmioCurrencyReward": SwarmioCurrencyReward,
"localizedDescriptions": [LocalizedOptionalString],
"localizedNames": [LocalizedString],
"name": "abc123",
"recurringPayoutBonus": RecurringReward,
"weight": 123.45
}
SubscriptionTypeCreationRequest
Fields
| Input Field | Description |
|---|---|
conflictSubscriptionTypeIds -
[String!]!
|
|
defaultLocale -
Locale!
|
|
enrollable -
Boolean!
|
|
explicitEnrollment -
ExplicitEnrollmentCreationRequest
|
|
implicitEnrollments -
[ImplicitEnrollmentCreationRequest!]!
|
|
initialSwarmioCurrencyReward -
SwarmioCurrencyRewardCreationRequest
|
|
localizedDescriptions -
[LocalizedOptionalStringInput!]!
|
|
localizedNames -
[LocalizedStringInput!]!
|
|
recurringPayoutBonus -
RecurringRewardCreationRequest
|
|
weight -
Float
|
Example
{
"conflictSubscriptionTypeIds": ["xyz789"],
"defaultLocale": "ar_BH",
"enrollable": true,
"explicitEnrollment": ExplicitEnrollmentCreationRequest,
"implicitEnrollments": [
ImplicitEnrollmentCreationRequest
],
"initialSwarmioCurrencyReward": SwarmioCurrencyRewardCreationRequest,
"localizedDescriptions": [LocalizedOptionalStringInput],
"localizedNames": [LocalizedStringInput],
"recurringPayoutBonus": RecurringRewardCreationRequest,
"weight": 123.45
}
SubscriptionTypeUpdateRequest
Fields
| Input Field | Description |
|---|---|
conflictSubscriptionTypeIds -
[String!]
|
|
enrollable -
Boolean
|
|
explicitEnrollmentUpdate -
ExplicitEnrollmentUpdateRequest
|
|
implicitEnrollmentCreationRequests -
[ImplicitEnrollmentCreationRequest!]!
|
|
initialSwarmioCurrencyReward -
SwarmioCurrencyRewardCreationRequest
|
|
localizedDescriptions -
[LocalizedOptionalStringInput!]
|
|
localizedNames -
[LocalizedStringInput!]
|
|
newExplicitEnrollment -
ExplicitEnrollmentCreationRequest
|
|
recurringPayoutBonus -
RecurringRewardCreationRequest
|
|
removeConflictSubscriptionTypeIds -
[String!]
|
|
removeImplicitEnrollmentIds -
[String!]!
|
|
weight -
Float
|
Example
{
"conflictSubscriptionTypeIds": ["xyz789"],
"enrollable": true,
"explicitEnrollmentUpdate": ExplicitEnrollmentUpdateRequest,
"implicitEnrollmentCreationRequests": [
ImplicitEnrollmentCreationRequest
],
"initialSwarmioCurrencyReward": SwarmioCurrencyRewardCreationRequest,
"localizedDescriptions": [LocalizedOptionalStringInput],
"localizedNames": [LocalizedStringInput],
"newExplicitEnrollment": ExplicitEnrollmentCreationRequest,
"recurringPayoutBonus": RecurringRewardCreationRequest,
"removeConflictSubscriptionTypeIds": [
"abc123"
],
"removeImplicitEnrollmentIds": ["xyz789"],
"weight": 987.65
}
Supplier
Example
{
"contact": Contact,
"createdBy": 123,
"createdDate": "abc123",
"creditLimit": "abc123",
"endpointUrl": "xyz789",
"id": 4,
"isActive": true,
"isDeleted": false,
"products": [Product],
"supplierId": "abc123",
"supplierName": "xyz789"
}
SupplierIdInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
Example
{"id": "4"}
SupplierInput
Example
{
"contact": ContactInput,
"createdBy": 123,
"creditLimit": "xyz789",
"endpointUrl": "xyz789",
"id": 4,
"isActive": false,
"isDeleted": true,
"supplierId": "xyz789",
"supplierName": "xyz789"
}
SwarmioCurrency
SwarmioCurrencyExchangeBlock
Fields
| Field Name | Description |
|---|---|
active -
Boolean!
|
|
created -
Date!
|
|
description -
String
|
|
forThisAmount -
Float
|
|
forThisSwarmioCurrency -
SwarmioCurrency!
|
|
forThisSwarmioCurrencyId -
String!
|
|
id -
String!
|
|
name -
String
|
|
thisAmount -
Float!
|
|
thisSwarmioCurrency -
SwarmioCurrency!
|
|
thisSwarmioCurrencyId -
String!
|
Example
{
"active": true,
"created": "2007-12-03",
"description": "abc123",
"forThisAmount": 123.45,
"forThisSwarmioCurrency": SwarmioCurrency,
"forThisSwarmioCurrencyId": "abc123",
"id": "abc123",
"name": "xyz789",
"thisAmount": 987.65,
"thisSwarmioCurrency": SwarmioCurrency,
"thisSwarmioCurrencyId": "abc123"
}
SwarmioCurrencyFixedPrizePayoutReceipt
Example
{
"accountId": "xyz789",
"amount": 123.45,
"created": "2007-12-03",
"id": "xyz789",
"notes": "xyz789",
"prizePayoutReceiptType": "CustomPrizePayoutReceiptType",
"prizeTierId": "xyz789",
"successful": false,
"swarmioCurrencyId": "xyz789"
}
SwarmioCurrencyItem
Fields
| Field Name | Description |
|---|---|
active -
Boolean!
|
|
amount -
Float!
|
|
costs -
[CurrencyItemCost!]!
|
|
created -
Date!
|
|
dealTagline -
String
|
|
id -
String!
|
|
name -
String
|
|
swarmioCurrency -
SwarmioCurrency!
|
Swarmio Currency |
swarmioCurrencyId -
String!
|
Example
{
"active": true,
"amount": 987.65,
"costs": [CurrencyItemCost],
"created": "2007-12-03",
"dealTagline": "abc123",
"id": "xyz789",
"name": "xyz789",
"swarmioCurrency": SwarmioCurrency,
"swarmioCurrencyId": "xyz789"
}
SwarmioCurrencyItemCost
Fields
| Field Name | Description |
|---|---|
cost -
Float!
|
|
created -
Date!
|
|
currencyItem -
SwarmioCurrencyItem!
|
Swarmio Currency Item |
currencyItemCostType -
CurrencyItemCostType!
|
|
id -
String!
|
|
realWorldCurrencyType -
RealWorldCurrency!
|
|
swarmioCurrencyItemId -
String!
|
|
version -
Int!
|
Example
{
"cost": 987.65,
"created": "2007-12-03",
"currencyItem": SwarmioCurrencyItem,
"currencyItemCostType": "ExternalCurrencyItemCost",
"id": "xyz789",
"realWorldCurrencyType": "AED",
"swarmioCurrencyItemId": "xyz789",
"version": 123
}
SwarmioCurrencyItemCostArchive
Fields
| Field Name | Description |
|---|---|
cost -
Float!
|
|
created -
Date!
|
|
currencyItem -
SwarmioCurrencyItem!
|
Swarmio Currency Item |
currencyItemCostType -
CurrencyItemCostType!
|
|
id -
String!
|
|
realWorldCurrencyType -
RealWorldCurrency!
|
|
swarmioCurrencyItemId -
String!
|
|
version -
Int!
|
Example
{
"cost": 123.45,
"created": "2007-12-03",
"currencyItem": SwarmioCurrencyItem,
"currencyItemCostType": "ExternalCurrencyItemCost",
"id": "xyz789",
"realWorldCurrencyType": "AED",
"swarmioCurrencyItemId": "abc123",
"version": 123
}
SwarmioCurrencyItemCostPurchaseRequest
Fields
| Field Name | Description |
|---|---|
created -
Date!
|
|
id -
String!
|
|
requesterId -
String!
|
|
swarmioCurrencyItemCostArchive -
SwarmioCurrencyItemCostArchive!
|
|
swarmioCurrencyItemCostArchiveId -
String!
|
Example
{
"created": "2007-12-03",
"id": "abc123",
"requesterId": "abc123",
"swarmioCurrencyItemCostArchive": SwarmioCurrencyItemCostArchive,
"swarmioCurrencyItemCostArchiveId": "xyz789"
}
SwarmioCurrencyItemCostRequest
Fields
| Input Field | Description |
|---|---|
cost -
Float!
|
|
maybeExternalId -
String
|
|
realWorldCurrencyType -
RealWorldCurrency!
|
Example
{
"cost": 987.65,
"maybeExternalId": "abc123",
"realWorldCurrencyType": "AED"
}
SwarmioCurrencyPayout
Fields
| Field Name | Description |
|---|---|
active -
Boolean!
|
|
amount -
Float!
|
|
costs -
[SwarmioCurrencyPayoutCost!]!
|
|
created -
Date!
|
|
id -
String!
|
|
name -
String
|
|
swarmioCurrency -
SwarmioCurrency!
|
Swarmio Currency |
swarmioCurrencyId -
String!
|
Example
{
"active": false,
"amount": 123.45,
"costs": [SwarmioCurrencyPayoutCost],
"created": "2007-12-03",
"id": "xyz789",
"name": "xyz789",
"swarmioCurrency": SwarmioCurrency,
"swarmioCurrencyId": "abc123"
}
SwarmioCurrencyPayoutCost
Fields
| Field Name | Description |
|---|---|
cost -
Float!
|
|
created -
Date!
|
|
id -
String!
|
|
realWorldCurrencyType -
RealWorldCurrency!
|
|
swarmioCurrencyPayout -
SwarmioCurrencyPayout!
|
Swarmio Currency Payout |
swarmioCurrencyPayoutId -
String!
|
|
version -
Int!
|
Example
{
"cost": 123.45,
"created": "2007-12-03",
"id": "xyz789",
"realWorldCurrencyType": "AED",
"swarmioCurrencyPayout": SwarmioCurrencyPayout,
"swarmioCurrencyPayoutId": "abc123",
"version": 987
}
SwarmioCurrencyPayoutCostArchive
Fields
| Field Name | Description |
|---|---|
cost -
Float!
|
|
created -
Date!
|
|
id -
String!
|
|
realWorldCurrencyType -
RealWorldCurrency!
|
|
swarmioCurrencyPayout -
SwarmioCurrencyPayout!
|
Swarmio Currency Payout |
swarmioCurrencyPayoutId -
String!
|
|
version -
Int!
|
Example
{
"cost": 123.45,
"created": "2007-12-03",
"id": "abc123",
"realWorldCurrencyType": "AED",
"swarmioCurrencyPayout": SwarmioCurrencyPayout,
"swarmioCurrencyPayoutId": "abc123",
"version": 123
}
SwarmioCurrencyPayoutCostRequest
Fields
| Input Field | Description |
|---|---|
cost -
Float!
|
|
realWorldCurrencyType -
RealWorldCurrency!
|
Example
{"cost": 123.45, "realWorldCurrencyType": "AED"}
SwarmioCurrencyPayoutPrize
Fields
| Field Name | Description |
|---|---|
amount -
Float!
|
|
id -
String!
|
|
prizeType -
PrizeType!
|
|
swarmioCurrencyId -
String!
|
Example
{
"amount": 987.65,
"id": "xyz789",
"prizeType": "CustomPrizeType",
"swarmioCurrencyId": "xyz789"
}
SwarmioCurrencyPayoutPrizeCreationRequest
SwarmioCurrencyPayoutRequest
Example
{
"completed": true,
"completedBy": "abc123",
"dateCompleted": "2007-12-03",
"dateRequested": "2007-12-03",
"id": "abc123",
"requesterId": "abc123",
"swarmioCurrencyPayoutArchiveCost": SwarmioCurrencyPayoutCostArchive,
"swarmioCurrencyPayoutCostArchiveId": "abc123"
}
SwarmioCurrencyReward
SwarmioCurrencyRewardCreationRequest
SwarmioItem
Fields
| Field Name | Description |
|---|---|
active -
Boolean!
|
|
catalogIds -
[String!]!
|
|
categoryIds -
[String!]!
|
|
costs -
[ItemCost!]!
|
|
description -
String
|
|
externalSKU -
String
|
|
id -
String!
|
|
images -
[String!]!
|
|
name -
String!
|
|
provisioner -
Provisioner!
|
|
stock -
Int
|
Example
{
"active": false,
"catalogIds": ["abc123"],
"categoryIds": ["xyz789"],
"costs": [ItemCost],
"description": "xyz789",
"externalSKU": "xyz789",
"id": "abc123",
"images": ["xyz789"],
"name": "xyz789",
"provisioner": "RootCode",
"stock": 987
}
SwarmioPayPayment
Fields
| Field Name | Description |
|---|---|
dateReceived -
Date!
|
|
destinationService -
String
|
The amount of currency |
id -
String!
|
|
internalTransactionId -
String
|
|
isValid -
Boolean!
|
|
itemId -
String
|
|
paymentProviderTransactionId -
String
|
|
paymentStatus -
PaymentStatus!
|
|
paymentType -
PaymentType!
|
The type of transaction |
receivedAmount -
Float
|
|
receivedCurrency -
RealWorldCurrency
|
|
requestedAmount -
Float
|
|
requestedCurrency -
RealWorldCurrency
|
Example
{
"dateReceived": "2007-12-03",
"destinationService": "abc123",
"id": "xyz789",
"internalTransactionId": "xyz789",
"isValid": false,
"itemId": "abc123",
"paymentProviderTransactionId": "abc123",
"paymentStatus": "Cancelled",
"paymentType": "Skrill",
"receivedAmount": 123.45,
"receivedCurrency": "AED",
"requestedAmount": 987.65,
"requestedCurrency": "AED"
}
SwarmioSubscription
Fields
| Field Name | Description |
|---|---|
expiry -
DateTime
|
|
id -
String!
|
|
isUsable -
Boolean!
|
|
subscriptionImplementation -
SubscriptionImplementation!
|
|
subscriptionState -
SubscriptionState!
|
|
subscriptionType -
SubscriptionType!
|
|
subscriptionTypeId -
String!
|
Possible Types
| SwarmioSubscription Types |
|---|
Example
{
"expiry": "2007-12-03T10:15:30Z",
"id": "abc123",
"isUsable": false,
"subscriptionImplementation": "ImplicitSubscriptionImplementation",
"subscriptionState": "Active",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "abc123"
}
SwarmioWallet
Description
Swarmio Wallet
Fields
| Field Name | Description |
|---|---|
balance -
Float!
|
|
boughtTransactions -
PaginatedBoughtTransaction!
|
|
cashOutTransactions -
PaginatedCashOutTransaction!
|
|
created -
Date!
|
|
exchangedTransactions -
PaginatedExchangedTransaction!
|
|
freebieTransactions -
PaginatedFreebieTransaction!
|
|
id -
String!
|
|
ownerId -
String!
|
|
swarmioCurrency -
SwarmioCurrency!
|
|
swarmioCurrencyId -
String!
|
|
transactions -
PaginatedSwarmioWalletTransactionWithMetadata!
|
|
transferTransactions -
PaginatedTransferTransaction!
|
|
Example
{
"balance": 987.65,
"boughtTransactions": PaginatedBoughtTransaction,
"cashOutTransactions": PaginatedCashOutTransaction,
"created": "2007-12-03",
"exchangedTransactions": PaginatedExchangedTransaction,
"freebieTransactions": PaginatedFreebieTransaction,
"id": "xyz789",
"ownerId": "xyz789",
"swarmioCurrency": SwarmioCurrency,
"swarmioCurrencyId": "xyz789",
"transactions": PaginatedSwarmioWalletTransactionWithMetadata,
"transferTransactions": PaginatedTransferTransaction
}
SwarmioWalletTransactionType
Description
The type of transaction
Values
| Enum Value | Description |
|---|---|
|
|
Currency purchased with real world currency |
|
|
Currency cashed out to real world currency |
|
|
An Exchange of Currency for other items |
|
|
Currency transferred in for free |
|
|
Transfer currency to another wallet |
Example
"BOUGHT"
SwarmioWalletTransactionWithMetadata
Fields
| Field Name | Description |
|---|---|
amount -
Float!
|
The amount of currency |
created -
Date!
|
The date and time of the transaction |
id -
String!
|
The transaction object |
transactionType -
SwarmioWalletTransactionType!
|
The type of transaction |
wallet -
SwarmioWallet!
|
|
walletId -
String!
|
The ID of the associated Swarmio wallet |
Possible Types
| SwarmioWalletTransactionWithMetadata Types |
|---|
Example
{
"amount": 123.45,
"created": "2007-12-03",
"id": "xyz789",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "xyz789"
}
TIMWEAccountCreationRequest
Fields
| Input Field | Description |
|---|---|
phoneNumber -
String!
|
Example
{"phoneNumber": "abc123"}
TIMWEExternalSubscriptionPackage
Fields
| Field Name | Description |
|---|---|
active -
Boolean!
|
Boolean to check if the ExternalSubscriptionPackage is currently active or not |
costs -
[Cost!]!
|
Type of Costs associated with this package |
description -
String
|
|
id -
String!
|
|
largeAccount -
String!
|
|
mcc -
String!
|
|
mnc -
String!
|
|
name -
String!
|
|
productId -
Int!
|
|
providerSubscriptionId -
String!
|
Used for identifying a SubscriptionProvider uniquely |
subKeyword -
String!
|
|
subscriptionPartner -
SubscriptionPartner!
|
Subscription Partner of this External Subscription Package |
subscriptionProvider -
SubscriptionProvider!
|
Type of Implicit Subscription Providers |
subscriptionType -
SubscriptionType!
|
Subscription Type this package belongs to |
subscriptionTypeId -
String!
|
Possible Types
| TIMWEExternalSubscriptionPackage Types |
|---|
Example
{
"active": false,
"costs": [Cost],
"description": "abc123",
"id": "abc123",
"largeAccount": "abc123",
"mcc": "abc123",
"mnc": "abc123",
"name": "xyz789",
"productId": 123,
"providerSubscriptionId": "abc123",
"subKeyword": "xyz789",
"subscriptionPartner": "D11",
"subscriptionProvider": "PayPal",
"subscriptionType": SubscriptionType,
"subscriptionTypeId": "abc123"
}
TIMWEProviderAccount
Fields
| Field Name | Description |
|---|---|
externalSubscriptionProviderAccountId -
String!
|
|
id -
String!
|
|
largeAccount -
String
|
|
mcc -
String
|
|
mnc -
String
|
|
msisdn -
String!
|
|
productId -
Int
|
|
subKeyword -
String
|
|
subscriptionProvider -
SubscriptionProvider!
|
|
subscriptionProviderAccountState -
SubscriptionProviderAccountState!
|
|
transactionId -
String
|
Example
{
"externalSubscriptionProviderAccountId": "xyz789",
"id": "xyz789",
"largeAccount": "abc123",
"mcc": "abc123",
"mnc": "xyz789",
"msisdn": "abc123",
"productId": 987,
"subKeyword": "xyz789",
"subscriptionProvider": "PayPal",
"subscriptionProviderAccountState": "AwaitingConfirmation",
"transactionId": "xyz789"
}
Tag
Description
Used to identify objects in our application and provide friendly vanity names supplied by our admins to improve our UX
Fields
| Field Name | Description |
|---|---|
localizations -
[LocalizedString!]!
|
Provides a list of localized strings for the tag |
name -
String!
|
Name of the tag ie "format" |
Example
{
"localizations": [LocalizedString],
"name": "xyz789"
}
TagInput
Fields
| Input Field | Description |
|---|---|
localizations -
[LocalizedStringInput!]!
|
|
name -
String!
|
Example
{
"localizations": [LocalizedStringInput],
"name": "xyz789"
}
Team
Fields
| Field Name | Description |
|---|---|
accountType -
String!
|
|
avatarURL -
String
|
|
bannerURL -
String
|
|
created -
Date!
|
|
description -
String
|
|
eventParticipations -
[Event!]!
|
|
groupInvitations -
[GroupInvitationWithPossibleError!]!
|
|
groupInvites -
[GroupInviteWithPossibleError!]!
|
|
groupMembers -
[GroupMember!]!
|
|
groupMemberships -
[GroupMembership!]!
|
|
groupType -
String!
|
|
id -
String!
|
|
isSupplier -
Boolean!
|
|
lastUpdated -
DateTime!
|
|
managedAccounts -
[ManagedAccount!]!
|
|
name -
String!
|
|
ownerId -
String!
|
|
publicURL -
String
|
|
purchaseTransactions -
[PurchaseTransaction!]!
|
|
socialLinks -
[SocialLink!]!
|
|
subscriptionProviderAccounts -
[SubscriptionProviderAccount!]!
|
|
subscriptions -
[SwarmioSubscription!]!
|
|
updated -
Date!
|
|
wallets -
[SwarmioWallet!]!
|
Example
{
"accountType": "abc123",
"avatarURL": "abc123",
"bannerURL": "xyz789",
"created": "2007-12-03",
"description": "xyz789",
"eventParticipations": [Event],
"groupInvitations": [GroupInvitationWithPossibleError],
"groupInvites": [GroupInviteWithPossibleError],
"groupMembers": [GroupMember],
"groupMemberships": [GroupMembership],
"groupType": "abc123",
"id": "xyz789",
"isSupplier": false,
"lastUpdated": "2007-12-03T10:15:30Z",
"managedAccounts": [ManagedAccount],
"name": "xyz789",
"ownerId": "xyz789",
"publicURL": "abc123",
"purchaseTransactions": [PurchaseTransaction],
"socialLinks": [SocialLink],
"subscriptionProviderAccounts": [
SubscriptionProviderAccount
],
"subscriptions": [SwarmioSubscription],
"updated": "2007-12-03",
"wallets": [SwarmioWallet]
}
TeamCompetitionParticipantCreationRequest
Fields
| Input Field | Description |
|---|---|
teamId -
String!
|
|
teamMemberIds -
[String!]!
|
Example
{
"teamId": "abc123",
"teamMemberIds": ["abc123"]
}
TeamCreationRequest
Example
{
"avatarURL": "abc123",
"bannerURL": "xyz789",
"description": "abc123",
"name": "abc123",
"ownerId": "abc123",
"publicURL": "abc123",
"socialLinks": [SocialLinkInput]
}
TeamEventCreationRequest
Fields
| Input Field | Description |
|---|---|
category -
EventCategory!
|
|
defaultLocale -
Locale!
|
|
entryLevel -
EntryLevel!
|
|
eventCreationRequestGameDetails -
EventCreationRequestGameDetails!
|
|
eventEntryRulesCreationRequest -
TeamEventEntryRulesCreationRequest
|
|
eventStages -
[EventStageCreationRequest!]!
|
|
localizedDescriptions -
[LocalizedOptionalStringInput!]!
|
|
localizedJoinInstructions -
[LocalizedOptionalStringInput!]!
|
|
localizedMediaContentDetails -
[LocalizedMediaContentDetailsRequest!]!
|
|
localizedNames -
[LocalizedStringInput!]!
|
|
localizedWrittenRules -
[LocalizedOptionalStringInput!]!
|
|
maximumParticipants -
Int
|
|
minimumParticipants -
Int
|
|
modifiers -
EventCreationRequestModifiers!
|
|
ownerAccountId -
String!
|
|
prizeId -
String
|
|
prizeListCreationRequest -
PrizeListCreationRequest
|
|
region -
Region
|
|
registrationDetails -
RegistrationDetails!
|
|
startTime -
Date!
|
|
tags -
[TagInput!]!
|
Example
{
"category": "Challenge",
"defaultLocale": "ar_BH",
"entryLevel": "Premium",
"eventCreationRequestGameDetails": EventCreationRequestGameDetails,
"eventEntryRulesCreationRequest": TeamEventEntryRulesCreationRequest,
"eventStages": [EventStageCreationRequest],
"localizedDescriptions": [LocalizedOptionalStringInput],
"localizedJoinInstructions": [
LocalizedOptionalStringInput
],
"localizedMediaContentDetails": [
LocalizedMediaContentDetailsRequest
],
"localizedNames": [LocalizedStringInput],
"localizedWrittenRules": [LocalizedOptionalStringInput],
"maximumParticipants": 987,
"minimumParticipants": 987,
"modifiers": EventCreationRequestModifiers,
"ownerAccountId": "abc123",
"prizeId": "xyz789",
"prizeListCreationRequest": PrizeListCreationRequest,
"region": "APAC",
"registrationDetails": RegistrationDetails,
"startTime": "2007-12-03",
"tags": [TagInput]
}
TeamEventEntryRules
TeamEventEntryRulesCreationRequest
TeamEventUpdate
Fields
| Input Field | Description |
|---|---|
category -
EventCategory
|
|
entryLevel -
EntryLevel
|
|
eventEntryRulesCreationRequest -
TeamEventEntryRulesCreationRequest
|
|
featured -
Boolean
|
|
localizedDescriptions -
[LocalizedOptionalStringInput!]
|
|
localizedJoinInstructions -
[LocalizedOptionalStringInput!]
|
|
localizedMediaContentDetails -
[LocalizedMediaContentDetailsRequest!]
|
|
localizedNames -
[LocalizedStringInput!]
|
|
localizedWrittenRules -
[LocalizedOptionalStringInput!]
|
|
maximumParticipants -
Int
|
|
minimumParticipants -
Int
|
|
newTags -
[TagInput!]
|
|
prizeId -
String
|
|
prizeListCreationRequest -
PrizeListCreationRequest
|
|
region -
Region
|
|
registrationClose -
Date
|
|
registrationOpen -
Date
|
|
startTime -
Date
|
|
tagsToDelete -
[String!]
|
|
unlisted -
Boolean
|
Example
{
"category": "Challenge",
"entryLevel": "Premium",
"eventEntryRulesCreationRequest": TeamEventEntryRulesCreationRequest,
"featured": true,
"localizedDescriptions": [LocalizedOptionalStringInput],
"localizedJoinInstructions": [
LocalizedOptionalStringInput
],
"localizedMediaContentDetails": [
LocalizedMediaContentDetailsRequest
],
"localizedNames": [LocalizedStringInput],
"localizedWrittenRules": [LocalizedOptionalStringInput],
"maximumParticipants": 987,
"minimumParticipants": 123,
"newTags": [TagInput],
"prizeId": "xyz789",
"prizeListCreationRequest": PrizeListCreationRequest,
"region": "APAC",
"registrationClose": "2007-12-03",
"registrationOpen": "2007-12-03",
"startTime": "2007-12-03",
"tagsToDelete": ["abc123"],
"unlisted": true
}
TeamKingOfTheHillFormatDetailsCreationRequest
Fields
| Input Field | Description |
|---|---|
host -
TeamCompetitionParticipantCreationRequest!
|
|
maximumNumberOfPhases -
Int
|
|
numberOfRoundsInPhaseRequests -
[NumberOfRoundsInPhaseRequest!]!
|
Example
{
"host": TeamCompetitionParticipantCreationRequest,
"maximumNumberOfPhases": 123,
"numberOfRoundsInPhaseRequests": [
NumberOfRoundsInPhaseRequest
]
}
TeamKingOfTheHillFormatDetailsUpdateRequest
Fields
| Input Field | Description |
|---|---|
host -
TeamCompetitionParticipantCreationRequest
|
|
maximumNumberOfPhases -
Int
|
|
numberOfRoundsInPhaseRequests -
[NumberOfRoundsInPhaseRequest!]!
|
Example
{
"host": TeamCompetitionParticipantCreationRequest,
"maximumNumberOfPhases": 987,
"numberOfRoundsInPhaseRequests": [
NumberOfRoundsInPhaseRequest
]
}
TeamParticipant
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
confirmed -
Boolean!
|
|
created -
Date!
|
|
id -
String!
|
|
participantType -
ParticipantType!
|
|
result -
Result
|
|
team -
Team
|
|
teamId -
String!
|
|
teamMembers -
[IndividualParticipant!]!
|
Example
{
"accountId": "abc123",
"confirmed": true,
"created": "2007-12-03",
"id": "xyz789",
"participantType": "IndividualParticipantType",
"result": Result,
"team": Team,
"teamId": "xyz789",
"teamMembers": [IndividualParticipant]
}
TeamUpdateRequest
Example
{
"avatarURL": "xyz789",
"bannerURL": "abc123",
"description": "abc123",
"name": "abc123",
"publicURL": "abc123",
"removePublicURL": false,
"socialLinks": [SocialLinkInput]
}
TechnicalParticipant
Fields
| Field Name | Description |
|---|---|
accountId -
String!
|
|
id -
String!
|
|
participant -
Participant!
|
|
roles -
[GamingRole!]!
|
Example
{
"accountId": "abc123",
"id": "xyz789",
"participant": Participant,
"roles": [GamingRole]
}
Tournament
Description
A tournament
Fields
| Field Name | Description |
|---|---|
brackets -
[TournamentBracket!]!
|
|
competitionState -
EventElementState!
|
|
competitionType -
CompetitionType!
|
|
created -
Date!
|
|
event -
Event!
|
|
eventId -
String!
|
|
eventStageId -
String!
|
|
game -
Game!
|
|
gameId -
String!
|
|
gameSpecificDetails -
GameSpecificCompetitionDetails
|
|
id -
String!
|
|
isSimulated -
Boolean!
|
|
manualAdvancement -
Boolean!
|
|
numberOfRounds -
Int!
|
|
participantType -
ParticipantType!
|
|
participants -
[CompetitionParticipantReference!]!
|
|
phaseBufferTime -
DurationInMilliseconds
|
|
startTime -
Date
|
|
tournamentFormat -
TournamentFormat!
|
|
tournamentFormatSpecificDetails -
TournamentSpecificDetails
|
Example
{
"brackets": [TournamentBracket],
"competitionState": "ARCHIVED",
"competitionType": "CHALLENGE",
"created": "2007-12-03",
"event": Event,
"eventId": "abc123",
"eventStageId": "abc123",
"game": Game,
"gameId": "xyz789",
"gameSpecificDetails": GameSpecificCompetitionDetails,
"id": "abc123",
"isSimulated": false,
"manualAdvancement": false,
"numberOfRounds": 987,
"participantType": "IndividualParticipantType",
"participants": [CompetitionParticipantReference],
"phaseBufferTime": DurationInMilliseconds,
"startTime": "2007-12-03",
"tournamentFormat": "PrunedSingleElimination",
"tournamentFormatSpecificDetails": TournamentSpecificDetails
}
TournamentBracket
Description
A generic bracket in a tournament
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
isComplete -
Boolean!
|
|
name -
TournamentBracketName!
|
|
phases -
[TournamentPhase!]!
|
Example
{
"id": "abc123",
"isComplete": true,
"name": "SingleElimination",
"phases": [TournamentPhase]
}
TournamentBracketName
Values
| Enum Value | Description |
|---|---|
|
|
Example
"SingleElimination"
TournamentCreationRequest
Fields
| Input Field | Description |
|---|---|
manualAdvancement -
Boolean!
|
|
numberOfRounds -
Int!
|
|
phaseBufferTime -
DurationInMilliseconds
|
|
prunedSingleEliminationSpecificDetails -
PrunedSingleEliminationDetailsRequest
|
|
singleEliminationSpecificDetails -
SingleEliminationDetailsRequest
|
|
startTime -
Date
|
|
tournamentFormat -
TournamentFormat!
|
Example
{
"manualAdvancement": false,
"numberOfRounds": 123,
"phaseBufferTime": DurationInMilliseconds,
"prunedSingleEliminationSpecificDetails": PrunedSingleEliminationDetailsRequest,
"singleEliminationSpecificDetails": SingleEliminationDetailsRequest,
"startTime": "2007-12-03",
"tournamentFormat": "PrunedSingleElimination"
}
TournamentFormat
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PrunedSingleElimination"
TournamentMatch
Description
A tournament match
Fields
| Field Name | Description |
|---|---|
gameSpecificDetails -
GameSpecificCompetitionDetails
|
|
id -
String!
|
|
isComplete -
Boolean!
|
|
startTime -
Date
|
Possible Types
| TournamentMatch Types |
|---|
Example
{
"gameSpecificDetails": GameSpecificCompetitionDetails,
"id": "xyz789",
"isComplete": false,
"startTime": "2007-12-03"
}
TournamentMatchBye
Fields
| Field Name | Description |
|---|---|
gameSpecificDetails -
GameSpecificCompetitionDetails
|
|
id -
String!
|
|
isComplete -
Boolean!
|
|
participants -
[CompetitionParticipantReferenceWithRoster!]!
|
|
startTime -
Date
|
Example
{
"gameSpecificDetails": GameSpecificCompetitionDetails,
"id": "abc123",
"isComplete": true,
"participants": [
CompetitionParticipantReferenceWithRoster
],
"startTime": "2007-12-03"
}
TournamentPhase
Description
A generic phase in a tournament
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
isComplete -
Boolean!
|
|
matches -
[TournamentMatch!]!
|
|
phaseNumber -
Int!
|
Example
{
"id": "abc123",
"isComplete": true,
"matches": [TournamentMatch],
"phaseNumber": 987
}
TournamentRound
Description
A generic round in a tournament
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
isComplete -
Boolean!
|
|
participants -
[CompetitionParticipantReference!]!
|
|
roundNumber -
Int!
|
Example
{
"id": "abc123",
"isComplete": false,
"participants": [CompetitionParticipantReference],
"roundNumber": 123
}
TournamentSpecificDetails
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
maybeMaxRoundParticipants -
Int
|
|
maybeParticipantsInRound -
Int
|
|
tournamentFormat -
TournamentFormat!
|
Possible Types
| TournamentSpecificDetails Types |
|---|
Example
{
"id": "abc123",
"maybeMaxRoundParticipants": 123,
"maybeParticipantsInRound": 987,
"tournamentFormat": "PrunedSingleElimination"
}
TournamentUpdateRequestForCompetitionId
Fields
| Input Field | Description |
|---|---|
manualAdvancement -
Boolean
|
|
phaseBufferTime -
DurationInMilliseconds
|
|
prunedSingleEliminationSpecificDetails -
PrunedSingleEliminationDetailsRequest
|
|
singleEliminationSpecificDetails -
SingleEliminationDetailsRequest
|
|
startTime -
Date
|
Example
{
"manualAdvancement": false,
"phaseBufferTime": DurationInMilliseconds,
"prunedSingleEliminationSpecificDetails": PrunedSingleEliminationDetailsRequest,
"singleEliminationSpecificDetails": SingleEliminationDetailsRequest,
"startTime": "2007-12-03"
}
TransferTransaction
Description
Transfer currency from one wallet to another
Fields
| Field Name | Description |
|---|---|
amount -
Float!
|
|
created -
Date!
|
|
id -
String!
|
|
otherWalletId -
String!
|
|
transactionType -
SwarmioWalletTransactionType!
|
The type of transaction |
wallet -
SwarmioWallet!
|
|
walletId -
String!
|
Example
{
"amount": 987.65,
"created": "2007-12-03",
"id": "xyz789",
"otherWalletId": "abc123",
"transactionType": "BOUGHT",
"wallet": SwarmioWallet,
"walletId": "abc123"
}
TransferTransactionRequest
TwitchStream
TwitchStreamCreationRequest
UnappliedPayment
UnappliedPaymentState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Excess"
UpcomingKingOfTheHillParticipant
Fields
| Field Name | Description |
|---|---|
display -
Boolean!
|
|
expectedStartTime -
Date
|
|
order -
Int
|
|
participant -
CompetitionParticipantReferenceWithRoster!
|
Example
{
"display": true,
"expectedStartTime": "2007-12-03",
"order": 987,
"participant": CompetitionParticipantReferenceWithRoster
}
User
Description
A user
Fields
| Field Name | Description |
|---|---|
accountManagers -
[AccountManagerWithPossibleError!]!
|
|
accountType -
String!
|
|
avatarURL -
String
|
|
bannerURL -
String
|
|
contactIdentifier -
StringAttributeWithPossibleError!
|
|
created -
Date!
|
|
description -
String
|
|
displayName -
String
|
|
email -
StringAttributeWithPossibleError
|
|
emailVerified -
Boolean!
|
|
groupInvitations -
[GroupInvitationWithPossibleError!]!
|
|
groupMemberships -
[GroupMembership!]!
|
|
hasValidContact -
Boolean!
|
|
id -
String!
|
|
managedAccounts -
[ManagedAccountWithPossibleError!]!
|
|
msisdn -
StringAttributeWithPossibleError
|
|
msisdnVerified -
Boolean!
|
|
publicURL -
String
|
|
socialLinks -
[SocialLink!]!
|
|
updated -
Date!
|
|
userType -
String!
|
|
wallets -
[SwarmioWallet!]!
|
Possible Types
| User Types |
|---|
Example
{
"accountManagers": [AccountManagerWithPossibleError],
"accountType": "xyz789",
"avatarURL": "xyz789",
"bannerURL": "abc123",
"contactIdentifier": StringAttributeWithPossibleError,
"created": "2007-12-03",
"description": "abc123",
"displayName": "xyz789",
"email": StringAttributeWithPossibleError,
"emailVerified": false,
"groupInvitations": [GroupInvitationWithPossibleError],
"groupMemberships": [GroupMembership],
"hasValidContact": false,
"id": "xyz789",
"managedAccounts": [ManagedAccountWithPossibleError],
"msisdn": StringAttributeWithPossibleError,
"msisdnVerified": false,
"publicURL": "xyz789",
"socialLinks": [SocialLink],
"updated": "2007-12-03",
"userType": "xyz789",
"wallets": [SwarmioWallet]
}
VariablePrize
Fields
| Field Name | Description |
|---|---|
conditionalPrizes -
[VariablePrizeCondition!]!
|
|
defaultPrize -
FixedPrize!
|
|
id -
String!
|
|
prizeType -
PrizeType!
|
Example
{
"conditionalPrizes": [VariablePrizeCondition],
"defaultPrize": FixedPrize,
"id": "xyz789",
"prizeType": "CustomPrizeType"
}
VariablePrizeCondition
Description
The criteria for qualifying for this prize variation
Fields
| Field Name | Description |
|---|---|
description -
String!
|
|
id -
String!
|
|
order -
Int!
|
|
prize -
FixedPrize!
|
|
variablePrizeConditionType -
VariablePrizeConditionType!
|
Possible Types
| VariablePrizeCondition Types |
|---|
Example
{
"description": "xyz789",
"id": "abc123",
"order": 987,
"prize": FixedPrize,
"variablePrizeConditionType": "SpecificSubscriptionPrizeConditionType"
}
VariablePrizeConditionType
Description
The type of variable prize condition
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SpecificSubscriptionPrizeConditionType"
VariablePrizeCreationRequest
Fields
| Input Field | Description |
|---|---|
customDefaultPrize -
CustomPrizeCreationRequest
|
|
specificSubscriptionConditionalPrizes -
[SpecificSubscriptionPrizeConditionCreationRequest!]
|
|
subscriptionConditionalPrizes -
[SubscriptionPrizeConditionCreationRequest!]
|
|
swarmioCurrencyPayoutDefaultPrize -
SwarmioCurrencyPayoutPrizeCreationRequest
|
Example
{
"customDefaultPrize": CustomPrizeCreationRequest,
"specificSubscriptionConditionalPrizes": [
SpecificSubscriptionPrizeConditionCreationRequest
],
"subscriptionConditionalPrizes": [
SubscriptionPrizeConditionCreationRequest
],
"swarmioCurrencyPayoutDefaultPrize": SwarmioCurrencyPayoutPrizeCreationRequest
}
Voucher
VoucherFilterInput
Fields
| Input Field | Description |
|---|---|
status -
VoucherStatus
|
Example
{"status": "DELETED"}
VoucherInventory
Example
{
"batchId": "4",
"createdDate": "abc123",
"currency": "xyz789",
"id": 4,
"modifiedDate": "xyz789",
"status": "AVAILABLE",
"stockCount": 123,
"unitPrice": 123.45
}
VoucherStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DELETED"
YouTubeStream
YouTubeStreamCreationRequest
YouTubeVideo
YouTubeVideoCreationRequest
categoryInput
Example
{
"categoryCoverImage": "xyz789",
"categoryDescription": "xyz789",
"categoryIcon": "xyz789",
"categoryId": "abc123",
"categoryImage": "abc123",
"categoryName": "xyz789",
"id": 4,
"isActive": false,
"isDeleted": false,
"itemCatalogCategory": [ItemCatalogCategoryInput],
"parentCategory": 123
}
purchaseItemInput
Example
{
"gamerEmail": "xyz789",
"gamerId": "xyz789",
"gamerName": "abc123",
"itemId": 4,
"orderDate": "abc123",
"quantity": 123,
"tagId": "4",
"transactionId": "abc123"
}