google-maps-api-sdk 1.0.0

data/lib/google_maps_platform/models/distance_matrix_element.rb

@@ -0,0 +1,132 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # DistanceMatrixElement Model.
+  class DistanceMatrixElement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total fare for the route.
+    # ```
+    # {
+    #   "currency" : "USD",
+    #   "value" : 6,
+    #   "text" : "$6.00"
+    # }
+    # ```
+    # @return [Fare]
+    attr_accessor :fare
+
+    # 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_in_traffic
+
+    # An object containing a numeric value and its formatted text
+    # representation.
+    # @return [TextValueObject]
+    attr_accessor :duration
+
+    # - `OK` indicates the response contains a valid result.
+    # - `NOT_FOUND` indicates that the origin and/or destination of this pairing
+    # could not be geocoded.
+    # - `ZERO_RESULTS` indicates no route could be found between the origin and
+    # destination.
+    # - `MAX_ROUTE_LENGTH_EXCEEDED` indicates the requested route is too long
+    # and cannot be processed.
+    # @return [DistanceMatrixElementStatus]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fare'] = 'fare'
+      @_hash['distance'] = 'distance'
+      @_hash['duration_in_traffic'] = 'duration_in_traffic'
+      @_hash['duration'] = 'duration'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fare
+        distance
+        duration_in_traffic
+        duration
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status:, fare: SKIP, distance: SKIP,
+                   duration_in_traffic: SKIP, duration: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @fare = fare unless fare == SKIP
+      @distance = distance unless distance == SKIP
+      @duration_in_traffic = duration_in_traffic unless duration_in_traffic == SKIP
+      @duration = duration unless duration == SKIP
+      @status = status
+      @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.
+      status = hash.key?('status') ? hash['status'] : nil
+      fare = Fare.from_hash(hash['fare']) if hash['fare']
+      distance = TextValueObject.from_hash(hash['distance']) if hash['distance']
+      duration_in_traffic = TextValueObject.from_hash(hash['duration_in_traffic']) if
+        hash['duration_in_traffic']
+      duration = TextValueObject.from_hash(hash['duration']) if hash['duration']
+
+      # 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.
+      DistanceMatrixElement.new(status: status,
+                                fare: fare,
+                                distance: distance,
+                                duration_in_traffic: duration_in_traffic,
+                                duration: duration,
+                                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} fare: #{@fare}, distance: #{@distance}, duration_in_traffic:"\
+      " #{@duration_in_traffic}, duration: #{@duration}, status: #{@status},"\
+      " 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} fare: #{@fare.inspect}, distance: #{@distance.inspect},"\
+      " duration_in_traffic: #{@duration_in_traffic.inspect}, duration: #{@duration.inspect},"\
+      " status: #{@status.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/distance_matrix_element_status.rb

