openapi: 3.2.0
info:
  title: Clevergy Connect Settings API
  description: Connect enables Clevergy customers to build integrations with the Clevergy platform. To request access please write to soporte.clientes@clever.gy
  version: 1.0.0
servers:
- url: https://connect.clever.gy
security:
- key: []
tags:
- name: Settings
paths:
  /houses/{houseId}/settings:
    get:
      summary: Get house settings
      description: 'Returns house settings.

        '
      tags:
      - Settings
      operationId: getHouseSettings
      parameters:
      - name: houseId
        in: path
        description: ID of the house
        required: true
        schema:
          type: string
      responses:
        '200':
          description: House settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HouseSettings'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorUnauthorized'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorNotFound'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      summary: Update house settings
      description: 'Updates house settings.

        '
      tags:
      - Settings
      operationId: updateHouseSettings
      parameters:
      - name: houseId
        in: path
        description: ID of the house
        required: true
        schema:
          type: string
      responses:
        '200':
          description: House settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HouseSettings'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorUnauthorized'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorNotFound'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HouseSettings'
components:
  schemas:
    HttpErrorNotFound:
      type: object
      properties:
        timestamp:
          description: Request date and time
          type: string
          example: '2023-12-26T10:23:19.508+00:00'
        status:
          description: Http error code
          type: integer
          format: int32
          example: 404
        error:
          description: Http error description
          type: string
          example: Not Found
        path:
          description: Request path
          type: string
          example: /auth/alice.smith@gmail.com/token
    HttpErrorUnauthorized:
      type: object
      properties:
        timestamp:
          description: Request date and time
          type: string
          example: '2023-12-26T10:23:19.508+00:00'
        status:
          description: Http error code
          type: integer
          format: int32
          example: 401
        error:
          description: Http error description
          type: string
          example: Unauthorized
        path:
          description: Request path
          type: string
          example: /auth/john.doe@gmail.com/token
    HouseSettings:
      type: object
      properties:
        houseId:
          type: string
        houseType:
          type: string
          enum:
          - FLAT
          - HOME
        meters:
          type: number
        housePeople:
          type: number
        devices:
          type: array
          items:
            type: string
            enum:
            - AEROTHERMAL_BOILER
            - AEROTHERMAL_HEATER
            - AIR_CONDITIONING
            - AUTOMATIC_IRRIGATION
            - BATTERY
            - CERAMIC_HOB
            - CENTRAL_HEATER
            - CHARGING_POINT
            - DISHWASHER
            - DRYER
            - ELECTRIC_BOILER
            - ELECTRIC_RADIATOR
            - ELECTRIC_VEHICLE
            - FILTER_PUMP
            - FRIDGE
            - FREEZER
            - GAS_BOILER
            - GAS_HEATER
            - GAS_KITCHEN
            - OVEN
            - PHOTOVOLTAIC_SOLAR_PANEL
            - SOLAR_THERMAL_PANEL
            - WASHING_MACHINE
    Error:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    key:
      type: apiKey
      in: header
      name: clevergy-api-key
x-google-endpoints:
- name: connect.clever.gy
  allowCors: true
x-google-backend:
  address: https://public-front-back-tl56gypzra-ew.a.run.app