nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/skynet/asset_details.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      class AssetDetails < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute id
+        #   ID of the asset. This is the same ID that was generated/provided at the time of
+        #   creating the asset.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute attributes
+        #   A string dictionary object containing attributes of the asset. These attributes
+        #   were associated with the asset at the time of creating or updating it.
+        #
+        #   attributes can be added to an asset using the _Update Asset Attributes_ method.
+        #
+        #   @return [Object, nil]
+        optional :attributes, Nextbillionai::Internal::Type::Unknown
+
+        # @!attribute created_at
+        #   A UNIX epoch timestamp in seconds representing the time at which the asset was
+        #   created.
+        #
+        #   @return [Integer, nil]
+        optional :created_at, Integer
+
+        # @!attribute description
+        #   Description of the asset. The value would be the same as that provided for the
+        #   description parameter at the time of creating or updating the asset.
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute device_id
+        #   ID of the device that is linked to this asset. Please note that there can be
+        #   multiple device_id linked to a single asset. An empty response is returned if no
+        #   devices are linked to the asset.
+        #
+        #   User can link a device to an asset using the _Bind Asset to Device_ method.
+        #
+        #   @return [String, nil]
+        optional :device_id, String
+
+        # @!attribute latest_location
+        #   An object with details of the last tracked location of the asset.
+        #
+        #   @return [Nextbillionai::Models::Skynet::AssetDetails::LatestLocation, nil]
+        optional :latest_location, -> { Nextbillionai::Skynet::AssetDetails::LatestLocation }
+
+        # @!attribute meta_data
+        #   Any valid json object data. Can be used to save customized data. Max size is
+        #   65kb.
+        #
+        #   @return [Object, nil]
+        optional :meta_data, Nextbillionai::Internal::Type::Unknown
+
+        # @!attribute name
+        #   Name of the asset. The value would be the same as that provided for the name
+        #   parameter at the time of creating or updating the asset.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute state
+        #   State of the asset. It will be "active" when the asset is in use or available
+        #   for use, and it will be "deleted" in case the asset has been deleted.
+        #
+        #   @return [String, nil]
+        optional :state, String
+
+        # @!attribute tags
+        #   **This parameter will be deprecated soon! Please move existing tags to
+        #   attributes parameter.**
+        #
+        #   Tags of the asset. These were associated with the asset when it was created or
+        #   updated. tags can be used for filtering assets in operations like _Get Asset
+        #   List_ and asset **Search** methods. They can also be used for monitoring of
+        #   assets using **Monitor** methods after linking tags and asset.
+        #
+        #   @return [Array<String>, nil]
+        optional :tags, Nextbillionai::Internal::Type::ArrayOf[String]
+
+        # @!attribute tracked_at
+        #   A UNIX epoch timestamp in seconds representing the last time when the asset was
+        #   tracked.
+        #
+        #   @return [Integer, nil]
+        optional :tracked_at, Integer
+
+        # @!attribute updated_at
+        #   A UNIX epoch timestamp in seconds representing the time at which the asset was
+        #   last updated.
+        #
+        #   @return [Integer, nil]
+        optional :updated_at, Integer
+
+        # @!method initialize(id: nil, attributes: nil, created_at: nil, description: nil, device_id: nil, latest_location: nil, meta_data: nil, name: nil, state: nil, tags: nil, tracked_at: nil, updated_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::AssetDetails} for more details.
+        #
+        #   An object with details of the asset properties.
+        #
+        #   @param id [String] ID of the asset. This is the same ID that was generated/provided at the time of
+        #
+        #   @param attributes [Object] A string dictionary object containing attributes of the asset. These attributes
+        #
+        #   @param created_at [Integer] A UNIX epoch timestamp in seconds representing the time at which the asset was c
+        #
+        #   @param description [String] Description of the asset. The value would be the same as that provided for the d
+        #
+        #   @param device_id [String] ID of the device that is linked to this asset. Please note that there can be mul
+        #
+        #   @param latest_location [Nextbillionai::Models::Skynet::AssetDetails::LatestLocation] An object with details of the last tracked location of the asset.
+        #
+        #   @param meta_data [Object] Any valid json object data. Can be used to save customized data. Max size is 65k
+        #
+        #   @param name [String] Name of the asset. The value would be the same as that provided for the name par
+        #
+        #   @param state [String] State of the asset. It will be "active" when the asset is in use or available fo
+        #
+        #   @param tags [Array<String>] \*\*This parameter will be deprecated soon! Please move existing tags to
+        #   attribute
+        #
+        #   @param tracked_at [Integer] A UNIX epoch timestamp in seconds representing the last time when the asset was
+        #
+        #   @param updated_at [Integer] A UNIX epoch timestamp in seconds representing the time at which the asset was l
+
+        # @see Nextbillionai::Models::Skynet::AssetDetails#latest_location
+        class LatestLocation < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute accuracy
+          #   If available, this property returns the accuracy of the GPS information received
+          #   at the last tracked location. It is represented as an estimated horizontal
+          #   accuracy radius, in meters, at the 68th percentile confidence level.
+          #
+          #   @return [Float, nil]
+          optional :accuracy, Float
+
+          # @!attribute altitude
+          #   If available in the GPS information, this property returns the altitude of the
+          #   asset at the last tracked location. It is represented as height, in meters,
+          #   above the WGS84 reference ellipsoid.
+          #
+          #   @return [Float, nil]
+          optional :altitude, Float
+
+          # @!attribute bearing
+          #   If available in the GPS information, this property returns the heading of the
+          #   asset calculated from true north in clockwise direction at the last tracked
+          #   location. Please note that the bearing is not affected by the device
+          #   orientation.
+          #
+          #   The bearing will always be in the range of [0, 360).
+          #
+          #   @return [Float, nil]
+          optional :bearing, Float
+
+          # @!attribute location
+          #   An object with the coordinates of the last tracked location.
+          #
+          #   @return [Nextbillionai::Models::Skynet::AssetDetails::LatestLocation::Location, nil]
+          optional :location, -> { Nextbillionai::Skynet::AssetDetails::LatestLocation::Location }
+
+          # @!attribute speed
+          #   If available in the GPS information, this property returns the speed of the
+          #   asset, in meters per second, at the last tracked location.
+          #
+          #   @return [Float, nil]
+          optional :speed, Float
+
+          # @!attribute timestamp
+          #   A UNIX epoch timestamp in milliseconds, representing the time at which the
+          #   location was tracked.
+          #
+          #   @return [Integer, nil]
+          optional :timestamp, Integer
+
+          # @!method initialize(accuracy: nil, altitude: nil, bearing: nil, location: nil, speed: nil, timestamp: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Skynet::AssetDetails::LatestLocation} for more details.
+          #
+          #   An object with details of the last tracked location of the asset.
+          #
+          #   @param accuracy [Float] If available, this property returns the accuracy of the GPS information received
+          #
+          #   @param altitude [Float] If available in the GPS information, this property returns the altitude of the a
+          #
+          #   @param bearing [Float] If available in the GPS information, this property returns the heading of the as
+          #
+          #   @param location [Nextbillionai::Models::Skynet::AssetDetails::LatestLocation::Location] An object with the coordinates of the last tracked location.
+          #
+          #   @param speed [Float] If available in the GPS information, this property returns the speed of the asse
+          #
+          #   @param timestamp [Integer] A UNIX epoch timestamp in milliseconds, representing the time at which the locat
+
+          # @see Nextbillionai::Models::Skynet::AssetDetails::LatestLocation#location
+          class Location < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute lat
+            #   Latitude of the tracked location of the asset.
+            #
+            #   @return [Float, nil]
+            optional :lat, Float
+
+            # @!attribute lon
+            #   Longitude of the tracked location of the asset.
+            #
+            #   @return [Float, nil]
+            optional :lon, Float
+
+            # @!method initialize(lat: nil, lon: nil)
+            #   An object with the coordinates of the last tracked location.
+            #
+            #   @param lat [Float] Latitude of the tracked location of the asset.
+            #
+            #   @param lon [Float] Longitude of the tracked location of the asset.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/asset_list_params.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Asset#list
+      class AssetListParams < 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 cluster
+        #   the cluster of the region you want to use
+        #
+        #   @return [Symbol, Nextbillionai::Models::Skynet::AssetListParams::Cluster, nil]
+        optional :cluster, enum: -> { Nextbillionai::Skynet::AssetListParams::Cluster }
+
+        # @!attribute include_all_of_attributes
+        #   Use this parameter to filter the assets by their attributes. Only the assets
+        #   having all the attributes added to this parameter, will be returned in the
+        #   response. Multiple attributes can be separated using pipes (|).
+        #
+        #   Please note the attributes are case sensitive. Also, this parameter can not be
+        #   used in conjunction with include_any_of_attributes parameter.
+        #
+        #   @return [String, nil]
+        optional :include_all_of_attributes, String
+
+        # @!attribute include_any_of_attributes
+        #   Use this parameter to filter the assets by their attributes. Assets having at
+        #   least one of the attributes added to this parameter, will be returned in the
+        #   response. Multiple attributes can be separated using pipes (|).
+        #
+        #   Please note the attributes are case sensitive. Also, this parameter can not be
+        #   used in conjunction with include_all_of_attributes parameter.
+        #
+        #   @return [String, nil]
+        optional :include_any_of_attributes, 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 sort
+        #   Provide a single field to sort the results by. Only updated_at or created_at
+        #   fields can be selected for ordering the results.
+        #
+        #   By default, the result is sorted by created_at field in the descending order.
+        #   Allowed values for specifying the order are asc for ascending order and desc for
+        #   descending order.
+        #
+        #   @return [String, nil]
+        optional :sort, String
+
+        # @!attribute tags
+        #   **This parameter will be deprecated soon! Please use the
+        #   include_all_of_attributes or include_any_of_attributes parameters to provide
+        #   labels or markers for the assets to be retrieved.**
+        #
+        #   tags can be used to filter the assets. Only those assets which have all the tags
+        #   provided, will be included in the result. In case multiple tags need to be
+        #   specified, use , to separate them.
+        #
+        #   @return [String, nil]
+        optional :tags, String
+
+        # @!method initialize(key:, cluster: nil, include_all_of_attributes: nil, include_any_of_attributes: nil, pn: nil, ps: nil, sort: nil, tags: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::AssetListParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param cluster [Symbol, Nextbillionai::Models::Skynet::AssetListParams::Cluster] the cluster of the region you want to use
+        #
+        #   @param include_all_of_attributes [String] Use this parameter to filter the assets by their attributes. Only the assets hav
+        #
+        #   @param include_any_of_attributes [String] Use this parameter to filter the assets by their attributes. Assets having at le
+        #
+        #   @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 sort [String] Provide a single field to sort the results by. Only updated_at or created_at fie
+        #
+        #   @param tags [String] \*\*This parameter will be deprecated soon! Please use the
+        #   include_all_of_attribut
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+        # the cluster of the region you want to use
+        module Cluster
+          extend Nextbillionai::Internal::Type::Enum
+
+          AMERICA = :america
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/asset_list_response.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Asset#list
+      class AssetListResponse < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute data
+        #   A data object containing the list of assets.
+        #
+        #   @return [Nextbillionai::Models::Skynet::AssetListResponse::Data, nil]
+        optional :data, -> { Nextbillionai::Models::Skynet::AssetListResponse::Data }
+
+        # @!attribute message
+        #   Displays the error message in case of a failed request. If the request is
+        #   successful, this field is not present in the response.
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!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, message: nil, status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::AssetListResponse} for more details.
+        #
+        #   @param data [Nextbillionai::Models::Skynet::AssetListResponse::Data] A data object containing the list of assets.
+        #
+        #   @param message [String] Displays the error message in case of a failed request. If the request is succes
+        #
+        #   @param status [String] A string indicating the state of the response. On successful responses, the valu
+
+        # @see Nextbillionai::Models::Skynet::AssetListResponse#data
+        class Data < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute list
+          #   An array of objects, with each object representing one asset.
+          #
+          #   @return [Array<Nextbillionai::Models::Skynet::AssetDetails>, nil]
+          optional :list, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Skynet::AssetDetails] }
+
+          # @!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::Skynet::AssetListResponse::Data} for more details.
+          #
+          #   A data object containing the list of assets.
+          #
+          #   @param list [Array<Nextbillionai::Models::Skynet::AssetDetails>] An array of objects, with each object representing one asset.
+          #
+          #   @param page [Nextbillionai::Models::Skynet::Pagination] An object with pagination details of the search results. Use this object to impl
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/asset_retrieve_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Asset#retrieve
+      class AssetRetrieveParams < 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 cluster
+        #   the cluster of the region you want to use
+        #
+        #   @return [Symbol, Nextbillionai::Models::Skynet::AssetRetrieveParams::Cluster, nil]
+        optional :cluster, enum: -> { Nextbillionai::Skynet::AssetRetrieveParams::Cluster }
+
+        # @!method initialize(key:, cluster: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::AssetRetrieveParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param cluster [Symbol, Nextbillionai::Models::Skynet::AssetRetrieveParams::Cluster] the cluster of the region you want to use
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+        # the cluster of the region you want to use
+        module Cluster
+          extend Nextbillionai::Internal::Type::Enum
+
+          AMERICA = :america
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/asset_retrieve_response.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Asset#retrieve
+      class AssetRetrieveResponse < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute data
+        #   An object containing the information about the asset returned.
+        #
+        #   @return [Nextbillionai::Models::Skynet::AssetRetrieveResponse::Data, nil]
+        optional :data, -> { Nextbillionai::Models::Skynet::AssetRetrieveResponse::Data }
+
+        # @!attribute message
+        #   Displays the error message in case of a failed request. If the request is
+        #   successful, this field is not present in the response.
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!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, message: nil, status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::AssetRetrieveResponse} for more details.
+        #
+        #   @param data [Nextbillionai::Models::Skynet::AssetRetrieveResponse::Data] An object containing the information about the asset returned.
+        #
+        #   @param message [String] Displays the error message in case of a failed request. If the request is succes
+        #
+        #   @param status [String] A string indicating the state of the response. On successful responses, the valu
+
+        # @see Nextbillionai::Models::Skynet::AssetRetrieveResponse#data
+        class Data < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute asset
+          #   An object with details of the asset properties.
+          #
+          #   @return [Nextbillionai::Models::Skynet::AssetDetails, nil]
+          optional :asset, -> { Nextbillionai::Skynet::AssetDetails }
+
+          # @!method initialize(asset: nil)
+          #   An object containing the information about the asset returned.
+          #
+          #   @param asset [Nextbillionai::Models::Skynet::AssetDetails] An object with details of the asset properties.
+        end
+      end
+    end
+  end
+end