{"info":{"title":"announcements basic","version":"1.0","contact":{"name":"Beamable Support","url":"https://api.beamable.com","email":"support@beamable.com"}},"servers":[{"url":"https://api.beamable.com"}],"paths":{"/basic/announcements/list/tags":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"tagNameFilter","in":"query","schema":{"type":"string"},"required":false}],"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}]},"/basic/announcements/list":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementContentResponse"}}}},"400":{"description":"Bad Request"}},"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}]},"/basic/announcements/search":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementContentResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"date","in":"query","schema":{"type":"string"},"required":false}],"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}]},"/basic/announcements/list/definitions":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDefinitionsResponse"}}}},"400":{"description":"Bad Request"}},"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}]},"/basic/announcements/":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementDto"}}}},"security":[{"user":["developer"]},{"server":[]}]},"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAnnouncementRequest"}}}},"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}]},"/basic/announcements/content":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementContentResponse"}}}},"400":{"description":"Bad Request"}},"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":{"ListTagsResponse":{"properties":{"tags":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"title":"List Tags Response","type":"object","required":["tags"]},"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"]},"AnnouncementContent":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"string"},"channel":{"type":"string"},"start_date":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"gift":{"$ref":"#/components/schemas/PlayerReward"},"stat_requirements":{"type":"array","items":{"$ref":"#/components/schemas/PlayerStatRequirement"}},"symbol":{"type":"string"},"clientData":{"type":"object","additionalProperties":{"type":"string"}},"end_date":{"type":"string"},"title":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementAttachment"}},"summary":{"type":"string"}},"required":["symbol","channel","title","summary","body"]},"WebhookInvocationType":{"type":"string","enum":["NonBlocking","Blocking"]},"AnnouncementContentResponse":{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementContent"}}},"additionalProperties":false,"title":"Announcement Content Response","type":"object","required":["content"]},"LocalizationRef":{"type":"object","additionalProperties":false,"properties":{"localizationId":{"type":"string"},"defaultValue":{"type":"string"},"empty":{"type":"boolean"}},"required":["localizationId","empty"]},"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"]},"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"]},"RouteParameters":{"type":"object","additionalProperties":false,"properties":{"parameters":{"type":"array","items":{"$ref":"#/components/schemas/RouteParameter"}},"payload":{"type":"string"},"objectId":{"type":"string"}},"required":["parameters"]},"ListDefinitionsResponse":{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementDto"}}},"additionalProperties":false,"title":"List Definitions Response","type":"object","required":["content"]},"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"]},"DeleteAnnouncementRequest":{"properties":{"symbol":{"type":"string"}},"additionalProperties":false,"title":"Delete Announcement Request","type":"object","required":["symbol"]},"EmptyResponse":{"properties":{"result":{"type":"string"}},"additionalProperties":false,"title":"Empty Response","type":"object","required":["result"]},"ItemProperty":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"ListTagsRequest":{"properties":{"tagNameFilter":{"type":"string"}},"additionalProperties":false,"title":"List Tags Request","type":"object"},"AnnouncementDto":{"type":"object","additionalProperties":false,"properties":{"body":{"$ref":"#/components/schemas/LocalizationRef"},"channel":{"type":"string"},"start_date":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"gift":{"$ref":"#/components/schemas/PlayerReward"},"stat_requirements":{"type":"array","items":{"$ref":"#/components/schemas/PlayerStatRequirement"}},"symbol":{"type":"string"},"clientData":{"type":"object","additionalProperties":{"type":"string"}},"end_date":{"type":"string"},"title":{"$ref":"#/components/schemas/LocalizationRef"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementAttachment"}},"summary":{"$ref":"#/components/schemas/LocalizationRef"}},"required":["symbol","channel","title","summary","body"]},"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"]},"SearchAnnouncementsRequest":{"properties":{"date":{"type":"string"}},"additionalProperties":false,"title":"Search Announcements Request","type":"object"}},"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"}