openapi: 3.2.0
info:
  title: Hostfully Available Property Rules 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: Available Property Rules
paths:
  /api/v3.3/available-property-rules:
    get:
      tags:
      - Available Property Rules
      summary: Get available property rules
      description: Finds available property rules for either a property or a hotel - one of the query 'propertyUid' and 'hotelUid' must be supplied. A request containing none of the parameters or both of them will fail with 400 status.
      operationId: findAll_7
      parameters:
      - name: propertyUid
        in: query
        required: false
        schema:
          type: string
      - name: hotelUid
        in: query
        required: false
        schema:
          type: string
      responses:
        '400':
          description: When none or both 'propertyUid' and 'hotelUid' query parameters are supplied
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AvailablePropertyRulesApiResponseWrapper'
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailablePropertyRulesApiResponseWrapper'
components:
  schemas:
    AvailablePropertyRuleApi3Dto:
      type: object
      properties:
        rule:
          type: string
          enum:
          - ALLOWS_PETS
          - ALLOWS_PETS_BY_ARRANGEMENT
          - CHILDREN_NOT_ALLOWED
          - INFANT_NOT_ALLOWED
          - ALLOWS_SMOKING
          - IS_FAMILY_FRIENDLY
          - IS_EVENT_FRIENDLY
        channels:
          type: object
          additionalProperties:
            type: boolean
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    AvailablePropertyRulesApiResponseWrapper:
      type: object
      properties:
        availablePropertyRules:
          type: array
          items:
            $ref: '#/components/schemas/AvailablePropertyRuleApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
  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