nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/browse_search_response.rb

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Browse#search
+    class BrowseSearchResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute items
+      #   The results are presented as a JSON list of candidates in ranked order
+      #   (most-likely to least-likely) based on the matched location criteria.
+      #
+      #   @return [Array<Nextbillionai::Models::BrowseSearchResponse::Item>, nil]
+      optional :items,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::BrowseSearchResponse::Item] }
+
+      # @!method initialize(items: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::BrowseSearchResponse} for more details.
+      #
+      #   @param items [Array<Nextbillionai::Models::BrowseSearchResponse::Item>] The results are presented as a JSON list of candidates in ranked order (most-lik
+
+      class Item < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the result item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute access
+        #   An array returning the location coordinates of all the access points of the
+        #   search result.
+        #
+        #   @return [Nextbillionai::Models::Access, nil]
+        optional :access, -> { Nextbillionai::Access }
+
+        # @!attribute address
+        #   Postal address of the result item.
+        #
+        #   @return [Nextbillionai::Models::Address, nil]
+        optional :address, -> { Nextbillionai::Address }
+
+        # @!attribute categories
+        #   The list of categories assigned to this place.
+        #
+        #   @return [Array<Nextbillionai::Models::Categories>, nil]
+        optional :categories, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Categories] }
+
+        # @!attribute contacts
+        #   Contact information like phone, email or website.
+        #
+        #   @return [Array<Nextbillionai::Models::Contacts>, nil]
+        optional :contacts, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Contacts] }
+
+        # @!attribute distance
+        #   The distance "as the crow flies" from the search center to this result item in
+        #   meters.
+        #
+        #   @return [Integer, nil]
+        optional :distance, Integer
+
+        # @!attribute map_view
+        #   The bounding box enclosing the geometric shape (area or line) that an individual
+        #   result covers. place typed results have no mapView.
+        #
+        #   @return [Nextbillionai::Models::MapView, nil]
+        optional :map_view, -> { Nextbillionai::MapView }, api_name: :mapView
+
+        # @!attribute opening_hours
+        #   Returns the operating hours of the place, if available.
+        #
+        #   @return [Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours, nil]
+        optional :opening_hours,
+                 -> { Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours },
+                 api_name: :openingHours
+
+        # @!attribute position
+        #   Returns the location coordinates of the result.
+        #
+        #   @return [Nextbillionai::Models::Position, nil]
+        optional :position, -> { Nextbillionai::Position }
+
+        # @!attribute scoring
+        #   Score of the result. A higher score indicates a closer match.
+        #
+        #   @return [Nextbillionai::Models::BrowseSearchResponse::Item::Scoring, nil]
+        optional :scoring, -> { Nextbillionai::Models::BrowseSearchResponse::Item::Scoring }
+
+        # @!attribute title
+        #   The localized display name of this result item.
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!method initialize(id: nil, access: nil, address: nil, categories: nil, contacts: nil, distance: nil, map_view: nil, opening_hours: nil, position: nil, scoring: nil, title: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::BrowseSearchResponse::Item} for more details.
+        #
+        #   @param id [String] The unique identifier for the result item.
+        #
+        #   @param access [Nextbillionai::Models::Access] An array returning the location coordinates of all the access points of the sear
+        #
+        #   @param address [Nextbillionai::Models::Address] Postal address of the result item.
+        #
+        #   @param categories [Array<Nextbillionai::Models::Categories>] The list of categories assigned to this place.
+        #
+        #   @param contacts [Array<Nextbillionai::Models::Contacts>] Contact information like phone, email or website.
+        #
+        #   @param distance [Integer] The distance "as the crow flies" from the search center to this result item in m
+        #
+        #   @param map_view [Nextbillionai::Models::MapView] The bounding box enclosing the geometric shape (area or line) that an individual
+        #
+        #   @param opening_hours [Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours] Returns the operating hours of the place, if available.
+        #
+        #   @param position [Nextbillionai::Models::Position] Returns the location coordinates of the result.
+        #
+        #   @param scoring [Nextbillionai::Models::BrowseSearchResponse::Item::Scoring] Score of the result. A higher score indicates a closer match.
+        #
+        #   @param title [String] The localized display name of this result item.
+
+        # @see Nextbillionai::Models::BrowseSearchResponse::Item#opening_hours
+        class OpeningHours < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute time_ranges
+          #   A collection of attributes with details about the opening and closing hours for
+          #   each day of the week.
+          #
+          #   @return [Array<Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours::TimeRange>, nil]
+          optional :time_ranges,
+                   -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours::TimeRange] },
+                   api_name: :timeRanges
+
+          # @!method initialize(time_ranges: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours} for more
+          #   details.
+          #
+          #   Returns the operating hours of the place, if available.
+          #
+          #   @param time_ranges [Array<Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours::TimeRange>] A collection of attributes with details about the opening and closing hours for
+
+          class TimeRange < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute end_time
+            #   Returns the closing time details.
+            #
+            #   @return [Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours::TimeRange::EndTime, nil]
+            optional :end_time,
+                     -> { Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours::TimeRange::EndTime },
+                     api_name: :endTime
+
+            # @!attribute start_time
+            #   Returns the open time details.
+            #
+            #   @return [Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours::TimeRange::StartTime, nil]
+            optional :start_time,
+                     -> { Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours::TimeRange::StartTime },
+                     api_name: :startTime
+
+            # @!method initialize(end_time: nil, start_time: nil)
+            #   @param end_time [Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours::TimeRange::EndTime] Returns the closing time details.
+            #
+            #   @param start_time [Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours::TimeRange::StartTime] Returns the open time details.
+
+            # @see Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours::TimeRange#end_time
+            class EndTime < Nextbillionai::Internal::Type::BaseModel
+              # @!attribute date
+              #   The date to which the subsequent closing time details belong to.
+              #
+              #   @return [String, nil]
+              optional :date, String
+
+              # @!attribute hour
+              #   The hour of the day when the place closes.
+              #
+              #   @return [Integer, nil]
+              optional :hour, Integer
+
+              # @!attribute minute
+              #   The minute of the hour when the place closes.
+              #
+              #   @return [Integer, nil]
+              optional :minute, Integer
+
+              # @!method initialize(date: nil, hour: nil, minute: nil)
+              #   Returns the closing time details.
+              #
+              #   @param date [String] The date to which the subsequent closing time details belong to.
+              #
+              #   @param hour [Integer] The hour of the day when the place closes.
+              #
+              #   @param minute [Integer] The minute of the hour when the place closes.
+            end
+
+            # @see Nextbillionai::Models::BrowseSearchResponse::Item::OpeningHours::TimeRange#start_time
+            class StartTime < Nextbillionai::Internal::Type::BaseModel
+              # @!attribute date
+              #   The date to which the subsequent open time details belong to.
+              #
+              #   @return [String, nil]
+              optional :date, String
+
+              # @!attribute hour
+              #   The hour of the day when the place opens.
+              #
+              #   @return [Integer, nil]
+              optional :hour, Integer
+
+              # @!attribute minute
+              #   The minute of the hour when the place opens.
+              #
+              #   @return [Integer, nil]
+              optional :minute, Integer
+
+              # @!method initialize(date: nil, hour: nil, minute: nil)
+              #   Returns the open time details.
+              #
+              #   @param date [String] The date to which the subsequent open time details belong to.
+              #
+              #   @param hour [Integer] The hour of the day when the place opens.
+              #
+              #   @param minute [Integer] The minute of the hour when the place opens.
+            end
+          end
+        end
+
+        # @see Nextbillionai::Models::BrowseSearchResponse::Item#scoring
+        class Scoring < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute field_score
+          #   A breakdown of how closely individual field of the result matched with the
+          #   provided query q.
+          #
+          #   @return [Object, nil]
+          optional :field_score, Nextbillionai::Internal::Type::Unknown, api_name: :fieldScore
+
+          # @!attribute query_score
+          #   A score, out of 1, indicating how closely the result matches with the provided
+          #   query q .
+          #
+          #   @return [Float, nil]
+          optional :query_score, Float, api_name: :queryScore
+
+          # @!method initialize(field_score: nil, query_score: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::BrowseSearchResponse::Item::Scoring} for more details.
+          #
+          #   Score of the result. A higher score indicates a closer match.
+          #
+          #   @param field_score [Object] A breakdown of how closely individual field of the result matched with the provi
+          #
+          #   @param query_score [Float] A score, out of 1, indicating how closely the result matches with the provided q
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/categories.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    class Categories < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute id
+      #   Identifier number for an associated category.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute name
+      #   Name of the place category in the result item language.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute primary
+      #   Whether or not it is a primary category. This field is visible only when the
+      #   value is 'true'.
+      #
+      #   @return [String, nil]
+      optional :primary, String
+
+      # @!method initialize(id: nil, name: nil, primary: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::Categories} for more details.
+      #
+      #   @param id [String] Identifier number for an associated category.
+      #
+      #   @param name [String] Name of the place category in the result item language.
+      #
+      #   @param primary [String] Whether or not it is a primary category. This field is visible only when the val
+    end
+  end
+end

