nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/geocode_batch_create_params.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geocode#batch_create
+    class GeocodeBatchCreateParams < Nextbillionai::Internal::Type::BaseModel
+      extend Nextbillionai::Internal::Type::RequestParameters::Converter
+      include Nextbillionai::Internal::Type::RequestParameters
+
+      # @!attribute key
+      #   A key is a unique identifier that is required to authenticate a request to the
+      #   API.
+      #
+      #   @return [String]
+      required :key, String
+
+      # @!attribute body
+      #
+      #   @return [Array<Nextbillionai::Models::GeocodeBatchCreateParams::Body>]
+      required :body,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::GeocodeBatchCreateParams::Body] }
+
+      # @!method initialize(key:, body:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::GeocodeBatchCreateParams} for more details.
+      #
+      #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+      #
+      #   @param body [Array<Nextbillionai::Models::GeocodeBatchCreateParams::Body>]
+      #
+      #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+      class Body < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute q
+        #   Specify the free-text search query. Please note that whitespace, urls, email
+        #   addresses, or other out-of-scope queries will yield no results.
+        #
+        #   @return [String]
+        required :q, String
+
+        # @!attribute at
+        #   Specify the center of the search context expressed as coordinates.
+        #
+        #   Please note that one of "at", "in=circle" or "in=bbox" should be provided for
+        #   relevant results.
+        #
+        #   @return [String, nil]
+        optional :at, String
+
+        # @!attribute in_
+        #   Search within a geographic area. This is a hard filter. Results will be returned
+        #   if they are located within the specified area.
+        #
+        #   A geographic area can be
+        #
+        #   - a country (or multiple countries), provided as comma-separated
+        #     [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country
+        #     codes
+        #
+        #     The country codes are to be provided in all uppercase.
+        #
+        #     Format: countryCode:{countryCode}[,{countryCode}]
+        #
+        #   - a circular area, provided as latitude, longitude, and radius (an integer with
+        #     meters as unit)
+        #
+        #     Format: circle:{latitude},{longitude};r={radius}
+        #
+        #   - a bounding box, provided as _west longitude_, _south latitude_, _east
+        #     longitude_, _north latitude_
+        #
+        #     Format: bbox:{west longitude},{south latitude},{east longitude},{north
+        #     latitude}
+        #
+        #   Please provide one of 'at', 'in=circle' or 'in=bbox' input for a relevant
+        #   result.
+        #
+        #   @return [String, nil]
+        optional :in_, String, api_name: :in
+
+        # @!attribute lang
+        #   Select the language to be used for result rendering from a list of
+        #   [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) compliant language
+        #   codes.
+        #
+        #   @return [String, nil]
+        optional :lang, String
+
+        # @!attribute limit
+        #   Maximum number of results to be returned. Please note that the minimum value
+        #   that can be provided is 1 and the maximum that can be provided is 100.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!method initialize(q:, at: nil, in_: nil, lang: nil, limit: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::GeocodeBatchCreateParams::Body} for more details.
+        #
+        #   @param q [String] Specify the free-text search query. Please note that whitespace, urls, email add
+        #
+        #   @param at [String] Specify the center of the search context expressed as coordinates.
+        #
+        #   @param in_ [String] Search within a geographic area. This is a hard filter. Results will be returned
+        #
+        #   @param lang [String] Select the language to be used for result rendering from a list of [BCP 47](http
+        #
+        #   @param limit [Integer] Maximum number of results to be returned. Please note that the minimum value tha
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/geocode_batch_create_response.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geocode#batch_create
+    class GeocodeBatchCreateResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute items
+      #   The results are presented as a JSON list of candidates in ranked order
+      #   (most-likely to least-likely) based on the matched location criteria.
+      #
+      #   @return [Array<Nextbillionai::Models::GeocodeBatchCreateResponse::Item>, nil]
+      optional :items,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::GeocodeBatchCreateResponse::Item] }
+
+      # @!method initialize(items: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::GeocodeBatchCreateResponse} for more details.
+      #
+      #   @param items [Array<Nextbillionai::Models::GeocodeBatchCreateResponse::Item>] The results are presented as a JSON list of candidates in ranked order (most-lik
+
+      class Item < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the result item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute access
+        #   An array returning the location coordinates of all the access points of the
+        #   search result.
+        #
+        #   @return [Nextbillionai::Models::Access, nil]
+        optional :access, -> { Nextbillionai::Access }
+
+        # @!attribute address
+        #   Postal address of the result item.
+        #
+        #   @return [Nextbillionai::Models::Address, nil]
+        optional :address, -> { Nextbillionai::Address }
+
+        # @!attribute categories
+        #   The list of categories assigned to this place.
+        #
+        #   @return [Array<Nextbillionai::Models::Categories>, nil]
+        optional :categories, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Categories] }
+
+        # @!attribute contacts
+        #   Contact information like phone, email or website.
+        #
+        #   @return [Array<Nextbillionai::Models::Contacts>, nil]
+        optional :contacts, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Contacts] }
+
+        # @!attribute distance
+        #   The distance "as the crow flies" from the search center to this result item in
+        #   meters.
+        #
+        #   @return [Integer, nil]
+        optional :distance, Integer
+
+        # @!attribute map_view
+        #   The bounding box enclosing the geometric shape (area or line) that an individual
+        #   result covers. place typed results have no mapView.
+        #
+        #   @return [Nextbillionai::Models::MapView, nil]
+        optional :map_view, -> { Nextbillionai::MapView }, api_name: :mapView
+
+        # @!attribute position
+        #   Returns the location coordinates of the result.
+        #
+        #   @return [Nextbillionai::Models::Position, nil]
+        optional :position, -> { Nextbillionai::Position }
+
+        # @!attribute scoring
+        #   Score of the result. A higher score indicates a closer match.
+        #
+        #   @return [Nextbillionai::Models::GeocodeBatchCreateResponse::Item::Scoring, nil]
+        optional :scoring, -> { Nextbillionai::Models::GeocodeBatchCreateResponse::Item::Scoring }
+
+        # @!attribute title
+        #   The localized display name of this result item.
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!method initialize(id: nil, access: nil, address: nil, categories: nil, contacts: nil, distance: nil, map_view: nil, position: nil, scoring: nil, title: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::GeocodeBatchCreateResponse::Item} for more details.
+        #
+        #   @param id [String] The unique identifier for the result item.
+        #
+        #   @param access [Nextbillionai::Models::Access] An array returning the location coordinates of all the access points of the sear
+        #
+        #   @param address [Nextbillionai::Models::Address] Postal address of the result item.
+        #
+        #   @param categories [Array<Nextbillionai::Models::Categories>] The list of categories assigned to this place.
+        #
+        #   @param contacts [Array<Nextbillionai::Models::Contacts>] Contact information like phone, email or website.
+        #
+        #   @param distance [Integer] The distance "as the crow flies" from the search center to this result item in m
+        #
+        #   @param map_view [Nextbillionai::Models::MapView] The bounding box enclosing the geometric shape (area or line) that an individual
+        #
+        #   @param position [Nextbillionai::Models::Position] Returns the location coordinates of the result.
+        #
+        #   @param scoring [Nextbillionai::Models::GeocodeBatchCreateResponse::Item::Scoring] Score of the result. A higher score indicates a closer match.
+        #
+        #   @param title [String] The localized display name of this result item.
+
+        # @see Nextbillionai::Models::GeocodeBatchCreateResponse::Item#scoring
+        class Scoring < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute field_score
+          #   A breakdown of how closely individual field of the result matched with the
+          #   provided query q.
+          #
+          #   @return [Object, nil]
+          optional :field_score, Nextbillionai::Internal::Type::Unknown, api_name: :fieldScore
+
+          # @!attribute query_score
+          #   A score, out of 1, indicating how closely the result matches with the provided
+          #   query q .
+          #
+          #   @return [Float, nil]
+          optional :query_score, Float, api_name: :queryScore
+
+          # @!method initialize(field_score: nil, query_score: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::GeocodeBatchCreateResponse::Item::Scoring} for more
+          #   details.
+          #
+          #   Score of the result. A higher score indicates a closer match.
+          #
+          #   @param field_score [Object] A breakdown of how closely individual field of the result matched with the provi
+          #
+          #   @param query_score [Float] A score, out of 1, indicating how closely the result matches with the provided q
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/geocode_retrieve_params.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geocode#retrieve
+    class GeocodeRetrieveParams < Nextbillionai::Internal::Type::BaseModel
+      extend Nextbillionai::Internal::Type::RequestParameters::Converter
+      include Nextbillionai::Internal::Type::RequestParameters
+
+      # @!attribute key
+      #   A key is a unique identifier that is required to authenticate a request to the
+      #   API.
+      #
+      #   @return [String]
+      required :key, String
+
+      # @!attribute q
+      #   Specify the free-text search query.
+      #
+      #   Please note that whitespace, urls, email addresses, or other out-of-scope
+      #   queries will yield no results.
+      #
+      #   @return [String]
+      required :q, String
+
+      # @!attribute at
+      #   Specify the center of the search context expressed as coordinates.
+      #
+      #   Please note that one of "at", "in=circle" or "in=bbox" should be provided for
+      #   relevant results.
+      #
+      #   @return [String, nil]
+      optional :at, String
+
+      # @!attribute in_
+      #   Search within a geographic area. This is a hard filter. Results will be returned
+      #   if they are located within the specified area.
+      #
+      #   A geographic area can be
+      #
+      #   - a country (or multiple countries), provided as comma-separated
+      #     [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country
+      #     codes
+      #
+      #     The country codes are to be provided in all uppercase.
+      #
+      #     Format: countryCode:{countryCode}[,{countryCode}]
+      #
+      #   - a circular area, provided as latitude, longitude, and radius (an integer with
+      #     meters as unit)
+      #
+      #     Format: circle:{latitude},{longitude};r={radius}
+      #
+      #   - a bounding box, provided as _west longitude_, _south latitude_, _east
+      #     longitude_, _north latitude_
+      #
+      #     Format: bbox:{west longitude},{south latitude},{east longitude},{north
+      #     latitude}
+      #
+      #   Please provide one of 'at', 'in=circle' or 'in=bbox' input for a relevant
+      #   result.
+      #
+      #   @return [String, nil]
+      optional :in_, String
+
+      # @!attribute lang
+      #   Select the language to be used for result rendering from a list of
+      #   [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) compliant language
+      #   codes.
+      #
+      #   @return [String, nil]
+      optional :lang, String
+
+      # @!attribute limit
+      #   Sets the maximum number of results to be returned.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(key:, q:, at: nil, in_: nil, lang: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::GeocodeRetrieveParams} for more details.
+      #
+      #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+      #
+      #   @param q [String] Specify the free-text search query.
+      #
+      #   @param at [String] Specify the center of the search context expressed as coordinates.
+      #
+      #   @param in_ [String] Search within a geographic area. This is a hard filter. Results will be returned
+      #
+      #   @param lang [String] Select the language to be used for result rendering from a list of [BCP 47](http
+      #
+      #   @param limit [Integer] Sets the maximum number of results to be returned.
+      #
+      #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/nextbillionai/models/geocode_retrieve_response.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geocode#retrieve
+    class GeocodeRetrieveResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute items
+      #   The results are presented as a JSON list of candidates in ranked order
+      #   (most-likely to least-likely) based on the matched location criteria.
+      #
+      #   @return [Array<Nextbillionai::Models::GeocodeRetrieveResponse::Item>, nil]
+      optional :items,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::GeocodeRetrieveResponse::Item] }
+
+      # @!method initialize(items: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::GeocodeRetrieveResponse} for more details.
+      #
+      #   @param items [Array<Nextbillionai::Models::GeocodeRetrieveResponse::Item>] The results are presented as a JSON list of candidates in ranked order (most-lik
+
+      class Item < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the result item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute access
+        #   An array returning the location coordinates of all the access points of the
+        #   search result.
+        #
+        #   @return [Nextbillionai::Models::Access, nil]
+        optional :access, -> { Nextbillionai::Access }
+
+        # @!attribute address
+        #   Postal address of the result item.
+        #
+        #   @return [Nextbillionai::Models::Address, nil]
+        optional :address, -> { Nextbillionai::Address }
+
+        # @!attribute categories
+        #   The list of categories assigned to this place.
+        #
+        #   @return [Array<Nextbillionai::Models::Categories>, nil]
+        optional :categories, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Categories] }
+
+        # @!attribute contacts
+        #   Contact information like phone, email or website.
+        #
+        #   @return [Array<Nextbillionai::Models::Contacts>, nil]
+        optional :contacts, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Contacts] }
+
+        # @!attribute distance
+        #   The distance "as the crow flies" from the search center to this result item in
+        #   meters.
+        #
+        #   @return [Integer, nil]
+        optional :distance, Integer
+
+        # @!attribute map_view
+        #   The bounding box enclosing the geometric shape (area or line) that an individual
+        #   result covers. place typed results have no mapView.
+        #
+        #   @return [Nextbillionai::Models::MapView, nil]
+        optional :map_view, -> { Nextbillionai::MapView }, api_name: :mapView
+
+        # @!attribute opening_hours
+        #   Returns the operating hours of the place, if available.
+        #
+        #   @return [Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours, nil]
+        optional :opening_hours,
+                 -> { Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours },
+                 api_name: :openingHours
+
+        # @!attribute position
+        #   Returns the location coordinates of the result.
+        #
+        #   @return [Nextbillionai::Models::Position, nil]
+        optional :position, -> { Nextbillionai::Position }
+
+        # @!attribute scoring
+        #   Score of the result. A higher score indicates a closer match.
+        #
+        #   @return [Nextbillionai::Models::GeocodeRetrieveResponse::Item::Scoring, nil]
+        optional :scoring, -> { Nextbillionai::Models::GeocodeRetrieveResponse::Item::Scoring }
+
+        # @!attribute title
+        #   The localized display name of this result item.
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!method initialize(id: nil, access: nil, address: nil, categories: nil, contacts: nil, distance: nil, map_view: nil, opening_hours: nil, position: nil, scoring: nil, title: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::GeocodeRetrieveResponse::Item} for more details.
+        #
+        #   @param id [String] The unique identifier for the result item.
+        #
+        #   @param access [Nextbillionai::Models::Access] An array returning the location coordinates of all the access points of the sear
+        #
+        #   @param address [Nextbillionai::Models::Address] Postal address of the result item.
+        #
+        #   @param categories [Array<Nextbillionai::Models::Categories>] The list of categories assigned to this place.
+        #
+        #   @param contacts [Array<Nextbillionai::Models::Contacts>] Contact information like phone, email or website.
+        #
+        #   @param distance [Integer] The distance "as the crow flies" from the search center to this result item in m
+        #
+        #   @param map_view [Nextbillionai::Models::MapView] The bounding box enclosing the geometric shape (area or line) that an individual
+        #
+        #   @param opening_hours [Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours] Returns the operating hours of the place, if available.
+        #
+        #   @param position [Nextbillionai::Models::Position] Returns the location coordinates of the result.
+        #
+        #   @param scoring [Nextbillionai::Models::GeocodeRetrieveResponse::Item::Scoring] Score of the result. A higher score indicates a closer match.
+        #
+        #   @param title [String] The localized display name of this result item.
+
+        # @see Nextbillionai::Models::GeocodeRetrieveResponse::Item#opening_hours
+        class OpeningHours < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute time_ranges
+          #   A collection of attributes with details about the opening and closing hours for
+          #   each day of the week.
+          #
+          #   @return [Array<Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours::TimeRange>, nil]
+          optional :time_ranges,
+                   -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours::TimeRange] },
+                   api_name: :timeRanges
+
+          # @!method initialize(time_ranges: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours} for more
+          #   details.
+          #
+          #   Returns the operating hours of the place, if available.
+          #
+          #   @param time_ranges [Array<Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours::TimeRange>] A collection of attributes with details about the opening and closing hours for
+
+          class TimeRange < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute end_time
+            #   Returns the closing time details.
+            #
+            #   @return [Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours::TimeRange::EndTime, nil]
+            optional :end_time,
+                     -> { Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours::TimeRange::EndTime },
+                     api_name: :endTime
+
+            # @!attribute start_time
+            #   Returns the open time details.
+            #
+            #   @return [Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours::TimeRange::StartTime, nil]
+            optional :start_time,
+                     -> { Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours::TimeRange::StartTime },
+                     api_name: :startTime
+
+            # @!method initialize(end_time: nil, start_time: nil)
+            #   @param end_time [Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours::TimeRange::EndTime] Returns the closing time details.
+            #
+            #   @param start_time [Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours::TimeRange::StartTime] Returns the open time details.
+
+            # @see Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours::TimeRange#end_time
+            class EndTime < Nextbillionai::Internal::Type::BaseModel
+              # @!attribute date
+              #   The date to which the subsequent closing time details belong to.
+              #
+              #   @return [String, nil]
+              optional :date, String
+
+              # @!attribute hour
+              #   The hour of the day when the place closes.
+              #
+              #   @return [Integer, nil]
+              optional :hour, Integer
+
+              # @!attribute minute
+              #   The minute of the hour when the place closes.
+              #
+              #   @return [Integer, nil]
+              optional :minute, Integer
+
+              # @!method initialize(date: nil, hour: nil, minute: nil)
+              #   Returns the closing time details.
+              #
+              #   @param date [String] The date to which the subsequent closing time details belong to.
+              #
+              #   @param hour [Integer] The hour of the day when the place closes.
+              #
+              #   @param minute [Integer] The minute of the hour when the place closes.
+            end
+
+            # @see Nextbillionai::Models::GeocodeRetrieveResponse::Item::OpeningHours::TimeRange#start_time
+            class StartTime < Nextbillionai::Internal::Type::BaseModel
+              # @!attribute date
+              #   The date to which the subsequent open time details belong to.
+              #
+              #   @return [String, nil]
+              optional :date, String
+
+              # @!attribute hour
+              #   The hour of the day when the place opens.
+              #
+              #   @return [Integer, nil]
+              optional :hour, Integer
+
+              # @!attribute minute
+              #   The minute of the hour when the place opens.
+              #
+              #   @return [Integer, nil]
+              optional :minute, Integer
+
+              # @!method initialize(date: nil, hour: nil, minute: nil)
+              #   Returns the open time details.
+              #
+              #   @param date [String] The date to which the subsequent open time details belong to.
+              #
+              #   @param hour [Integer] The hour of the day when the place opens.
+              #
+              #   @param minute [Integer] The minute of the hour when the place opens.
+            end
+          end
+        end
+
+        # @see Nextbillionai::Models::GeocodeRetrieveResponse::Item#scoring
+        class Scoring < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute field_score
+          #   A breakdown of how closely individual field of the result matched with the
+          #   provided query q.
+          #
+          #   @return [Object, nil]
+          optional :field_score, Nextbillionai::Internal::Type::Unknown, api_name: :fieldScore
+
+          # @!attribute query_score
+          #   A score, out of 1, indicating how closely the result matches with the provided
+          #   query q .
+          #
+          #   @return [Float, nil]
+          optional :query_score, Float, api_name: :queryScore
+
+          # @!method initialize(field_score: nil, query_score: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::GeocodeRetrieveResponse::Item::Scoring} for more
+          #   details.
+          #
+          #   Score of the result. A higher score indicates a closer match.
+          #
+          #   @param field_score [Object] A breakdown of how closely individual field of the result matched with the provi
+          #
+          #   @param query_score [Float] A score, out of 1, indicating how closely the result matches with the provided q
+        end
+      end
+    end
+  end
+end