class PlaceOS::Client::APIWrapper::AssetInstances

Included Modules

Defined in:

placeos/api_wrapper/asset_instances.cr

Instance Method Summary

Instance methods inherited from module PlaceOS::Client::APIWrapper::Endpoint::Destroy

destroy(id : String) destroy

Instance methods inherited from module PlaceOS::Client::APIWrapper::Endpoint::Fetch(PlaceOS::Client::API::Models::AssetInstance)

fetch(id : String) fetch

Instance methods inherited from class PlaceOS::Client::APIWrapper::Endpoint

base : String base

Constructor methods inherited from class PlaceOS::Client::APIWrapper::Endpoint

new(client : APIWrapper) new

Macros inherited from class PlaceOS::Client::APIWrapper::Endpoint

delete(path, params = nil, headers = nil, body = nil, as model = nil) delete, get(path, params = nil, headers = nil, body = nil, as model = nil) get, head(path, params = nil, headers = nil, body = nil, as model = nil) head, options(path, params = nil, headers = nil, body = nil, as model = nil) options, patch(path, params = nil, headers = nil, body = nil, as model = nil) patch, post(path, params = nil, headers = nil, body = nil, as model = nil) post, put(path, params = nil, headers = nil, body = nil, as model = nil) put

Instance Method Detail

def base : String #
Description copied from class PlaceOS::Client::APIWrapper::Endpoint

The base route for the endpoint


[View source]
def create(name : String, usage_start : Time, usage_end : Time) #

Creates a new asset instance.


[View source]
def search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0) #

[View source]
def update(id : String, name : String | Nil = nil, purchase_date : Time | Nil = nil, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil) #

Updates asset instance attributes or configuration.


[View source]