Beamable Object API

openapi: 3.0.2
info:
  title: realms Basic Object API
  version: '1.0'
  contact:
    name: Beamable Support
    url: https://api.beamable.com
    email: support@beamable.com
servers:
- url: https://api.beamable.com
security: []
tags:
- name: Object
paths:
  /object/event-players/{objectId}/claim-entitlements:
    post:
      parameters:
      - name: objectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventClaimEntitlementsRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '400':
          description: Bad Request
      security:
      - scope: []
        user: []
      tags:
      - Object
  /object/event-players/{objectId}/:
    get:
      parameters:
      - name: objectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventPlayerView'
        '400':
          description: Bad Request
      security:
      - scope: []
      tags:
      - Object
  /object/event-players/{objectId}/claim:
    post:
      parameters:
      - name: objectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventClaimRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventClaimResponse'
        '400':
          description: Bad Request
      security:
      - scope: []
      tags:
      - Object
  /object/event-players/{objectId}/score:
    put:
      parameters:
      - name: objectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventScoreRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '400':
          description: Bad Request
      security:
      - scope: []
      tags:
      - Object
components:
  schemas:
    EventPlayerStateView:
      required:
      - score
      - rank
      - running
      - secondsRemaining
      type: object
      properties:
        name:
          type: string
        running:
          type: boolean
        allPhases:
          type: array
          items:
            $ref: '#/components/schemas/EventPlayerPhaseView'
        rank:
          type: integer
        score:
          type: number
        currentPhase:
          $ref: '#/components/schemas/EventPlayerPhaseView'
        secondsRemaining:
          type: integer
        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'
      additionalProperties: false
    EventInventoryRewardItem:
      type: object
      properties:
        id:
          type: string
        properties:
          type: object
      additionalProperties: false
    EventRewardObtain:
      required:
      - count
      type: object
      properties:
        symbol:
          type: string
        count:
          type: integer
      additionalProperties: false
    ItemProperty:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
      additionalProperties: false
    EventPlayerView:
      title: Event Player View
      type: object
      properties:
        running:
          type: array
          items:
            $ref: '#/components/schemas/EventPlayerStateView'
        done:
          type: array
          items:
            $ref: '#/components/schemas/EventPlayerStateView'
      additionalProperties: false
    ItemCreateRequest:
      type: object
      properties:
        contentId:
          type: string
        properties:
          type: array
          items:
            $ref: '#/components/schemas/ItemProperty'
      additionalProperties: false
    EventInventoryRewardCurrency:
      required:
      - amount
      type: object
      properties:
        id:
          type: string
        amount:
          type: integer
      additionalProperties: false
    EventInventoryPendingRewards:
      required:
      - empty
      type: object
      properties:
        currencies:
          type: object
        items:
          type: array
          items:
            $ref: '#/components/schemas/ItemCreateRequest'
        empty:
          type: boolean
      additionalProperties: false
    CommonResponse:
      title: Common Response
      type: object
      properties:
        result:
          type: string
        data:
          type: object
      additionalProperties: false
    EventPlayerPhaseView:
      required:
      - durationSeconds
      type: object
      properties:
        name:
          type: string
        durationSeconds:
          type: integer
        rules:
          type: array
          items:
            $ref: '#/components/schemas/EventRule'
      additionalProperties: false
    EventClaimResponse:
      title: Event Claim Response
      type: object
      properties:
        view:
          $ref: '#/components/schemas/EventPlayerStateView'
        gameRspJson:
          type: string
      additionalProperties: false
    EventRule:
      type: object
      properties:
        rule:
          type: string
        value:
          type: string
      additionalProperties: false
    EventClaimRequest:
      title: Event Claim Request
      type: object
      properties:
        eventId:
          type: string
      additionalProperties: false
    EventScoreRequest:
      title: Event Score Request
      required:
      - score
      type: object
      properties:
        eventId:
          type: string
        score:
          type: number
        increment:
          type: boolean
        stats:
          type: object
      additionalProperties: false
    EntitlementClaimWindow:
      required:
      - open
      - close
      type: object
      properties:
        open:
          type: integer
        close:
          type: integer
      additionalProperties: false
    EventClaimEntitlementsRequest:
      title: Event Claim Entitlements Request
      type: object
      properties:
        eventId:
          type: string
        generators:
          type: array
          items:
            $ref: '#/components/schemas/EntitlementGenerator'
      additionalProperties: false
    EntitlementGenerator:
      type: object
      properties:
        quantity:
          type: integer
        claimWindow:
          $ref: '#/components/schemas/EntitlementClaimWindow'
        params:
          type: object
        symbol:
          type: string
        specialization:
          type: string
        action:
          type: string
      additionalProperties: false
    EventPlayerGroupState:
      required:
      - groupScore
      - groupRank
      type: object
      properties:
        groupScore:
          type: number
        groupId:
          type: string
        rankRewards:
          type: array
          items:
            $ref: '#/components/schemas/EventRewardState'
        groupRank:
          type: integer
        scoreRewards:
          type: array
          items:
            $ref: '#/components/schemas/EventRewardState'
      additionalProperties: false
    EventRewardState:
      required:
      - min
      - earned
      - claimed
      type: object
      properties:
        pendingInventoryRewards:
          $ref: '#/components/schemas/EventInventoryPendingRewards'
        currencies:
          type: array
          items:
            $ref: '#/components/schemas/EventInventoryRewardCurrency'
        pendingCurrencyRewards:
          type: object
        pendingItemRewards:
          type: array
          items:
            $ref: '#/components/schemas/ItemCreateRequest'
        items:
          type: array
          items:
            $ref: '#/components/schemas/EventInventoryRewardItem'
        min:
          type: number
        max:
          type: number
        earned:
          type: boolean
        claimed:
          type: boolean
        pendingEntitlementRewards:
          type: object
        obtain:
          type: array
          items:
            $ref: '#/components/schemas/EventRewardObtain'
      additionalProperties: false
  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>
externalDocs:
  description: Beamable Documentation
  url: https://docs.beamable.com