openapi: 3.2.0
info:
  title: Hostfully Property Pricing 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 Pricing Rules
paths:
  /api/v3.3/property-pricing-rules/{propertyUid}:
    get:
      tags:
      - Property Pricing Rules
      summary: Get pricing rules
      description: Retrieves all pricing rules for a property
      operationId: findByPropertyUid_3
      parameters:
      - name: propertyUid
        in: path
        required: true
        schema:
          type: string
      - name: _cursor
        in: query
        description: Cursor for pagination
        required: false
        schema:
          type: string
          description: Cursor for pagination
      - name: _limit
        in: query
        description: Limit for pagination
        required: false
        schema:
          type: string
          description: Limit for pagination
      - name: sort
        in: query
        required: true
        schema:
          type: string
      - name: sortDirection
        in: query
        required: true
        schema:
          type: string
          enum:
          - ASC
          - DESC
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyPricingRulesApi3_3ResponseWrapper'
    put:
      tags:
      - Property Pricing Rules
      summary: Update pricing rules
      description: Creates or updates pricing rules for a property with Airbnb override option
      operationId: update
      parameters:
      - name: propertyUid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyPricingRulesSavingApi3_3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyPricingRulesApi3_3UpdateResponseWrapper'
components:
  schemas:
    PropertyPricingRulesApi3_3ResponseWrapper:
      type: object
      properties:
        pricingRules:
          type: array
          items:
            $ref: '#/components/schemas/PropertyPricingRuleApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
        _paging:
          $ref: '#/components/schemas/Api3ResponsePaging'
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    PropertyPricingRuleApi3Dto:
      required:
      - priceChange
      - priceChangeType
      - ruleType
      - threshold
      type: object
      properties:
        uid:
          type: string
        ruleType:
          type: string
          enum:
          - LAST_MINUTE_DISCOUNT
          - EARLY_BIRD_DISCOUNT
        threshold:
          type: integer
          format: int32
        priceChange:
          type: number
        priceChangeType:
          type: string
          enum:
          - PERCENT
    PropertyPricingRulesSavingApi3_3Dto:
      type: object
      properties:
        enabledForAirbnb:
          type: boolean
        pricingRules:
          type: array
          items:
            $ref: '#/components/schemas/PropertyPricingRuleApi3Dto'
    Api3ResponsePaging:
      type: object
      properties:
        _limit:
          type: integer
          format: int32
        _nextCursor:
          type: string
    PropertyPricingRulesApi3_3UpdateResponseWrapper:
      type: object
      properties:
        pricingRules:
          type: array
          items:
            $ref: '#/components/schemas/PropertyPricingRuleApi3Dto'
        _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