@@ -0,0 +1,48 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # - `OK` indicates the response contains a valid result. - `NOT_FOUND`
+  # indicates that the origin and/or destination of this pairing could not be
+  # geocoded. - `ZERO_RESULTS` indicates no route could be found between the
+  # origin and destination. - `MAX_ROUTE_LENGTH_EXCEEDED` indicates the
+  # requested route is too long and cannot be processed.
+  class DistanceMatrixElementStatus
+    DISTANCE_MATRIX_ELEMENT_STATUS = [
+      # TODO: Write general description for OK
+      OK = 'OK'.freeze,
+
+      # TODO: Write general description for NOT_FOUND
+      NOT_FOUND = 'NOT_FOUND'.freeze,
+
+      # TODO: Write general description for ZERO_RESULTS
+      ZERO_RESULTS = 'ZERO_RESULTS'.freeze,
+
+      # TODO: Write general description for MAX_ROUTE_LENGTH_EXCEEDED
+      MAX_ROUTE_LENGTH_EXCEEDED = 'MAX_ROUTE_LENGTH_EXCEEDED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DISTANCE_MATRIX_ELEMENT_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = OK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ok' then OK
+      when 'not_found' then NOT_FOUND
+      when 'zero_results' then ZERO_RESULTS
+      when 'max_route_length_exceeded' then MAX_ROUTE_LENGTH_EXCEEDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/google_maps_platform/models/distance_matrix_response.rb

@@ -0,0 +1,149 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # DistanceMatrixResponse Model.
+  class DistanceMatrixResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of addresses as returned by the API from your original request.
+    # These are formatted by the geocoder and localized according to the
+    # language parameter passed with the request. This content is meant to be
+    # read as-is. Do not programatically parse the formatted addresses.
+    # @return [Array[String]]
+    attr_accessor :origin_addresses
+
+    # An array of addresses as returned by the API from your original request.
+    # As with `origin_addresses`, these are localized if appropriate. This
+    # content is meant to be read as-is. Do not programatically parse the
+    # formatted addresses.
+    # @return [Array[String]]
+    attr_accessor :destination_addresses
+
+    # An array of elements, which in turn each contain a `status`, `duration`,
+    # and `distance` element.
+    # @return [Array[DistanceMatrixRow]]
+    attr_accessor :rows
+
+    # Status codes returned by service.
+    # - `OK` indicates the response contains a valid result.
+    # - `INVALID_REQUEST` indicates that the provided request was invalid.
+    # - `MAX_ELEMENTS_EXCEEDED` indicates that the product of origins and
+    # destinations exceeds the per-query limit.
+    # - `MAX_DIMENSIONS_EXCEEDED` indicates that the number of origins or
+    # destinations exceeds the per-query limit.
+    # - `OVER_DAILY_LIMIT` indicates any of the following:
+    #   - The API key is missing or invalid.
+    #   - Billing has not been enabled on your account.
+    #   - A self-imposed usage cap has been exceeded.
+    #   - The provided method of payment is no longer valid (for example, a
+    # credit card has expired).
+    # - `OVER_QUERY_LIMIT` indicates the service has received too many requests
+    # from your application within the allowed time period.
+    # - `REQUEST_DENIED` indicates that the service denied use of the Distance
+    # Matrix service by your application.
+    # - `UNKNOWN_ERROR` indicates a Distance Matrix request could not be
+    # processed due to a server error. The request may succeed if you try again.
+    # @return [DistanceMatrixStatus]
+    attr_accessor :status
+
+    # A string containing the human-readable text of any errors encountered
+    # while the request was being processed.
+    # @return [String]
+    attr_accessor :error_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['origin_addresses'] = 'origin_addresses'
+      @_hash['destination_addresses'] = 'destination_addresses'
+      @_hash['rows'] = 'rows'
+      @_hash['status'] = 'status'
+      @_hash['error_message'] = 'error_message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(origin_addresses:, destination_addresses:, rows:, status:,
+                   error_message: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @origin_addresses = origin_addresses
+      @destination_addresses = destination_addresses
+      @rows = rows
+      @status = status
+      @error_message = error_message unless error_message == 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.
+      origin_addresses =
+        hash.key?('origin_addresses') ? hash['origin_addresses'] : nil
+      destination_addresses =
+        hash.key?('destination_addresses') ? hash['destination_addresses'] : nil
+      # Parameter is an array, so we need to iterate through it
+      rows = nil
+      unless hash['rows'].nil?
+        rows = []
+        hash['rows'].each do |structure|
+          rows << (DistanceMatrixRow.from_hash(structure) if structure)
+        end
+      end
+
+      rows = nil unless hash.key?('rows')
+      status = hash.key?('status') ? hash['status'] : nil
+      error_message = hash.key?('error_message') ? hash['error_message'] : 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.
+      DistanceMatrixResponse.new(origin_addresses: origin_addresses,
+                                 destination_addresses: destination_addresses,
+                                 rows: rows,
+                                 status: status,
+                                 error_message: error_message,
+                                 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} origin_addresses: #{@origin_addresses}, destination_addresses:"\
+      " #{@destination_addresses}, rows: #{@rows}, status: #{@status}, error_message:"\
+      " #{@error_message}, 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} origin_addresses: #{@origin_addresses.inspect}, destination_addresses:"\
+      " #{@destination_addresses.inspect}, rows: #{@rows.inspect}, status: #{@status.inspect},"\
+      " error_message: #{@error_message.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/distance_matrix_row.rb

@@ -0,0 +1,89 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # DistanceMatrixRow Model.
+  class DistanceMatrixRow < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When the Distance Matrix API returns results, it places them within a JSON
+    # rows array. Even if no results are returned (such as when the origins
+    # and/or destinations don't exist), it still returns an empty array. 
+    # Rows are ordered according to the values in the origin parameter of the
+    # request. Each row corresponds to an origin, and each element within that
+    # row corresponds to a pairing of the origin with a destination value.
+    # Each row array contains one or more element entries, which in turn contain
+    # the information about a single origin-destination pairing.
+    # @return [Array[DistanceMatrixElement]]
+    attr_accessor :elements
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['elements'] = 'elements'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(elements:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @elements = elements
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      elements = nil
+      unless hash['elements'].nil?
+        elements = []
+        hash['elements'].each do |structure|
+          elements << (DistanceMatrixElement.from_hash(structure) if structure)
+        end
+      end
+
+      elements = nil unless hash.key?('elements')
+
+      # 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.
+      DistanceMatrixRow.new(elements: elements,
+                            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} elements: #{@elements}, 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} elements: #{@elements.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/distance_matrix_status.rb

@@ -0,0 +1,74 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # Status codes returned by service. - `OK` indicates the response contains a
+  # valid result. - `INVALID_REQUEST` indicates that the provided request was
+  # invalid. - `MAX_ELEMENTS_EXCEEDED` indicates that the product of origins and
+  # destinations exceeds the per-query limit. - `MAX_DIMENSIONS_EXCEEDED`
+  # indicates that the number of origins or destinations exceeds the per-query
+  # limit. - `OVER_DAILY_LIMIT` indicates any of the following:   - The API key
+  # is missing or invalid.   - Billing has not been enabled on your account.   -
+  # A self-imposed usage cap has been exceeded.   - The provided method of
+  # payment is no longer valid (for example, a credit card has expired). -
+  # `OVER_QUERY_LIMIT` indicates the service has received too many requests from
+  # your application within the allowed time period. - `REQUEST_DENIED`
+  # indicates that the service denied use of the Distance Matrix service by your
+  # application. - `UNKNOWN_ERROR` indicates a Distance Matrix request could not
+  # be processed due to a server error. The request may succeed if you try
+  # again.
+  class DistanceMatrixStatus
+    DISTANCE_MATRIX_STATUS = [
+      # TODO: Write general description for OK
+      OK = 'OK'.freeze,
+
+      # TODO: Write general description for INVALID_REQUEST
+      INVALID_REQUEST = 'INVALID_REQUEST'.freeze,
+
+      # TODO: Write general description for MAX_ELEMENTS_EXCEEDED
+      MAX_ELEMENTS_EXCEEDED = 'MAX_ELEMENTS_EXCEEDED'.freeze,
+
+      # TODO: Write general description for MAX_DIMENSIONS_EXCEEDED
+      MAX_DIMENSIONS_EXCEEDED = 'MAX_DIMENSIONS_EXCEEDED'.freeze,
+
+      # TODO: Write general description for OVER_DAILY_LIMIT
+      OVER_DAILY_LIMIT = 'OVER_DAILY_LIMIT'.freeze,
+
+      # TODO: Write general description for OVER_QUERY_LIMIT
+      OVER_QUERY_LIMIT = 'OVER_QUERY_LIMIT'.freeze,
+
+      # TODO: Write general description for REQUEST_DENIED
+      REQUEST_DENIED = 'REQUEST_DENIED'.freeze,
+
+      # TODO: Write general description for UNKNOWN_ERROR
+      UNKNOWN_ERROR = 'UNKNOWN_ERROR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DISTANCE_MATRIX_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = OK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ok' then OK
+      when 'invalid_request' then INVALID_REQUEST
+      when 'max_elements_exceeded' then MAX_ELEMENTS_EXCEEDED
+      when 'max_dimensions_exceeded' then MAX_DIMENSIONS_EXCEEDED
+      when 'over_daily_limit' then OVER_DAILY_LIMIT
+      when 'over_query_limit' then OVER_QUERY_LIMIT
+      when 'request_denied' then REQUEST_DENIED
+      when 'unknown_error' then UNKNOWN_ERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/google_maps_platform/models/elevation_response.rb

@@ -0,0 +1,132 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # ElevationResponse Model.
+  class ElevationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When the service returns a status code other than `OK`, there may be an
+    # additional `error_message` field within the response object. This field
+    # contains more detailed information about thereasons behind the given
+    # status code. This field is not always returned, and its content is subject
+    # to change.
+    # @return [String]
+    attr_accessor :error_message
+
+    # Status codes returned by service.
+    # - `OK` indicating the API request was successful.
+    # - `DATA_NOT_AVAILABLE` indicating that there's no available data for the
+    # input locations. 
+    # - `INVALID_REQUEST` indicating the API request was malformed.
+    # - `OVER_DAILY_LIMIT` indicating any of the following:
+    #   - The API key is missing or invalid.
+    #   - Billing has not been enabled on your account.
+    #   - A self-imposed usage cap has been exceeded.
+    #   - The provided method of payment is no longer valid (for example, a
+    # credit card has expired).
+    # - `OVER_QUERY_LIMIT` indicating the requestor has exceeded quota.
+    # - `REQUEST_DENIED` indicating the API did not complete the request.
+    # - `UNKNOWN_ERROR` indicating an unknown error.
+    # @return [ElevationStatus]
+    attr_accessor :status
+
+    # Status codes returned by service.
+    # - `OK` indicating the API request was successful.
+    # - `DATA_NOT_AVAILABLE` indicating that there's no available data for the
+    # input locations. 
+    # - `INVALID_REQUEST` indicating the API request was malformed.
+    # - `OVER_DAILY_LIMIT` indicating any of the following:
+    #   - The API key is missing or invalid.
+    #   - Billing has not been enabled on your account.
+    #   - A self-imposed usage cap has been exceeded.
+    #   - The provided method of payment is no longer valid (for example, a
+    # credit card has expired).
+    # - `OVER_QUERY_LIMIT` indicating the requestor has exceeded quota.
+    # - `REQUEST_DENIED` indicating the API did not complete the request.
+    # - `UNKNOWN_ERROR` indicating an unknown error.
+    # @return [Array[ElevationResult]]
+    attr_accessor :results
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_message'] = 'error_message'
+      @_hash['status'] = 'status'
+      @_hash['results'] = 'results'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status:, results:, error_message: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @error_message = error_message unless error_message == SKIP
+      @status = status
+      @results = results
+      @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.
+      status = hash.key?('status') ? hash['status'] : nil
+      # Parameter is an array, so we need to iterate through it
+      results = nil
+      unless hash['results'].nil?
+        results = []
+        hash['results'].each do |structure|
+          results << (ElevationResult.from_hash(structure) if structure)
+        end
+      end
+
+      results = nil unless hash.key?('results')
+      error_message = hash.key?('error_message') ? hash['error_message'] : 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.
+      ElevationResponse.new(status: status,
+                            results: results,
+                            error_message: error_message,
+                            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} error_message: #{@error_message}, status: #{@status}, results: #{@results},"\
+      " 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} error_message: #{@error_message.inspect}, status: #{@status.inspect},"\
+      " results: #{@results.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end