openapi: 3.2.0
info:
  title: THEOads Monetized Stream V2 API
  version: 25.9.0
  description: The THEOads REST API allows you to create and manage monetized streams, which are deployments of signaling services. Each monetized stream corresponds to an origin stream that is monetized using THEOads (SGAI). For detailed information on the various parameters and their usage, please refer to the getting started guide.
  license:
    name: UNLICENSED
  contact: {}
servers:
- url: /ads-client/api
tags:
- name: Monetized-Stream-V2
paths:
  /v2/monetized-streams:
    get:
      operationId: GetMonetizedStreamsPaginated
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/MonetizedStreamApiResponse'
                - type: string
      tags:
      - Monetized-Stream-V2
      security: []
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          format: double
          type: number
      - in: query
        name: skip
        required: false
        schema:
          format: double
          type: number
      summary: Get monetized streams paginated
      x-summary-source: derived
  /v2/monetized-streams/{monetizedStreamId}/break:
    get:
      operationId: GetMonetizedStreamBreaksPaginated
      responses:
        '200':
          description: A monetized stream
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/AdbreakApiResponse'
                - type: string
      description: Retrieves all adbreaks linked to the monetized stream
      tags:
      - Monetized-Stream-V2
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      - in: query
        name: limit
        required: false
        schema:
          format: double
          type: number
      - in: query
        name: skip
        required: false
        schema:
          format: double
          type: number
      summary: Get monetized stream breaks paginated
      x-summary-source: derived
  /v2/monetized-streams/{monetizedStreamId}/overlay:
    get:
      operationId: GetMonetizedStreamOverlaysPaginated
      responses:
        '200':
          description: A monetized stream
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/OverlayApiResponse'
                - type: string
      description: Retrieves all overlays linked to the monetized sctream
      tags:
      - Monetized-Stream-V2
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      - in: query
        name: limit
        required: false
        schema:
          format: double
          type: number
      - in: query
        name: skip
        required: false
        schema:
          format: double
          type: number
      summary: Get monetized stream overlays paginated
      x-summary-source: derived
components:
  schemas:
    OverlayApiResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/IOverlay'
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationDetails'
      required:
      - data
      - pagination
      type: object
      additionalProperties: false
    MonetizedStreamLayout:
      enum:
      - SINGLE
      - DOUBLE
      - LSHAPE_AD
      - LSHAPE_CONTENT
      type: string
    IAdBreak:
      properties:
        id:
          type: string
        startDate:
          type: string
        endDate:
          type:
          - string
          - 'null'
          format: date-time
        duration:
          type: number
          format: double
        source:
          type: string
        layout:
          $ref: '#/components/schemas/MonetizedStreamLayout'
        assetURI:
          type: string
        status:
          $ref: '#/components/schemas/SignaledAdBreakStatus'
        asset_key:
          type: string
        network_code:
          type: string
        backdropURI:
          type: string
        backdropURIGamProperties:
          $ref: '#/components/schemas/IGamProperties'
        startPts:
          type: number
          format: double
        name:
          type: string
      required:
      - id
      - startDate
      type: object
      additionalProperties: false
    MonetizedStreamApiResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/IMonetizedStream'
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationDetails'
      required:
      - data
      - pagination
      type: object
      additionalProperties: false
    IMonetizedStream:
      properties:
        name:
          type: string
        version:
          type: string
        streamId:
          type: string
        streamType:
          $ref: '#/components/schemas/MonetizedStreamType'
        origin:
          type: string
        segmentOrigin:
          type: string
        layout:
          $ref: '#/components/schemas/MonetizedStreamLayout'
        assetKey:
          type: string
        networkCode:
          type: string
        originPath:
          type: string
        assetURI:
          type: string
        backdropURI:
          type: string
        backdropURIGamProperties:
          $ref: '#/components/schemas/IGamProperties'
      required:
      - streamId
      - layout
      type: object
      additionalProperties: false
    SignaledAdBreakStatus:
      enum:
      - new
      - future
      - signaled
      - finished
      - error
      - continuous
      type: string
    AdbreakApiResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/IAdBreak'
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationDetails'
      required:
      - data
      - pagination
      type: object
      additionalProperties: false
    OverlayURITypes:
      enum:
      - png
      - svg
      type: string
    IGamProperties:
      properties:
        iu:
          type: string
        sz:
          properties:
            tv:
              type: string
            phone:
              type: string
            default:
              type: string
          required:
          - default
          type: object
      required:
      - iu
      - sz
      type: object
      additionalProperties: false
    IOverlay:
      properties:
        name:
          type: string
        id:
          type: string
        startDate:
          type: string
        endDate:
          type: string
        duration:
          type: number
          format: double
        type:
          $ref: '#/components/schemas/OverlayTypes'
        position:
          properties:
            bottom:
              type: number
              format: double
            top:
              type: number
              format: double
            right:
              type: number
              format: double
            left:
              type: number
              format: double
          type: object
        size:
          properties:
            height:
              type: number
              format: double
            width:
              type: number
              format: double
          required:
          - height
          - width
          type: object
        opacity:
          type: number
          format: double
        gamProperties:
          $ref: '#/components/schemas/IGamProperties'
        resourceURI:
          items:
            properties:
              tv:
                type: string
              phone:
                type: string
              default:
                type: string
              type:
                $ref: '#/components/schemas/OverlayURITypes'
            required:
            - default
            - type
            type: object
          type: array
        clickThroughURI:
          type: string
      required:
      - id
      - startDate
      - duration
      - type
      - position
      - size
      type: object
      additionalProperties: false
    OverlayTypes:
      enum:
      - image
      type: string
    PaginationDetails:
      properties:
        total_records:
          type: number
          format: double
        current_page:
          type: number
          format: double
        total_pages:
          type: number
          format: double
        next_page:
          type:
          - number
          - 'null'
          format: double
        prev_page:
          type:
          - number
          - 'null'
          format: double
      required:
      - total_records
      - current_page
      - total_pages
      - next_page
      - prev_page
      type: object
      additionalProperties: false
    MonetizedStreamType:
      enum:
      - LIVE
      - VOD
      type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: X-API-KEY
      in: header