openapi: 3.2.0
info:
  title: Hostfully Pricing Periods 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: Pricing Periods
paths:
  /api/v3.3/pricing-periods:
    get:
      tags:
      - Pricing Periods
      summary: Get pricing periods
      description: Retrieves pricing periods for a property within specified date range. Requires propertyUid, from and to date parameters
      operationId: findByPropertyUid_2
      parameters:
      - name: propertyUid
        in: query
        required: true
        schema:
          type: string
      - name: from
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: to
        in: query
        required: true
        schema:
          type: string
          format: date
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PricingPeriodsApiResponseWrapper'
    post:
      tags:
      - Pricing Periods
      summary: Modify pricing period
      description: Creates/updates or removes a pricing period for a property. Supports SET (create/update) and REMOVE operations
      operationId: post_8
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PricingPeriodModificationApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PricingPeriodApiResponseWrapper'
components:
  schemas:
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    PricingPeriodsApiResponseWrapper:
      type: object
      properties:
        pricingPeriods:
          type: array
          items:
            $ref: '#/components/schemas/PricingPeriodApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    PricingPeriodSavingApi3Dto:
      required:
      - date
      - propertyUid
      type: object
      properties:
        propertyUid:
          type: string
        date:
          type: string
          format: date
        price:
          type: number
        minimumStay:
          type: integer
          format: int32
        availableForCheckIn:
          type: boolean
        availableForCheckOut:
          type: boolean
        name:
          type: string
    PricingPeriodApi3Dto:
      type: object
      properties:
        propertyUid:
          type: string
        date:
          type: string
          format: date
        price:
          type: number
        minimumStay:
          type: integer
          format: int32
        availableForCheckIn:
          type: boolean
        availableForCheckOut:
          type: boolean
        name:
          type: string
    PricingPeriodModificationApi3Dto:
      required:
      - operation
      - pricingPeriod
      type: object
      properties:
        operation:
          type: string
          enum:
          - REMOVE
          - SET
        pricingPeriod:
          $ref: '#/components/schemas/PricingPeriodSavingApi3Dto'
    PricingPeriodApiResponseWrapper:
      type: object
      properties:
        pricingPeriod:
          $ref: '#/components/schemas/PricingPeriodApi3Dto'
  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