{"info":{"title":"inventory 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/inventory/{objectId}/preview":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewVipBonusResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"Gamertag"},"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/InventoryUpdateRequest"}}}},"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/inventory/{objectId}/multipliers":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipliersGetResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"Gamertag"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"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/inventory/{objectId}/transaction":{"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"Gamertag"},"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/EndTransactionRequest"}}}},"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/inventory/{objectId}/":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryView"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"scope","in":"query","schema":{"type":"string"},"required":false},{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"Gamertag"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"security":[{}]},"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryView"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"Gamertag"},"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/InventoryQueryRequest"}}}},"security":[{}]},"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryUpdateResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"Gamertag"},"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/InventoryUpdateRequest"}}}},"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/inventory/{objectId}/proxy/reload":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"Gamertag"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"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/inventory/{objectId}/transfer":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"Gamertag"},"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/TransferRequest"}}}},"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"]},"ItemDeltas":{"type":"object","additionalProperties":false,"properties":{"created":{"type":"array","items":{"$ref":"#/components/schemas/ItemPropertiesDelta"}},"updated":{"type":"array","items":{"$ref":"#/components/schemas/ItemPropertiesDelta"}},"deleted":{"type":"array","items":{"$ref":"#/components/schemas/ItemPropertiesDelta"}}},"required":["created","updated","deleted"]},"ItemPropertiesDelta":{"type":"object","additionalProperties":false,"properties":{"contentId":{"type":"string"},"itemId":{"type":"integer","format":"int64"},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PropertyDelta"}}},"required":["contentId","itemId"]},"ItemGroup":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}},"required":["id","items"]},"ItemUpdateRequest":{"type":"object","additionalProperties":false,"properties":{"contentId":{"type":"string"},"id":{"type":"integer","format":"int64"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ItemProperty"}}},"required":["contentId","id","properties"]},"PropertyDelta":{"type":"object","additionalProperties":false,"properties":{"before":{"type":"string"},"after":{"type":"string"}}},"CommonResponse":{"properties":{"result":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false,"title":"Common Response","type":"object","required":["result","data"]},"TimeRange":{"type":"object","additionalProperties":false,"properties":{"from":{"type":"integer","format":"int64"},"to":{"type":"integer","format":"int64"}}},"CurrencyPreview":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"amount":{"type":"integer","format":"int64"},"originalAmount":{"type":"integer","format":"int64"}},"required":["id","amount","originalAmount"]},"ContentTagFilter":{"type":"object","additionalProperties":false,"properties":{"allOf":{"type":"array","items":{"type":"string"}},"anyOf":{"type":"array","items":{"type":"string"}},"noneOf":{"type":"array","items":{"type":"string"}}},"required":["allOf","anyOf","noneOf"]},"CurrencyView":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"amount":{"type":"integer","format":"int64"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyProperty"}},"proxy":{"$ref":"#/components/schemas/FederationInfo"}},"required":["id","amount","properties"]},"InventoryView":{"properties":{"currencies":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyView"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemGroup"}},"scope":{"type":"string"},"itemFilters":{"$ref":"#/components/schemas/InventoryFiltersDTO"}},"additionalProperties":false,"title":"Inventory View","type":"object","required":["currencies","items"]},"InventoryUpdateDelta":{"type":"object","additionalProperties":false,"properties":{"currencies":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CurrencyDelta"}},"items":{"$ref":"#/components/schemas/ItemDeltas"}},"required":["currencies","items"]},"InventoryGetRequest":{"properties":{"scope":{"type":"string"}},"additionalProperties":false,"title":"Inventory Get Request","type":"object"},"MultipliersGetResponse":{"properties":{"multipliers":{"type":"array","items":{"$ref":"#/components/schemas/VipBonus"}}},"additionalProperties":false,"title":"Multipliers Get Response","type":"object","required":["multipliers"]},"CurrencyProperty":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"EndTransactionRequest":{"properties":{"transaction":{"type":"string"}},"additionalProperties":false,"title":"End Transaction Request","type":"object","required":["transaction"]},"OptionalJsonNodeWrapper":{"type":"object","additionalProperties":false,"x-beamable-json-object":true,"properties":{"node":{"type":"string"}}},"PredicateDTO":{"type":"object","additionalProperties":false,"properties":{"caseInsensitive":{"type":"boolean"},"as":{"type":"string"},"lower":{"type":"string"},"upper":{"type":"string"},"substr":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"kind":{"type":"string"},"includeUpper":{"type":"boolean"},"value":{"type":"string"},"includeLower":{"type":"boolean"}},"required":["kind"]},"InventoryUpdateRequest":{"properties":{"currencies":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"includeDeltas":{"type":"boolean"},"scopes":{"type":"array","items":{"type":"string"}},"currencyProperties":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyProperty"}}},"applyVipBonus":{"type":"boolean"},"updateItems":{"type":"array","items":{"$ref":"#/components/schemas/ItemUpdateRequest"}},"newItems":{"type":"array","items":{"$ref":"#/components/schemas/ItemCreateRequest"}},"transaction":{"type":"string"},"deleteItems":{"type":"array","items":{"$ref":"#/components/schemas/ItemDeleteRequest"}}},"additionalProperties":false,"title":"Inventory Update Request","type":"object"},"PropertyFilterDTO":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string"},"predicate":{"$ref":"#/components/schemas/PredicateDTO"}},"required":["key","predicate"]},"Item":{"type":"object","additionalProperties":false,"properties":{"updatedAt":{"type":"integer","format":"int64"},"proxyId":{"type":"string"},"id":{"type":"integer","format":"int64"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ItemProperty"}},"proxy":{"$ref":"#/components/schemas/FederationInfo"},"createdAt":{"type":"integer","format":"int64"}},"required":["id","properties"]},"CurrencyDelta":{"type":"object","additionalProperties":false,"properties":{"before":{"type":"integer","format":"int64"},"after":{"type":"integer","format":"int64"},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PropertyDelta"}}},"required":["before","after"]},"ItemProperty":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"InventoryQueryRequest":{"properties":{"scopes":{"type":"array","items":{"type":"string"}},"itemFilters":{"$ref":"#/components/schemas/InventoryFiltersDTO"}},"additionalProperties":false,"title":"Inventory Query Request","type":"object"},"InventoryUpdateResponse":{"properties":{"result":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"string"}},"deltas":{"$ref":"#/components/schemas/InventoryUpdateDelta"}},"additionalProperties":false,"title":"Inventory Update Response","type":"object","required":["result","data"]},"ItemDeleteRequest":{"type":"object","additionalProperties":false,"properties":{"contentId":{"type":"string"},"id":{"type":"integer","format":"int64"}},"required":["contentId","id"]},"VipBonus":{"type":"object","additionalProperties":false,"properties":{"currency":{"type":"string"},"multiplier":{"type":"number","format":"double"},"roundToNearest":{"type":"integer","format":"int32"}},"required":["currency","multiplier","roundToNearest"]},"PreviewVipBonusResponse":{"properties":{"currencies":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyPreview"}}},"additionalProperties":false,"title":"Preview Vip Bonus Response","type":"object","required":["currencies"]},"InventoryFiltersDTO":{"type":"object","additionalProperties":false,"properties":{"updatedAt":{"$ref":"#/components/schemas/TimeRange"},"proxyIds":{"type":"array","items":{"type":"string"}},"propertyFilters":{"type":"array","items":{"$ref":"#/components/schemas/PropertyFilterDTO"}},"createdAt":{"$ref":"#/components/schemas/TimeRange"},"contentTagFilter":{"$ref":"#/components/schemas/ContentTagFilter"}}},"FederationInfo":{"type":"object","additionalProperties":false,"properties":{"service":{"type":"string"},"namespace":{"type":"string"},"settings":{"$ref":"#/components/schemas/OptionalJsonNodeWrapper"}},"required":["service","namespace"]},"TransferRequest":{"properties":{"transaction":{"type":"string"},"recipientPlayer":{"type":"integer","format":"int64","x-beamable-semantic-type":"Gamertag"},"currencies":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}}},"additionalProperties":false,"title":"Transfer Request","type":"object","required":["recipientPlayer"]}},"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"}