google-maps-platform-sdk 1.0.0

data/lib/google_maps_platform/models/directions_step.rb

@@ -0,0 +1,216 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # Each element in the steps array defines a single step of the calculated
+  # directions. A step is the most atomic unit of a direction's route,
+  # containing a single step describing a specific, single instruction on the
+  # journey. E.g. "Turn left at W. 4th St." The step not only describes the
+  # instruction but also contains distance and duration information relating to
+  # how this step relates to the following step. For example, a step denoted as
+  # "Merge onto I-80 West" may contain a duration of "37 miles" and "40
+  # minutes," indicating that the next step is 37 miles/40 minutes from this
+  # step. When using the Directions API to search for transit directions, the
+  # steps array will include additional transit details in the form of a
+  # transit_details array. If the directions include multiple modes of
+  # transportation, detailed directions will be provided for walking or driving
+  # steps in an inner steps array. For example, a walking step will include
+  # directions from the start and end locations: "Walk to Innes Ave & Fitch St".
+  # That step will include detailed walking directions for that route in the
+  # inner steps array, such as: "Head north-west", "Turn left onto Arelious
+  # Walker", and "Turn left onto Innes Ave".
+  class DirectionsStep < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An object containing a numeric value and its formatted text
+    # representation.
+    # @return [TextValueObject]
+    attr_accessor :distance
+
+    # An object containing a numeric value and its formatted text
+    # representation.
+    # @return [TextValueObject]
+    attr_accessor :duration
+
+    # An object describing a specific location with Latitude and Longitude in
+    # decimal degrees.
+    # @return [LatLngLiteral]
+    attr_accessor :end_location
+
+    # Contains formatted instructions for this step, presented as an HTML text
+    # string. This content is meant to be read as-is. Do not programmatically
+    # parse this display-only content.
+    # @return [String]
+    attr_accessor :html_instructions
+
+    # Contains the action to take for the current step (turn left, merge,
+    # straight, etc.). Values are subject to change, and new values may be
+    # introduced without prior notice.
+    # @return [Maneuver]
+    attr_accessor :maneuver
+
+    # [Polyline
+    # encoding](https://developers.google.com/maps/documentation/utilities/polyl
+    # inealgorithm) is a lossy compression algorithm that allows you to store a
+    # series of coordinates as a single string. Point coordinates are encoded
+    # using signed values. If you only have a few static points, you may also
+    # wish to use the interactive polyline encoding utility.
+    # The encoding process converts a binary value into a series of character
+    # codes for ASCII characters using the familiar base64 encoding scheme: to
+    # ensure proper display of these characters, encoded values are summed with
+    # 63 (the ASCII character '?') before converting them into ASCII. The
+    # algorithm also checks for additional character codes for a given point by
+    # checking the least significant bit of each byte group; if this bit is set
+    # to 1, the point is not yet fully formed and additional data must follow.
+    # Additionally, to conserve space, points only include the offset from the
+    # previous point (except of course for the first point). All points are
+    # encoded in Base64 as signed integers, as latitudes and longitudes are
+    # signed values. The encoding format within a polyline needs to represent
+    # two coordinates representing latitude and longitude to a reasonable
+    # precision. Given a maximum longitude of +/- 180 degrees to a precision of
+    # 5 decimal places (180.00000 to -180.00000), this results in the need for a
+    # 32 bit signed binary integer value.
+    # @return [DirectionsPolyline]
+    attr_accessor :polyline
+
+    # An object describing a specific location with Latitude and Longitude in
+    # decimal degrees.
+    # @return [LatLngLiteral]
+    attr_accessor :start_location
+
+    # Additional information that is not relevant for other modes of
+    # transportation.
+    # @return [DirectionsTransitDetails]
+    attr_accessor :transit_details
+
+    # - `DRIVING` (default) indicates calculation using the road network.
+    # - `BICYCLING` requests calculation for bicycling via bicycle paths &
+    # preferred streets (where available).
+    # - `TRANSIT` requests calculation via public transit routes (where
+    # available). 
+    # - `WALKING` requests calculation for walking via pedestrian paths &
+    # sidewalks (where available).
+    # @return [TravelMode]
+    attr_accessor :travel_mode
+
+    # Contains detailed directions for walking or driving steps in transit
+    # directions. Substeps are only available when travel_mode is set to
+    # "transit". The inner steps array is of the same type as steps.
+    # @return [Object]
+    attr_accessor :steps
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['distance'] = 'distance'
+      @_hash['duration'] = 'duration'
+      @_hash['end_location'] = 'end_location'
+      @_hash['html_instructions'] = 'html_instructions'
+      @_hash['maneuver'] = 'maneuver'
+      @_hash['polyline'] = 'polyline'
+      @_hash['start_location'] = 'start_location'
+      @_hash['transit_details'] = 'transit_details'
+      @_hash['travel_mode'] = 'travel_mode'
+      @_hash['steps'] = 'steps'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        distance
+        maneuver
+        transit_details
+        steps
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(duration:, end_location:, html_instructions:, polyline:,
+                   start_location:, travel_mode:, distance: SKIP,
+                   maneuver: SKIP, transit_details: SKIP, steps: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @distance = distance unless distance == SKIP
+      @duration = duration
+      @end_location = end_location
+      @html_instructions = html_instructions
+      @maneuver = maneuver unless maneuver == SKIP
+      @polyline = polyline
+      @start_location = start_location
+      @transit_details = transit_details unless transit_details == SKIP
+      @travel_mode = travel_mode
+      @steps = steps unless steps == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      duration = TextValueObject.from_hash(hash['duration']) if hash['duration']
+      end_location = LatLngLiteral.from_hash(hash['end_location']) if hash['end_location']
+      html_instructions =
+        hash.key?('html_instructions') ? hash['html_instructions'] : nil
+      polyline = DirectionsPolyline.from_hash(hash['polyline']) if hash['polyline']
+      start_location = LatLngLiteral.from_hash(hash['start_location']) if hash['start_location']
+      travel_mode = hash.key?('travel_mode') ? hash['travel_mode'] : nil
+      distance = TextValueObject.from_hash(hash['distance']) if hash['distance']
+      maneuver = hash.key?('maneuver') ? hash['maneuver'] : SKIP
+      transit_details = DirectionsTransitDetails.from_hash(hash['transit_details']) if
+        hash['transit_details']
+      steps = hash.key?('steps') ? hash['steps'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      DirectionsStep.new(duration: duration,
+                         end_location: end_location,
+                         html_instructions: html_instructions,
+                         polyline: polyline,
+                         start_location: start_location,
+                         travel_mode: travel_mode,
+                         distance: distance,
+                         maneuver: maneuver,
+                         transit_details: transit_details,
+                         steps: steps,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} distance: #{@distance}, duration: #{@duration}, end_location:"\
+      " #{@end_location}, html_instructions: #{@html_instructions}, maneuver: #{@maneuver},"\
+      " polyline: #{@polyline}, start_location: #{@start_location}, transit_details:"\
+      " #{@transit_details}, travel_mode: #{@travel_mode}, steps: #{@steps},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} distance: #{@distance.inspect}, duration: #{@duration.inspect},"\
+      " end_location: #{@end_location.inspect}, html_instructions: #{@html_instructions.inspect},"\
+      " maneuver: #{@maneuver.inspect}, polyline: #{@polyline.inspect}, start_location:"\
+      " #{@start_location.inspect}, transit_details: #{@transit_details.inspect}, travel_mode:"\
+      " #{@travel_mode.inspect}, steps: #{@steps.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/directions_traffic_speed_entry.rb

@@ -0,0 +1,84 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # DirectionsTrafficSpeedEntry Model.
+  class DirectionsTrafficSpeedEntry < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The current traffic/speed conditions on this portion of a path.
+    # @return [String]
+    attr_accessor :speed_category
+
+    # The offset along the path (in meters) up to which this speed category is
+    # valid.
+    # @return [Float]
+    attr_accessor :offset_meters
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['speed_category'] = 'speed_category'
+      @_hash['offset_meters'] = 'offset_meters'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(speed_category:, offset_meters:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @speed_category = speed_category
+      @offset_meters = offset_meters
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      speed_category =
+        hash.key?('speed_category') ? hash['speed_category'] : nil
+      offset_meters = hash.key?('offset_meters') ? hash['offset_meters'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      DirectionsTrafficSpeedEntry.new(speed_category: speed_category,
+                                      offset_meters: offset_meters,
+                                      additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} speed_category: #{@speed_category}, offset_meters: #{@offset_meters},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} speed_category: #{@speed_category.inspect}, offset_meters:"\
+      " #{@offset_meters.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/directions_transit_agency.rb

@@ -0,0 +1,95 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # DirectionsTransitAgency Model.
+  class DirectionsTransitAgency < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of this transit agency.
+    # @return [String]
+    attr_accessor :name
+
+    # The transit agency's phone number.
+    # @return [String]
+    attr_accessor :phone
+
+    # The transit agency's URL.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['phone'] = 'phone'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        phone
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, phone: SKIP, url: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @phone = phone unless phone == SKIP
+      @url = url unless url == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      DirectionsTransitAgency.new(name: name,
+                                  phone: phone,
+                                  url: url,
+                                  additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, phone: #{@phone}, url: #{@url}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, phone: #{@phone.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/directions_transit_details.rb

@@ -0,0 +1,176 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # Additional information that is not relevant for other modes of
+  # transportation.
+  class DirectionsTransitDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DirectionsTransitStop]
+    attr_accessor :arrival_stop
+
+    # An object containing Unix time, a time zone, and its formatted text
+    # representation.
+    # @return [TimeZoneTextValueObject]
+    attr_accessor :arrival_time
+
+    # An object containing Unix time, a time zone, and its formatted text
+    # representation.
+    # @return [DirectionsTransitStop]
+    attr_accessor :departure_stop
+
+    # An object containing Unix time, a time zone, and its formatted text
+    # representation.
+    # @return [TimeZoneTextValueObject]
+    attr_accessor :departure_time
+
+    # Specifies the direction in which to travel on this line, as it is marked
+    # on the vehicle or at the departure stop. This will often be the terminus
+    # station.
+    # @return [String]
+    attr_accessor :headsign
+
+    # Specifies the expected number of seconds between departures from the same
+    # stop at this time. For example, with a `headway` value of 600, you would
+    # expect a ten minute wait if you should miss your bus.
+    # @return [Integer]
+    attr_accessor :headway
+
+    # Specifies the expected number of seconds between departures from the same
+    # stop at this time. For example, with a `headway` value of 600, you would
+    # expect a ten minute wait if you should miss your bus.
+    # @return [DirectionsTransitLine]
+    attr_accessor :line
+
+    # The number of stops from the departure to the arrival stop. This includes
+    # the arrival stop, but not the departure stop. For example, if your
+    # directions involve leaving from Stop A, passing through stops B and C, and
+    # arriving at stop D, `num_stops` will return 3.
+    # @return [Integer]
+    attr_accessor :num_stops
+
+    # The text that appears in schedules and sign boards to identify a transit
+    # trip to passengers. The text should uniquely identify a trip within a
+    # service day. For example, "538" is the `trip_short_name` of the Amtrak
+    # train that leaves San Jose, CA at 15:10 on weekdays to Sacramento, CA.
+    # @return [String]
+    attr_accessor :trip_short_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['arrival_stop'] = 'arrival_stop'
+      @_hash['arrival_time'] = 'arrival_time'
+      @_hash['departure_stop'] = 'departure_stop'
+      @_hash['departure_time'] = 'departure_time'
+      @_hash['headsign'] = 'headsign'
+      @_hash['headway'] = 'headway'
+      @_hash['line'] = 'line'
+      @_hash['num_stops'] = 'num_stops'
+      @_hash['trip_short_name'] = 'trip_short_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        arrival_stop
+        arrival_time
+        departure_stop
+        departure_time
+        headsign
+        headway
+        line
+        num_stops
+        trip_short_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(arrival_stop: SKIP, arrival_time: SKIP, departure_stop: SKIP,
+                   departure_time: SKIP, headsign: SKIP, headway: SKIP,
+                   line: SKIP, num_stops: SKIP, trip_short_name: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @arrival_stop = arrival_stop unless arrival_stop == SKIP
+      @arrival_time = arrival_time unless arrival_time == SKIP
+      @departure_stop = departure_stop unless departure_stop == SKIP
+      @departure_time = departure_time unless departure_time == SKIP
+      @headsign = headsign unless headsign == SKIP
+      @headway = headway unless headway == SKIP
+      @line = line unless line == SKIP
+      @num_stops = num_stops unless num_stops == SKIP
+      @trip_short_name = trip_short_name unless trip_short_name == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      arrival_stop = DirectionsTransitStop.from_hash(hash['arrival_stop']) if hash['arrival_stop']
+      arrival_time = TimeZoneTextValueObject.from_hash(hash['arrival_time']) if
+        hash['arrival_time']
+      departure_stop = DirectionsTransitStop.from_hash(hash['departure_stop']) if
+        hash['departure_stop']
+      departure_time = TimeZoneTextValueObject.from_hash(hash['departure_time']) if
+        hash['departure_time']
+      headsign = hash.key?('headsign') ? hash['headsign'] : SKIP
+      headway = hash.key?('headway') ? hash['headway'] : SKIP
+      line = DirectionsTransitLine.from_hash(hash['line']) if hash['line']
+      num_stops = hash.key?('num_stops') ? hash['num_stops'] : SKIP
+      trip_short_name =
+        hash.key?('trip_short_name') ? hash['trip_short_name'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      DirectionsTransitDetails.new(arrival_stop: arrival_stop,
+                                   arrival_time: arrival_time,
+                                   departure_stop: departure_stop,
+                                   departure_time: departure_time,
+                                   headsign: headsign,
+                                   headway: headway,
+                                   line: line,
+                                   num_stops: num_stops,
+                                   trip_short_name: trip_short_name,
+                                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} arrival_stop: #{@arrival_stop}, arrival_time: #{@arrival_time},"\
+      " departure_stop: #{@departure_stop}, departure_time: #{@departure_time}, headsign:"\
+      " #{@headsign}, headway: #{@headway}, line: #{@line}, num_stops: #{@num_stops},"\
+      " trip_short_name: #{@trip_short_name}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} arrival_stop: #{@arrival_stop.inspect}, arrival_time:"\
+      " #{@arrival_time.inspect}, departure_stop: #{@departure_stop.inspect}, departure_time:"\
+      " #{@departure_time.inspect}, headsign: #{@headsign.inspect}, headway: #{@headway.inspect},"\
+      " line: #{@line.inspect}, num_stops: #{@num_stops.inspect}, trip_short_name:"\
+      " #{@trip_short_name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end