data/lib/nextbillionai/models/contact_object.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    class ContactObject < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute categories
+      #   The list of place categories this contact refers to.
+      #
+      #   @return [Array<Nextbillionai::Models::ContactObject::Category>, nil]
+      optional :categories,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::ContactObject::Category] }
+
+      # @!attribute label
+      #   Optional label for the contact string, such as "Customer Service" or "Pharmacy
+      #   Fax".
+      #
+      #   @return [String, nil]
+      optional :label, String
+
+      # @!attribute value
+      #   Contact information, as specified by the contact type.
+      #
+      #   @return [String, nil]
+      optional :value, String
+
+      # @!method initialize(categories: nil, label: nil, value: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::ContactObject} for more details.
+      #
+      #   @param categories [Array<Nextbillionai::Models::ContactObject::Category>] The list of place categories this contact refers to.
+      #
+      #   @param label [String] Optional label for the contact string, such as "Customer Service" or "Pharmacy F
+      #
+      #   @param value [String] Contact information, as specified by the contact type.
+
+      class Category < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute id
+        #   Identifier number for an associated category. For example: "900-9300-0000"
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!method initialize(id: nil)
+        #   @param id [String] Identifier number for an associated category. For example: "900-9300-0000"
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/contacts.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    class Contacts < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute email
+      #
+      #   @return [Array<Nextbillionai::Models::ContactObject>, nil]
+      optional :email, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::ContactObject] }
+
+      # @!attribute fax
+      #
+      #   @return [Array<Nextbillionai::Models::ContactObject>, nil]
+      optional :fax, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::ContactObject] }
+
+      # @!attribute mobile
+      #
+      #   @return [Array<Nextbillionai::Models::ContactObject>, nil]
+      optional :mobile, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::ContactObject] }
+
+      # @!attribute phone
+      #
+      #   @return [Array<Nextbillionai::Models::ContactObject>, nil]
+      optional :phone, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::ContactObject] }
+
+      # @!attribute toll_free
+      #
+      #   @return [Array<Nextbillionai::Models::ContactObject>, nil]
+      optional :toll_free,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::ContactObject] },
+               api_name: :tollFree
+
+      # @!attribute www
+      #
+      #   @return [Array<Nextbillionai::Models::ContactObject>, nil]
+      optional :www, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::ContactObject] }
+
+      # @!method initialize(email: nil, fax: nil, mobile: nil, phone: nil, toll_free: nil, www: nil)
+      #   @param email [Array<Nextbillionai::Models::ContactObject>]
+      #   @param fax [Array<Nextbillionai::Models::ContactObject>]
+      #   @param mobile [Array<Nextbillionai::Models::ContactObject>]
+      #   @param phone [Array<Nextbillionai::Models::ContactObject>]
+      #   @param toll_free [Array<Nextbillionai::Models::ContactObject>]
+      #   @param www [Array<Nextbillionai::Models::ContactObject>]
+    end
+  end
+end