AegeanBot Channel Manager API

openapi: 3.2.0
info:
  title: Whitelabel PMS Channel Manager API
  version: 0.1.0
tags:
- name: Channel Manager
paths:
  /channel-manager:
    get:
      summary: Get Channel Manager
      operationId: get_channel_manager_channel_manager_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Channel Manager
    delete:
      summary: Disconnect Channel Manager
      description: 'Disconnect. Every external_pms listing drops to content-only (NULL method) —

        its feed is dead, and one-method-per-listing means there''s no other source to

        fall back to. The teardown cancels the feed''s rows so the dates free immediately.'
      operationId: disconnect_channel_manager_channel_manager_delete
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Channel Manager
  /channel-manager/connect:
    post:
      summary: Connect Channel Manager
      description: 'Save credentials and run the first sync. Unlike envfee (save first, discover a

        bad key when the sync fails), the key is validated against /rentals BEFORE saving.'
      operationId: connect_channel_manager_channel_manager_connect_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannelManagerConnectIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Channel Manager
  /channel-manager/sync:
    post:
      summary: Sync Channel Manager
      operationId: sync_channel_manager_channel_manager_sync_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Channel Manager
  /channel-manager/listings:
    get:
      summary: Channel Manager Listings
      description: The remote-listing crosswalk — the hosthub/configure mapping form's data.
      operationId: channel_manager_listings_channel_manager_listings_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Channel Manager
  /channel-manager/listings/{remote_id}/map:
    put:
      summary: Map Channel Manager Listing
      description: Point a remote listing at an existing PMS listing, or ignore it (null).
      operationId: map_channel_manager_listing_channel_manager_listings__remote_id__map_put
      parameters:
      - name: remote_id
        in: path
        required: true
        schema:
          type: string
          title: Remote Id
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannelManagerMapIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Channel Manager
  /channel-manager/sync-all:
    post:
      summary: Sync All Channel Managers
      description: 'Scheduler safety net (same trust model as /channex/pull): re-sync every

        connection that isn''t auth_failed. Idempotent. Also back-fills future OTA

        bookings for any newly connected Channex channel nobody has opened in the

        console yet.'
      operationId: sync_all_channel_managers_channel_manager_sync_all_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Channel Manager
components:
  schemas:
    ChannelManagerMapIn:
      properties:
        property_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Property Id
      type: object
      title: ChannelManagerMapIn
      description: 'Map a remote listing to an existing PMS listing (property_id set) or have one

        auto-created on the next sync (property_id null).'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ChannelManagerConnectIn:
      properties:
        cm_type:
          type: string
          const: hosthub
          title: Cm Type
          default: hosthub
        api_key:
          type: string
          title: Api Key
        discover_only:
          type: boolean
          title: Discover Only
          default: false
        account_email:
          anyOf:
          - type: string
          - type: 'null'
          title: Account Email
      type: object
      required:
      - api_key
      title: ChannelManagerConnectIn
      description: 'envfee connect-channel-manager form, one manager per owner. Only HostHub is

        live; the Literal grows as Smoobu/Lodgify ports land.'