nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/autosuggest_suggest_response.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Autosuggest#suggest
+    class AutosuggestSuggestResponse < 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::AutosuggestSuggestResponse::Item>, nil]
+      optional :items,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::AutosuggestSuggestResponse::Item] }
+
+      # @!method initialize(items: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::AutosuggestSuggestResponse} for more details.
+      #
+      #   @param items [Array<Nextbillionai::Models::AutosuggestSuggestResponse::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::AutosuggestSuggestResponse::Item::OpeningHours, nil]
+        optional :opening_hours,
+                 -> { Nextbillionai::Models::AutosuggestSuggestResponse::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::AutosuggestSuggestResponse::Item::Scoring, nil]
+        optional :scoring, -> { Nextbillionai::Models::AutosuggestSuggestResponse::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::AutosuggestSuggestResponse::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::AutosuggestSuggestResponse::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::AutosuggestSuggestResponse::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::AutosuggestSuggestResponse::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::AutosuggestSuggestResponse::Item::OpeningHours::TimeRange>, nil]
+          optional :time_ranges,
+                   -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::AutosuggestSuggestResponse::Item::OpeningHours::TimeRange] },
+                   api_name: :timeRanges
+
+          # @!method initialize(time_ranges: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::AutosuggestSuggestResponse::Item::OpeningHours} for more
+          #   details.
+          #
+          #   Returns the operating hours of the place, if available.
+          #
+          #   @param time_ranges [Array<Nextbillionai::Models::AutosuggestSuggestResponse::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::AutosuggestSuggestResponse::Item::OpeningHours::TimeRange::EndTime, nil]
+            optional :end_time,
+                     -> { Nextbillionai::Models::AutosuggestSuggestResponse::Item::OpeningHours::TimeRange::EndTime },
+                     api_name: :endTime
+
+            # @!attribute start_time
+            #   Returns the open time details.
+            #
+            #   @return [Nextbillionai::Models::AutosuggestSuggestResponse::Item::OpeningHours::TimeRange::StartTime, nil]
+            optional :start_time,
+                     -> { Nextbillionai::Models::AutosuggestSuggestResponse::Item::OpeningHours::TimeRange::StartTime },
+                     api_name: :startTime
+
+            # @!method initialize(end_time: nil, start_time: nil)
+            #   @param end_time [Nextbillionai::Models::AutosuggestSuggestResponse::Item::OpeningHours::TimeRange::EndTime] Returns the closing time details.
+            #
+            #   @param start_time [Nextbillionai::Models::AutosuggestSuggestResponse::Item::OpeningHours::TimeRange::StartTime] Returns the open time details.
+
+            # @see Nextbillionai::Models::AutosuggestSuggestResponse::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::AutosuggestSuggestResponse::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::AutosuggestSuggestResponse::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::AutosuggestSuggestResponse::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/batch_create_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Batch#create
+    class BatchCreateParams < 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 requests
+      #   An array of objects to collect the details of individual routing queries that
+      #   will form a batch.
+      #
+      #   @return [Array<Nextbillionai::Models::BatchCreateParams::Request>, nil]
+      optional :requests,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::BatchCreateParams::Request] }
+
+      # @!method initialize(key:, requests: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::BatchCreateParams} for more details.
+      #
+      #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+      #
+      #   @param requests [Array<Nextbillionai::Models::BatchCreateParams::Request>] An array of objects to collect the details of individual routing queries that wi
+      #
+      #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+      class Request < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute query
+        #   Specify the routing query in the form of a string. The supported attributes and
+        #   their formats are consistent with the standard routing endpoint that is being
+        #   used as part of the batch. Check the
+        #   [Sample Request](https://docs.nextbillion.ai/docs/navigation/batch-routing-api#sample-request-1)
+        #   section for an example request.
+        #
+        #   @return [String, nil]
+        optional :query, String
+
+        # @!method initialize(query: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::BatchCreateParams::Request} for more details.
+        #
+        #   @param query [String] Specify the routing query in the form of a string. The supported attributes and
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/batch_create_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Batch#create
+    class BatchCreateResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute msg
+      #   Displays the error message in case of a failed request or operation. Please note
+      #   that this parameter is not returned in the response in case of a successful
+      #   request.
+      #
+      #   @return [String, nil]
+      optional :msg, String
+
+      # @!attribute status
+      #   Returns the overall status of the API request. Its value will belong to one of
+      #   success, failed, and pending. It can also contain HTTP error codes in case of a
+      #   failed request or operation.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute track_id
+      #   Returns the unique ID of the batch processing task. Use this ID using the GET
+      #   request to retrieve the solution once the task processing is completed.
+      #
+      #   @return [String, nil]
+      optional :track_id, String
+
+      # @!method initialize(msg: nil, status: nil, track_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::BatchCreateResponse} for more details.
+      #
+      #   @param msg [String] Displays the error message in case of a failed request or operation. Please note
+      #
+      #   @param status [String] Returns the overall status of the API request. Its value will belong to one of s
+      #
+      #   @param track_id [String] Returns the unique ID of the batch processing task. Use this ID using the GET re
+    end
+  end
+end

