nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/mdm_get_distance_matrix_status_response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Mdm#get_distance_matrix_status
+    class MdmGetDistanceMatrixStatusResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute code
+      #   A code representing the status of the request.
+      #
+      #   @return [Symbol, Nextbillionai::Models::MdmGetDistanceMatrixStatusResponse::Code, nil]
+      optional :code, enum: -> { Nextbillionai::Models::MdmGetDistanceMatrixStatusResponse::Code }
+
+      # @!attribute output_addr
+      #   Returns the GCS result of a successful task. Please note that this is an
+      #   internal field.
+      #
+      #   _internal field, the gcs result of specific task if task is success._
+      #
+      #   @return [String, nil]
+      optional :output_addr, String
+
+      # @!attribute result_link
+      #   Returns the link for the result file (csv format) once the task is completed
+      #   successfully.
+      #
+      #   @return [String, nil]
+      optional :result_link, String
+
+      # @!attribute status
+      #   Returns the status detail of the result. Indicative error messages/codes are
+      #   returned in case of errors. See the [API Error Codes](#api-error-codes) section
+      #   below for more information.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!method initialize(code: nil, output_addr: nil, result_link: nil, status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::MdmGetDistanceMatrixStatusResponse} for more details.
+      #
+      #   @param code [Symbol, Nextbillionai::Models::MdmGetDistanceMatrixStatusResponse::Code] A code representing the status of the request.
+      #
+      #   @param output_addr [String] Returns the GCS result of a successful task. Please note that this is an interna
+      #
+      #   @param result_link [String] Returns the link for the result file (csv format) once the task is completed suc
+      #
+      #   @param status [String] Returns the status detail of the result. Indicative error messages/codes are ret
+
+      # A code representing the status of the request.
+      #
+      # @see Nextbillionai::Models::MdmGetDistanceMatrixStatusResponse#code
+      module Code
+        extend Nextbillionai::Internal::Type::Enum
+
+        OK = :Ok
+        PROCESSING = :Processing
+        FAILED = :Failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,276 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Multigeocode
+      # @see Nextbillionai::Resources::Multigeocode::Place#create
+      class PlaceCreateParams < 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 place
+        #   This parameter represents the place details, including geographical information,
+        #   address and other related information.
+        #
+        #   @return [Array<Nextbillionai::Models::Multigeocode::PlaceCreateParams::Place>]
+        required :place,
+                 -> {
+                   Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Multigeocode::PlaceCreateParams::Place]
+                 }
+
+        # @!attribute data_source
+        #   It contains information about the dataset that returns the specific result
+        #
+        #   @return [Nextbillionai::Models::Multigeocode::PlaceCreateParams::DataSource, nil]
+        optional :data_source,
+                 -> { Nextbillionai::Multigeocode::PlaceCreateParams::DataSource },
+                 api_name: :dataSource
+
+        # @!attribute force
+        #   When 2 places are located within 100 meters of each other and have more than 90%
+        #   of matching attributes (at least 11 out of 12 attributes in the “place” object),
+        #   they will be considered duplicates and any requests to add such a new place
+        #   would be rejected. Set force=true to override this duplicate check. You can use
+        #   this to create closely located POIs. For instance, places inside a mall,
+        #   university or a government building etc.
+        #
+        #   @return [Boolean, nil]
+        optional :force, Nextbillionai::Internal::Type::Boolean
+
+        # @!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:, place:, data_source: nil, force: nil, score: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Multigeocode::PlaceCreateParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param place [Array<Nextbillionai::Models::Multigeocode::PlaceCreateParams::Place>] This parameter represents the place details, including geographical information,
+        #
+        #   @param data_source [Nextbillionai::Models::Multigeocode::PlaceCreateParams::DataSource] It contains information about the dataset that returns the specific result
+        #
+        #   @param force [Boolean] When 2 places are located within 100 meters of each other and have more than 90%
+        #
+        #   @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 Place < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute geopoint
+          #   This parameter represents the geographical coordinates of the place. It includes
+          #   the latitude and longitude values.
+          #
+          #   @return [Nextbillionai::Models::Multigeocode::PlaceCreateParams::Place::Geopoint]
+          required :geopoint, -> { Nextbillionai::Multigeocode::PlaceCreateParams::Place::Geopoint }
+
+          # @!attribute address
+          #   This parameter represents the complete address of the place, including the
+          #   street, city, state, postal code and country.
+          #
+          #   @return [String, nil]
+          optional :address, String
+
+          # @!attribute building
+          #   This parameter represents additional building information if applicable.
+          #
+          #   @return [String, nil]
+          optional :building, String
+
+          # @!attribute city
+          #   This parameter represents the city or town 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
+          #   This parameter represents the district of the place.
+          #
+          #   @return [String, nil]
+          optional :district, String
+
+          # @!attribute house
+          #   This parameter represents the house or building number of the place.
+          #
+          #   @return [String, nil]
+          optional :house, String
+
+          # @!attribute poi
+          #   This parameter represents a point of interest within the place. A Point of
+          #   Interest (POI) refers to a specific location or area that is of interest to
+          #   individuals for various reasons. It could be a landmark, tourist attraction,
+          #   business, or any other location that people might find important or intriguing.
+          #
+          #   @return [Nextbillionai::Models::Multigeocode::PlaceCreateParams::Place::Poi, nil]
+          optional :poi, -> { Nextbillionai::Multigeocode::PlaceCreateParams::Place::Poi }
+
+          # @!attribute postal_code
+          #   This parameter represents the postal code or ZIP code of the place.
+          #
+          #   @return [String, nil]
+          optional :postal_code, String, api_name: :postalCode
+
+          # @!attribute state
+          #   This parameter represents the state or region of the place.
+          #
+          #   @return [String, nil]
+          optional :state, String
+
+          # @!attribute street
+          #   This parameter represents the street name of the place.
+          #
+          #   @return [String, nil]
+          optional :street, String
+
+          # @!attribute sub_district
+          #   This parameter represents the sub-district or locality of the place.
+          #
+          #   @return [String, nil]
+          optional :sub_district, String, api_name: :subDistrict
+
+          # @!method initialize(geopoint:, address: nil, building: nil, city: nil, country: nil, district: nil, house: nil, poi: nil, postal_code: nil, state: nil, street: nil, sub_district: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Multigeocode::PlaceCreateParams::Place} for more
+          #   details.
+          #
+          #   @param geopoint [Nextbillionai::Models::Multigeocode::PlaceCreateParams::Place::Geopoint] This parameter represents the geographical coordinates of the place. It includes
+          #
+          #   @param address [String] This parameter represents the complete address of the place, including the stree
+          #
+          #   @param building [String] This parameter represents additional building information if applicable.
+          #
+          #   @param city [String] This parameter represents the city or town of the place.
+          #
+          #   @param country [String] Country of the search context provided as comma-separated [ISO 3166-1 alpha-3](h
+          #
+          #   @param district [String] This parameter represents the district of the place.
+          #
+          #   @param house [String] This parameter represents the house or building number of the place.
+          #
+          #   @param poi [Nextbillionai::Models::Multigeocode::PlaceCreateParams::Place::Poi] This parameter represents a point of interest within the place. A Point of Inter
+          #
+          #   @param postal_code [String] This parameter represents the postal code or ZIP code of the place.
+          #
+          #   @param state [String] This parameter represents the state or region of the place.
+          #
+          #   @param street [String] This parameter represents the street name of the place.
+          #
+          #   @param sub_district [String] This parameter represents the sub-district or locality of the place.
+
+          # @see Nextbillionai::Models::Multigeocode::PlaceCreateParams::Place#geopoint
+          class Geopoint < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute lat
+            #   This parameter represents the latitude value of the place.
+            #
+            #   @return [Float, nil]
+            optional :lat, Float
+
+            # @!attribute lng
+            #   This parameter represents the longitude value of the place.
+            #
+            #   @return [Float, nil]
+            optional :lng, Float
+
+            # @!method initialize(lat: nil, lng: nil)
+            #   This parameter represents the geographical coordinates of the place. It includes
+            #   the latitude and longitude values.
+            #
+            #   @param lat [Float] This parameter represents the latitude value of the place.
+            #
+            #   @param lng [Float] This parameter represents the longitude value of the place.
+          end
+
+          # @see Nextbillionai::Models::Multigeocode::PlaceCreateParams::Place#poi
+          class Poi < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute title
+            #   A title that describes the point of interest.
+            #
+            #   @return [String, nil]
+            optional :title, String
+
+            # @!method initialize(title: nil)
+            #   This parameter represents a point of interest within the place. A Point of
+            #   Interest (POI) refers to a specific location or area that is of interest to
+            #   individuals for various reasons. It could be a landmark, tourist attraction,
+            #   business, or any other location that people might find important or intriguing.
+            #
+            #   @param title [String] A title that describes the point of interest.
+          end
+        end
+
+        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::Multigeocode::PlaceCreateParams::DataSource::Status, nil]
+          optional :status, enum: -> { Nextbillionai::Multigeocode::PlaceCreateParams::DataSource::Status }
+
+          # @!method initialize(ref_id: nil, source: nil, status: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Multigeocode::PlaceCreateParams::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::Multigeocode::PlaceCreateParams::DataSource::Status] This parameter indicates if a place is searchable.
+
+          # This parameter indicates if a place is searchable.
+          #
+          # @see Nextbillionai::Models::Multigeocode::PlaceCreateParams::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_create_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Multigeocode
+      # @see Nextbillionai::Resources::Multigeocode::Place#create
+      class PlaceCreateResponse < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute doc_id
+        #   A unique NextBillion DocID will be created for the POI. Use this ID to search
+        #   this place through the “Get Place” method, to update attributes or ‘status’
+        #   through the “Update Place” method or delete it using the “Delete Place” method.
+        #
+        #   @return [String, nil]
+        optional :doc_id, String, api_name: :docId
+
+        # @!method initialize(doc_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Multigeocode::PlaceCreateResponse} for more details.
+        #
+        #   @param doc_id [String] A unique NextBillion DocID will be created for the POI. Use this ID to search t
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Multigeocode
+      # @see Nextbillionai::Resources::Multigeocode::Place#delete
+      class PlaceDeleteParams < 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
+
+        # @!method initialize(key:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Multigeocode::PlaceDeleteParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Multigeocode
+      # @see Nextbillionai::Resources::Multigeocode::Place#delete
+      class PlaceDeleteResponse < 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::PlaceDeleteResponse} 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/place_item.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Multigeocode
+      class PlaceItem < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute address
+        #   This parameter represents the complete address of the place, including the
+        #   street, city, state, postal code and country.
+        #
+        #   @return [String, nil]
+        optional :address, String
+
+        # @!attribute building
+        #   This parameter represents additional building information if applicable.
+        #
+        #   @return [String, nil]
+        optional :building, String
+
+        # @!attribute city
+        #   This parameter represents the city or town of the place.
+        #
+        #   @return [String, nil]
+        optional :city, String
+
+        # @!attribute country
+        #   This parameter represents the country of the place.
+        #
+        #   @return [String, nil]
+        optional :country, String
+
+        # @!attribute district
+        #   This parameter represents the district of the place.
+        #
+        #   @return [String, nil]
+        optional :district, String
+
+        # @!attribute geopoint
+        #   This parameter represents the geographical coordinates of the place. It includes
+        #   the latitude and longitude values.
+        #
+        #   @return [Nextbillionai::Models::Multigeocode::PlaceItem::Geopoint, nil]
+        optional :geopoint, -> { Nextbillionai::Multigeocode::PlaceItem::Geopoint }
+
+        # @!attribute house
+        #   This parameter represents the house or building number of the place.
+        #
+        #   @return [String, nil]
+        optional :house, String
+
+        # @!attribute poi
+        #   This parameter represents a point of interest within the place. A Point of
+        #   Interest (POI) refers to a specific location or area that is of interest to
+        #   individuals for various reasons. It could be a landmark, tourist attraction,
+        #   business, or any other location that people might find important or intriguing.
+        #
+        #   @return [Nextbillionai::Models::Multigeocode::PlaceItem::Poi, nil]
+        optional :poi, -> { Nextbillionai::Multigeocode::PlaceItem::Poi }
+
+        # @!attribute postal_code
+        #   This parameter represents the postal code or ZIP code of the place.
+        #
+        #   @return [String, nil]
+        optional :postal_code, String, api_name: :postalCode
+
+        # @!attribute state
+        #   This parameter represents the state or region of the place.
+        #
+        #   @return [String, nil]
+        optional :state, String
+
+        # @!attribute street
+        #   This parameter represents the street name of the place.
+        #
+        #   @return [String, nil]
+        optional :street, String
+
+        # @!attribute sub_district
+        #   This parameter represents the sub-district or locality of the place.
+        #
+        #   @return [String, nil]
+        optional :sub_district, String, api_name: :subDistrict
+
+        # @!method initialize(address: nil, building: nil, city: nil, country: nil, district: nil, geopoint: nil, house: nil, poi: nil, postal_code: nil, state: nil, street: nil, sub_district: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Multigeocode::PlaceItem} for more details.
+        #
+        #   @param address [String] This parameter represents the complete address of the place, including the stree
+        #
+        #   @param building [String] This parameter represents additional building information if applicable.
+        #
+        #   @param city [String] This parameter represents the city or town of the place.
+        #
+        #   @param country [String] This parameter represents the country of the place.
+        #
+        #   @param district [String] This parameter represents the district of the place.
+        #
+        #   @param geopoint [Nextbillionai::Models::Multigeocode::PlaceItem::Geopoint] This parameter represents the geographical coordinates of the place. It includes
+        #
+        #   @param house [String] This parameter represents the house or building number of the place.
+        #
+        #   @param poi [Nextbillionai::Models::Multigeocode::PlaceItem::Poi] This parameter represents a point of interest within the place. A Point of Inter
+        #
+        #   @param postal_code [String] This parameter represents the postal code or ZIP code of the place.
+        #
+        #   @param state [String] This parameter represents the state or region of the place.
+        #
+        #   @param street [String] This parameter represents the street name of the place.
+        #
+        #   @param sub_district [String] This parameter represents the sub-district or locality of the place.
+
+        # @see Nextbillionai::Models::Multigeocode::PlaceItem#geopoint
+        class Geopoint < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute lat
+          #   This parameter represents the latitude value of the place.
+          #
+          #   @return [Float, nil]
+          optional :lat, Float
+
+          # @!attribute lng
+          #   This parameter represents the longitude value of the place.
+          #
+          #   @return [Float, nil]
+          optional :lng, Float
+
+          # @!method initialize(lat: nil, lng: nil)
+          #   This parameter represents the geographical coordinates of the place. It includes
+          #   the latitude and longitude values.
+          #
+          #   @param lat [Float] This parameter represents the latitude value of the place.
+          #
+          #   @param lng [Float] This parameter represents the longitude value of the place.
+        end
+
+        # @see Nextbillionai::Models::Multigeocode::PlaceItem#poi
+        class Poi < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute title
+          #   A title that describes the point of interest.
+          #
+          #   @return [String, nil]
+          optional :title, String
+
+          # @!method initialize(title: nil)
+          #   This parameter represents a point of interest within the place. A Point of
+          #   Interest (POI) refers to a specific location or area that is of interest to
+          #   individuals for various reasons. It could be a landmark, tourist attraction,
+          #   business, or any other location that people might find important or intriguing.
+          #
+          #   @param title [String] A title that describes the point of interest.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Multigeocode
+      # @see Nextbillionai::Resources::Multigeocode::Place#retrieve
+      class PlaceRetrieveParams < 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
+
+        # @!method initialize(key:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Multigeocode::PlaceRetrieveParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end