google-maps-api-sdk 1.0.0

data/lib/google_maps_platform/models/result.rb

@@ -0,0 +1,96 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # Result Model.
+  class Result < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :elevation
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :resolution
+
+    # An object describing a specific location with Latitude and Longitude in
+    # decimal degrees.
+    # @return [LatLngLiteral]
+    attr_accessor :location
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['elevation'] = 'elevation'
+      @_hash['resolution'] = 'resolution'
+      @_hash['location'] = 'location'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        elevation
+        resolution
+        location
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(elevation: SKIP, resolution: SKIP, location: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @elevation = elevation unless elevation == SKIP
+      @resolution = resolution unless resolution == SKIP
+      @location = location unless location == 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.
+      elevation = hash.key?('elevation') ? hash['elevation'] : SKIP
+      resolution = hash.key?('resolution') ? hash['resolution'] : SKIP
+      location = LatLngLiteral.from_hash(hash['location']) if hash['location']
+
+      # 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.
+      Result.new(elevation: elevation,
+                 resolution: resolution,
+                 location: location,
+                 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} elevation: #{@elevation}, resolution: #{@resolution}, location:"\
+      " #{@location}, 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} elevation: #{@elevation.inspect}, resolution: #{@resolution.inspect},"\
+      " location: #{@location.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/result_type.rb

@@ -0,0 +1,112 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # result_type.
+  class ResultType
+    RESULT_TYPE = [
+      # TODO: Write general description for ADMINISTRATIVE_AREA_LEVEL_1
+      ADMINISTRATIVE_AREA_LEVEL_1 = 'administrative_area_level_1'.freeze,
+
+      # TODO: Write general description for ADMINISTRATIVE_AREA_LEVEL_2
+      ADMINISTRATIVE_AREA_LEVEL_2 = 'administrative_area_level_2'.freeze,
+
+      # TODO: Write general description for ADMINISTRATIVE_AREA_LEVEL_3
+      ADMINISTRATIVE_AREA_LEVEL_3 = 'administrative_area_level_3'.freeze,
+
+      # TODO: Write general description for ADMINISTRATIVE_AREA_LEVEL_4
+      ADMINISTRATIVE_AREA_LEVEL_4 = 'administrative_area_level_4'.freeze,
+
+      # TODO: Write general description for ADMINISTRATIVE_AREA_LEVEL_5
+      ADMINISTRATIVE_AREA_LEVEL_5 = 'administrative_area_level_5'.freeze,
+
+      # TODO: Write general description for AIRPORT
+      AIRPORT = 'airport'.freeze,
+
+      # TODO: Write general description for COLLOQUIAL_AREA
+      COLLOQUIAL_AREA = 'colloquial_area'.freeze,
+
+      # TODO: Write general description for COUNTRY
+      COUNTRY = 'country'.freeze,
+
+      # TODO: Write general description for INTERSECTION
+      INTERSECTION = 'intersection'.freeze,
+
+      # TODO: Write general description for LOCALITY
+      LOCALITY = 'locality'.freeze,
+
+      # TODO: Write general description for NATURAL_FEATURE
+      NATURAL_FEATURE = 'natural_feature'.freeze,
+
+      # TODO: Write general description for NEIGHBORHOOD
+      NEIGHBORHOOD = 'neighborhood'.freeze,
+
+      # TODO: Write general description for PARK
+      PARK = 'park'.freeze,
+
+      # TODO: Write general description for PLUS_CODE
+      PLUS_CODE = 'plus_code'.freeze,
+
+      # TODO: Write general description for POLITICAL
+      POLITICAL = 'political'.freeze,
+
+      # TODO: Write general description for POSTAL_CODE
+      POSTAL_CODE = 'postal_code'.freeze,
+
+      # TODO: Write general description for PREMISE
+      PREMISE = 'premise'.freeze,
+
+      # TODO: Write general description for ROUTE
+      ROUTE = 'route'.freeze,
+
+      # TODO: Write general description for STREET_ADDRESS
+      STREET_ADDRESS = 'street_address'.freeze,
+
+      # TODO: Write general description for SUBLOCALITY
+      SUBLOCALITY = 'sublocality'.freeze,
+
+      # TODO: Write general description for SUBPREMISE
+      SUBPREMISE = 'subpremise'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RESULT_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ADMINISTRATIVE_AREA_LEVEL_1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'administrative_area_level_1' then ADMINISTRATIVE_AREA_LEVEL_1
+      when 'administrative_area_level_2' then ADMINISTRATIVE_AREA_LEVEL_2
+      when 'administrative_area_level_3' then ADMINISTRATIVE_AREA_LEVEL_3
+      when 'administrative_area_level_4' then ADMINISTRATIVE_AREA_LEVEL_4
+      when 'administrative_area_level_5' then ADMINISTRATIVE_AREA_LEVEL_5
+      when 'airport' then AIRPORT
+      when 'colloquial_area' then COLLOQUIAL_AREA
+      when 'country' then COUNTRY
+      when 'intersection' then INTERSECTION
+      when 'locality' then LOCALITY
+      when 'natural_feature' then NATURAL_FEATURE
+      when 'neighborhood' then NEIGHBORHOOD
+      when 'park' then PARK
+      when 'plus_code' then PLUS_CODE
+      when 'political' then POLITICAL
+      when 'postal_code' then POSTAL_CODE
+      when 'premise' then PREMISE
+      when 'route' then ROUTE
+      when 'street_address' then STREET_ADDRESS
+      when 'sublocality' then SUBLOCALITY
+      when 'subpremise' then SUBPREMISE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/google_maps_platform/models/snap_to_roads_response.rb

@@ -0,0 +1,96 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # SnapToRoadsResponse Model.
+  class SnapToRoadsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of snapped points.
+    # @return [Array[SnappedPoint]]
+    attr_accessor :snapped_points
+
+    # A string containing a user-visible warning.
+    # @return [String]
+    attr_accessor :warning_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['snapped_points'] = 'snappedPoints'
+      @_hash['warning_message'] = 'warningMessage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        snapped_points
+        warning_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(snapped_points: SKIP, warning_message: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @snapped_points = snapped_points unless snapped_points == SKIP
+      @warning_message = warning_message unless warning_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.
+      # Parameter is an array, so we need to iterate through it
+      snapped_points = nil
+      unless hash['snappedPoints'].nil?
+        snapped_points = []
+        hash['snappedPoints'].each do |structure|
+          snapped_points << (SnappedPoint.from_hash(structure) if structure)
+        end
+      end
+
+      snapped_points = SKIP unless hash.key?('snappedPoints')
+      warning_message =
+        hash.key?('warningMessage') ? hash['warningMessage'] : 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.
+      SnapToRoadsResponse.new(snapped_points: snapped_points,
+                              warning_message: warning_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} snapped_points: #{@snapped_points}, warning_message: #{@warning_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} snapped_points: #{@snapped_points.inspect}, warning_message:"\
+      " #{@warning_message.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/snapped_point.rb

@@ -0,0 +1,103 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # SnappedPoint Model.
+  class SnappedPoint < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An object describing a specific location with Latitude and Longitude in
+    # decimal degrees.
+    # @return [LatitudeLongitudeLiteral]
+    attr_accessor :location
+
+    # An integer that indicates the corresponding value in the original request.
+    # Each value in the request should map to a snapped value in the response.
+    # However, if you've set interpolate=true or if you're using nearest roads,
+    # then it's possible that the response will contain more coordinates than
+    # the request. Interpolated values will not have an `originalIndex`. These
+    # values are indexed from `0`, so a point with an originalIndex of `4` will
+    # be the snapped value of the 5th latitude/longitude passed to the path
+    # parameter. Nearest Roads points may contain several points for single
+    # coordinates with differing location or placeId.
+    # @return [Float]
+    attr_accessor :original_index
+
+    # A unique identifier for a place. All place IDs returned by the Roads API
+    # correspond to road segments.
+    # @return [String]
+    attr_accessor :place_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['location'] = 'location'
+      @_hash['original_index'] = 'originalIndex'
+      @_hash['place_id'] = 'placeId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        original_index
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(location:, place_id:, original_index: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @location = location
+      @original_index = original_index unless original_index == SKIP
+      @place_id = place_id
+      @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.
+      location = LatitudeLongitudeLiteral.from_hash(hash['location']) if hash['location']
+      place_id = hash.key?('placeId') ? hash['placeId'] : nil
+      original_index = hash.key?('originalIndex') ? hash['originalIndex'] : 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.
+      SnappedPoint.new(location: location,
+                       place_id: place_id,
+                       original_index: original_index,
+                       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} location: #{@location}, original_index: #{@original_index}, place_id:"\
+      " #{@place_id}, 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} location: #{@location.inspect}, original_index: #{@original_index.inspect},"\
+      " place_id: #{@place_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/source.rb

@@ -0,0 +1,36 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # source.
+  class Source
+    SOURCE = [
+      # TODO: Write general description for DEFAULT
+      DEFAULT = 'default'.freeze,
+
+      # TODO: Write general description for OUTDOOR
+      OUTDOOR = 'outdoor'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SOURCE.include?(value)
+    end
+
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'default' then DEFAULT
+      when 'outdoor' then OUTDOOR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/google_maps_platform/models/street_view_response.rb

@@ -0,0 +1,135 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # StreetViewResponse Model.
+  class StreetViewResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains the copyright notices associated with this panorama.
+    # @return [String]
+    attr_accessor :copyright
+
+    # A string indicating year and month that the panorama was captured.
+    # @return [String]
+    attr_accessor :date
+
+    # An object describing a specific location with Latitude and Longitude in
+    # decimal degrees.
+    # @return [LatLngLiteral]
+    attr_accessor :location
+
+    # A specific panorama ID. These are generally stable, though panoramas may
+    # change ID over time as imagery is refreshed.
+    # @return [String]
+    attr_accessor :pano_id
+
+    # The `status` field within the Streetview Metadata response object contains
+    # the status of the request. The `status` field may contain the following
+    # values:
+    # - `OK` indicates that no errors occurred; a panorama is found and metadata
+    # is returned.
+    # - `INVALID_REQUEST` indicates that the request was malformed.
+    # - `NOT_FOUND` indicates that the address string provided in the `location`
+    # parameter could not be found. This may occur if a non-existent address is
+    # given.
+    # - `ZERO_RESULTS` indicates that no panorama could be found near the
+    # provided location. This may occur if a non-existent or invalid `pano` id
+    # is given.
+    # - `OVER_QUERY_LIMIT` indicates the requestor has exceeded quota.
+    # - `REQUEST_DENIED` indicates that your request was denied. This may occur
+    # if you did not
+    # [authorize](https://developers.google.com/maps/documentation/streetview/ge
+    # t-api-key) your request, or if the Street View Static API is not activated
+    # in the Google Cloud Console project containing your API key.
+    # - `UNKNOWN_ERROR` indicates that the request could not be processed due to
+    # a server error. This is often a temporary status. The request may succeed
+    # if you try again
+    # @return [StreetViewStatus]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['copyright'] = 'copyright'
+      @_hash['date'] = 'date'
+      @_hash['location'] = 'location'
+      @_hash['pano_id'] = 'pano_id'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        copyright
+        date
+        location
+        pano_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status:, copyright: SKIP, date: SKIP, location: SKIP,
+                   pano_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @copyright = copyright unless copyright == SKIP
+      @date = date unless date == SKIP
+      @location = location unless location == SKIP
+      @pano_id = pano_id unless pano_id == 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
+      copyright = hash.key?('copyright') ? hash['copyright'] : SKIP
+      date = hash.key?('date') ? hash['date'] : SKIP
+      location = LatLngLiteral.from_hash(hash['location']) if hash['location']
+      pano_id = hash.key?('pano_id') ? hash['pano_id'] : 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.
+      StreetViewResponse.new(status: status,
+                             copyright: copyright,
+                             date: date,
+                             location: location,
+                             pano_id: pano_id,
+                             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} copyright: #{@copyright}, date: #{@date}, location: #{@location}, pano_id:"\
+      " #{@pano_id}, 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} copyright: #{@copyright.inspect}, date: #{@date.inspect}, location:"\
+      " #{@location.inspect}, pano_id: #{@pano_id.inspect}, status: #{@status.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/street_view_status.rb

@@ -0,0 +1,71 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # The `status` field within the Streetview Metadata response object contains
+  # the status of the request. The `status` field may contain the following
+  # values: - `OK` indicates that no errors occurred; a panorama is found and
+  # metadata is returned. - `INVALID_REQUEST` indicates that the request was
+  # malformed. - `NOT_FOUND` indicates that the address string provided in the
+  # `location` parameter could not be found. This may occur if a non-existent
+  # address is given. - `ZERO_RESULTS` indicates that no panorama could be found
+  # near the provided location. This may occur if a non-existent or invalid
+  # `pano` id is given. - `OVER_QUERY_LIMIT` indicates the requestor has
+  # exceeded quota. - `REQUEST_DENIED` indicates that your request was denied.
+  # This may occur if you did not
+  # [authorize](https://developers.google.com/maps/documentation/streetview/get-
+  # api-key) your request, or if the Street View Static API is not activated in
+  # the Google Cloud Console project containing your API key. - `UNKNOWN_ERROR`
+  # indicates that the request could not be processed due to a server error.
+  # This is often a temporary status. The request may succeed if you try again
+  class StreetViewStatus
+    STREET_VIEW_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 NOT_FOUND
+      NOT_FOUND = 'NOT_FOUND'.freeze,
+
+      # TODO: Write general description for ZERO_RESULTS
+      ZERO_RESULTS = 'ZERO_RESULTS'.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?
+
+      STREET_VIEW_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 'not_found' then NOT_FOUND
+      when 'zero_results' then ZERO_RESULTS
+      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