{"info":{"title":"announcements 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/announcements/{objectId}/read":{"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/AnnouncementRequest"}}}},"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/announcements/{objectId}/claim":{"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/AnnouncementRequest"}}}},"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/announcements/{objectId}/raw":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementRawResponse"}}}},"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":["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/announcements/{objectId}/":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementQueryResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"include_deleted","in":"query","schema":{"type":"boolean"},"required":false},{"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":["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":"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/AnnouncementRequest"}}}},"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":{"ItemCreateRequest":{"type":"object","additionalProperties":false,"properties":{"contentId":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ItemProperty"}}},"required":["contentId","properties"]},"WebhookComet":{"type":"object","additionalProperties":false,"properties":{"method":{"type":"string"},"description":{"type":"string"},"variables":{"$ref":"#/components/schemas/RouteVariables"},"symbol":{"type":"string"},"route":{"$ref":"#/components/schemas/ServiceRoute"},"parameters":{"$ref":"#/components/schemas/RouteParameters"}},"required":["symbol","method","route","variables","parameters"]},"WebhookServiceType":{"type":"string","enum":["UserMicroservice","ObjectService","BasicService"]},"AnnouncementRawResponse":{"properties":{"announcements":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnnouncementState"}}},"additionalProperties":false,"title":"Announcement Raw Response","type":"object","required":["announcements"]},"WebhookInvocationType":{"type":"string","enum":["NonBlocking","Blocking"]},"CommonResponse":{"properties":{"result":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false,"title":"Common Response","type":"object","required":["result","data"]},"AnnouncementQuery":{"properties":{"include_deleted":{"type":"boolean"}},"additionalProperties":false,"title":"Announcement Query","type":"object"},"AnnouncementAttachment":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"count":{"type":"integer","format":"int32"},"type":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentProperty"}}},"required":["symbol","count"]},"RouteVariable":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"typeName":{"type":"string"}},"required":["name","typeName"]},"WebhookInvocationStrategy":{"type":"object","additionalProperties":false,"properties":{"invocationType":{"$ref":"#/components/schemas/WebhookInvocationType"},"retryType":{"$ref":"#/components/schemas/WebhookRetryType"}},"required":["invocationType","retryType"]},"RouteParameter":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"body":{"type":"string"},"typeName":{"type":"string"},"variableRef":{"$ref":"#/components/schemas/VariableReference"}},"required":["name","body","typeName"]},"RouteVariables":{"type":"object","additionalProperties":false,"properties":{"variables":{"type":"array","items":{"$ref":"#/components/schemas/RouteVariable"}}},"required":["variables"]},"PlayerReward":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"addItemRequests":{"type":"array","items":{"$ref":"#/components/schemas/ItemCreateRequest"}},"changeCurrencies":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyChangeReward"}},"callWebhooks":{"type":"array","items":{"$ref":"#/components/schemas/WebhookReward"}},"addItems":{"type":"array","items":{"$ref":"#/components/schemas/NewItemReward"}},"applyVipBonus":{"type":"boolean"},"addCurrencyMap":{"type":"object","additionalProperties":{"type":"string"}}},"required":["addCurrencyMap","addItemRequests"]},"VariableReference":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"]},"AttachmentProperty":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"RouteParameters":{"type":"object","additionalProperties":false,"properties":{"parameters":{"type":"array","items":{"$ref":"#/components/schemas/RouteParameter"}},"payload":{"type":"string"},"objectId":{"type":"string"}},"required":["parameters"]},"AnnouncementState":{"type":"object","additionalProperties":false,"properties":{"isRead":{"type":"boolean"},"isClaimed":{"type":"boolean"},"isDeleted":{"type":"boolean"}},"required":["isRead","isClaimed","isDeleted"]},"ServiceRoute":{"type":"object","additionalProperties":false,"properties":{"service":{"type":"string"},"endpoint":{"type":"string"},"serviceTypeStr":{"$ref":"#/components/schemas/WebhookServiceType"}},"required":["service","endpoint","serviceTypeStr"]},"CurrencyChangeReward":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"amount":{"type":"integer","format":"int64"}},"required":["symbol","amount"]},"AnnouncementRequest":{"properties":{"announcement":{"type":"string"},"announcements":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"title":"Announcement Request","type":"object"},"ItemProperty":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"AnnouncementQueryResponse":{"properties":{"announcements":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementView"}}},"additionalProperties":false,"title":"Announcement Query Response","type":"object","required":["announcements"]},"WebhookReward":{"type":"object","additionalProperties":false,"properties":{"webhookSymbol":{"type":"string"},"strategy":{"$ref":"#/components/schemas/WebhookInvocationStrategy"},"webHookComet":{"$ref":"#/components/schemas/WebhookComet"}},"required":["strategy"]},"NewItemReward":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}}},"required":["symbol"]},"WebhookRetryType":{"type":"string","enum":["None","Once","ExponentialBackoff"]},"AnnouncementView":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"string"},"isClaimed":{"type":"boolean"},"channel":{"type":"string"},"endDate":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"clientDataList":{"type":"array","items":{"$ref":"#/components/schemas/ClientDataEntry"}},"gift":{"$ref":"#/components/schemas/PlayerReward"},"secondsRemaining":{"type":"integer","format":"int64"},"id":{"type":"string"},"isDeleted":{"type":"boolean"},"isRead":{"type":"boolean"},"title":{"type":"string"},"startDate":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementAttachment"}},"summary":{"type":"string"}},"required":["id","channel","title","summary","body","attachments","isRead","isClaimed","isDeleted","clientDataList"]},"ClientDataEntry":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]}},"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"}