openapi: 3.2.0
info:
  title: Hostfully Pricing Periods Bulk 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 Bulk
paths:
  /api/v3.3/pricing-periods/bulk:
    post:
      tags:
      - Pricing Periods Bulk
      summary: Bulk update pricing
      description: Submits a bulk pricing periods update task for asynchronous processing. Returns created asynchronous task details that can be used for checking the task progress.
      operationId: post_7
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PricingPeriodsBulkUpdatesApi3Dto'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PricingPeriodsBulkUpdateTaskApiResponseWrapper'
        '400':
          description: When request is invalid
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PricingPeriodsBulkUpdateTaskApiResponseWrapper'
        '403':
          description: When not authorized to edit any of the specified properties
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PricingPeriodsBulkUpdateTaskApiResponseWrapper'
  /api/v3.3/pricing-periods/bulk/{updateTaskUid}:
    get:
      tags:
      - Pricing Periods Bulk
      summary: Check bulk update status
      description: Returns bulk pricing periods update task's status which indicates its progress.
      operationId: findUpdateTaskStatusByUid
      parameters:
      - name: updateTaskUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '404':
          description: When requested update task does not exist
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PricingPeriodsBulkUpdateTaskApiResponseWrapper'
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PricingPeriodsBulkUpdateTaskApiResponseWrapper'
components:
  schemas:
    PricingPeriodsBulkUpdatesApi3Dto:
      required:
      - pricingPeriods
      type: object
      properties:
        pricingPeriods:
          type: array
          items:
            $ref: '#/components/schemas/PricingPeriodsBulkUpdateApi3Dto'
    PricingPeriodsBulkUpdateApi3Dto:
      required:
      - from
      - price
      - propertyUid
      - to
      type: object
      properties:
        propertyUid:
          type: string
        from:
          type: string
          format: date
        to:
          type: string
          format: date
        price:
          type: number
        minimumStay:
          type: integer
          format: int32
        availableForCheckIn:
          type: boolean
        availableForCheckOut:
          type: boolean
    PricingPeriodsBulkUpdateTaskApi3Dto:
      type: object
      properties:
        asyncTaskUid:
          type: string
        failureInfo:
          type: string
        status:
          type: string
          enum:
          - QUEUED
          - PROCESSING
          - SUCCESSFUL
          - FAILED
    PricingPeriodsBulkUpdateTaskApiResponseWrapper:
      type: object
      properties:
        updateTask:
          $ref: '#/components/schemas/PricingPeriodsBulkUpdateTaskApi3Dto'
  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