{"info":{"title":"events 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/events/{objectId}/endPhase":{"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":"Format: events.event_content_id.event_started_timestamp","required":true,"x-beamable-object-id":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventPhaseEndRequest"}}}},"security":[{"user":["developer"]},{"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/events/{objectId}/":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventObjectData"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Format: events.event_content_id.event_started_timestamp","required":true,"x-beamable-object-id":{"type":"string"}}],"security":[{"user":["tester"]},{"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/events/{objectId}/ping":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PingRsp"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Format: events.event_content_id.event_started_timestamp","required":true,"x-beamable-object-id":{"type":"string"}}],"security":[{"user":["tester"]},{"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/events/{objectId}/content":{"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":"Format: events.event_content_id.event_started_timestamp","required":true,"x-beamable-object-id":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetContentRequest"}}}},"security":[{"user":["developer"]},{"server":[]}]},"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":"Format: events.event_content_id.event_started_timestamp","required":true,"x-beamable-object-id":{"type":"string"}}],"security":[{"user":["developer"]},{"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/events/{objectId}/refresh":{"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":"Format: events.event_content_id.event_started_timestamp","required":true,"x-beamable-object-id":{"type":"string"}}],"security":[{"user":["developer"]},{"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":{"EventInventoryRewardItem":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}}},"required":["id"]},"LeaderboardCohort":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"description":{"type":"string"},"statRequirements":{"type":"array","items":{"$ref":"#/components/schemas/PlayerStatRequirement"}}},"required":["id","statRequirements"]},"EventPhaseEndRequest":{"properties":{"time":{"type":"string"}},"additionalProperties":false,"title":"Event Phase End Request","type":"object"},"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"]},"LeaderboardCohortSettings":{"type":"object","additionalProperties":false,"properties":{"cohorts":{"type":"array","items":{"$ref":"#/components/schemas/LeaderboardCohort"}}},"required":["cohorts"]},"PingRsp":{"properties":{"keepAlive":{"type":"boolean"}},"additionalProperties":false,"title":"Ping Rsp","type":"object","required":["keepAlive"]},"Event":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"start_date":{"type":"string"},"phases":{"type":"array","items":{"$ref":"#/components/schemas/EventPhase"}},"partition_size":{"type":"integer","format":"int32"},"group_rewards":{"$ref":"#/components/schemas/EventGroupRewards"},"cohortSettings":{"$ref":"#/components/schemas/LeaderboardCohortSettings"},"permissions":{"$ref":"#/components/schemas/ClientPermission"},"stores":{"type":"array","items":{"type":"string"}},"symbol":{"type":"string"},"score_rewards":{"type":"array","items":{"$ref":"#/components/schemas/EventRewardContent"}},"schedule":{"$ref":"#/components/schemas/Schedule"},"rank_rewards":{"type":"array","items":{"$ref":"#/components/schemas/EventRewardContent"}}},"required":["symbol","name","start_date","phases"]},"CommonResponse":{"properties":{"result":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false,"title":"Common Response","type":"object","required":["result","data"]},"EventPhaseTime":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"startTime":{"type":"integer","format":"int64"},"endTime":{"type":"integer","format":"int64"}},"required":["name"]},"EventRewardObtain":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"count":{"type":"integer","format":"int32"}},"required":["symbol","count"]},"PlayerStatRequirement":{"type":"object","additionalProperties":false,"properties":{"domain":{"type":"string"},"stat":{"type":"string"},"constraint":{"type":"string"},"value":{"type":"string"},"access":{"type":"string"}},"required":["stat","constraint","value"]},"EventGroupRewards":{"type":"object","additionalProperties":false,"properties":{"scoreRewards":{"type":"array","items":{"$ref":"#/components/schemas/EventRewardContent"}}}},"ClientPermission":{"type":"object","additionalProperties":false,"properties":{"write_self":{"type":"boolean"}},"required":["write_self"]},"EventRewardContent":{"type":"object","additionalProperties":false,"properties":{"currencies":{"type":"array","items":{"$ref":"#/components/schemas/EventInventoryRewardCurrency"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/EventInventoryRewardItem"}},"min":{"type":"number","format":"double"},"max":{"type":"number","format":"double"},"obtain":{"type":"array","items":{"$ref":"#/components/schemas/EventRewardObtain"}}},"required":["min"]},"EventPhaseRuntime":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"startTime":{"type":"integer","format":"int64"},"endTime":{"type":"integer","format":"int64"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/EventRule"}}},"required":["name","startTime","endTime","rules"]},"EventObjectData":{"properties":{"inFlight":{"type":"array","items":{"$ref":"#/components/schemas/InFlightMessage"}},"startTime":{"type":"integer","format":"int64"},"rootEventId":{"type":"string"},"originType":{"type":"string"},"state":{"$ref":"#/components/schemas/EventState"},"running":{"type":"boolean"},"phase":{"$ref":"#/components/schemas/EventPhaseRuntime"},"permissions":{"$ref":"#/components/schemas/ClientPermission"},"lastChildEventId":{"type":"string"},"endTime":{"type":"integer","format":"int64"},"id":{"type":"string"},"origin":{"type":"string"},"createdAt":{"type":"integer","format":"int64"},"content":{"$ref":"#/components/schemas/Event"},"done":{"type":"boolean"},"leaderboardId":{"type":"string"},"phaseTimes":{"type":"array","items":{"$ref":"#/components/schemas/EventPhaseTime"}}},"additionalProperties":false,"title":"Event Object Data","type":"object","required":["id","content","leaderboardId","state","done","running"]},"EventInventoryRewardCurrency":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"amount":{"type":"integer","format":"int64"}},"required":["id","amount"]},"EventState":{"type":"string","enum":["running","unknown","cancelled","done","pending"]},"EventRule":{"type":"object","additionalProperties":false,"properties":{"rule":{"type":"string"},"value":{"type":"string"}},"required":["rule","value"]},"Schedule":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"crons":{"type":"array","items":{"type":"string"}},"activeTo":{"type":"string"},"activeFrom":{"type":"string"},"definitions":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleDefinition"}}},"required":["activeFrom"]},"ScheduleDefinition":{"type":"object","additionalProperties":false,"properties":{"dayOfWeek":{"type":"array","items":{"type":"string"}},"minute":{"type":"array","items":{"type":"string"}},"dayOfMonth":{"type":"array","items":{"type":"string"}},"year":{"type":"array","items":{"type":"string"}},"hour":{"type":"array","items":{"type":"string"}},"second":{"type":"array","items":{"type":"string"}},"month":{"type":"array","items":{"type":"string"}}},"required":["second","minute","hour","dayOfMonth","month","dayOfWeek","year"]},"EventPhase":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"duration_minutes":{"type":"integer","format":"int32"},"durationMillis":{"type":"integer","format":"int64"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/EventRule"}},"durationSeconds":{"type":"integer","format":"int64"}},"required":["name","duration_minutes","durationMillis","durationSeconds"]},"SetContentRequest":{"properties":{"event":{"$ref":"#/components/schemas/Event"},"origin":{"type":"string"},"rootEventId":{"type":"string"},"originType":{"type":"string"}},"additionalProperties":false,"title":"Set Content Request","type":"object","required":["event","origin"]}},"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"}