nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/geofence/console_search_response.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Geofence
+      # @see Nextbillionai::Resources::Geofence::Console#search
+      class ConsoleSearchResponse < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Nextbillionai::Models::Geofence::ConsoleSearchResponse::Data]
+        required :data, -> { Nextbillionai::Models::Geofence::ConsoleSearchResponse::Data }
+
+        # @!attribute status
+        #   A string indicating the state of the response. On successful responses, the
+        #   value will be Ok. Indicative error messages are returned for different errors.
+        #   See the [API Error Codes](#api-error-codes) section below for more information.
+        #
+        #   @return [String]
+        required :status, String
+
+        # @!method initialize(data:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Geofence::ConsoleSearchResponse} for more details.
+        #
+        #   @param data [Nextbillionai::Models::Geofence::ConsoleSearchResponse::Data]
+        #
+        #   @param status [String] A string indicating the state of the response. On successful responses, the valu
+
+        # @see Nextbillionai::Models::Geofence::ConsoleSearchResponse#data
+        class Data < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute result
+          #
+          #   @return [Array<Nextbillionai::Models::Geofence::ConsoleSearchResponse::Data::Result>]
+          required :result,
+                   -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::Geofence::ConsoleSearchResponse::Data::Result] }
+
+          # @!method initialize(result:)
+          #   @param result [Array<Nextbillionai::Models::Geofence::ConsoleSearchResponse::Data::Result>]
+
+          class Result < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute id
+            #   ID of goefence. Could be empty string.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute name
+            #   Name of goefence. Could be empty string.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!method initialize(id:, name:)
+            #   @param id [String] ID of goefence. Could be empty string.
+            #
+            #   @param name [String] Name of goefence. Could be empty string.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/geofence/polygon_geojson.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Geofence
+      class PolygonGeojson < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute coordinates
+        #   An array of coordinates in the [longitude, latitude] format, representing the
+        #   geofence boundary.
+        #
+        #   @return [Array<Array<Float>>, nil]
+        optional :coordinates,
+                 Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Internal::Type::ArrayOf[Float]]
+
+        # @!attribute type
+        #   Type of the geoJSON geometry. Will always be Polygon.
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!method initialize(coordinates: nil, type: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Geofence::PolygonGeojson} for more details.
+        #
+        #   An object with geoJSON details of the geofence. The contents of this object
+        #   follow the [geoJSON standard](https://datatracker.ietf.org/doc/html/rfc7946).
+        #
+        #   @param coordinates [Array<Array<Float>>] An array of coordinates in the [longitude, latitude] format, representing the ge
+        #
+        #   @param type [String] Type of the geoJSON geometry. Will always be Polygon.
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/geofence.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    class GeofenceAPI < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute id
+      #   ID of the geofence provided/generated at the time of creating the geofence.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute circle_center
+      #
+      #   @return [Nextbillionai::Models::GeofenceAPI::CircleCenter, nil]
+      optional :circle_center, -> { Nextbillionai::GeofenceAPI::CircleCenter }
+
+      # @!attribute circle_radius
+      #   When the type of the geofence is circle, this property returns the radius of the
+      #   geofence in meters (m).
+      #
+      #   @return [Float, nil]
+      optional :circle_radius, Float
+
+      # @!attribute created_at
+      #   Time at which the geofence was created, expressed as a UNIX timestamp in
+      #   seconds.
+      #
+      #   @return [Integer, nil]
+      optional :created_at, Integer
+
+      # @!attribute geojson
+      #   An object with geoJSON details of the geofence. The contents of this object
+      #   follow the [geoJSON standard](https://datatracker.ietf.org/doc/html/rfc7946).
+      #
+      #   @return [Nextbillionai::Models::Geofence::PolygonGeojson, nil]
+      optional :geojson, -> { Nextbillionai::Geofence::PolygonGeojson }
+
+      # @!attribute ic_contours_meter
+      #   For a geofence based on isochrone contour determined using a specific driving
+      #   distance, this property returns the duration value, in meters.
+      #
+      #   The value would be the same as that provided for the contours_meter parameter at
+      #   the time of creating or updating the geofence.
+      #
+      #   @return [Integer, nil]
+      optional :ic_contours_meter, Integer
+
+      # @!attribute ic_contours_minute
+      #   For a geofence based on isochrone contour determined using a specific driving
+      #   duration, this property returns the duration value, in minutes. The value would
+      #   be the same as the value provided for the contours_minute parameter at the time
+      #   of creating or updating the geofence.
+      #
+      #   @return [Integer, nil]
+      optional :ic_contours_minute, Integer
+
+      # @!attribute ic_coordinates
+      #   For a geofence based on isochrone contour, this property returns the coordinates
+      #   of the location, in [latitude,longitude] format, which was used as the starting
+      #   point to identify the geofence boundary.
+      #
+      #   The value would be the same as that provided for the coordinates parameter at
+      #   the time of creating or updating the geofence.
+      #
+      #   @return [String, nil]
+      optional :ic_coordinates, String
+
+      # @!attribute ic_denoise
+      #   For a geofence based on isochrone contour, this property returns the denoise
+      #   value which would be the same as that provided for the denoise parameter at the
+      #   time of creating or updating the geofence.
+      #
+      #   @return [Float, nil]
+      optional :ic_denoise, Float
+
+      # @!attribute ic_departure_time
+      #   For a geofence based on isochrone contour, this property returns the departure
+      #   time, as a UNIX epoch timestamp in seconds, which was used to determine the
+      #   geofence boundary after taking into account the traffic conditions at the time.
+      #
+      #   The value would be the same as that provided for the departure_time parameter at
+      #   the time of creating or updating the geofence.
+      #
+      #   @return [Integer, nil]
+      optional :ic_departure_time, Integer
+
+      # @!attribute ic_mode
+      #   For a geofence based on isochrone contour, this property returns the driving
+      #   mode used to determine the geofence boundary.
+      #
+      #   The value would be the same as that provided for the mode parameter at the time
+      #   of creating or updating the geofence.
+      #
+      #   @return [Float, nil]
+      optional :ic_mode, Float
+
+      # @!attribute meta_data
+      #   Metadata of the geofence added at the time of creating or updating it.
+      #
+      #   @return [Object, nil]
+      optional :meta_data, Nextbillionai::Internal::Type::Unknown
+
+      # @!attribute name
+      #   Name of the geofence added at the time of creating or updating it.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute tags
+      #   An array of strings representing the tags associated with the geofence added at
+      #   the time of creating or updating it.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, Nextbillionai::Internal::Type::ArrayOf[String]
+
+      # @!attribute type
+      #   Type of the geofence.
+      #
+      #   @return [Symbol, Nextbillionai::Models::GeofenceAPI::Type, nil]
+      optional :type, enum: -> { Nextbillionai::GeofenceAPI::Type }
+
+      # @!attribute updated_at
+      #   Time at which the geofence was last updated, expressed as a UNIX timestamp in
+      #   seconds.
+      #
+      #   @return [Integer, nil]
+      optional :updated_at, Integer
+
+      # @!method initialize(id: nil, circle_center: nil, circle_radius: nil, created_at: nil, geojson: nil, ic_contours_meter: nil, ic_contours_minute: nil, ic_coordinates: nil, ic_denoise: nil, ic_departure_time: nil, ic_mode: nil, meta_data: nil, name: nil, tags: nil, type: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::GeofenceAPI} for more details.
+      #
+      #   An object with details of the geofence.
+      #
+      #   @param id [String] ID of the geofence provided/generated at the time of creating the geofence.
+      #
+      #   @param circle_center [Nextbillionai::Models::GeofenceAPI::CircleCenter]
+      #
+      #   @param circle_radius [Float] When the type of the geofence is circle, this property returns the radius of the
+      #
+      #   @param created_at [Integer] Time at which the geofence was created, expressed as a UNIX timestamp in seconds
+      #
+      #   @param geojson [Nextbillionai::Models::Geofence::PolygonGeojson] An object with geoJSON details of the geofence. The contents of this object foll
+      #
+      #   @param ic_contours_meter [Integer] For a geofence based on isochrone contour determined using a specific driving di
+      #
+      #   @param ic_contours_minute [Integer] For a geofence based on isochrone contour determined using a specific driving du
+      #
+      #   @param ic_coordinates [String] For a geofence based on isochrone contour, this property returns the coordinates
+      #
+      #   @param ic_denoise [Float] For a geofence based on isochrone contour, this property returns the denoise val
+      #
+      #   @param ic_departure_time [Integer] For a geofence based on isochrone contour, this property returns the departure t
+      #
+      #   @param ic_mode [Float] For a geofence based on isochrone contour, this property returns the driving mod
+      #
+      #   @param meta_data [Object] Metadata of the geofence added at the time of creating or updating it.
+      #
+      #   @param name [String] Name of the geofence added at the time of creating or updating it.
+      #
+      #   @param tags [Array<String>] An array of strings representing the tags associated with the geofence added at
+      #
+      #   @param type [Symbol, Nextbillionai::Models::GeofenceAPI::Type] Type of the geofence.
+      #
+      #   @param updated_at [Integer] Time at which the geofence was last updated, expressed as a UNIX timestamp in se
+
+      # @see Nextbillionai::Models::GeofenceAPI#circle_center
+      class CircleCenter < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute lat
+        #   Latitude of the location.
+        #
+        #   @return [Float, nil]
+        optional :lat, Float
+
+        # @!attribute lon
+        #   Longitude of the location.
+        #
+        #   @return [Float, nil]
+        optional :lon, Float
+
+        # @!method initialize(lat: nil, lon: nil)
+        #   @param lat [Float] Latitude of the location.
+        #
+        #   @param lon [Float] Longitude of the location.
+      end
+
+      # Type of the geofence.
+      #
+      # @see Nextbillionai::Models::GeofenceAPI#type
+      module Type
+        extend Nextbillionai::Internal::Type::Enum
+
+        CIRCLE = :circle
+        POLYGON = :polygon
+        ISOCHRONE = :isochrone
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/geofence_contains_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geofence#contains
+    class GeofenceContainsParams < 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 locations
+      #   Pipe (|) separated coordinates, in [latitude,longitude] format, of the locations
+      #   to be searched against the geofences.
+      #
+      #   @return [String]
+      required :locations, String
+
+      # @!attribute geofences
+      #   A , separated list geofence IDs against which the locations will be searched. If
+      #   not provided, then the 'locations' will be searched against all your existing
+      #   geofences.
+      #
+      #   Maximum length of the string can be 256 characters.
+      #
+      #   @return [String, nil]
+      optional :geofences, String
+
+      # @!attribute verbose
+      #   When true, an array with detailed information of geofences is returned. When
+      #   false, an array containing only the IDs of the geofences is returned.
+      #
+      #   @return [String, nil]
+      optional :verbose, String
+
+      # @!method initialize(key:, locations:, geofences: nil, verbose: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::GeofenceContainsParams} for more details.
+      #
+      #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+      #
+      #   @param locations [String] Pipe (|) separated coordinates, in [latitude,longitude] format, of the locations
+      #
+      #   @param geofences [String] A , separated list geofence IDs against which the locations will be searched. If
+      #
+      #   @param verbose [String] When true, an array with detailed information of geofences is returned. When fal
+      #
+      #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/nextbillionai/models/geofence_contains_response.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geofence#contains
+    class GeofenceContainsResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Nextbillionai::Models::GeofenceContainsResponse::Data, nil]
+      optional :data, -> { Nextbillionai::Models::GeofenceContainsResponse::Data }
+
+      # @!attribute status
+      #   A string indicating the state of the response. On successful responses, the
+      #   value will be Ok. Indicative error messages are returned for different errors.
+      #   See the [API Error Codes](#api-error-codes) section below for more information.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!method initialize(data: nil, status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::GeofenceContainsResponse} for more details.
+      #
+      #   @param data [Nextbillionai::Models::GeofenceContainsResponse::Data]
+      #
+      #   @param status [String] A string indicating the state of the response. On successful responses, the valu
+
+      # @see Nextbillionai::Models::GeofenceContainsResponse#data
+      class Data < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute result_list
+        #   An array of objects containing each of the geofences provided in the geofences
+        #   input. If geofences in not provided then the array will return all the geofences
+        #   associated with the key
+        #
+        #   @return [Array<Nextbillionai::Models::GeofenceContainsResponse::Data::ResultList>, nil]
+        optional :result_list,
+                 -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::GeofenceContainsResponse::Data::ResultList] }
+
+        # @!method initialize(result_list: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::GeofenceContainsResponse::Data} for more details.
+        #
+        #   @param result_list [Array<Nextbillionai::Models::GeofenceContainsResponse::Data::ResultList>] An array of objects containing each of the geofences provided in the geofences i
+
+        class ResultList < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute geofence_detail
+          #   An object with details of the geofence.
+          #
+          #   @return [Nextbillionai::Models::GeofenceAPI, nil]
+          optional :geofence_detail, -> { Nextbillionai::GeofenceAPI }
+
+          # @!attribute geofence_id
+          #   ID of the geofence provided/generated at the time of creating the geofence.
+          #
+          #   @return [String, nil]
+          optional :geofence_id, String
+
+          # @!attribute result
+          #   An array of objects with results of the contains check for each of the
+          #   coordinate points in locations against the geofence represented by geofence_id.
+          #
+          #   @return [Array<Nextbillionai::Models::GeofenceContainsResponse::Data::ResultList::Result>, nil]
+          optional :result,
+                   -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::GeofenceContainsResponse::Data::ResultList::Result] }
+
+          # @!method initialize(geofence_detail: nil, geofence_id: nil, result: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::GeofenceContainsResponse::Data::ResultList} for more
+          #   details.
+          #
+          #   @param geofence_detail [Nextbillionai::Models::GeofenceAPI] An object with details of the geofence.
+          #
+          #   @param geofence_id [String] ID of the geofence provided/generated at the time of creating the geofence.
+          #
+          #   @param result [Array<Nextbillionai::Models::GeofenceContainsResponse::Data::ResultList::Result>] An array of objects with results of the contains check for each of the coordinat
+
+          class Result < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute contain
+            #   true when a coordinate point in locations is contained by this geofence.
+            #
+            #   @return [Boolean, nil]
+            optional :contain, Nextbillionai::Internal::Type::Boolean
+
+            # @!attribute location_index
+            #   Index of the coordinate point in the input locations.
+            #
+            #   @return [Integer, nil]
+            optional :location_index, Integer
+
+            # @!method initialize(contain: nil, location_index: nil)
+            #   @param contain [Boolean] true when a coordinate point in locations is contained by this geofence.
+            #
+            #   @param location_index [Integer] Index of the coordinate point in the input locations.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/geofence_create_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geofence#create
+    class GeofenceCreateParams < Nextbillionai::Models::GeofenceEntityCreate
+      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::GeofenceCreateParams} 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

