openapi: 3.2.0
info:
  title: Hostfully 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: Property Rules
paths:
  /api/v3.3/property-rules/{uid}:
    get:
      tags:
      - Property Rules
      summary: Get rule details
      description: Retrieves details of a specific property rule
      operationId: findByUid_1
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyRuleApiResponseWrapper'
    put:
      tags:
      - Property Rules
      summary: Update property rule
      description: Completely replaces a property rule configuration
      operationId: updatePropertyRule
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyRuleSavingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyRuleApiResponseWrapper'
    delete:
      tags:
      - Property Rules
      summary: Delete property rule
      description: Removes a rule configuration from a property
      operationId: deletePropertyRule
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
    patch:
      tags:
      - Property Rules
      summary: Modify property rule
      description: Partially updates a property rule configuration
      operationId: patchPropertyRule
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyRulePatchingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyRuleApiResponseWrapper'
  /api/v3.3/property-rules:
    get:
      tags:
      - Property Rules
      summary: List property rules
      description: Retrieves all rules configured for a property
      operationId: findAll_3
      parameters:
      - name: propertyUid
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyRulesApiResponseWrapper'
    post:
      tags:
      - Property Rules
      summary: Create property rule
      description: Creates a new rule configuration for a property
      operationId: createPropertyRule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyRuleSavingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyRuleApiResponseWrapper'
components:
  schemas:
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    PropertyRuleApiResponseWrapper:
      type: object
      properties:
        propertyRule:
          $ref: '#/components/schemas/PropertyRuleApi3Dto'
    PropertyRulesApiResponseWrapper:
      type: object
      properties:
        propertyRules:
          type: array
          items:
            $ref: '#/components/schemas/PropertyRuleApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    PropertyRulePatchingApi3Dto:
      type: object
      properties:
        description:
          maxLength: 300
          minLength: 0
          type: string
        propertyUid:
          type: string
        rule:
          type: string
          enum:
          - ALLOWS_PETS
          - ALLOWS_PETS_BY_ARRANGEMENT
          - CHILDREN_NOT_ALLOWED
          - INFANT_NOT_ALLOWED
          - ALLOWS_SMOKING
          - IS_FAMILY_FRIENDLY
          - IS_EVENT_FRIENDLY
        fieldsToClear:
          uniqueItems: true
          type: array
          items:
            type: string
    PropertyRuleSavingApi3Dto:
      required:
      - propertyUid
      - rule
      type: object
      properties:
        description:
          maxLength: 300
          minLength: 0
          type: string
        propertyUid:
          type: string
        rule:
          type: string
          enum:
          - ALLOWS_PETS
          - ALLOWS_PETS_BY_ARRANGEMENT
          - CHILDREN_NOT_ALLOWED
          - INFANT_NOT_ALLOWED
          - ALLOWS_SMOKING
          - IS_FAMILY_FRIENDLY
          - IS_EVENT_FRIENDLY
    PropertyRuleApi3Dto:
      type: object
      properties:
        uid:
          type: string
        rule:
          type: string
          enum:
          - ALLOWS_PETS
          - ALLOWS_PETS_BY_ARRANGEMENT
          - CHILDREN_NOT_ALLOWED
          - INFANT_NOT_ALLOWED
          - ALLOWS_SMOKING
          - IS_FAMILY_FRIENDLY
          - IS_EVENT_FRIENDLY
        propertyUid:
          type: string
        description:
          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