google-maps-api-sdk 1.0.0

data/lib/google_maps_platform/models/place_special_day.rb

@@ -0,0 +1,93 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # PlaceSpecialDay Model.
+  class PlaceSpecialDay < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A date expressed in RFC3339 format in the local timezone for the place,
+    # for example 2010-12-31.
+    # @return [String]
+    attr_accessor :date
+
+    # True if there are exceptional hours for this day. If `true`, this means
+    # that there is at least one exception for this day. Exceptions cause
+    # different values to occur in the subfields of `current_opening_hours` and
+    # `secondary_opening_hours` such as `periods`, `weekday_text`, `open_now`.
+    # The exceptions apply to the hours, and the hours are used to generate the
+    # other fields.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exceptional_hours
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date'] = 'date'
+      @_hash['exceptional_hours'] = 'exceptional_hours'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        date
+        exceptional_hours
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(date: SKIP, exceptional_hours: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @date = date unless date == SKIP
+      @exceptional_hours = exceptional_hours unless exceptional_hours == 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.
+      date = hash.key?('date') ? hash['date'] : SKIP
+      exceptional_hours =
+        hash.key?('exceptional_hours') ? hash['exceptional_hours'] : 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.
+      PlaceSpecialDay.new(date: date,
+                          exceptional_hours: exceptional_hours,
+                          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} date: #{@date}, exceptional_hours: #{@exceptional_hours},"\
+      " 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} date: #{@date.inspect}, exceptional_hours: #{@exceptional_hours.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/places_autocomplete_response.rb

@@ -0,0 +1,141 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # PlacesAutocompleteResponse Model.
+  class PlacesAutocompleteResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains an array of predictions.
+    # @return [Array[PlaceAutocompletePrediction]]
+    attr_accessor :predictions
+
+    # Status codes returned by service.
+    # - `OK` indicating the API request was successful.
+    # - `ZERO_RESULTS` indicating that the search was successful but returned no
+    # results. This may occur if the search was passed a bounds in a remote
+    # location.
+    # - `INVALID_REQUEST` indicating the API request was malformed, generally
+    # due to the missing `input` parameter.
+    # - `OVER_QUERY_LIMIT` indicating any of the following:
+    #   - You have exceeded the QPS limits.
+    #   - Billing has not been enabled on your account.
+    #   - The monthly $200 credit, or a self-imposed usage cap, has been
+    # exceeded.
+    #   - The provided method of payment is no longer valid (for example, a
+    # credit card has expired).
+    #   See the [Maps
+    # FAQ](https://developers.google.com/maps/faq#over-limit-key-error) for more
+    # information about how to resolve this error.
+    # - `REQUEST_DENIED` indicating that your request was denied, generally
+    # because:
+    #   - The request is missing an API key.
+    #   - The `key` parameter is invalid.
+    # - `UNKNOWN_ERROR` indicating an unknown error.
+    # @return [PlacesAutocompleteStatus]
+    attr_accessor :status
+
+    # 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
+
+    # When the service returns additional information about the request
+    # specification, there may be an additional `info_messages` field within the
+    # response object. This field is only returned for successful requests. It
+    # may not always be returned, and its content is subject to change.
+    # @return [Array[String]]
+    attr_accessor :info_messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['predictions'] = 'predictions'
+      @_hash['status'] = 'status'
+      @_hash['error_message'] = 'error_message'
+      @_hash['info_messages'] = 'info_messages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error_message
+        info_messages
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(predictions:, status:, error_message: SKIP,
+                   info_messages: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @predictions = predictions
+      @status = status
+      @error_message = error_message unless error_message == SKIP
+      @info_messages = info_messages unless info_messages == 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
+      predictions = nil
+      unless hash['predictions'].nil?
+        predictions = []
+        hash['predictions'].each do |structure|
+          predictions << (PlaceAutocompletePrediction.from_hash(structure) if structure)
+        end
+      end
+
+      predictions = nil unless hash.key?('predictions')
+      status = hash.key?('status') ? hash['status'] : nil
+      error_message = hash.key?('error_message') ? hash['error_message'] : SKIP
+      info_messages = hash.key?('info_messages') ? hash['info_messages'] : 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.
+      PlacesAutocompleteResponse.new(predictions: predictions,
+                                     status: status,
+                                     error_message: error_message,
+                                     info_messages: info_messages,
+                                     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} predictions: #{@predictions}, status: #{@status}, error_message:"\
+      " #{@error_message}, info_messages: #{@info_messages}, 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} predictions: #{@predictions.inspect}, status: #{@status.inspect},"\
+      " error_message: #{@error_message.inspect}, info_messages: #{@info_messages.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/places_autocomplete_status.rb

@@ -0,0 +1,66 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # Status codes returned by service. - `OK` indicating the API request was
+  # successful. - `ZERO_RESULTS` indicating that the search was successful but
+  # returned no results. This may occur if the search was passed a bounds in a
+  # remote location. - `INVALID_REQUEST` indicating the API request was
+  # malformed, generally due to the missing `input` parameter. -
+  # `OVER_QUERY_LIMIT` indicating any of the following:   - You have exceeded
+  # the QPS limits.   - Billing has not been enabled on your account.   - The
+  # monthly $200 credit, or a self-imposed usage cap, has been exceeded.   - The
+  # provided method of payment is no longer valid (for example, a credit card
+  # has expired).   See the [Maps
+  # FAQ](https://developers.google.com/maps/faq#over-limit-key-error) for more
+  # information about how to resolve this error. - `REQUEST_DENIED` indicating
+  # that your request was denied, generally because:   - The request is missing
+  # an API key.   - The `key` parameter is invalid. - `UNKNOWN_ERROR` indicating
+  # an unknown error.
+  class PlacesAutocompleteStatus
+    PLACES_AUTOCOMPLETE_STATUS = [
+      # TODO: Write general description for OK
+      OK = 'OK'.freeze,
+
+      # TODO: Write general description for ZERO_RESULTS
+      ZERO_RESULTS = 'ZERO_RESULTS'.freeze,
+
+      # TODO: Write general description for INVALID_REQUEST
+      INVALID_REQUEST = 'INVALID_REQUEST'.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?
+
+      PLACES_AUTOCOMPLETE_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 'zero_results' then ZERO_RESULTS
+      when 'invalid_request' then INVALID_REQUEST
+      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/places_details_response.rb

@@ -0,0 +1,131 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # PlacesDetailsResponse Model.
+  class PlacesDetailsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # May contain a set of attributions about this listing which must be
+    # displayed to the user (some listings may not have attribution).
+    # @return [Array[String]]
+    attr_accessor :html_attributions
+
+    # Attributes describing a place. Not all attributes will be available for
+    # all place types.
+    # @return [Place]
+    attr_accessor :result
+
+    # Status codes returned by service.
+    # - `OK` indicating the API request was successful.
+    # - `ZERO_RESULTS` indicating that the referenced location, `place_id`, was
+    # valid but no longer refers to a valid result. This may occur if the
+    # establishment is no longer in business. 
+    # - `NOT_FOUND` indicating that that the referenced location, `place_id`,
+    # was not found in the Places database. 
+    # - `INVALID_REQUEST` indicating the API request was malformed.
+    # - `OVER_QUERY_LIMIT` indicating any of the following:
+    #   - You have exceeded the QPS limits.
+    #   - Billing has not been enabled on your account.
+    #   - The monthly $200 credit, or a self-imposed usage cap, has been
+    # exceeded.
+    #   - The provided method of payment is no longer valid (for example, a
+    # credit card has expired).
+    #   See the [Maps
+    # FAQ](https://developers.google.com/maps/faq#over-limit-key-error) for more
+    # information about how to resolve this error.
+    # - `REQUEST_DENIED` indicating that your request was denied, generally
+    # because:
+    #   - The request is missing an API key.
+    #   - The `key` parameter is invalid.
+    # - `UNKNOWN_ERROR` indicating an unknown error.
+    # @return [PlacesDetailsStatus]
+    attr_accessor :status
+
+    # When the service returns additional information about the request
+    # specification, there may be an additional `info_messages` field within the
+    # response object. This field is only returned for successful requests. It
+    # may not always be returned, and its content is subject to change.
+    # @return [Array[String]]
+    attr_accessor :info_messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['html_attributions'] = 'html_attributions'
+      @_hash['result'] = 'result'
+      @_hash['status'] = 'status'
+      @_hash['info_messages'] = 'info_messages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        info_messages
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(html_attributions:, result:, status:, info_messages: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @html_attributions = html_attributions
+      @result = result
+      @status = status
+      @info_messages = info_messages unless info_messages == 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.
+      html_attributions =
+        hash.key?('html_attributions') ? hash['html_attributions'] : nil
+      result = Place.from_hash(hash['result']) if hash['result']
+      status = hash.key?('status') ? hash['status'] : nil
+      info_messages = hash.key?('info_messages') ? hash['info_messages'] : 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.
+      PlacesDetailsResponse.new(html_attributions: html_attributions,
+                                result: result,
+                                status: status,
+                                info_messages: info_messages,
+                                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} html_attributions: #{@html_attributions}, result: #{@result}, status:"\
+      " #{@status}, info_messages: #{@info_messages}, 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} html_attributions: #{@html_attributions.inspect}, result:"\
+      " #{@result.inspect}, status: #{@status.inspect}, info_messages: #{@info_messages.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/places_details_status.rb

@@ -0,0 +1,71 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # Status codes returned by service. - `OK` indicating the API request was
+  # successful. - `ZERO_RESULTS` indicating that the referenced location,
+  # `place_id`, was valid but no longer refers to a valid result. This may occur
+  # if the establishment is no longer in business.  - `NOT_FOUND` indicating
+  # that that the referenced location, `place_id`, was not found in the Places
+  # database.  - `INVALID_REQUEST` indicating the API request was malformed. -
+  # `OVER_QUERY_LIMIT` indicating any of the following:   - You have exceeded
+  # the QPS limits.   - Billing has not been enabled on your account.   - The
+  # monthly $200 credit, or a self-imposed usage cap, has been exceeded.   - The
+  # provided method of payment is no longer valid (for example, a credit card
+  # has expired).   See the [Maps
+  # FAQ](https://developers.google.com/maps/faq#over-limit-key-error) for more
+  # information about how to resolve this error. - `REQUEST_DENIED` indicating
+  # that your request was denied, generally because:   - The request is missing
+  # an API key.   - The `key` parameter is invalid. - `UNKNOWN_ERROR` indicating
+  # an unknown error.
+  class PlacesDetailsStatus
+    PLACES_DETAILS_STATUS = [
+      # TODO: Write general description for OK
+      OK = 'OK'.freeze,
+
+      # TODO: Write general description for ZERO_RESULTS
+      ZERO_RESULTS = 'ZERO_RESULTS'.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 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?
+
+      PLACES_DETAILS_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 'zero_results' then ZERO_RESULTS
+      when 'invalid_request' then INVALID_REQUEST
+      when 'not_found' then NOT_FOUND
+      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/places_find_place_from_text_response.rb

@@ -0,0 +1,145 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # PlacesFindPlaceFromTextResponse Model.
+  class PlacesFindPlaceFromTextResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains an array of Place candidates.
+    # <div class="caution">Place Search requests return a subset of the fields
+    # that are returned by Place Details requests. If the field you want is not
+    # returned by Place Search, you can use Place Search to get a place_id, then
+    # use that Place ID to make a Place Details request.</div>
+    # @return [Array[Place]]
+    attr_accessor :candidates
+
+    # Status codes returned by service.
+    # - `OK` indicating the API request was successful.
+    # - `ZERO_RESULTS` indicating that the search was successful but returned no
+    # results. This may occur if the search was passed a `latlng` in a remote
+    # location.
+    # - `INVALID_REQUEST` indicating the API request was malformed, generally
+    # due to missing required query parameter (`location` or `radius`).
+    # - `OVER_QUERY_LIMIT` indicating any of the following:
+    #   - You have exceeded the QPS limits.
+    #   - Billing has not been enabled on your account.
+    #   - The monthly $200 credit, or a self-imposed usage cap, has been
+    # exceeded.
+    #   - The provided method of payment is no longer valid (for example, a
+    # credit card has expired).
+    #   See the [Maps
+    # FAQ](https://developers.google.com/maps/faq#over-limit-key-error) for more
+    # information about how to resolve this error.
+    # - `REQUEST_DENIED` indicating that your request was denied, generally
+    # because:
+    #   - The request is missing an API key.
+    #   - The `key` parameter is invalid.
+    # - `UNKNOWN_ERROR` indicating an unknown error.
+    # @return [PlacesSearchStatus]
+    attr_accessor :status
+
+    # 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
+
+    # When the service returns additional information about the request
+    # specification, there may be an additional `info_messages` field within the
+    # response object. This field is only returned for successful requests. It
+    # may not always be returned, and its content is subject to change.
+    # @return [Array[String]]
+    attr_accessor :info_messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['candidates'] = 'candidates'
+      @_hash['status'] = 'status'
+      @_hash['error_message'] = 'error_message'
+      @_hash['info_messages'] = 'info_messages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error_message
+        info_messages
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(candidates:, status:, error_message: SKIP,
+                   info_messages: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @candidates = candidates
+      @status = status
+      @error_message = error_message unless error_message == SKIP
+      @info_messages = info_messages unless info_messages == 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
+      candidates = nil
+      unless hash['candidates'].nil?
+        candidates = []
+        hash['candidates'].each do |structure|
+          candidates << (Place.from_hash(structure) if structure)
+        end
+      end
+
+      candidates = nil unless hash.key?('candidates')
+      status = hash.key?('status') ? hash['status'] : nil
+      error_message = hash.key?('error_message') ? hash['error_message'] : SKIP
+      info_messages = hash.key?('info_messages') ? hash['info_messages'] : 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.
+      PlacesFindPlaceFromTextResponse.new(candidates: candidates,
+                                          status: status,
+                                          error_message: error_message,
+                                          info_messages: info_messages,
+                                          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} candidates: #{@candidates}, status: #{@status}, error_message:"\
+      " #{@error_message}, info_messages: #{@info_messages}, 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} candidates: #{@candidates.inspect}, status: #{@status.inspect},"\
+      " error_message: #{@error_message.inspect}, info_messages: #{@info_messages.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end