openapi: 3.2.0
info:
  title: Hostfully Rooms 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: Rooms
paths:
  /api/v3.3/rooms/{roomUid}:
    get:
      tags:
      - Rooms
      summary: Get room details
      description: Retrieves details of a specific room
      operationId: getOne_2
      parameters:
      - name: roomUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RoomApiResponseWrapper'
    put:
      tags:
      - Rooms
      summary: Update room
      description: Modifies an existing room's details
      operationId: put_2
      parameters:
      - name: roomUid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoomApi3UpdatingDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RoomApiResponseWrapper'
    delete:
      tags:
      - Rooms
      summary: Delete room
      description: Removes a room from a property
      operationId: delete_2
      parameters:
      - name: roomUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /api/v3.3/rooms:
    get:
      tags:
      - Rooms
      summary: List property rooms
      description: Retrieves all rooms for a property
      operationId: getAll_3
      parameters:
      - name: propertyUid
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RoomsApiResponseWrapper'
    post:
      tags:
      - Rooms
      summary: Create room
      description: Adds a new room to a property
      operationId: post_3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoomApi3AddingDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RoomApiResponseWrapper'
components:
  schemas:
    RoomApi3UpdatingDto:
      required:
      - hasPrivateBathroom
      - roomType
      type: object
      properties:
        roomType:
          type: string
          enum:
          - ART_STUDIO
          - BACKYARD
          - BALCONY
          - BEDROOM
          - BOWLING_ALLEY
          - CHILDRENS_PLAYROOM
          - COURTYARD
          - DARKROOM
          - DECK
          - DINING_ROOM
          - EVENT_ROOM
          - EXTERIOR
          - FRONT_YARD
          - FULL_BATHROOM
          - GAME_ROOM
          - GARAGE
          - GARDEN
          - GYM
          - HALF_BATHROOM
          - HOT_TUB
          - JP_ONLY_FLOOR_PLAN
          - KITCHEN
          - KITCHENETTE
          - LAUNDRY_ROOM
          - LIBRARY
          - LIVING_ROOM
          - MOVIE_THEATER
          - MUSIC_STUDIO
          - OFFICE
          - ONSEN
          - PATIO
          - PHOTOGRAPHY_STUDIO
          - POOL
          - PORCH
          - ROOFTOP
          - STUDIO
          - SUNROOM
          - TERRACE
          - THEME_ROOM
          - WINE_CELLAR
          - WOODSHOP
          - WORKSHOP
          - WORKSPACE
          - COMMON_SPACES
        hasPrivateBathroom:
          type: boolean
        bedCounts:
          type: object
          properties:
            doubleBed:
              type: number
            toddlerBed:
              type: number
            crib:
              type: number
            couch:
              type: number
            sofaBed:
              type: number
            queenBed:
              type: number
            kingBed:
              type: number
            futonBed:
              type: number
            airMattress:
              type: number
            floorMattress:
              type: number
            singleBed:
              type: number
            waterBed:
              type: number
            bunkBed:
              type: number
            hammockBed:
              type: number
    RoomsApiResponseWrapper:
      type: object
      properties:
        rooms:
          type: array
          items:
            $ref: '#/components/schemas/RoomApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    RoomApi3Dto:
      type: object
      properties:
        uid:
          type: string
        roomNumber:
          type: integer
          format: int32
        bedCounts:
          type: object
          properties:
            doubleBed:
              type: number
            toddlerBed:
              type: number
            crib:
              type: number
            couch:
              type: number
            sofaBed:
              type: number
            queenBed:
              type: number
            kingBed:
              type: number
            futonBed:
              type: number
            airMattress:
              type: number
            floorMattress:
              type: number
            singleBed:
              type: number
            waterBed:
              type: number
            bunkBed:
              type: number
            hammockBed:
              type: number
        hasPrivateBathroom:
          type: boolean
        roomType:
          type: string
          enum:
          - ART_STUDIO
          - BACKYARD
          - BALCONY
          - BEDROOM
          - BOWLING_ALLEY
          - CHILDRENS_PLAYROOM
          - COURTYARD
          - DARKROOM
          - DECK
          - DINING_ROOM
          - EVENT_ROOM
          - EXTERIOR
          - FRONT_YARD
          - FULL_BATHROOM
          - GAME_ROOM
          - GARAGE
          - GARDEN
          - GYM
          - HALF_BATHROOM
          - HOT_TUB
          - JP_ONLY_FLOOR_PLAN
          - KITCHEN
          - KITCHENETTE
          - LAUNDRY_ROOM
          - LIBRARY
          - LIVING_ROOM
          - MOVIE_THEATER
          - MUSIC_STUDIO
          - OFFICE
          - ONSEN
          - PATIO
          - PHOTOGRAPHY_STUDIO
          - POOL
          - PORCH
          - ROOFTOP
          - STUDIO
          - SUNROOM
          - TERRACE
          - THEME_ROOM
          - WINE_CELLAR
          - WOODSHOP
          - WORKSHOP
          - WORKSPACE
          - COMMON_SPACES
    RoomApiResponseWrapper:
      type: object
      properties:
        room:
          $ref: '#/components/schemas/RoomApi3Dto'
    RoomApi3AddingDto:
      required:
      - hasPrivateBathroom
      - propertyUid
      - roomNumber
      - roomType
      type: object
      properties:
        propertyUid:
          type: string
        roomType:
          type: string
          enum:
          - ART_STUDIO
          - BACKYARD
          - BALCONY
          - BEDROOM
          - BOWLING_ALLEY
          - CHILDRENS_PLAYROOM
          - COURTYARD
          - DARKROOM
          - DECK
          - DINING_ROOM
          - EVENT_ROOM
          - EXTERIOR
          - FRONT_YARD
          - FULL_BATHROOM
          - GAME_ROOM
          - GARAGE
          - GARDEN
          - GYM
          - HALF_BATHROOM
          - HOT_TUB
          - JP_ONLY_FLOOR_PLAN
          - KITCHEN
          - KITCHENETTE
          - LAUNDRY_ROOM
          - LIBRARY
          - LIVING_ROOM
          - MOVIE_THEATER
          - MUSIC_STUDIO
          - OFFICE
          - ONSEN
          - PATIO
          - PHOTOGRAPHY_STUDIO
          - POOL
          - PORCH
          - ROOFTOP
          - STUDIO
          - SUNROOM
          - TERRACE
          - THEME_ROOM
          - WINE_CELLAR
          - WOODSHOP
          - WORKSHOP
          - WORKSPACE
          - COMMON_SPACES
        bedCounts:
          type: object
          properties:
            doubleBed:
              type: number
            toddlerBed:
              type: number
            crib:
              type: number
            couch:
              type: number
            sofaBed:
              type: number
            queenBed:
              type: number
            kingBed:
              type: number
            futonBed:
              type: number
            airMattress:
              type: number
            floorMattress:
              type: number
            singleBed:
              type: number
            waterBed:
              type: number
            bunkBed:
              type: number
            hammockBed:
              type: number
        hasPrivateBathroom:
          type: boolean
        roomNumber:
          type: integer
          format: int32
  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