data/lib/nextbillionai/models/batch_retrieve_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Batch#retrieve
+    class BatchRetrieveParams < 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 track_id
+      #   Specify the track ID of the batch that was returned in the response after
+      #   submitting a successful batch request.
+      #
+      #   @return [String]
+      required :track_id, String
+
+      # @!method initialize(key:, track_id:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::BatchRetrieveParams} for more details.
+      #
+      #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+      #
+      #   @param track_id [String] Specify the track ID of the batch that was returned in the response after submit
+      #
+      #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/nextbillionai/models/batch_retrieve_response.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Batch#retrieve
+    class BatchRetrieveResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute msg
+      #   Displays the error message in case of a failed request or operation. Please note
+      #   that this parameter is not returned in the response in case of a successful
+      #   request.
+      #
+      #   @return [String, nil]
+      optional :msg, String
+
+      # @!attribute responses
+      #   An array of objects returning the results of all the individual routing queries
+      #   specified in the input. Each object represents the solution to an individual
+      #   query in the input.
+      #
+      #   @return [Array<Nextbillionai::Models::BatchRetrieveResponse::Response>, nil]
+      optional :responses,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::BatchRetrieveResponse::Response] }
+
+      # @!attribute status
+      #   Returns the overall status of the API request. Its value will always be one of
+      #   success, failed, and pending.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute track_id
+      #   Returns the unique ID of the batch processing task.
+      #
+      #   @return [String, nil]
+      optional :track_id, String
+
+      # @!method initialize(msg: nil, responses: nil, status: nil, track_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::BatchRetrieveResponse} for more details.
+      #
+      #   @param msg [String] Displays the error message in case of a failed request or operation. Please note
+      #
+      #   @param responses [Array<Nextbillionai::Models::BatchRetrieveResponse::Response>] An array of objects returning the results of all the individual routing queries
+      #
+      #   @param status [String] Returns the overall status of the API request. Its value will always be one of s
+      #
+      #   @param track_id [String] Returns the unique ID of the batch processing task.
+
+      class Response < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute response
+        #   An object returning the routing solution of an individual query. The JSON format
+        #   and structure of the response would vary depending on the routing endpoint used
+        #   in each individual query. However, it will be consistent with standard response
+        #   for a given routing endpoint.
+        #
+        #   @return [Object, nil]
+        optional :response, Nextbillionai::Internal::Type::Unknown
+
+        # @!attribute status_code
+        #   Returns the HTTP status code for the individual routing request. See the
+        #   [API Errors Codes](#api-error-codes) section below for more information.
+        #
+        #   @return [Integer, nil]
+        optional :status_code, Integer
+
+        # @!method initialize(response: nil, status_code: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::BatchRetrieveResponse::Response} for more details.
+        #
+        #   @param response [Object] An object returning the routing solution of an individual query. The JSON format
+        #
+        #   @param status_code [Integer] Returns the HTTP status code for the individual routing request. See the [API Er
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/browse_search_params.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Browse#search
+    class BrowseSearchParams < 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 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 categories
+      #   This is a category filter consisting of a comma-separated list of categories.
+      #   Places with any assigned categories that match any of the requested categories
+      #   are included in the response.
+      #
+      #   @return [String, nil]
+      optional :categories, 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:, at: nil, categories: nil, in_: nil, lang: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::BrowseSearchParams} for more details.
+      #
+      #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+      #
+      #   @param at [String] Specify the center of the search context expressed as coordinates.
+      #
+      #   @param categories [String] This is a category filter consisting of a comma-separated list of categories. Pl
+      #
+      #   @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