nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/discover_retrieve_params.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Discover#retrieve
+    class DiscoverRetrieveParams < 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::DiscoverRetrieveParams} 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/discover_retrieve_response.rb

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module DistanceMatrix
+      # @see Nextbillionai::Resources::DistanceMatrix::Json#create
+      class JsonCreateParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/distance_matrix/json_retrieve_params.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module DistanceMatrix
+      # @see Nextbillionai::Resources::DistanceMatrix::Json#retrieve
+      class JsonRetrieveParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        # @!attribute destinations
+        #   "destinations" are the ending coordinates of your route. Ensure that
+        #   "destinations" are routable land locations. Multiple "destinations" should be
+        #   separated by a pipe symbol "|".
+        #
+        #   @return [String]
+        required :destinations, String
+
+        # @!attribute key
+        #   A key is a unique identifier that is required to authenticate a request to the
+        #   API.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!attribute origins
+        #   "origins" are the starting point of your route. Ensure that "origins" are
+        #   routable land locations. Multiple "origins" should be separated by a pipe symbol
+        #   "|".
+        #
+        #   @return [String]
+        required :origins, String
+
+        # @!attribute approaches
+        #   A semicolon-separated list indicating the side of the road from which the route
+        #   will approach "destinations". When set to "unrestricted" a route can arrive at a
+        #   destination from either side of the road. When set to "curb" the route will
+        #   arrive at a destination on the driving side of the region. Please note the
+        #   number of values provided must be equal to the number of "destinations".
+        #   However, you can skip a coordinate and show its position in the list with the
+        #   ";" separator. The values provided for the "approaches" parameter are effective
+        #   for the "destinations" value at the same index. Example: "curb;;curb" will apply
+        #   curbside restriction on the "destinations" points provided at the first and
+        #   third index.
+        #
+        #   @return [Symbol, Nextbillionai::Models::DistanceMatrix::JsonRetrieveParams::Approaches, nil]
+        optional :approaches, enum: -> { Nextbillionai::DistanceMatrix::JsonRetrieveParams::Approaches }
+
+        # @!attribute avoid
+        #   Setting this will ensure the route avoids ferries, tolls, highways or nothing.
+        #   Multiple values should be separated by a pipe (|). If "none" is provided along
+        #   with other values, an error is returned as a valid route is not feasible. Please
+        #   note that when this parameter is not provided in the input, ferries are set to
+        #   be avoided by default. When this parameter is provided, only the mentioned
+        #   objects are avoided.
+        #
+        #   @return [Symbol, Nextbillionai::Models::DistanceMatrix::JsonRetrieveParams::Avoid, nil]
+        optional :avoid, enum: -> { Nextbillionai::DistanceMatrix::JsonRetrieveParams::Avoid }
+
+        # @!attribute bearings
+        #   Limits the search to segments with given bearing in degrees towards true north
+        #   in clockwise direction. Each "bearing" should be in the format of
+        #   "degree,range", where the "degree" should be a value between \[0, 360\] and
+        #   "range" should be a value between \[0, 180\]. Please note that the number of
+        #   "bearings" should be equal to the sum of the number of points in "origins" and
+        #   "destinations". If a route can approach a destination from any direction, the
+        #   bearing for that point can be specified as "0,180".
+        #
+        #   @return [String, nil]
+        optional :bearings, String
+
+        # @!attribute mode
+        #   Set which driving mode the service should use to determine the "distance" and
+        #   "duration" values. For example, if you use "car", the API will return the
+        #   duration and distance of a route that a car can take. Using "truck" will return
+        #   the same for a route a truck can use, taking into account appropriate truck
+        #   routing restrictions.
+        #
+        #   When "mode=truck", following are the default dimensions that are used:
+        #
+        #   \- truck_height = 214 centimeters
+        #
+        #   \- truck_width = 183 centimeters
+        #
+        #   \- truck_length = 519 centimeters
+        #
+        #   \- truck_weight = 5000 kg
+        #
+        #   Please use the Distance Matrix Flexible version if you want to use custom truck
+        #   dimensions.
+        #
+        #   Note: Only the "car" profile is enabled by default. Please note that customized
+        #   profiles (including "truck") might not be available for all regions. Please
+        #   contact your [NextBillion.ai](http://NextBillion.ai) account manager, sales
+        #   representative or reach out at
+        #   [support@nextbillion.ai](mailto:support@nextbillion.ai) in case you need
+        #   additional profiles.
+        #
+        #   @return [Symbol, Nextbillionai::Models::DistanceMatrix::JsonRetrieveParams::Mode, nil]
+        optional :mode, enum: -> { Nextbillionai::DistanceMatrix::JsonRetrieveParams::Mode }
+
+        # @!attribute route_failed_prompt
+        #   A prompt to modify the response in case no feasible route is available for a
+        #   given pair of origin and destination. When set to "true", a value of "-1" is
+        #   returned for those pairs in which:
+        #
+        #   \- Either origin or the destination can not be snapped to a nearest road. Please
+        #   note that if all the origins and destinations in a request can't be snapped to
+        #   their nearest roads, a 4xx error is returned instead, as the entire request
+        #   failed.
+        #
+        #   \- Both origin and destination can be snapped to the nearest road, but the
+        #   service can't find a valid route between them. However, a value of "0" is
+        #   returned if both the origin and destination are snapped to the same location.
+        #
+        #   "false" is the default value. In this case, a "0" value is returned for all the
+        #   above cases. A 4xx error is returned, in this case as well, when all origins and
+        #   destinations in the request can't be snapped to their nearest road.
+        #
+        #   @return [Boolean, nil]
+        optional :route_failed_prompt, Nextbillionai::Internal::Type::Boolean
+
+        # @!method initialize(destinations:, key:, origins:, approaches: nil, avoid: nil, bearings: nil, mode: nil, route_failed_prompt: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::DistanceMatrix::JsonRetrieveParams} for more details.
+        #
+        #   @param destinations [String] "destinations" are the ending coordinates of your route. Ensure that "destinatio
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param origins [String] "origins" are the starting point of your route. Ensure that "origins" are routab
+        #
+        #   @param approaches [Symbol, Nextbillionai::Models::DistanceMatrix::JsonRetrieveParams::Approaches] A semicolon-separated list indicating the side of the road from which the route
+        #
+        #   @param avoid [Symbol, Nextbillionai::Models::DistanceMatrix::JsonRetrieveParams::Avoid] Setting this will ensure the route avoids ferries, tolls, highways or nothing. M
+        #
+        #   @param bearings [String] Limits the search to segments with given bearing in degrees towards true north i
+        #
+        #   @param mode [Symbol, Nextbillionai::Models::DistanceMatrix::JsonRetrieveParams::Mode] Set which driving mode the service should use to determine the "distance" and "d
+        #
+        #   @param route_failed_prompt [Boolean] A prompt to modify the response in case no feasible route is available for a giv
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+        # A semicolon-separated list indicating the side of the road from which the route
+        # will approach "destinations". When set to "unrestricted" a route can arrive at a
+        # destination from either side of the road. When set to "curb" the route will
+        # arrive at a destination on the driving side of the region. Please note the
+        # number of values provided must be equal to the number of "destinations".
+        # However, you can skip a coordinate and show its position in the list with the
+        # ";" separator. The values provided for the "approaches" parameter are effective
+        # for the "destinations" value at the same index. Example: "curb;;curb" will apply
+        # curbside restriction on the "destinations" points provided at the first and
+        # third index.
+        module Approaches
+          extend Nextbillionai::Internal::Type::Enum
+
+          UNRESTRICTED = :unrestricted
+          CURB = :curb
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Setting this will ensure the route avoids ferries, tolls, highways or nothing.
+        # Multiple values should be separated by a pipe (|). If "none" is provided along
+        # with other values, an error is returned as a valid route is not feasible. Please
+        # note that when this parameter is not provided in the input, ferries are set to
+        # be avoided by default. When this parameter is provided, only the mentioned
+        # objects are avoided.
+        module Avoid
+          extend Nextbillionai::Internal::Type::Enum
+
+          TOLL = :toll
+          FERRY = :ferry
+          HIGHWAY = :highway
+          NONE = :none
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Set which driving mode the service should use to determine the "distance" and
+        # "duration" values. For example, if you use "car", the API will return the
+        # duration and distance of a route that a car can take. Using "truck" will return
+        # the same for a route a truck can use, taking into account appropriate truck
+        # routing restrictions.
+        #
+        # When "mode=truck", following are the default dimensions that are used:
+        #
+        # \- truck_height = 214 centimeters
+        #
+        # \- truck_width = 183 centimeters
+        #
+        # \- truck_length = 519 centimeters
+        #
+        # \- truck_weight = 5000 kg
+        #
+        # Please use the Distance Matrix Flexible version if you want to use custom truck
+        # dimensions.
+        #
+        # Note: Only the "car" profile is enabled by default. Please note that customized
+        # profiles (including "truck") might not be available for all regions. Please
+        # contact your [NextBillion.ai](http://NextBillion.ai) account manager, sales
+        # representative or reach out at
+        # [support@nextbillion.ai](mailto:support@nextbillion.ai) in case you need
+        # additional profiles.
+        module Mode
+          extend Nextbillionai::Internal::Type::Enum
+
+          CAR = :car
+          TRUCK = :truck
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/distance_matrix/json_retrieve_response.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module DistanceMatrix
+      # @see Nextbillionai::Resources::DistanceMatrix::Json#retrieve
+      class JsonRetrieveResponse < 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 rows
+        #   Container object for a response with an array of arrays structure.
+        #
+        #   @return [Array<Nextbillionai::Models::DistanceMatrix::JsonRetrieveResponse::Row>, nil]
+        optional :rows,
+                 -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::DistanceMatrix::JsonRetrieveResponse::Row] }
+
+        # @!attribute status
+        #   A string indicating the state of the response. On normal responses, the value
+        #   will be Ok. Indicative HTTP error codes are returned for different errors. See
+        #   the [API Errors Codes](#api-error-codes) section below for more information.
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!method initialize(msg: nil, rows: nil, status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::DistanceMatrix::JsonRetrieveResponse} for more details.
+        #
+        #   @param msg [String] Displays the error message in case of a failed request or operation. Please note
+        #
+        #   @param rows [Array<Nextbillionai::Models::DistanceMatrix::JsonRetrieveResponse::Row>] Container object for a response with an array of arrays structure.
+        #
+        #   @param status [String] A string indicating the state of the response. On normal responses, the value wi
+
+        class Row < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute elements
+          #   An array of objects. Each elements array corresponds to a single origins
+          #   coordinate and contains objects with distance and duration values for each of
+          #   the destinations. The details in the first elements array correspond to the
+          #   first origins point and the first object corresponds to the first destinations
+          #   point and so on.
+          #
+          #   @return [Array<Nextbillionai::Models::DistanceMatrix::JsonRetrieveResponse::Row::Element>, nil]
+          optional :elements,
+                   -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::DistanceMatrix::JsonRetrieveResponse::Row::Element] }
+
+          # @!method initialize(elements: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::DistanceMatrix::JsonRetrieveResponse::Row} for more
+          #   details.
+          #
+          #   @param elements [Array<Nextbillionai::Models::DistanceMatrix::JsonRetrieveResponse::Row::Element>] An array of objects. Each elements array corresponds to a single origins coordin
+
+          class Element < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute distance
+            #   Distance of the route from an origin to a destination, in meters.
+            #
+            #   @return [Float, nil]
+            optional :distance, Float
+
+            # @!attribute duration
+            #   Duration of the trip from an origin to a destination, in seconds.
+            #
+            #   @return [Float, nil]
+            optional :duration, Float
+
+            # @!method initialize(distance: nil, duration: nil)
+            #   @param distance [Float] Distance of the route from an origin to a destination, in meters.
+            #
+            #   @param duration [Float] Duration of the trip from an origin to a destination, in seconds.
+          end
+        end
+      end
+    end
+  end
+end