{"info":{"title":"event-players 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/event-players/{objectId}/":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventPlayerView"}}}},"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/event-players/{objectId}/claim":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventClaimResponse"}}}},"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/EventClaimRequest"}}}},"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/event-players/{objectId}/score":{"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/EventScoreRequest"}}}},"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}]}},"components":{"schemas":{"EventInventoryRewardItem":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}}},"required":["id"]},"ItemCreateRequest":{"type":"object","additionalProperties":false,"properties":{"contentId":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ItemProperty"}}},"required":["contentId","properties"]},"EventClaimResponse":{"properties":{"view":{"$ref":"#/components/schemas/EventPlayerStateView"},"gameRspJson":{"type":"string"}},"additionalProperties":false,"title":"Event Claim Response","type":"object","required":["view","gameRspJson"]},"EventPlayerView":{"properties":{"running":{"type":"array","items":{"$ref":"#/components/schemas/EventPlayerStateView"}},"done":{"type":"array","items":{"$ref":"#/components/schemas/EventPlayerStateView"}}},"additionalProperties":false,"title":"Event Player View","type":"object","required":["running","done"]},"CommonResponse":{"properties":{"result":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false,"title":"Common Response","type":"object","required":["result","data"]},"EventRewardState":{"type":"object","additionalProperties":false,"properties":{"pendingInventoryRewards":{"$ref":"#/components/schemas/EventInventoryPendingRewards"},"currencies":{"type":"array","items":{"$ref":"#/components/schemas/EventInventoryRewardCurrency"}},"pendingCurrencyRewards":{"type":"object","additionalProperties":{"type":"string"}},"pendingItemRewards":{"type":"array","items":{"$ref":"#/components/schemas/ItemCreateRequest"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/EventInventoryRewardItem"}},"min":{"type":"number","format":"double"},"max":{"type":"number","format":"double"},"earned":{"type":"boolean"},"claimed":{"type":"boolean"},"pendingEntitlementRewards":{"type":"object","additionalProperties":{"type":"string"}},"obtain":{"type":"array","items":{"$ref":"#/components/schemas/EventRewardObtain"}}},"required":["min","earned","claimed","pendingInventoryRewards"]},"EventScoreRequest":{"properties":{"eventId":{"type":"string"},"score":{"type":"number","format":"double"},"increment":{"type":"boolean"},"stats":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false,"title":"Event Score Request","type":"object","required":["eventId","score"]},"EventRewardObtain":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"count":{"type":"integer","format":"int32"}},"required":["symbol","count"]},"EventClaimRequest":{"properties":{"eventId":{"type":"string"}},"additionalProperties":false,"title":"Event Claim Request","type":"object","required":["eventId"]},"EventInventoryRewardCurrency":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"amount":{"type":"integer","format":"int64"}},"required":["id","amount"]},"EventInventoryPendingRewards":{"type":"object","additionalProperties":false,"properties":{"currencies":{"type":"object","additionalProperties":{"type":"string"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemCreateRequest"}},"empty":{"type":"boolean"}},"required":["empty"]},"EventPlayerStateView":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"running":{"type":"boolean"},"allPhases":{"type":"array","items":{"$ref":"#/components/schemas/EventPlayerPhaseView"}},"rank":{"type":"integer","format":"int64"},"score":{"type":"number","format":"double"},"currentPhase":{"$ref":"#/components/schemas/EventPlayerPhaseView"},"secondsRemaining":{"type":"integer","format":"int64"},"id":{"type":"string"},"leaderboardId":{"type":"string"},"rankRewards":{"type":"array","items":{"$ref":"#/components/schemas/EventRewardState"}},"groupRewards":{"$ref":"#/components/schemas/EventPlayerGroupState"},"scoreRewards":{"type":"array","items":{"$ref":"#/components/schemas/EventRewardState"}}},"required":["id","name","leaderboardId","score","rank","scoreRewards","rankRewards","running","secondsRemaining","allPhases"]},"EventPlayerPhaseView":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"durationSeconds":{"type":"integer","format":"int64"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/EventRule"}}},"required":["name","durationSeconds","rules"]},"ItemProperty":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"EventRule":{"type":"object","additionalProperties":false,"properties":{"rule":{"type":"string"},"value":{"type":"string"}},"required":["rule","value"]},"EventPlayerGroupState":{"type":"object","additionalProperties":false,"properties":{"groupScore":{"type":"number","format":"double"},"groupId":{"type":"string"},"rankRewards":{"type":"array","items":{"$ref":"#/components/schemas/EventRewardState"}},"groupRank":{"type":"integer","format":"int64"},"scoreRewards":{"type":"array","items":{"$ref":"#/components/schemas/EventRewardState"}}},"required":["groupScore","groupRank","scoreRewards","rankRewards"]}},"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"}