nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/geofence_entity_create.rb

@@ -0,0 +1,328 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    class GeofenceEntityCreate < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute type
+      #   Specify the type of the geofence that is being created.
+      #
+      #   @return [Symbol, Nextbillionai::Models::GeofenceEntityCreate::Type]
+      required :type, enum: -> { Nextbillionai::GeofenceEntityCreate::Type }
+
+      # @!attribute circle
+      #   Provide the details to create a circular geofence. Please note that this object
+      #   is mandatory when type is circle. When the type is not circle, the properties of
+      #   this object will be ignored while creating the geofence.
+      #
+      #   @return [Nextbillionai::Models::GeofenceEntityCreate::Circle, nil]
+      optional :circle, -> { Nextbillionai::GeofenceEntityCreate::Circle }
+
+      # @!attribute custom_id
+      #   Set an unique ID for the new geofence. If not provided, an ID will be
+      #   automatically generated in UUID format. A valid custom*id can contain letters,
+      #   numbers, "-", & "*" only.
+      #
+      #   Please note that the ID of a geofence can not be changed once it is created.
+      #
+      #   @return [String, nil]
+      optional :custom_id, String
+
+      # @!attribute isochrone
+      #   Provide the details to create an isochrone based geofence. Use this object when
+      #   type is isochrone. When the type is not isochrone, the properties of this object
+      #   will be ignored while creating the geofence.
+      #
+      #   @return [Nextbillionai::Models::GeofenceEntityCreate::Isochrone, nil]
+      optional :isochrone, -> { Nextbillionai::GeofenceEntityCreate::Isochrone }
+
+      # @!attribute meta_data
+      #   Metadata of the geofence. Use this field to define custom attributes that
+      #   provide more context and information about the geofence being created like
+      #   country, group ID etc.
+      #
+      #   The data being added should be in valid JSON object format (i.e. key and value
+      #   pairs). Max size allowed for the object is 65kb.
+      #
+      #   @return [Object, nil]
+      optional :meta_data, Nextbillionai::Internal::Type::Unknown
+
+      # @!attribute name
+      #   Name of the geofence. Use this field to assign a meaningful, custom name to the
+      #   geofence being created.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute polygon
+      #   Provide the details to create a custom polygon type of geofence. Please note
+      #   that this object is mandatory when type is polygon. When the type is not
+      #   polygon, the properties of this object will be ignored while creating the
+      #   geofence.
+      #
+      #   Self-intersecting polygons or polygons containing other polygons are invalid and
+      #   will be removed while processing the request.
+      #
+      #   Area of the polygon should be less than 2000 km<sup>2</sup>.
+      #
+      #   @return [Nextbillionai::Models::GeofenceEntityCreate::Polygon, nil]
+      optional :polygon, -> { Nextbillionai::GeofenceEntityCreate::Polygon }
+
+      # @!attribute tags
+      #   An array of strings to associate multiple tags to the geofence. tags can be used
+      #   to search or filter geofences (using Get Geofence List method).
+      #
+      #   Create valid tags using a string consisting of alphanumeric characters (A-Z,
+      #   a-z, 0-9) along with the underscore ('\_') and hyphen ('-') symbols.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, Nextbillionai::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(type:, circle: nil, custom_id: nil, isochrone: nil, meta_data: nil, name: nil, polygon: nil, tags: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::GeofenceEntityCreate} for more details.
+      #
+      #   @param type [Symbol, Nextbillionai::Models::GeofenceEntityCreate::Type] Specify the type of the geofence that is being created.
+      #
+      #   @param circle [Nextbillionai::Models::GeofenceEntityCreate::Circle] Provide the details to create a circular geofence. Please note that this object
+      #
+      #   @param custom_id [String] Set an unique ID for the new geofence. If not provided, an ID will be automatica
+      #
+      #   @param isochrone [Nextbillionai::Models::GeofenceEntityCreate::Isochrone] Provide the details to create an isochrone based geofence. Use this object when
+      #
+      #   @param meta_data [Object] Metadata of the geofence. Use this field to define custom attributes that provid
+      #
+      #   @param name [String] Name of the geofence. Use this field to assign a meaningful, custom name to the
+      #
+      #   @param polygon [Nextbillionai::Models::GeofenceEntityCreate::Polygon] Provide the details to create a custom polygon type of geofence. Please note tha
+      #
+      #   @param tags [Array<String>] An array of strings to associate multiple tags to the geofence. tags can be used
+
+      # Specify the type of the geofence that is being created.
+      #
+      # @see Nextbillionai::Models::GeofenceEntityCreate#type
+      module Type
+        extend Nextbillionai::Internal::Type::Enum
+
+        CIRCLE = :circle
+        POLYGON = :polygon
+        ISOCHRONE = :isochrone
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Nextbillionai::Models::GeofenceEntityCreate#circle
+      class Circle < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute center
+        #   Coordinate of the location which will act as the center of a circular geofence.
+        #
+        #   @return [Nextbillionai::Models::GeofenceEntityCreate::Circle::Center]
+        required :center, -> { Nextbillionai::GeofenceEntityCreate::Circle::Center }
+
+        # @!attribute radius
+        #   Radius of the circular geofence, in meters. Maximum value allowed is 50000
+        #   meters.
+        #
+        #   @return [Float]
+        required :radius, Float
+
+        # @!method initialize(center:, radius:)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::GeofenceEntityCreate::Circle} for more details.
+        #
+        #   Provide the details to create a circular geofence. Please note that this object
+        #   is mandatory when type is circle. When the type is not circle, the properties of
+        #   this object will be ignored while creating the geofence.
+        #
+        #   @param center [Nextbillionai::Models::GeofenceEntityCreate::Circle::Center] Coordinate of the location which will act as the center of a circular geofence.
+        #
+        #   @param radius [Float] Radius of the circular geofence, in meters. Maximum value allowed is 50000 meter
+
+        # @see Nextbillionai::Models::GeofenceEntityCreate::Circle#center
+        class Center < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute lat
+          #   Latitude of the center location.
+          #
+          #   @return [Float]
+          required :lat, Float
+
+          # @!attribute lon
+          #   Longitude of the center location.
+          #
+          #   @return [Float]
+          required :lon, Float
+
+          # @!method initialize(lat:, lon:)
+          #   Coordinate of the location which will act as the center of a circular geofence.
+          #
+          #   @param lat [Float] Latitude of the center location.
+          #
+          #   @param lon [Float] Longitude of the center location.
+        end
+      end
+
+      # @see Nextbillionai::Models::GeofenceEntityCreate#isochrone
+      class Isochrone < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute coordinates
+        #   Coordinates of the location, in [latitude,longitude] format, which would act as
+        #   the starting point for identifying the isochrone polygon or the boundary of
+        #   reachable area. This parameter is mandatory when type is isochrone.
+        #
+        #   @return [String]
+        required :coordinates, String
+
+        # @!attribute contours_meter
+        #   The distance, in meters, for which an isochrone polygon needs to be determined.
+        #   When provided, the API would create a geofence representing the area that can be
+        #   reached after driving the given number of meters starting from the point
+        #   specified in coordinates.
+        #
+        #   The maximum distance that can be specified is 60000 meters (60km).
+        #
+        #   At least one of contours_meter or contours_minute is mandatory when type is
+        #   isochrone.
+        #
+        #   @return [Integer, nil]
+        optional :contours_meter, Integer
+
+        # @!attribute contours_minute
+        #   The duration, in minutes, for which an isochrone polygon needs to be determined.
+        #   When provided, the API would create a geofence representing the area that can be
+        #   reached after driving for the given number of minutes starting from the point
+        #   specified in coordinates.
+        #
+        #   The maximum duration that can be specified is 40 minutes.
+        #
+        #   At least one of contours_meter or contours_minute is mandatory when type is
+        #   isochrone.
+        #
+        #   @return [Integer, nil]
+        optional :contours_minute, Integer
+
+        # @!attribute denoise
+        #   A floating point value from 0.0 to 1.0 that can be used to remove smaller
+        #   contours. A value of 1.0 will only return the largest contour for a given value.
+        #   A value of 0.5 drops any contours that are less than half the area of the
+        #   largest contour in the set of contours for that same value.
+        #
+        #   @return [Float, nil]
+        optional :denoise, Float
+
+        # @!attribute departure_time
+        #   A UNIX epoch timestamp in seconds format that can be used to set the departure
+        #   time. The isochrone boundary will be determined based on the typical traffic
+        #   conditions at the given time. If no input is provided for this parameter then
+        #   the traffic conditions at the time of making the request are considered
+        #
+        #   @return [Integer, nil]
+        optional :departure_time, Integer
+
+        # @!attribute mode
+        #   Set which driving mode the service should use to determine the isochrone line.
+        #
+        #   For example, if you use car, the API will return an isochrone polygon that a car
+        #   can cover within the specified time or after driving the specified distance.
+        #   Using truck will return an isochrone that a truck can reach after taking into
+        #   account appropriate truck routing restrictions.
+        #
+        #   @return [Symbol, Nextbillionai::Models::GeofenceEntityCreate::Isochrone::Mode, nil]
+        optional :mode, enum: -> { Nextbillionai::GeofenceEntityCreate::Isochrone::Mode }
+
+        # @!method initialize(coordinates:, contours_meter: nil, contours_minute: nil, denoise: nil, departure_time: nil, mode: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::GeofenceEntityCreate::Isochrone} for more details.
+        #
+        #   Provide the details to create an isochrone based geofence. Use this object when
+        #   type is isochrone. When the type is not isochrone, the properties of this object
+        #   will be ignored while creating the geofence.
+        #
+        #   @param coordinates [String] Coordinates of the location, in [latitude,longitude] format, which would act as
+        #
+        #   @param contours_meter [Integer] The distance, in meters, for which an isochrone polygon needs to be determined.
+        #
+        #   @param contours_minute [Integer] The duration, in minutes, for which an isochrone polygon needs to be determined.
+        #
+        #   @param denoise [Float] A floating point value from 0.0 to 1.0 that can be used to remove smaller contou
+        #
+        #   @param departure_time [Integer] A UNIX epoch timestamp in seconds format that can be used to set the departure t
+        #
+        #   @param mode [Symbol, Nextbillionai::Models::GeofenceEntityCreate::Isochrone::Mode] Set which driving mode the service should use to determine the isochrone line.
+
+        # Set which driving mode the service should use to determine the isochrone line.
+        #
+        # For example, if you use car, the API will return an isochrone polygon that a car
+        # can cover within the specified time or after driving the specified distance.
+        # Using truck will return an isochrone that a truck can reach after taking into
+        # account appropriate truck routing restrictions.
+        #
+        # @see Nextbillionai::Models::GeofenceEntityCreate::Isochrone#mode
+        module Mode
+          extend Nextbillionai::Internal::Type::Enum
+
+          CAR = :car
+          TRUCK = :truck
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Nextbillionai::Models::GeofenceEntityCreate#polygon
+      class Polygon < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute geojson
+        #   An object to collect geoJSON details of the geofence. The contents of this
+        #   object follow the
+        #   [geoJSON standard](https://datatracker.ietf.org/doc/html/rfc7946).
+        #
+        #   @return [Nextbillionai::Models::GeofenceEntityCreate::Polygon::Geojson]
+        required :geojson, -> { Nextbillionai::GeofenceEntityCreate::Polygon::Geojson }
+
+        # @!method initialize(geojson:)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::GeofenceEntityCreate::Polygon} for more details.
+        #
+        #   Provide the details to create a custom polygon type of geofence. Please note
+        #   that this object is mandatory when type is polygon. When the type is not
+        #   polygon, the properties of this object will be ignored while creating the
+        #   geofence.
+        #
+        #   Self-intersecting polygons or polygons containing other polygons are invalid and
+        #   will be removed while processing the request.
+        #
+        #   Area of the polygon should be less than 2000 km<sup>2</sup>.
+        #
+        #   @param geojson [Nextbillionai::Models::GeofenceEntityCreate::Polygon::Geojson] An object to collect geoJSON details of the geofence. The contents of this objec
+
+        # @see Nextbillionai::Models::GeofenceEntityCreate::Polygon#geojson
+        class Geojson < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute coordinates
+          #   An array of coordinates in the [longitude, latitude] format, representing the
+          #   geofence boundary.
+          #
+          #   @return [Array<Array<Float>>]
+          required :coordinates,
+                   Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Internal::Type::ArrayOf[Float]]
+
+          # @!attribute type
+          #   Type of the geoJSON geometry. Should always be Polygon.
+          #
+          #   @return [String]
+          required :type, String
+
+          # @!method initialize(coordinates:, type:)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::GeofenceEntityCreate::Polygon::Geojson} for more
+          #   details.
+          #
+          #   An object to collect 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. Should always be Polygon.
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/geofence_list_params.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geofence#list
+    class GeofenceListParams < 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 pn
+      #   Denotes page number. Use this along with the ps parameter to implement
+      #   pagination for your searched results. This parameter does not have a maximum
+      #   limit but would return an empty response in case a higher value is provided when
+      #   the result-set itself is smaller.
+      #
+      #   @return [Integer, nil]
+      optional :pn, Integer
+
+      # @!attribute ps
+      #   Denotes number of search results per page. Use this along with the pn parameter
+      #   to implement pagination for your searched results.
+      #
+      #   @return [Integer, nil]
+      optional :ps, Integer
+
+      # @!attribute tags
+      #   Comma (,) separated list of tags which will be used to filter the geofences.
+      #
+      #   Please note only the geofences which have all the tags added to this parameter
+      #   will be included in the result. This parameter can accept a string with a
+      #   maximum length of 256 characters.
+      #
+      #   @return [String, nil]
+      optional :tags, String
+
+      # @!method initialize(key:, pn: nil, ps: nil, tags: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::GeofenceListParams} for more details.
+      #
+      #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+      #
+      #   @param pn [Integer] Denotes page number. Use this along with the ps parameter to implement paginatio
+      #
+      #   @param ps [Integer] Denotes number of search results per page. Use this along with the pn parameter
+      #
+      #   @param tags [String] Comma (,) separated list of tags which will be used to filter the geofences.
+      #
+      #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/nextbillionai/models/geofence_list_response.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geofence#list
+    class GeofenceListResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Nextbillionai::Models::GeofenceListResponse::Data, nil]
+      optional :data, -> { Nextbillionai::Models::GeofenceListResponse::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::GeofenceListResponse} for more details.
+      #
+      #   @param data [Nextbillionai::Models::GeofenceListResponse::Data]
+      #
+      #   @param status [String] A string indicating the state of the response. On successful responses, the valu
+
+      # @see Nextbillionai::Models::GeofenceListResponse#data
+      class Data < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute list
+        #
+        #   @return [Array<Nextbillionai::Models::GeofenceAPI>, nil]
+        optional :list, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::GeofenceAPI] }
+
+        # @!attribute page
+        #   An object with pagination details of the search results. Use this object to
+        #   implement pagination in your application.
+        #
+        #   @return [Nextbillionai::Models::Skynet::Pagination, nil]
+        optional :page, -> { Nextbillionai::Skynet::Pagination }
+
+        # @!method initialize(list: nil, page: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::GeofenceListResponse::Data} for more details.
+        #
+        #   @param list [Array<Nextbillionai::Models::GeofenceAPI>]
+        #
+        #   @param page [Nextbillionai::Models::Skynet::Pagination] An object with pagination details of the search results. Use this object to impl
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/geofence_retrieve_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geofence#retrieve
+    class GeofenceRetrieveParams < 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::GeofenceRetrieveParams} 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_retrieve_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Geofence#retrieve
+    class GeofenceRetrieveResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Nextbillionai::Models::GeofenceRetrieveResponse::Data, nil]
+      optional :data, -> { Nextbillionai::Models::GeofenceRetrieveResponse::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::GeofenceRetrieveResponse} for more details.
+      #
+      #   @param data [Nextbillionai::Models::GeofenceRetrieveResponse::Data]
+      #
+      #   @param status [String] A string indicating the state of the response. On successful responses, the valu
+
+      # @see Nextbillionai::Models::GeofenceRetrieveResponse#data
+      class Data < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute geofence
+        #   An object with details of the geofence.
+        #
+        #   @return [Nextbillionai::Models::GeofenceAPI, nil]
+        optional :geofence, -> { Nextbillionai::GeofenceAPI }
+
+        # @!method initialize(geofence: nil)
+        #   @param geofence [Nextbillionai::Models::GeofenceAPI] An object with details of the geofence.
+      end
+    end
+  end
+end