openapi: 3.2.0
info:
  title: Hostfully Custom Amenities 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: Custom Amenities
paths:
  /api/v3.3/custom-amenities:
    get:
      tags:
      - Custom Amenities
      summary: Get all custom amenities
      description: Returns a list of custom amenities for the given object UID and type
      operationId: getAll_12
      parameters:
      - name: objectUid
        in: query
        required: true
        schema:
          type: string
      - name: objectType
        in: query
        required: true
        schema:
          type: string
          enum:
          - PROPERTY
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomAmenitiesApiResponseWrapper'
    post:
      tags:
      - Custom Amenities
      summary: Create a new custom amenity
      description: Adds a new custom amenity to the specified object UID and type
      operationId: post_10
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomAmenityAddingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomAmenityApiResponseWrapper'
  /api/v3.3/custom-amenities/{uid}:
    delete:
      tags:
      - Custom Amenities
      summary: Delete a custom amenity by UID
      description: Deletes the custom amenity identified by the given UID if it exists
      operationId: delete_9
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
components:
  schemas:
    CustomAmenitiesApiResponseWrapper:
      type: object
      properties:
        customAmenities:
          type: array
          items:
            $ref: '#/components/schemas/CustomAmenityApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    CustomAmenityApiResponseWrapper:
      type: object
      properties:
        customAmenity:
          $ref: '#/components/schemas/CustomAmenityApi3Dto'
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    CustomAmenityApi3Dto:
      type: object
      properties:
        uid:
          type: string
        name:
          type: string
        objectUid:
          type: string
        objectType:
          type: string
          enum:
          - PROPERTY
    CustomAmenityAddingApi3Dto:
      required:
      - name
      - objectType
      - objectUid
      type: object
      properties:
        name:
          maxLength: 255
          minLength: 0
          type: string
        objectUid:
          maxLength: 255
          minLength: 0
          type: string
        objectType:
          type: string
          enum:
          - PROPERTY
  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