google-maps-api-sdk 1.0.0

data/lib/google_maps_platform/models/place_opening_hours.rb

@@ -0,0 +1,138 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # An object describing the opening hours of a place.
+  class PlaceOpeningHours < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A boolean value indicating if the place is open at the current time.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :open_now
+
+    # An array of opening periods covering seven days, starting from Sunday, in
+    # chronological order.
+    # @return [Array[PlaceOpeningHoursPeriod]]
+    attr_accessor :periods
+
+    # An array of up to seven entries corresponding to the next seven days.
+    # @return [Array[PlaceSpecialDay]]
+    attr_accessor :special_days
+
+    # A type string used to identify the type of secondary hours (for example,
+    # `DRIVE_THROUGH`, `HAPPY_HOUR`, `DELIVERY`, `TAKEOUT`, `KITCHEN`,
+    # `BREAKFAST`, `LUNCH`, `DINNER`, `BRUNCH`, `PICKUP`, `SENIOR_HOURS`). Set
+    # for `secondary_opening_hours` only.
+    # @return [String]
+    attr_accessor :type
+
+    # An array of strings describing in human-readable text the hours of the
+    # place.
+    # @return [Array[String]]
+    attr_accessor :weekday_text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['open_now'] = 'open_now'
+      @_hash['periods'] = 'periods'
+      @_hash['special_days'] = 'special_days'
+      @_hash['type'] = 'type'
+      @_hash['weekday_text'] = 'weekday_text'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        open_now
+        periods
+        special_days
+        type
+        weekday_text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(open_now: SKIP, periods: SKIP, special_days: SKIP,
+                   type: SKIP, weekday_text: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @open_now = open_now unless open_now == SKIP
+      @periods = periods unless periods == SKIP
+      @special_days = special_days unless special_days == SKIP
+      @type = type unless type == SKIP
+      @weekday_text = weekday_text unless weekday_text == 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.
+      open_now = hash.key?('open_now') ? hash['open_now'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      periods = nil
+      unless hash['periods'].nil?
+        periods = []
+        hash['periods'].each do |structure|
+          periods << (PlaceOpeningHoursPeriod.from_hash(structure) if structure)
+        end
+      end
+
+      periods = SKIP unless hash.key?('periods')
+      # Parameter is an array, so we need to iterate through it
+      special_days = nil
+      unless hash['special_days'].nil?
+        special_days = []
+        hash['special_days'].each do |structure|
+          special_days << (PlaceSpecialDay.from_hash(structure) if structure)
+        end
+      end
+
+      special_days = SKIP unless hash.key?('special_days')
+      type = hash.key?('type') ? hash['type'] : SKIP
+      weekday_text = hash.key?('weekday_text') ? hash['weekday_text'] : 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.
+      PlaceOpeningHours.new(open_now: open_now,
+                            periods: periods,
+                            special_days: special_days,
+                            type: type,
+                            weekday_text: weekday_text,
+                            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} open_now: #{@open_now}, periods: #{@periods}, special_days:"\
+      " #{@special_days}, type: #{@type}, weekday_text: #{@weekday_text}, 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} open_now: #{@open_now.inspect}, periods: #{@periods.inspect}, special_days:"\
+      " #{@special_days.inspect}, type: #{@type.inspect}, weekday_text: #{@weekday_text.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/place_opening_hours_period.rb

@@ -0,0 +1,84 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # PlaceOpeningHoursPeriod Model.
+  class PlaceOpeningHoursPeriod < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PlaceOpeningHoursPeriodDetail]
+    attr_accessor :open
+
+    # TODO: Write general description for this method
+    # @return [PlaceOpeningHoursPeriodDetail]
+    attr_accessor :close
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['open'] = 'open'
+      @_hash['close'] = 'close'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        close
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(open:, close: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @open = open
+      @close = close unless close == 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.
+      open = PlaceOpeningHoursPeriodDetail.from_hash(hash['open']) if hash['open']
+      close = PlaceOpeningHoursPeriodDetail.from_hash(hash['close']) if hash['close']
+
+      # 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.
+      PlaceOpeningHoursPeriod.new(open: open,
+                                  close: close,
+                                  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} open: #{@open}, close: #{@close}, 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} open: #{@open.inspect}, close: #{@close.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/place_opening_hours_period_detail.rb

@@ -0,0 +1,108 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # PlaceOpeningHoursPeriodDetail Model.
+  class PlaceOpeningHoursPeriodDetail < 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
+
+    # A number from 0–6, corresponding to the days of the week, starting on
+    # Sunday. For example, 2 means Tuesday.
+    # @return [Float]
+    attr_accessor :day
+
+    # May contain a time of day in 24-hour hhmm format. Values are in the range
+    # 0000–2359. The time will be reported in the place’s time zone.
+    # @return [String]
+    attr_accessor :time
+
+    # True if a given period was truncated due to a seven-day cutoff, where the
+    # period starts before midnight on the date of the request and/or ends at or
+    # after  midnight on the last day. This property indicates that the period
+    # for open or close can extend past this seven-day cutoff.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :truncated
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date'] = 'date'
+      @_hash['day'] = 'day'
+      @_hash['time'] = 'time'
+      @_hash['truncated'] = 'truncated'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        date
+        truncated
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(day:, time:, date: SKIP, truncated: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @date = date unless date == SKIP
+      @day = day
+      @time = time
+      @truncated = truncated unless truncated == 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.
+      day = hash.key?('day') ? hash['day'] : nil
+      time = hash.key?('time') ? hash['time'] : nil
+      date = hash.key?('date') ? hash['date'] : SKIP
+      truncated = hash.key?('truncated') ? hash['truncated'] : 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.
+      PlaceOpeningHoursPeriodDetail.new(day: day,
+                                        time: time,
+                                        date: date,
+                                        truncated: truncated,
+                                        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}, day: #{@day}, time: #{@time}, truncated: #{@truncated},"\
+      " 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}, day: #{@day.inspect}, time: #{@time.inspect},"\
+      " truncated: #{@truncated.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/place_photo.rb

@@ -0,0 +1,109 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # A photo of a Place. The photo can be accesed via the [Place
+  # Photo](https://developers.google.com/places/web-service/photos) API using an
+  # url in the following pattern: ```
+  # https://maps.googleapis.com/maps/api/place/photo?maxwidth=400&photo_referenc
+  # e=photo_reference&key=YOUR_API_KEY ``` See [Place
+  # Photos](https://developers.google.com/places/web-service/photos) for more
+  # information.
+  class PlacePhoto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The height of the photo.
+    # @return [Float]
+    attr_accessor :height
+
+    # The width of the photo.
+    # @return [Float]
+    attr_accessor :width
+
+    # The HTML attributions for the photo.
+    # @return [Array[String]]
+    attr_accessor :html_attributions
+
+    # A string used to identify the photo when you perform a Photo request.
+    # @return [String]
+    attr_accessor :photo_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['height'] = 'height'
+      @_hash['width'] = 'width'
+      @_hash['html_attributions'] = 'html_attributions'
+      @_hash['photo_reference'] = 'photo_reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(height:, width:, html_attributions:, photo_reference:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @height = height
+      @width = width
+      @html_attributions = html_attributions
+      @photo_reference = photo_reference
+      @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.
+      height = hash.key?('height') ? hash['height'] : nil
+      width = hash.key?('width') ? hash['width'] : nil
+      html_attributions =
+        hash.key?('html_attributions') ? hash['html_attributions'] : nil
+      photo_reference =
+        hash.key?('photo_reference') ? hash['photo_reference'] : 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.
+      PlacePhoto.new(height: height,
+                     width: width,
+                     html_attributions: html_attributions,
+                     photo_reference: photo_reference,
+                     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} height: #{@height}, width: #{@width}, html_attributions:"\
+      " #{@html_attributions}, photo_reference: #{@photo_reference}, 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} height: #{@height.inspect}, width: #{@width.inspect}, html_attributions:"\
+      " #{@html_attributions.inspect}, photo_reference: #{@photo_reference.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/google_maps_platform/models/place_review.rb

@@ -0,0 +1,186 @@
+# google_maps_platform
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module GoogleMapsPlatform
+  # A review of the place submitted by a user.
+  class PlaceReview < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the user who submitted the review. Anonymous reviews are
+    # attributed to "A Google user".
+    # @return [String]
+    attr_accessor :author_name
+
+    # The URL to the user's Google Maps Local Guides profile, if available.
+    # @return [String]
+    attr_accessor :author_url
+
+    # The URL to the user's profile photo, if available.
+    # @return [String]
+    attr_accessor :profile_photo_url
+
+    # An IETF language code indicating the language of the returned review.
+    # This field contains the main language tag only, and not the secondary tag
+    # indicating country or region. For example, all the English reviews are
+    # tagged as 'en', and not 'en-AU' or 'en-UK' and so on.
+    # This field is empty if there is only a rating with no review text.
+    # @return [String]
+    attr_accessor :language
+
+    # An IETF language code indicating the original language of the review. If
+    # the review has been translated, then `original_language` != `language`.
+    # This field contains the main language tag only, and not the secondary tag
+    # indicating country or region. For example, all the English reviews are
+    # tagged as 'en', and not 'en-AU' or 'en-UK' and so on.
+    # This field is empty if there is only a rating with no review text.
+    # @return [String]
+    attr_accessor :original_language
+
+    # The user's overall rating for this place. This is a whole number, ranging
+    # from 1 to 5.
+    # @return [Float]
+    attr_accessor :rating
+
+    # The time that the review was submitted in text, relative to the current
+    # time.
+    # @return [String]
+    attr_accessor :relative_time_description
+
+    # The user's review. When reviewing a location with Google Places, text
+    # reviews are considered optional. Therefore, this field may be empty. Note
+    # that this field may include simple HTML markup. For example, the entity
+    # reference `&amp;` may represent an ampersand character.
+    # @return [String]
+    attr_accessor :text
+
+    # The time that the review was submitted, measured in the number of seconds
+    # since since midnight, January 1, 1970 UTC.
+    # @return [Float]
+    attr_accessor :time
+
+    # A boolean value indicating if the review was translated from the original
+    # language it was written in.
+    # If a review has been translated, corresponding to a value of true, Google
+    # recommends that you indicate this to your users. For example, you can add
+    # the following string, “Translated by Google”, to the review.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :translated
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['author_name'] = 'author_name'
+      @_hash['author_url'] = 'author_url'
+      @_hash['profile_photo_url'] = 'profile_photo_url'
+      @_hash['language'] = 'language'
+      @_hash['original_language'] = 'original_language'
+      @_hash['rating'] = 'rating'
+      @_hash['relative_time_description'] = 'relative_time_description'
+      @_hash['text'] = 'text'
+      @_hash['time'] = 'time'
+      @_hash['translated'] = 'translated'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        author_url
+        profile_photo_url
+        language
+        original_language
+        text
+        translated
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(author_name:, rating:, relative_time_description:, time:,
+                   author_url: SKIP, profile_photo_url: SKIP, language: SKIP,
+                   original_language: SKIP, text: SKIP, translated: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @author_name = author_name
+      @author_url = author_url unless author_url == SKIP
+      @profile_photo_url = profile_photo_url unless profile_photo_url == SKIP
+      @language = language unless language == SKIP
+      @original_language = original_language unless original_language == SKIP
+      @rating = rating
+      @relative_time_description = relative_time_description
+      @text = text unless text == SKIP
+      @time = time
+      @translated = translated unless translated == 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.
+      author_name = hash.key?('author_name') ? hash['author_name'] : nil
+      rating = hash.key?('rating') ? hash['rating'] : nil
+      relative_time_description =
+        hash.key?('relative_time_description') ? hash['relative_time_description'] : nil
+      time = hash.key?('time') ? hash['time'] : nil
+      author_url = hash.key?('author_url') ? hash['author_url'] : SKIP
+      profile_photo_url =
+        hash.key?('profile_photo_url') ? hash['profile_photo_url'] : SKIP
+      language = hash.key?('language') ? hash['language'] : SKIP
+      original_language =
+        hash.key?('original_language') ? hash['original_language'] : SKIP
+      text = hash.key?('text') ? hash['text'] : SKIP
+      translated = hash.key?('translated') ? hash['translated'] : 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.
+      PlaceReview.new(author_name: author_name,
+                      rating: rating,
+                      relative_time_description: relative_time_description,
+                      time: time,
+                      author_url: author_url,
+                      profile_photo_url: profile_photo_url,
+                      language: language,
+                      original_language: original_language,
+                      text: text,
+                      translated: translated,
+                      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} author_name: #{@author_name}, author_url: #{@author_url},"\
+      " profile_photo_url: #{@profile_photo_url}, language: #{@language}, original_language:"\
+      " #{@original_language}, rating: #{@rating}, relative_time_description:"\
+      " #{@relative_time_description}, text: #{@text}, time: #{@time}, translated: #{@translated},"\
+      " 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} author_name: #{@author_name.inspect}, author_url: #{@author_url.inspect},"\
+      " profile_photo_url: #{@profile_photo_url.inspect}, language: #{@language.inspect},"\
+      " original_language: #{@original_language.inspect}, rating: #{@rating.inspect},"\
+      " relative_time_description: #{@relative_time_description.inspect}, text: #{@text.inspect},"\
+      " time: #{@time.inspect}, translated: #{@translated.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end