openapi: 3.2.0
info:
  title: Hostfully Property Channel Links API
  license:
    name: Apache 2.0
    url: https://www.hostfully.com/
  version: v3.0.1
servers:
- url: https://sandbox-api.hostfully.com
security:
- JWT-Authentication: []
- Agency-API-key: []
tags:
- name: Property Channel Links
paths:
  /api/v3.3/property-channel-links/{uid}:
    get:
      tags:
      - Property Channel Links
      summary: Get channel link details
      description: Retrieves details of a specific channel link by its UID
      operationId: getOne_5
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyChannelLinkApiResponseWrapper'
    put:
      tags:
      - Property Channel Links
      summary: Update channel link
      description: Updates an existing property channel connection
      operationId: put_6
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyChannelLinkUpdatingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyChannelLinkApiResponseWrapper'
    delete:
      tags:
      - Property Channel Links
      summary: Delete channel link
      description: Removes a channel connection from a property
      operationId: delete_6
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
  /api/v3.3/property-channel-links:
    get:
      tags:
      - Property Channel Links
      summary: List channel links
      description: Retrieves all channel links for a property, optionally filtered by channel type
      operationId: getAll_6
      parameters:
      - name: propertyUid
        in: query
        required: true
        schema:
          type: string
      - name: channel
        in: query
        required: false
        schema:
          type: string
          enum:
          - HOME_TO_GO
          - GO_LIGHTLY
          - VACAY_MY_WAY
          - HOMADS
          - AIRBNB
          - BOOKING_DOT_COM
          - VRBO
          - GOOGLE
          - HVMI
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyChannelLinksApiResponseWrapper'
    post:
      tags:
      - Property Channel Links
      summary: Create channel link
      description: Creates a new channel connection for a property
      operationId: post_6
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyChannelLinkAddingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyChannelLinkApiResponseWrapper'
components:
  schemas:
    PropertyChannelLinkUpdatingApi3Dto:
      required:
      - url
      type: object
      properties:
        url:
          type: string
    PropertyChannelLinkApiResponseWrapper:
      type: object
      properties:
        propertyChannelLink:
          $ref: '#/components/schemas/PropertyChannelLinkApi3Dto'
    PropertyChannelLinksApiResponseWrapper:
      type: object
      properties:
        propertyChannelLinks:
          type: array
          items:
            $ref: '#/components/schemas/PropertyChannelLinkApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    PropertyChannelLinkAddingApi3Dto:
      required:
      - propertyUid
      - url
      type: object
      properties:
        propertyUid:
          type: string
        channel:
          type: string
          enum:
          - HOME_TO_GO
          - GO_LIGHTLY
          - VACAY_MY_WAY
          - HOMADS
          - AIRBNB
          - BOOKING_DOT_COM
          - VRBO
          - GOOGLE
          - HVMI
        url:
          type: string
    PropertyChannelLinkApi3Dto:
      type: object
      properties:
        uid:
          type: string
        propertyUid:
          type: string
        channel:
          type: string
          description: This field might be extended with new values. Consumers of the API should handle unknown channel types and have their implementation ready for extension if needed.
          enum:
          - HOME_TO_GO
          - GO_LIGHTLY
          - VACAY_MY_WAY
          - HOMADS
          - AIRBNB
          - BOOKING_DOT_COM
          - VRBO
          - GOOGLE
          - HVMI
        url:
          type: string
        channelId:
          type: string
  securitySchemes:
    JWT-Authentication:
      type: apiKey
      description: OAuth Access Token
      name: Authorization
      in: header
    Agency-API-key:
      type: apiKey
      description: API Key
      name: X-HOSTFULLY-APIKEY
      in: header
externalDocs:
  description: Hostfully Documentation
  url: https://dev.hostfully.com/v3.0/reference
x-readme:
  explorer-enabled: true
  proxy-enabled: true