{"info":{"title":"groups object","version":"1.0","contact":{"name":"Beamable Support","url":"https://api.beamable.com","email":"support@beamable.com"}},"servers":[{"url":"https://api.beamable.com"}],"paths":{"/object/groups/{objectId}/role":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleChangeRequest"}}}},"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/groups/{objectId}/kick":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMembershipResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickRequest"}}}},"security":[{}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/groups/{objectId}/apply":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupApplication"}}}},"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/groups/{objectId}/donations":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDonationRequest"}}}},"security":[{"user":[]},{"server":[]}]},"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MakeDonationRequest"}}}},"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/groups/{objectId}/member":{"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMembershipResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickRequest"}}}},"security":[{}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/groups/{objectId}/":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"security":[{}]},"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupUpdate"}}}},"security":[{}]},"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisbandRequest"}}}},"security":[{}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/groups/{objectId}/donations/claim":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/groups/{objectId}/invite":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupInvite"}}}},"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/groups/{objectId}/petition":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupApplication"}}}},"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]}},"components":{"schemas":{"GroupInvite":{"properties":{"gamerTag":{"type":"integer","format":"int64"},"subGroup":{"type":"integer","format":"int64"},"useNewRewardsSystem":{"type":"boolean"}},"additionalProperties":false,"title":"Group Invite","type":"object","required":["gamerTag"]},"DonationEntry":{"type":"object","additionalProperties":false,"properties":{"playerId":{"type":"integer","format":"int64"},"amount":{"type":"integer","format":"int64"},"time":{"type":"integer","format":"int64"},"claimed":{"type":"boolean"}},"required":["playerId","amount","time"]},"CreateDonationRequest":{"properties":{"currencyId":{"type":"string"},"amount":{"type":"integer","format":"int64"},"config":{"type":"string"}},"additionalProperties":false,"title":"Create Donation Request","type":"object","required":["currencyId","amount"]},"GroupType":{"type":"string","enum":["guild","subgroup"]},"Member":{"type":"object","additionalProperties":false,"properties":{"canDemote":{"type":"boolean"},"canKick":{"type":"boolean"},"role":{"type":"string"},"gamerTag":{"type":"integer","format":"int64"},"canPromote":{"type":"boolean"},"scores":{"type":"array","items":{"$ref":"#/components/schemas/GroupScoreBinding"}}},"required":["gamerTag","role"]},"InFlightMessage":{"type":"object","additionalProperties":false,"properties":{"method":{"type":"string"},"body":{"type":"string"},"path":{"type":"string"},"gamerTag":{"type":"integer","format":"int64"},"limitFailureRetries":{"type":"boolean"},"shard":{"type":"string"},"service":{"type":"string"},"id":{"type":"string"}},"required":["service","id","method","path","body"]},"KickRequest":{"properties":{"gamerTag":{"type":"integer","format":"int64"},"subGroup":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Kick Request","type":"object","required":["gamerTag"]},"GroupMembershipResponse":{"properties":{"gamerTag":{"type":"integer","format":"int64"},"member":{"type":"boolean"},"type":{"$ref":"#/components/schemas/GroupType"},"subGroups":{"type":"array","items":{"type":"integer","format":"int64"}},"group":{"$ref":"#/components/schemas/GroupMetaData"}},"additionalProperties":false,"title":"Group Membership Response","type":"object","required":["group","member","type","subGroups"]},"GroupRole":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"permissions":{"type":"array","items":{"type":"string"}}},"required":["name","permissions"]},"GroupUpdate":{"properties":{"name":{"type":"string"},"enrollmentType":{"type":"string"},"tag":{"type":"string"},"slogan":{"type":"string"},"requirement":{"type":"integer","format":"int64"},"motd":{"type":"string"},"clientData":{"type":"string"},"subGroup":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Group Update","type":"object"},"CommonResponse":{"properties":{"result":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false,"title":"Common Response","type":"object","required":["result","data"]},"DonationRequest":{"type":"object","additionalProperties":false,"properties":{"timeRequested":{"type":"integer","format":"int64"},"progress":{"type":"array","items":{"$ref":"#/components/schemas/DonationEntry"}},"satisfied":{"type":"boolean"},"playerId":{"type":"integer","format":"int64"},"currency":{"$ref":"#/components/schemas/Currency"}},"required":["playerId","currency","timeRequested","progress","satisfied"]},"GroupApplication":{"properties":{"subGroup":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Group Application","type":"object"},"CurrencyProperty":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"Group":{"type":"object","additionalProperties":false,"properties":{"inFlight":{"type":"array","items":{"$ref":"#/components/schemas/InFlightMessage"}},"name":{"type":"string"},"enrollmentType":{"type":"string"},"donations":{"type":"array","items":{"$ref":"#/components/schemas/DonationRequest"}},"freeSlots":{"type":"integer","format":"int32"},"maybeDonations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DonationRequest"}},"tag":{"type":"string"},"canUpdateMOTD":{"type":"boolean"},"shard":{"type":"string"},"canUpdateSlogan":{"type":"boolean"},"leader":{"type":"integer","format":"int64"},"slogan":{"type":"string"},"requirement":{"type":"integer","format":"int64"},"motd":{"type":"string"},"version":{"type":"integer","format":"int32"},"id":{"type":"integer","format":"int64"},"clientData":{"type":"string"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/GroupRole"}},"scores":{"type":"object","additionalProperties":{"type":"string"}},"canUpdateEnrollment":{"type":"boolean"},"members":{"type":"array","items":{"$ref":"#/components/schemas/Member"}},"canDisband":{"type":"boolean"},"type":{"$ref":"#/components/schemas/GroupType"},"maxSize":{"type":"integer","format":"int32"},"subGroups":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"created":{"type":"integer","format":"int64","x-beamable-date-format":"unix","description":"Milliseconds since midnight, January 1, 1970 UTC"}},"required":["id","name","slogan","motd","enrollmentType","requirement","maxSize","members","subGroups","created","type","freeSlots","scores","leader"]},"Currency":{"type":"object","additionalProperties":false,"properties":{"updatedAt":{"type":"integer","format":"int64"},"amount":{"type":"integer","format":"int64"},"id":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyProperty"}},"proxy":{"$ref":"#/components/schemas/FederationInfo"}},"required":["id","amount"]},"GroupScoreBinding":{"type":"object","additionalProperties":false,"properties":{"board":{"type":"string"},"derivatives":{"type":"array","items":{"type":"string"}},"score":{"type":"integer","format":"int64"}},"required":["board","derivatives","score"]},"OptionalJsonNodeWrapper":{"type":"object","additionalProperties":false,"x-beamable-json-object":true,"properties":{"node":{"type":"string"}}},"EmptyResponse":{"properties":{"result":{"type":"string"}},"additionalProperties":false,"title":"Empty Response","type":"object","required":["result"]},"GroupMetaData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"tag":{"type":"string"}},"required":["id"]},"MakeDonationRequest":{"properties":{"recipientId":{"type":"integer","format":"int64"},"amount":{"type":"integer","format":"int64"},"autoClaim":{"type":"boolean"}},"additionalProperties":false,"title":"Make Donation Request","type":"object","required":["recipientId","amount"]},"RoleChangeRequest":{"properties":{"gamerTag":{"type":"integer","format":"int64"},"role":{"type":"string"},"subGroup":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Role Change Request","type":"object","required":["gamerTag","role"]},"DisbandRequest":{"properties":{"subGroup":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Disband Request","type":"object"},"FederationInfo":{"type":"object","additionalProperties":false,"properties":{"service":{"type":"string"},"namespace":{"type":"string"},"settings":{"$ref":"#/components/schemas/OptionalJsonNodeWrapper"}},"required":["service","namespace"]}},"securitySchemes":{"server":{"type":"apiKey","name":"X-DE-SIGNATURE","in":"header","description":"Signed Request authentication using project secret key."},"user":{"type":"http","description":"Bearer authentication with a player access token in the Authorization header.","scheme":"bearer","bearerFormat":"Bearer <Access Token>"}}},"security":[],"externalDocs":{"description":"Beamable Documentation","url":"https://docs.beamable.com"},"openapi":"3.0.2"}