class PlaceOS::Client::APIWrapper::Settings

Included Modules

Defined in:

placeos/api_wrapper/settings.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::Settings)

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(parent_id : String, settings_string : String, encryption_level : Encryption::Level = Encryption::Level::Support) #

Create new settings.


[View source]
def search(parent_ids : Array(String)) #

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

List or search for systems.


[View source]
def update(id : String, settings_string : String) #

Update settings.


[View source]