nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/multigeocode/place_retrieve_response.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Multigeocode
+      # @see Nextbillionai::Resources::Multigeocode::Place#retrieve
+      class PlaceRetrieveResponse < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute data_sorce
+        #   It displays the information about the current source and current status of the
+        #   place. Use the “Update Place” method to change these values, as needed.
+        #
+        #   @return [Nextbillionai::Models::Multigeocode::PlaceRetrieveResponse::DataSorce, nil]
+        optional :data_sorce,
+                 -> { Nextbillionai::Models::Multigeocode::PlaceRetrieveResponse::DataSorce },
+                 api_name: :dataSorce
+
+        # @!attribute doc_id
+        #   The unique NextBillion ID for the result item.
+        #
+        #   @return [String, nil]
+        optional :doc_id, String, api_name: :docId
+
+        # @!attribute place
+        #   This parameter represents the place details, including geographical information,
+        #   address and other related information.
+        #
+        #   @return [Array<Nextbillionai::Models::Multigeocode::PlaceItem>, nil]
+        optional :place, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Multigeocode::PlaceItem] }
+
+        # @!attribute score
+        #   It returns the system calculated weighted score of the place. It depends on how
+        #   ‘richly’ the place was defined at the time of creation. In order to modify the
+        #   score, use “Update Place” method and update information for parameters which are
+        #   not set currently. As an alternative, you can directly update the score to a
+        #   custom value.
+        #
+        #   @return [Integer, nil]
+        optional :score, Integer
+
+        # @!method initialize(data_sorce: nil, doc_id: nil, place: nil, score: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Multigeocode::PlaceRetrieveResponse} for more details.
+        #
+        #   @param data_sorce [Nextbillionai::Models::Multigeocode::PlaceRetrieveResponse::DataSorce] It displays the information about the current source and current status of the p
+        #
+        #   @param doc_id [String] The unique NextBillion ID for the result item.
+        #
+        #   @param place [Array<Nextbillionai::Models::Multigeocode::PlaceItem>] This parameter represents the place details, including geographical information,
+        #
+        #   @param score [Integer] It returns the system calculated weighted score of the place. It depends on how
+
+        # @see Nextbillionai::Models::Multigeocode::PlaceRetrieveResponse#data_sorce
+        class DataSorce < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute ref_id
+          #   This parameter represents the unique reference ID associated with the data
+          #   source.
+          #
+          #   @return [String, nil]
+          optional :ref_id, String, api_name: :refId
+
+          # @!attribute source
+          #   This parameter represents the current dataset source of the information returned
+          #   in the result.
+          #
+          #   @return [String, nil]
+          optional :source, String
+
+          # @!attribute status
+          #   This parameter indicates if a place is currently discoverable by search API or
+          #   not.
+          #
+          #   @return [Symbol, Nextbillionai::Models::Multigeocode::PlaceRetrieveResponse::DataSorce::Status, nil]
+          optional :status,
+                   enum: -> { Nextbillionai::Models::Multigeocode::PlaceRetrieveResponse::DataSorce::Status }
+
+          # @!method initialize(ref_id: nil, source: nil, status: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Multigeocode::PlaceRetrieveResponse::DataSorce} for more
+          #   details.
+          #
+          #   It displays the information about the current source and current status of the
+          #   place. Use the “Update Place” method to change these values, as needed.
+          #
+          #   @param ref_id [String] This parameter represents the unique reference ID associated with the data sourc
+          #
+          #   @param source [String] This parameter represents the current dataset source of the information returned
+          #
+          #   @param status [Symbol, Nextbillionai::Models::Multigeocode::PlaceRetrieveResponse::DataSorce::Status] This parameter indicates if a place is currently discoverable by search API or n
+
+          # This parameter indicates if a place is currently discoverable by search API or
+          # not.
+          #
+          # @see Nextbillionai::Models::Multigeocode::PlaceRetrieveResponse::DataSorce#status
+          module Status
+            extend Nextbillionai::Internal::Type::Enum
+
+            ENABLE = :enable
+            DISABLE = :disable
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/multigeocode/place_update_params.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Multigeocode
+      # @see Nextbillionai::Resources::Multigeocode::Place#update
+      class PlaceUpdateParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        # @!attribute key
+        #   A key is a unique identifier that is required to authenticate a request to the
+        #   API.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!attribute data_source
+        #   dataSource values can be updated to enhance or prioritize the search results to
+        #   better suit specific business use cases.
+        #
+        #   @return [Nextbillionai::Models::Multigeocode::PlaceUpdateParams::DataSource, nil]
+        optional :data_source,
+                 -> { Nextbillionai::Multigeocode::PlaceUpdateParams::DataSource },
+                 api_name: :dataSource
+
+        # @!attribute place
+        #   This parameter represents the place details, including geographical information,
+        #   address and other related information.
+        #
+        #   @return [Array<Nextbillionai::Models::Multigeocode::PlaceItem>, nil]
+        optional :place, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Multigeocode::PlaceItem] }
+
+        # @!attribute score
+        #   Search score of the place. This is calculated based on how ‘richly’ the place is
+        #   defined. For instance, a place with street name, city, state and country
+        #   attributes set might be ranked lower than a place which has values of house,
+        #   building, street name, city, state and country attributes set. The score
+        #   determines the rank of the place among search results. You can also use this
+        #   field to set a custom score as per its relevance to rank it among the search
+        #   results from multiple data sources.
+        #
+        #   @return [Integer, nil]
+        optional :score, Integer
+
+        # @!method initialize(key:, data_source: nil, place: nil, score: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Multigeocode::PlaceUpdateParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param data_source [Nextbillionai::Models::Multigeocode::PlaceUpdateParams::DataSource] dataSource values can be updated to enhance or prioritize the search results to
+        #
+        #   @param place [Array<Nextbillionai::Models::Multigeocode::PlaceItem>] This parameter represents the place details, including geographical information,
+        #
+        #   @param score [Integer] Search score of the place. This is calculated based on how ‘richly’ the place is
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+        class DataSource < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute ref_id
+          #   This parameter represents the unique reference ID associated with the data
+          #   source.
+          #
+          #   @return [String, nil]
+          optional :ref_id, String, api_name: :refId
+
+          # @!attribute source
+          #   1. Move the place to a new dataset by setting the value to a unique dataset
+          #      name. You can also move the place to an existing dataset by using an existing
+          #      dataset name other than the current one. In both cases, the current
+          #      datasource will be replaced for the specified docID.
+          #
+          #   2. Update the place in an existing dataset by setting the name to the current
+          #      value.
+          #
+          #   @return [String, nil]
+          optional :source, String
+
+          # @!attribute status
+          #   Set this to either enable or disable to allow the place to be retrieved by a
+          #   search API or block it respectively.
+          #
+          #   @return [Symbol, Nextbillionai::Models::Multigeocode::PlaceUpdateParams::DataSource::Status, nil]
+          optional :status, enum: -> { Nextbillionai::Multigeocode::PlaceUpdateParams::DataSource::Status }
+
+          # @!method initialize(ref_id: nil, source: nil, status: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Multigeocode::PlaceUpdateParams::DataSource} for more
+          #   details.
+          #
+          #   dataSource values can be updated to enhance or prioritize the search results to
+          #   better suit specific business use cases.
+          #
+          #   @param ref_id [String] This parameter represents the unique reference ID associated with the data sourc
+          #
+          #   @param source [String] 1. Move the place to a new dataset by setting the value to a unique dataset name
+          #
+          #   @param status [Symbol, Nextbillionai::Models::Multigeocode::PlaceUpdateParams::DataSource::Status] Set this to either enable or disable to allow the place to be retrieved by a sea
+
+          # Set this to either enable or disable to allow the place to be retrieved by a
+          # search API or block it respectively.
+          #
+          # @see Nextbillionai::Models::Multigeocode::PlaceUpdateParams::DataSource#status
+          module Status
+            extend Nextbillionai::Internal::Type::Enum
+
+            ENABLE = :enable
+            DISABLE = :disable
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/multigeocode/place_update_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Multigeocode
+      # @see Nextbillionai::Resources::Multigeocode::Place#update
+      class PlaceUpdateResponse < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute msg
+        #   This could be “Ok” representing success or “not found” representing error in
+        #   processing the request.
+        #
+        #   @return [String, nil]
+        optional :msg, String
+
+        # @!attribute status
+        #   Represents the status of the response.
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!method initialize(msg: nil, status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Multigeocode::PlaceUpdateResponse} for more details.
+        #
+        #   @param msg [String] This could be “Ok” representing success or “not found” representing error in pro
+        #
+        #   @param status [String] Represents the status of the response.
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/multigeocode_search_params.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Multigeocode#search
+    class MultigeocodeSearchParams < Nextbillionai::Internal::Type::BaseModel
+      extend Nextbillionai::Internal::Type::RequestParameters::Converter
+      include Nextbillionai::Internal::Type::RequestParameters
+
+      # @!attribute key
+      #   A key is a unique identifier that is required to authenticate a request to the
+      #   API.
+      #
+      #   @return [String]
+      required :key, String
+
+      # @!attribute at
+      #   Specify the center of the search context expressed as coordinates.
+      #
+      #   @return [Nextbillionai::Models::MultigeocodeSearchParams::At]
+      required :at, -> { Nextbillionai::MultigeocodeSearchParams::At }
+
+      # @!attribute query
+      #   A free-form, complete or incomplete string to be searched. It allows searching
+      #   for places using keywords or names.
+      #
+      #   @return [String]
+      required :query, String
+
+      # @!attribute city
+      #   Specifies the primary city of the place.
+      #
+      #   @return [String, nil]
+      optional :city, String
+
+      # @!attribute country
+      #   Country of the search context provided as comma-separated
+      #   [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country
+      #   codes.
+      #   Note: Country codes should be provided in uppercase.
+      #
+      #   @return [String, nil]
+      optional :country, String
+
+      # @!attribute district
+      #   Specifies the district of the search place.
+      #
+      #   @return [String, nil]
+      optional :district, String
+
+      # @!attribute limit
+      #   Sets the maximum number of results to be returned.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute radius
+      #   Filters the results to places within the specified radius from the 'at'
+      #   location.
+      #
+      #   Note: Supports 'meter' (m) and 'kilometer' (km) units. If no radius is given,
+      #   the search method returns as many results as specified in limit.
+      #
+      #   @return [String, nil]
+      optional :radius, String
+
+      # @!attribute state
+      #   Specifies the state of the search place.
+      #
+      #   @return [String, nil]
+      optional :state, String
+
+      # @!attribute street
+      #   Specifies the street name of the search place.
+      #
+      #   @return [String, nil]
+      optional :street, String
+
+      # @!attribute sub_district
+      #   Specifies the subDistrict of the search place.
+      #
+      #   @return [String, nil]
+      optional :sub_district, String, api_name: :subDistrict
+
+      # @!method initialize(key:, at:, query:, city: nil, country: nil, district: nil, limit: nil, radius: nil, state: nil, street: nil, sub_district: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::MultigeocodeSearchParams} for more details.
+      #
+      #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+      #
+      #   @param at [Nextbillionai::Models::MultigeocodeSearchParams::At] Specify the center of the search context expressed as coordinates.
+      #
+      #   @param query [String] A free-form, complete or incomplete string to be searched. It allows searching f
+      #
+      #   @param city [String] Specifies the primary city of the place.
+      #
+      #   @param country [String] Country of the search context provided as comma-separated [ISO 3166-1 alpha-3](h
+      #
+      #   @param district [String] Specifies the district of the search place.
+      #
+      #   @param limit [Integer] Sets the maximum number of results to be returned.
+      #
+      #   @param radius [String] Filters the results to places within the specified radius from the 'at' location
+      #
+      #   @param state [String] Specifies the state of the search place.
+      #
+      #   @param street [String] Specifies the street name of the search place.
+      #
+      #   @param sub_district [String] Specifies the subDistrict of the search place.
+      #
+      #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+      class At < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute lat
+        #   Latitude coordinate of the location
+        #
+        #   @return [Float]
+        required :lat, Float
+
+        # @!attribute lng
+        #   Longitude coordinate of the location.
+        #
+        #   @return [Float]
+        required :lng, Float
+
+        # @!method initialize(lat:, lng:)
+        #   Specify the center of the search context expressed as coordinates.
+        #
+        #   @param lat [Float] Latitude coordinate of the location
+        #
+        #   @param lng [Float] Longitude coordinate of the location.
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/multigeocode_search_response.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Multigeocode#search
+    class MultigeocodeSearchResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute entities
+      #   An array of objects containing the search result response. Each object
+      #   represents one place returned in the search response. An empty array would be
+      #   returned if no matching place is found.
+      #
+      #   @return [Array<Nextbillionai::Models::MultigeocodeSearchResponse::Entity>, nil]
+      optional :entities,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::MultigeocodeSearchResponse::Entity] }
+
+      # @!method initialize(entities: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::MultigeocodeSearchResponse} for more details.
+      #
+      #   @param entities [Array<Nextbillionai::Models::MultigeocodeSearchResponse::Entity>] An array of objects containing the search result response. Each object represent
+
+      class Entity < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute data_source
+        #   It contains information about the dataset that returns the specific result
+        #
+        #   @return [Nextbillionai::Models::MultigeocodeSearchResponse::Entity::DataSource, nil]
+        optional :data_source,
+                 -> { Nextbillionai::Models::MultigeocodeSearchResponse::Entity::DataSource },
+                 api_name: :dataSource
+
+        # @!attribute doc_id
+        #   The unique NextBillion ID for the result item. This ID can be used as input in
+        #   “Get Place”, “Update Place”, “Delete Place” methods.
+        #
+        #   @return [String, nil]
+        optional :doc_id, String, api_name: :docId
+
+        # @!attribute place
+        #   This parameter represents the place details, including geographical information,
+        #   address and other related information.
+        #
+        #   @return [Array<Nextbillionai::Models::Multigeocode::PlaceItem>, nil]
+        optional :place, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Multigeocode::PlaceItem] }
+
+        # @!attribute score
+        #   Integer value representing how good the result is. Higher score indicates a
+        #   better match between the search query and the result. This can be used to accept
+        #   or reject the results depending on how “relevant” a result is, for a given use
+        #   case
+        #
+        #   @return [Integer, nil]
+        optional :score, Integer
+
+        # @!method initialize(data_source: nil, doc_id: nil, place: nil, score: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::MultigeocodeSearchResponse::Entity} for more details.
+        #
+        #   @param data_source [Nextbillionai::Models::MultigeocodeSearchResponse::Entity::DataSource] It contains information about the dataset that returns the specific result
+        #
+        #   @param doc_id [String] The unique NextBillion ID for the result item. This ID can be used as input in “
+        #
+        #   @param place [Array<Nextbillionai::Models::Multigeocode::PlaceItem>] This parameter represents the place details, including geographical information,
+        #
+        #   @param score [Integer] Integer value representing how good the result is. Higher score indicates a bett
+
+        # @see Nextbillionai::Models::MultigeocodeSearchResponse::Entity#data_source
+        class DataSource < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute ref_id
+          #   This parameter represents the unique reference ID associated with the data
+          #   source.
+          #
+          #   @return [String, nil]
+          optional :ref_id, String, api_name: :refId
+
+          # @!attribute source
+          #   This parameter represents the source of the data.
+          #
+          #   @return [String, nil]
+          optional :source, String
+
+          # @!attribute status
+          #   This parameter indicates if a place is searchable.
+          #
+          #   @return [Symbol, Nextbillionai::Models::MultigeocodeSearchResponse::Entity::DataSource::Status, nil]
+          optional :status,
+                   enum: -> { Nextbillionai::Models::MultigeocodeSearchResponse::Entity::DataSource::Status }
+
+          # @!method initialize(ref_id: nil, source: nil, status: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::MultigeocodeSearchResponse::Entity::DataSource} for more
+          #   details.
+          #
+          #   It contains information about the dataset that returns the specific result
+          #
+          #   @param ref_id [String] This parameter represents the unique reference ID associated with the data sourc
+          #
+          #   @param source [String] This parameter represents the source of the data.
+          #
+          #   @param status [Symbol, Nextbillionai::Models::MultigeocodeSearchResponse::Entity::DataSource::Status] This parameter indicates if a place is searchable.
+
+          # This parameter indicates if a place is searchable.
+          #
+          # @see Nextbillionai::Models::MultigeocodeSearchResponse::Entity::DataSource#status
+          module Status
+            extend Nextbillionai::Internal::Type::Enum
+
+            ENABLE = :enable
+            DISABLE = :disable
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end