action netatmo_gethomedata {
  label: "gethomedata"
  description: "Returns information about users homes and cameras.\n"
  provider: netatmo
  method: GET
  path: "/gethomedata"
  encoding: json
  input: {
    type: "object"
    properties: {
      home_id: {
        type: "string"
      }
      size: {
        type: "integer"
      }
    }
    additionalProperties: false
  }
  output: {
    properties: {
      body: {
        properties: {
          global_info: {
            properties: {
              show_tags: {
                type: "boolean"
                description: "show tags"
              }
            }
          }
          homes: {
            type: "array"
            items: {
              properties: {
                cameras: {
                  type: "array"
                  items: {
                    properties: {
                      alim_status: {
                        type: "string"
                        description: "If power supply is ok (on/off)"
                      }
                      id: {
                        type: "string"
                        description: "Id of the camera"
                      }
                      is_local: {
                        type: "boolean"
                        description: "Only for scope access_camera. If Camera and application requesting the information are on the same IP (true/false)"
                      }
                      light_mode_status: {
                        type: "string"
                        description: "State of (flood-)light"
                        enum: ["on", "off", "auto"]
                      }
                      name: {
                        type: "string"
                        description: "Name of the camera"
                      }
                      sd_status: {
                        type: "string"
                        description: "If SD card status is ok (on/off)"
                      }
                      status: {
                        type: "string"
                        description: "If camera is monitoring (on/off)"
                      }
                      type: {
                        type: "string"
                        description: "Type of the camera"
                      }
                      vpn_url: {
                        type: "string"
                        description: "Only for scope access_camera. Address of the camera"
                      }
                    }
                  }
                }
                events: {
                  type: "array"
                  items: {
                    properties: {
                      camera_id: {
                        type: "string"
                        description: "Camera that detected the event"
                      }
                      category: {
                        type: "string"
                        description: "Type of the detected object."
                        enum: ["human", "animal", "vehicle"]
                      }
                      event_list: {
                        type: "array"
                        items: {
                          properties: {
                            id: {
                              type: "object"
                              additionalProperties: true
                            }
                            message: {
                              type: "object"
                              additionalProperties: true
                            }
                            offset: {
                              type: "object"
                              additionalProperties: true
                            }
                            snapshot: {
                              type: "object"
                              additionalProperties: true
                            }
                            time: {
                              type: "object"
                              additionalProperties: true
                            }
                            type: {
                              type: "object"
                              additionalProperties: true
                            }
                          }
                        }
                      }
                      id: {
                        type: "string"
                        description: "Identifier of the event"
                      }
                      is_arrival: {
                        type: "boolean"
                        description: "If person was considered away before being seen during this event"
                      }
                      message: {
                        type: "string"
                        description: "User facing event description"
                      }
                      person_id: {
                        type: "string"
                        description: "Id of the person the event is about (if any)"
                      }
                      snapshot: {
                        type: "object"
                        additionalProperties: true
                      }
                      sub_type: {
                        type: "integer"
                        format: "int32"
                        description: "Subtypes of SD and Alim events. Go to Welcome page for further details."
                      }
                      time: {
                        type: "integer"
                        format: "int32"
                        description: "Time of occurence of event"
                      }
                      type: {
                        type: "string"
                        description: "Type of events. Go to the Welcome page for further details."
                      }
                      video_id: {
                        type: "string"
                        description: "Identifier of the video"
                      }
                      video_status: {
                        type: "string"
                        description: "Status of the video (recording, deleted or available)"
                      }
                    }
                  }
                }
                id: {
                  type: "string"
                  description: "Id of the home."
                }
                modules: {
                  type: "array"
                  items: {
                    properties: {
                      battery_percent: {
                        type: "integer"
                        format: "int32"
                        description: "remaining battery percentage"
                      }
                      id: {
                        type: "string"
                        description: "mac address of the module"
                      }
                      last_activity: {
                        type: "integer"
                        format: "int32"
                        description: "Timestamp of last move detected by the module"
                      }
                      name: {
                        type: "string"
                        description: "name of the module (given by the user)"
                      }
                      rf: {
                        type: "string"
                        description: "Radio status"
                      }
                      status: {
                        type: "string"
                        description: "status of the module"
                      }
                      type: {
                        type: "string"
                        description: "NACamDoorTag for tags"
                      }
                    }
                  }
                }
                name: {
                  type: "string"
                  description: "Name of the home"
                }
                persons: {
                  type: "array"
                  items: {
                    properties: {
                      face: {
                        properties: {
                          id: {
                            type: "string"
                            description: "Id of the face."
                          }
                          key: {
                            type: "string"
                            description: "Key for this face to use in getcamerapicture."
                          }
                          version: {
                            type: "integer"
                            format: "int32"
                            description: "Version of the face if user changed their photo."
                          }
                        }
                      }
                      id: {
                        type: "string"
                        description: "Id of the person."
                      }
                      last_seen: {
                        type: "integer"
                        format: "int32"
                        description: "Time at which the person was last seen."
                      }
                      out_of_sight: {
                        type: "boolean"
                        description: "True if the Person is out of sight."
                      }
                      pseudo: {
                        type: "string"
                        description: "Name of the person, if pseudo is missing, person is unknown."
                      }
                    }
                  }
                }
                place: {
                  properties: {
                    city: {
                      type: "string"
                      description: "City of the home."
                    }
                    country: {
                      type: "string"
                      description: "Country of the home."
                    }
                    timezone: {
                      type: "string"
                      description: "Timezone of the home."
                    }
                  }
                }
              }
            }
          }
          user: {
            properties: {
              lang: {
                type: "string"
                description: "user locale"
              }
              reg_locale: {
                type: "string"
                description: "user regional preferences (used for displaying date)"
              }
            }
          }
        }
      }
      status: {
        type: "string"
      }
      time_exec: {
        type: "number"
        format: "double"
      }
      time_server: {
        type: "integer"
        format: "int32"
      }
    }
  }
}