nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/revgeocode_retrieve_params.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Revgeocode#retrieve
+    class RevgeocodeRetrieveParams < Nextbillionai::Internal::Type::BaseModel
+      extend Nextbillionai::Internal::Type::RequestParameters::Converter
+      include Nextbillionai::Internal::Type::RequestParameters
+
+      # @!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]
+      required :at, 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 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}
+      #
+      #   @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
+
+      # @!method initialize(at:, key:, in_: nil, lang: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::RevgeocodeRetrieveParams} for more details.
+      #
+      #   @param at [String] Specify the center of the search context expressed as coordinates.
+      #
+      #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+      #
+      #   @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 request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/nextbillionai/models/revgeocode_retrieve_response.rb

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

@@ -0,0 +1,292 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    class RichGroupRequest < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute area
+      #   Specify the area name. It represents a region where restrictions can be applied.
+      #   This is a custom field and it is recommended for the users to check with
+      #   [NextBillion.ai](www.nextbillion.ai) support for the right value. Alternatively,
+      #   users can invoke the _[Areas](#supported-areas)_ method to get a list of
+      #   available areas for them.
+      #
+      #   @return [String]
+      required :area, String
+
+      # @!attribute name
+      #   Specify a custom, descriptive name for the restriction.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute comment
+      #   Use this parameter to add any custom information about the restriction being
+      #   created.
+      #
+      #   @return [String, nil]
+      optional :comment, String
+
+      # @!attribute direction
+      #   Represents the traffic direction on the segments to which the restriction will
+      #   be applied.
+      #
+      #   @return [Symbol, Nextbillionai::Models::RichGroupRequest::Direction, nil]
+      optional :direction, enum: -> { Nextbillionai::RichGroupRequest::Direction }
+
+      # @!attribute end_time
+      #   Provide a UNIX epoch timestamp in seconds, representing the time when the
+      #   restriction should cease to be in-effect.
+      #
+      #   @return [Float, nil]
+      optional :end_time, Float
+
+      # @!attribute geofence
+      #   An array of coordinates denoting the boundary of an area in which the
+      #   restrictions are to be applied. The format in which coordinates should be listed
+      #   is defined by the latlon field.
+      #
+      #   Geofences can be used to create all restriction types, except for a turn type
+      #   restriction. Please note that segments is not required when using geofence to
+      #   create restrictions.
+      #
+      #   @return [Array<Array<Float>>, nil]
+      optional :geofence,
+               Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Internal::Type::ArrayOf[Float]]
+
+      # @!attribute height
+      #   Specify the maximum truck height, in centimeter, that will be allowed under the
+      #   restriction. A value of 0 indicates no limit.
+      #
+      #   Please note this parameter is effective only when restriction_type is truck. At
+      #   least one of truck parameters - weight, height, width and truck - needs to be
+      #   provided when restriction type is truck.
+      #
+      #   @return [Integer, nil]
+      optional :height, Integer
+
+      # @!attribute length
+      #   Specify the maximum truck length, in centimeter, that will be allowed under the
+      #   restriction. A value of 0 indicates no limit.
+      #
+      #   Please note this parameter is effective only when restriction_type is truck. At
+      #   least one of truck parameters - weight, height, width and truck - needs to be
+      #   provided when restriction type is truck.
+      #
+      #   @return [Integer, nil]
+      optional :length, Integer
+
+      # @!attribute mode
+      #   Provide the driving modes for which the restriction should be effective. If the
+      #   value is an empty array or if it is not provided then the restriction would be
+      #   applied for all modes.
+      #
+      #   @return [Array<Symbol, Nextbillionai::Models::RichGroupRequest::Mode>, nil]
+      optional :mode,
+               -> {
+                 Nextbillionai::Internal::Type::ArrayOf[enum: Nextbillionai::RichGroupRequest::Mode]
+               }
+
+      # @!attribute repeat_on
+      #   It represents the days and times when the restriction is in effect. Users can
+      #   use this property to set recurring or one-time restrictions as per the
+      #   [given format](https://wiki.openstreetmap.org/wiki/Key:opening_hours) for
+      #   specifying the recurring schedule of the restriction.
+      #
+      #   Please provided values as per the local time of the region where the restriction
+      #   is being applied.
+      #
+      #   @return [String, nil]
+      optional :repeat_on, String
+
+      # @!attribute segments
+      #   An array of objects to collect the details of the segments of a road on which
+      #   the restriction has to be applied. Each object corresponds to a new segment.
+      #
+      #   Please note that segments is mandatory for all restrtiction_type except turn.
+      #
+      #   @return [Array<Nextbillionai::Models::RichGroupRequest::Segment>, nil]
+      optional :segments,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::RichGroupRequest::Segment] }
+
+      # @!attribute speed
+      #   Provide the the fixed speed of the segment where the restriction needs to be
+      #   applied. Please note that this parameter is mandatory when the restrictionType
+      #   is fixedspeed.
+      #
+      #   @return [Float, nil]
+      optional :speed, Float
+
+      # @!attribute speed_limit
+      #   Provide the the maximum speed of the segment where the restriction needs to be
+      #   applied. Please note that this parameter is mandatory when the restrictionType
+      #   is maxspeed.
+      #
+      #   @return [Float, nil]
+      optional :speed_limit, Float
+
+      # @!attribute start_time
+      #   Provide a UNIX epoch timestamp in seconds, representing the start time for the
+      #   restriction to be in-effect.
+      #
+      #   @return [Float, nil]
+      optional :start_time, Float
+
+      # @!attribute tracks
+      #   Specify a sequence of coordinates (track) where the restriction is to be
+      #   applied. The coordinates will be snapped to nearest road. Please note when using
+      #   tracks, segments and turns are not required.
+      #
+      #   @return [Array<Array<Float>>, nil]
+      optional :tracks, Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Internal::Type::ArrayOf[Float]]
+
+      # @!attribute turns
+      #   An array of objects to collect the details of the turns of a road on which the
+      #   restriction has to be applied. Each object corresponds to a new turn.
+      #
+      #   Please note that turns is mandatory for when restrtiction_type=turn.
+      #
+      #   @return [Array<Nextbillionai::Models::RichGroupRequest::Turn>, nil]
+      optional :turns, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::RichGroupRequest::Turn] }
+
+      # @!attribute weight
+      #   Specify the maximum truck weight, in kilograms, that the restriction will allow.
+      #   A value of 0 indicates no limit.
+      #
+      #   Please note this parameter is effective only when restriction_type is truck. At
+      #   least one of truck parameters - weight, height, width and truck - needs to be
+      #   provided for is truck restriction type.
+      #
+      #   @return [Integer, nil]
+      optional :weight, Integer
+
+      # @!attribute width
+      #   Specify the maximum truck width, in centimeter, that will be allowed under the
+      #   restriction. A value of 0 indicates no limit.
+      #
+      #   Please note this parameter is effective only when restriction_type is truck. At
+      #   least one of truck parameters - weight, height, width and truck - needs to be
+      #   provided when restriction type is truck.
+      #
+      #   @return [Integer, nil]
+      optional :width, Integer
+
+      # @!method initialize(area:, name:, comment: nil, direction: nil, end_time: nil, geofence: nil, height: nil, length: nil, mode: nil, repeat_on: nil, segments: nil, speed: nil, speed_limit: nil, start_time: nil, tracks: nil, turns: nil, weight: nil, width: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::RichGroupRequest} for more details.
+      #
+      #   @param area [String] Specify the area name. It represents a region where restrictions can be applied.
+      #
+      #   @param name [String] Specify a custom, descriptive name for the restriction.
+      #
+      #   @param comment [String] Use this parameter to add any custom information about the restriction being cre
+      #
+      #   @param direction [Symbol, Nextbillionai::Models::RichGroupRequest::Direction] Represents the traffic direction on the segments to which the restriction will b
+      #
+      #   @param end_time [Float] Provide a UNIX epoch timestamp in seconds, representing the time when the restri
+      #
+      #   @param geofence [Array<Array<Float>>] An array of coordinates denoting the boundary of an area in which the restrictio
+      #
+      #   @param height [Integer] Specify the maximum truck height, in centimeter, that will be allowed under the
+      #
+      #   @param length [Integer] Specify the maximum truck length, in centimeter, that will be allowed under the
+      #
+      #   @param mode [Array<Symbol, Nextbillionai::Models::RichGroupRequest::Mode>] Provide the driving modes for which the restriction should be effective. If the
+      #
+      #   @param repeat_on [String] It represents the days and times when the restriction is in effect. Users can us
+      #
+      #   @param segments [Array<Nextbillionai::Models::RichGroupRequest::Segment>] An array of objects to collect the details of the segments of a road on which th
+      #
+      #   @param speed [Float] Provide the the fixed speed of the segment where the restriction needs to be app
+      #
+      #   @param speed_limit [Float] Provide the the maximum speed of the segment where the restriction needs to be a
+      #
+      #   @param start_time [Float] Provide a UNIX epoch timestamp in seconds, representing the start time for the r
+      #
+      #   @param tracks [Array<Array<Float>>] Specify a sequence of coordinates (track) where the restriction is to be applied
+      #
+      #   @param turns [Array<Nextbillionai::Models::RichGroupRequest::Turn>] An array of objects to collect the details of the turns of a road on which the r
+      #
+      #   @param weight [Integer] Specify the maximum truck weight, in kilograms, that the restriction will allow.
+      #
+      #   @param width [Integer] Specify the maximum truck width, in centimeter, that will be allowed under the
+
+      # Represents the traffic direction on the segments to which the restriction will
+      # be applied.
+      #
+      # @see Nextbillionai::Models::RichGroupRequest#direction
+      module Direction
+        extend Nextbillionai::Internal::Type::Enum
+
+        FORWARD = :forward
+        BACKWARD = :backward
+        BOTH = :both
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module Mode
+        extend Nextbillionai::Internal::Type::Enum
+
+        MODE_0W = :"0w"
+        MODE_2W = :"2w"
+        MODE_3W = :"3w"
+        MODE_4W = :"4w"
+        MODE_6W = :"6w"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Segment < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute from
+        #   An integer value representing the ID of the starting node of the segment.
+        #
+        #   @return [Float, nil]
+        optional :from, Float
+
+        # @!attribute to
+        #   An integer value representing the ID of the ending node of the segment.
+        #
+        #   @return [Float, nil]
+        optional :to, Float
+
+        # @!method initialize(from: nil, to: nil)
+        #   @param from [Float] An integer value representing the ID of the starting node of the segment.
+        #
+        #   @param to [Float] An integer value representing the ID of the ending node of the segment.
+      end
+
+      class Turn < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute from
+        #   An integer value that represents the ID of the starting node of the turn.
+        #
+        #   @return [Integer, nil]
+        optional :from, Integer
+
+        # @!attribute to
+        #   An integer value that represents the ID of the ending node of the turn.
+        #
+        #   @return [Integer, nil]
+        optional :to, Integer
+
+        # @!attribute via
+        #   An integer value that represents the ID of a node connecting from and to nodes
+        #   of the turn.
+        #
+        #   @return [Integer, nil]
+        optional :via, Integer
+
+        # @!method initialize(from: nil, to: nil, via: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::RichGroupRequest::Turn} for more details.
+        #
+        #   @param from [Integer] An integer value that represents the ID of the starting node of the turn.
+        #
+        #   @param to [Integer] An integer value that represents the ID of the ending node of the turn.
+        #
+        #   @param via [Integer] An integer value that represents the ID of a node connecting from and to nodes o
+      end
+    end
+  end
+end