schema {
  query: LocatorApiQuery
}

"""
Input object for the area query.
"""
input Area {
  """
  Latitude of the point.
  """
  latitude: Float!

  """
  Longitude of the point.
  """
  longitude: Float!

  """
  The poi id that should be found
  """
  poiId: Int!

  """
  The radius in meters
  """
  radius: Float!
}

"""
Input object for the distance query.
"""
input Distance {
  """
  The maximum distance in meter from the point of pois to return.
  """
  distance: Float!

  """
  Latitude of the point.
  """
  latitude: Float!

  """
  The maximum number of pois to return.
  """
  limit: Int

  """
  Longitude of the point.
  """
  longitude: Float!
}

type GeoPoint {
  coordinates: [Float!]!
  type: String!
}

"""
An ISO 8601-encoded datetime
"""
scalar ISO8601DateTime @specifiedBy(url: "https://tools.ietf.org/html/rfc3339")

"""
Represents untyped JSON
"""
scalar JSON

type LocatorApiQuery {
  """
  Return if a poi is inside coordinates area.
  """
  checkInArea(
    """
    Input object for the area query.
    """
    input: Area!
  ): Boolean!

  """
  Return a PoI given a id or uniq_id.
  """
  poi(
    """
    Identifies the primary key from the database.
    """
    id: ID

    """
    User defined PoI identifier.
    """
    uniqId: String
  ): Poi

  """
  Return all PoIs.
  """
  pois(
    """
    The maximum number of PoIs to return.
    """
    limit: Int
  ): [Poi!]!

  """
  Return PoIs sorted by distance in meters from the coordinates.
  """
  poisByDistance(
    """
    Input object for the distance query.
    """
    input: Distance!
  ): [PoiDistance!]!
}

"""
LocatorAPI PoI entity.
"""
type Poi implements TimestampInterface {
  """
  The address of the PoI.
  """
  address: JSON!

  """
  Create DateTime.
  """
  createdAt: ISO8601DateTime!

  """
  Identifies the primary key from the database.
  """
  id: ID!

  """
  Latitude of the PoI location.
  """
  latitude: Float!

  """
  Object representing the PoI location.
  """
  location: GeoPoint!

  """
  Longitude of the PoI location.
  """
  longitude: Float!

  """
  The metadata of the PoI.
  """
  metadata: JSON!

  """
  The name of the PoI.
  """
  name: String!

  """
  The openings of the PoI.
  """
  openings: JSON!

  """
  User defined PoI identifier.
  """
  uniqId: String!

  """
  Update DateTime.
  """
  updatedAt: ISO8601DateTime!

  """
  Primary key of the User associated with the PoI.
  """
  userId: ID!
}

"""
LocatorAPI PoI entity with distance in meters from the point.
"""
type PoiDistance implements TimestampInterface {
  """
  The address of the PoI.
  """
  address: JSON!

  """
  Create DateTime.
  """
  createdAt: ISO8601DateTime!

  """
  Distance in meters from the point.
  """
  distance: Float!

  """
  Identifies the primary key from the database.
  """
  id: ID!

  """
  Latitude of the PoI location.
  """
  latitude: Float!

  """
  Object representing the PoI location.
  """
  location: GeoPoint!

  """
  Longitude of the PoI location.
  """
  longitude: Float!

  """
  The metadata of the PoI.
  """
  metadata: JSON!

  """
  The name of the PoI.
  """
  name: String!

  """
  The openings of the PoI.
  """
  openings: JSON!

  """
  User defined PoI identifier.
  """
  uniqId: String!

  """
  Update DateTime.
  """
  updatedAt: ISO8601DateTime!

  """
  Primary key of the User associated with the PoI.
  """
  userId: ID!
}

"""
Create and Update DateTime.
"""
interface TimestampInterface {
  """
  Create DateTime.
  """
  createdAt: ISO8601DateTime!

  """
  Update DateTime.
  """
  updatedAt: ISO8601DateTime!
}