data/lib/nextbillionai/models/geofence_create_response.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geofence#create
+    class GeofenceCreateResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute data
+      #   A data object containing the ID of the geofence created.
+      #
+      #   @return [Nextbillionai::Models::GeofenceCreateResponse::Data, nil]
+      optional :data, -> { Nextbillionai::Models::GeofenceCreateResponse::Data }
+
+      # @!attribute status
+      #   A string indicating the state of the response. On successful responses, the
+      #   value will be Ok. Indicative error messages are returned for different errors.
+      #   See the [API Error Codes](#api-error-codes) section below for more information.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!method initialize(data: nil, status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::GeofenceCreateResponse} for more details.
+      #
+      #   @param data [Nextbillionai::Models::GeofenceCreateResponse::Data] A data object containing the ID of the geofence created.
+      #
+      #   @param status [String] A string indicating the state of the response. On successful responses, the valu
+
+      # @see Nextbillionai::Models::GeofenceCreateResponse#data
+      class Data < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique ID of the geofence created. It will be the same as custom_id, if
+        #   provided. Else it will be an auto generated UUID. Please note this ID cannot be
+        #   updated.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!method initialize(id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::GeofenceCreateResponse::Data} for more details.
+        #
+        #   A data object containing the ID of the geofence created.
+        #
+        #   @param id [String] Unique ID of the geofence created. It will be the same as custom_id, if provided
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/geofence_delete_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geofence#delete
+    class GeofenceDeleteParams < 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::GeofenceDeleteParams} 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