diff --git a/404.html b/404.html new file mode 100644 index 0000000..45347e9 --- /dev/null +++ b/404.html @@ -0,0 +1,557 @@ + + + + + + + + + + + + + + + + + placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ 404 Not Found +

+ +

+ This page is unavailable in this version of the API docs. +

+ +

+ You can use the sidebar to search for your page, or try a different + Crystal version. +

+ +
+ + diff --git a/PlaceOS.html b/PlaceOS.html new file mode 100644 index 0000000..f5b7cdc --- /dev/null +++ b/PlaceOS.html @@ -0,0 +1,753 @@ + + + + + + + + + + + + + + + + + PlaceOS - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + module PlaceOS + +

+ + + + + +

+ + + + Overview +

+ +

Low-level wrapper for the PlaceOS API.

+

Each method maps one-to-one with an API endpoint. All invocations will either +provide a type-safe response object, or raise an PlaceOS::Client::API::Error.

+

It's possible to use this class directly if you require the extra flexibility, +however in most cases the abstractions provided by the higher-level +PlaceOS::Client may be the better choice.

+ + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + lib/placeos-models/src/placeos-models/error.cr + +
+ + + placeos.cr + +
+ + + placeos/api_wrapper.cr + +
+ + + placeos/api_wrapper/api_keys.cr + +
+ + + placeos/api_wrapper/asset_instances.cr + +
+ + + placeos/api_wrapper/assets.cr + +
+ + + placeos/api_wrapper/authority.cr + +
+ + + placeos/api_wrapper/auths/base.cr + +
+ + + placeos/api_wrapper/auths/ldap.cr + +
+ + + placeos/api_wrapper/auths/oauth.cr + +
+ + + placeos/api_wrapper/auths/saml.cr + +
+ + + placeos/api_wrapper/cluster.cr + +
+ + + placeos/api_wrapper/domains.cr + +
+ + + placeos/api_wrapper/drivers.cr + +
+ + + placeos/api_wrapper/endpoint.cr + +
+ + + placeos/api_wrapper/metadata.cr + +
+ + + placeos/api_wrapper/modules.cr + +
+ + + placeos/api_wrapper/oauth_applications.cr + +
+ + + placeos/api_wrapper/repositories.cr + +
+ + + placeos/api_wrapper/root.cr + +
+ + + placeos/api_wrapper/settings.cr + +
+ + + placeos/api_wrapper/system_triggers.cr + +
+ + + placeos/api_wrapper/systems.cr + +
+ + + placeos/api_wrapper/triggers.cr + +
+ + + placeos/api_wrapper/users.cr + +
+ + + placeos/api_wrapper/zones.cr + +
+ + + placeos/client.cr + +
+ + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ + + diff --git a/PlaceOS/Client.html b/PlaceOS/Client.html new file mode 100644 index 0000000..c4b55c2 --- /dev/null +++ b/PlaceOS/Client.html @@ -0,0 +1,1298 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/client.cr + +
+ + + + + +

+ + + + Constant Summary +

+ +
+ +
+ API_ROOT = "/api/engine/v2" +
+ + +
+ AUTH_API_ROOT = "/auth" +
+ + +
+ VERSION = {{ (`shards version \"/__w/crystal-client/crystal-client/src/placeos\"`).chomp.stringify.downcase }} +
+ + +
+ + + +

+ + + + Constructors +

+ + + + +

+ + + + Class Method Summary +

+ + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(base_uri : URI | String, email : String | Nil = nil, password : String | Nil = nil, client_id : String | Nil = nil, client_secret : String | Nil = nil, token : OAuth2::AccessToken | Nil = nil, host_header : String | Nil = nil, insecure : Bool = false, x_api_key : String | Nil = nil) + + # +
+ +
+
+ +
+
+ + + + +

+ + + + Class Method Detail +

+ +
+
+ + def self.from_environment_user + + # +
+ +
+
+ +
+
+ +
+
+ + def self.from_environment_user(&) + + # +
+ +
+
+ +
+
+ + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def api_wrapper : APIWrapper + + # +
+ +
+
+ +
+
+ +
+
+ + def apikeys : APIWrapper::APIKeys + + # +
+ +
+ +

Provide an object for managing APIKeys. See PlaceOS::Client::APIWrapper::APIKeys.

+
+ +
+
+ +
+
+ +
+
+ + def authenticated? + + # +
+ +
+
+ +
+
+ +
+
+ + def authority : APIWrapper::Authority + + # +
+ +
+ +

Provide an object for managing Authority. See PlaceOS::Client::APIWrapper::Authority.

+
+ +
+
+ +
+
+ +
+
+ + def close(*args, **options) + + # +
+ +
+
+ +
+
+ +
+
+ + def close(*args, **options, &) + + # +
+ +
+
+ +
+
+ +
+
+ + def cluster : APIWrapper::Cluster + + # +
+ +
+ +

Provide an object for managing Cluster. See PlaceOS::Client::APIWrapper::Cluster.

+
+ +
+
+ +
+
+ +
+
+ + def domains : APIWrapper::Domains + + # +
+ +
+ +

Provide an object for managing Domains. See PlaceOS::Client::APIWrapper::Domains.

+
+ +
+
+ +
+
+ +
+
+ + def drivers : APIWrapper::Drivers + + # +
+ +
+ +

Provide an object for managing Drivers. See PlaceOS::Client::APIWrapper::Drivers.

+
+ +
+
+ +
+
+ +
+
+ + def ldap : APIWrapper::Ldap + + # +
+ +
+ +

Provide an object for managing Ldap. See PlaceOS::Client::APIWrapper::Ldap.

+
+ +
+
+ +
+
+ +
+
+ + def metadata : APIWrapper::Metadata + + # +
+ +
+ +

Provide an object for managing Metadata. See PlaceOS::Client::APIWrapper::Metadata.

+
+ +
+
+ +
+
+ +
+
+ + def modules : APIWrapper::Modules + + # +
+ +
+ +

Provide an object for managing Modules. See PlaceOS::Client::APIWrapper::Modules.

+
+ +
+
+ +
+
+ +
+
+ + def oauth : APIWrapper::OAuth + + # +
+ +
+ +

Provide an object for managing OAuth. See PlaceOS::Client::APIWrapper::OAuth.

+
+ +
+
+ +
+
+ +
+
+ + def oauthapplications : APIWrapper::OAuthApplications + + # +
+ +
+ +

Provide an object for managing OAuthApplications. See PlaceOS::Client::APIWrapper::OAuthApplications.

+
+ +
+
+ +
+
+ +
+
+ + def root : APIWrapper::Root + + # +
+ +
+ +

Provide an object for managing Root. See PlaceOS::Client::APIWrapper::Root.

+
+ +
+
+ +
+
+ +
+
+ + def saml : APIWrapper::Saml + + # +
+ +
+ +

Provide an object for managing Saml. See PlaceOS::Client::APIWrapper::Saml.

+
+ +
+
+ +
+
+ +
+
+ + def settings : APIWrapper::Settings + + # +
+ +
+ +

Provide an object for managing Settings. See PlaceOS::Client::APIWrapper::Settings.

+
+ +
+
+ +
+
+ +
+
+ + def systems : APIWrapper::Systems + + # +
+ +
+ +

Provide an object for managing Systems. See PlaceOS::Client::APIWrapper::Systems.

+
+ +
+
+ +
+
+ +
+
+ + def uri : URI + + # +
+ +
+
+ +
+
+ +
+
+ + def users : APIWrapper::Users + + # +
+ +
+ +

Provide an object for managing Users. See PlaceOS::Client::APIWrapper::Users.

+
+ +
+
+ +
+
+ +
+
+ + def zones : APIWrapper::Zones + + # +
+ +
+ +

Provide an object for managing Zones. See PlaceOS::Client::APIWrapper::Zones.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API.html b/PlaceOS/Client/API.html new file mode 100644 index 0000000..b2069bf --- /dev/null +++ b/PlaceOS/Client/API.html @@ -0,0 +1,607 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + module PlaceOS::Client::API + +

+ + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/error.cr + +
+ + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ + + diff --git a/PlaceOS/Client/API/Error.html b/PlaceOS/Client/API/Error.html new file mode 100644 index 0000000..1ab3d4b --- /dev/null +++ b/PlaceOS/Client/API/Error.html @@ -0,0 +1,689 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Error - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::API::Error + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/error.cr + +
+ + + + + + + + +

+ + + + Class Method Summary +

+ + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +

+ + + + Class Method Detail +

+ +
+
+ + def self.from_response(response : HTTP::Client::Response) + + # +
+ +
+
+ +
+
+ + + + + + + +
+ + + diff --git a/PlaceOS/Client/API/Models.html b/PlaceOS/Client/API/Models.html new file mode 100644 index 0000000..2442bd3 --- /dev/null +++ b/PlaceOS/Client/API/Models.html @@ -0,0 +1,741 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + module PlaceOS::Client::API::Models + +

+ + + + + + + + + + + + + + + +

+ + + + Direct including types +

+ + + + + +

+ + + + Defined in: +

+ + + placeos/api/models.cr + +
+ + + placeos/api/models/api_key.cr + +
+ + + placeos/api/models/asset.cr + +
+ + + placeos/api/models/asset_instance.cr + +
+ + + placeos/api/models/authority.cr + +
+ + + placeos/api/models/auths/ldap.cr + +
+ + + placeos/api/models/auths/oauth.cr + +
+ + + placeos/api/models/auths/saml.cr + +
+ + + placeos/api/models/cluster.cr + +
+ + + placeos/api/models/driver.cr + +
+ + + placeos/api/models/function.cr + +
+ + + placeos/api/models/metadata.cr + +
+ + + placeos/api/models/module.cr + +
+ + + placeos/api/models/oauth_application.cr + +
+ + + placeos/api/models/ping.cr + +
+ + + placeos/api/models/repository.cr + +
+ + + placeos/api/models/response.cr + +
+ + + placeos/api/models/role.cr + +
+ + + placeos/api/models/settings.cr + +
+ + + placeos/api/models/system.cr + +
+ + + placeos/api/models/trigger.cr + +
+ + + placeos/api/models/trigger_instance.cr + +
+ + + placeos/api/models/user.cr + +
+ + + placeos/api/models/version.cr + +
+ + + placeos/api/models/zone.cr + +
+ + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ + + diff --git a/PlaceOS/Client/API/Models/APIKey.html b/PlaceOS/Client/API/Models/APIKey.html new file mode 100644 index 0000000..538b33d --- /dev/null +++ b/PlaceOS/Client/API/Models/APIKey.html @@ -0,0 +1,1032 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::APIKey - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::APIKey + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/api_key.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

Instance methods inherited from module PlaceOS::Client::API::Models::Timestamps

+ + + + created_at : Time + created_at, + + + + updated_at : Time + updated_at + + + + + + + + + + + + + + + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def authority : Authority + + # +
+ +
+
+ +
+
+ +
+
+ + def authority_id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def description : String | Nil + + # +
+ +
+ +

Markdown formatted text that describes the zone.

+
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+ +

A universally unique identifier for the zone.

+
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+ +

A human readable identifier.

+
+ +
+
+ +
+
+ +
+
+ + def permissions : PlaceOS::Model::UserJWT::Permissions + + # +
+ +
+ +

The permission level of the user

+
+ +
+
+ +
+
+ +
+
+ + def scopes : Array(String) + + # +
+ +
+ +

API scopes

+
+ +
+
+ +
+
+ +
+
+ + def user : User + + # +
+ +
+
+ +
+
+ +
+
+ + def user_id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def x_api_key : String + + # +
+ +
+ +

The auth key, only returned on create

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Asset.html b/PlaceOS/Client/API/Models/Asset.html new file mode 100644 index 0000000..c8c8cce --- /dev/null +++ b/PlaceOS/Client/API/Models/Asset.html @@ -0,0 +1,1086 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Asset - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Asset + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/asset.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def brand : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def category : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def description : String | Nil + + # +
+ +
+ +

Markdown formatted text that describes the asset.

+
+ +
+
+ +
+
+ +
+
+ + def good_until_date : Time | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+ +

A universally unique identifier for the Asset.

+
+ +
+
+ +
+
+ +
+
+ + def identifier : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def images : Array(String) + + # +
+ +
+ +

Array of URLs to images for an asset

+
+ +
+
+ +
+
+ +
+
+ + def in_use : Int32 + + # +
+ +
+
+ +
+
+ +
+
+ + def invoice : String | Nil + + # +
+ +
+ +

URL of downloadable receipt

+
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+ +

A human readable identifier.

+
+ +
+
+ +
+
+ +
+
+ + def other_data : JSON::Any + + # +
+ +
+
+ +
+
+ +
+
+ + def parent_id : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def purchase_date : Time + + # +
+ +
+
+ +
+
+ +
+
+ + def purchase_price : Int32 | Nil + + # +
+ +
+ +

TODO define currency for #purchase_price

+
+ +
+
+ +
+
+ +
+
+ + def quantity : Int32 + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/AssetInstance.html b/PlaceOS/Client/API/Models/AssetInstance.html new file mode 100644 index 0000000..79d807b --- /dev/null +++ b/PlaceOS/Client/API/Models/AssetInstance.html @@ -0,0 +1,937 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::AssetInstance - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::AssetInstance + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/asset_instance.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def approval : Bool + + # +
+ +
+
+ +
+
+ +
+
+ + def asset_id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+ +

A universally unique identifier for the Asset.

+
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+
+ +
+
+ +
+
+ + def requester_id : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def tracking : Tracking + + # +
+ +
+
+ +
+
+ +
+
+ + def usage_end : Time | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def usage_start : Time | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def zone_id : String | Nil + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/AssetInstance/Tracking.html b/PlaceOS/Client/API/Models/AssetInstance/Tracking.html new file mode 100644 index 0000000..9b29802 --- /dev/null +++ b/PlaceOS/Client/API/Models/AssetInstance/Tracking.html @@ -0,0 +1,791 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::AssetInstance::Tracking - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + enum PlaceOS::Client::API::Models::AssetInstance::Tracking + +

+ + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/asset_instance.cr + +
+ + + + + +

+ + + + Enum Members +

+ +
+ +
+ InStorage = 0 +
+ + +
+ OnTheWay = 1 +
+ + +
+ InRoom = 2 +
+ + +
+ Returned = 3 +
+ + +
+ + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def in_room? + + # +
+ +
+
+ +
+
+ +
+
+ + def in_storage? + + # +
+ +
+
+ +
+
+ +
+
+ + def on_the_way? + + # +
+ +
+
+ +
+
+ +
+
+ + def returned? + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Authority.html b/PlaceOS/Client/API/Models/Authority.html new file mode 100644 index 0000000..ecb85f5 --- /dev/null +++ b/PlaceOS/Client/API/Models/Authority.html @@ -0,0 +1,989 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Authority - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Authority + +

+ + + + + + + +

+ + + + Overview +

+ +

Metadata about the PlaceOS instance connected to.

+

This provides information that may be of relevance for authentication or +providing client-side configuration information.

+ + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/authority.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+ +

Metadata about the PlaceOS instance connected to.

+

This provides information that may be of relevance for authentication or +providing client-side configuration information.

+
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def config : Hash(String, JSON::Any) + + # +
+ +
+ +

Additional configuration / context for clients.

+
+ +
+
+ +
+
+ +
+
+ + def description : String | Nil + + # +
+ +
+ +

Authority description (markdown).

+
+ +
+
+ +
+
+ +
+
+ + def domain : String + + # +
+ +
+ +

FQDN or IP address this authority serves.

+
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+ +

A universally unique identifier that represents the Authority.

+
+ +
+
+ +
+
+ +
+
+ + def login_url : String + + # +
+ +
+ +

Path that clients should use for initiating authentication.

+
+ +
+
+ +
+
+ +
+
+ + def logout_url : String + + # +
+ +
+ +

Path that clients should use for revoking authentication.

+
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+ +

Human readable name

+
+ +
+
+ +
+
+ +
+
+ + def version : String + + # +
+ +
+ +

Version of application

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Cluster.html b/PlaceOS/Client/API/Models/Cluster.html new file mode 100644 index 0000000..2a251c8 --- /dev/null +++ b/PlaceOS/Client/API/Models/Cluster.html @@ -0,0 +1,737 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Cluster - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Cluster + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/cluster.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Driver.html b/PlaceOS/Client/API/Models/Driver.html new file mode 100644 index 0000000..4068ea2 --- /dev/null +++ b/PlaceOS/Client/API/Models/Driver.html @@ -0,0 +1,1024 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Driver - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Driver + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/driver.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

Instance methods inherited from module PlaceOS::Client::API::Models::Timestamps

+ + + + created_at : Time + created_at, + + + + updated_at : Time + updated_at + + + + + + + + + + + + + + + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def commit : String + + # +
+ +
+
+ +
+
+ +
+
+ + def default_port : Int32 | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def default_uri : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def description : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def file_name : String + + # +
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def ignore_connected : Bool + + # +
+ +
+ +

Don't include this module in statistics or disconnected searches +Might be a device that commonly goes offline (like a PC or Display that only supports Wake on Lan)

+
+ +
+
+ +
+
+ +
+
+ + def module_name : String + + # +
+ +
+ +

Module instance configuration

+
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+
+ +
+
+ +
+
+ + def repository_id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def role : Role + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Function.html b/PlaceOS/Client/API/Models/Function.html new file mode 100644 index 0000000..4a9b2c4 --- /dev/null +++ b/PlaceOS/Client/API/Models/Function.html @@ -0,0 +1,829 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Function - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Function + +

+ + + + + + + +

+ + + + Overview +

+ +

Invocation information for interaction with an exposed driver behaviour.

+ + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/function.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+ +

Invocation information for interaction with an exposed driver behaviour.

+
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def arity : Int32 + + # +
+ +
+ +

The number of parameters that the function accepts.

+
+ +
+
+ +
+
+ +
+
+ + def params : Array(Parameter) + + # +
+ +
+ +

Parameter information.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Function/Parameter.html b/PlaceOS/Client/API/Models/Function/Parameter.html new file mode 100644 index 0000000..2884ce5 --- /dev/null +++ b/PlaceOS/Client/API/Models/Function/Parameter.html @@ -0,0 +1,628 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Function::Parameter - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + alias PlaceOS::Client::API::Models::Function::Parameter + +

+ + + + + +

+ + + + Overview +

+ +

Parameter information as {kind, name}.

+ + + +

+ + + + Alias Definition +

+ {PlaceOS::Client::API::Models::Function::ParameterKind, String} + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/function.cr + +
+ + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Function/ParameterKind.html b/PlaceOS/Client/API/Models/Function/ParameterKind.html new file mode 100644 index 0000000..775f0c1 --- /dev/null +++ b/PlaceOS/Client/API/Models/Function/ParameterKind.html @@ -0,0 +1,790 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Function::ParameterKind - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + enum PlaceOS::Client::API::Models::Function::ParameterKind + +

+ + + + + +

+ + + + Overview +

+ +

Possible parameter kinds.

+ + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/function.cr + +
+ + + + + +

+ + + + Enum Members +

+ +
+ +
+ Req = 0 +
+ +
+

Required

+
+ + +
+ Opt = 1 +
+ +
+

Optional

+
+ + +
+ Rest = 2 +
+ +
+

A capture all for all trailing arguments.

+
+ + +
+ + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def opt? + + # +
+ +
+
+ +
+
+ +
+
+ + def req? + + # +
+ +
+
+ +
+
+ +
+
+ + def rest? + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/LdapAuthentication.html b/PlaceOS/Client/API/Models/LdapAuthentication.html new file mode 100644 index 0000000..3d0b126 --- /dev/null +++ b/PlaceOS/Client/API/Models/LdapAuthentication.html @@ -0,0 +1,1038 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::LdapAuthentication - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::LdapAuthentication + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/auths/ldap.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

Instance methods inherited from module PlaceOS::Client::API::Models::Timestamps

+ + + + created_at : Time + created_at, + + + + updated_at : Time + updated_at + + + + + + + + + + + + + + + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def auth_method : String + + # +
+ +
+ +

Options are: plain, ssl, tls

+
+ +
+
+ +
+
+ +
+
+ + def authority_id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def base : String + + # +
+ +
+ +

BaseDN such as dc=intridea, dc=com

+
+ +
+
+ +
+
+ +
+
+ + def bind_dn : String + + # +
+ +
+ +

:bind_dn and :password is the default credentials to perform user lookup

+
+ +
+
+ +
+
+ +
+
+ + def filter : String + + # +
+ +
+ +

LDAP filter like: (&(uid=%{username})(memberOf=cn=myapp-users,ou=groups,dc=example,dc=com)) +Can be used instead of UID

+
+ +
+
+ +
+
+ +
+
+ + def host : String + + # +
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+
+ +
+
+ +
+
+ + def password : String + + # +
+ +
+
+ +
+
+ +
+
+ + def port : Int32 + + # +
+ +
+
+ +
+
+ +
+
+ + def uid : String + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Metadata.html b/PlaceOS/Client/API/Models/Metadata.html new file mode 100644 index 0000000..f781547 --- /dev/null +++ b/PlaceOS/Client/API/Models/Metadata.html @@ -0,0 +1,892 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Metadata - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Metadata + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/metadata.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def description : String + + # +
+ +
+
+ +
+
+ +
+
+ + def details : JSON::Any + + # +
+ +
+
+ +
+
+ +
+
+ + def editors : Array(String) | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def modified_by_id : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+
+ +
+
+ +
+
+ + def parent_id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def schema_id : String | Nil + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Module.html b/PlaceOS/Client/API/Models/Module.html new file mode 100644 index 0000000..af03ce4 --- /dev/null +++ b/PlaceOS/Client/API/Models/Module.html @@ -0,0 +1,1219 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Module - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Module + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/module.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

Instance methods inherited from module PlaceOS::Client::API::Models::Timestamps

+ + + + created_at : Time + created_at, + + + + updated_at : Time + updated_at + + + + + + + + + + + + + + + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def connected : Bool + + # +
+ +
+ +

Flag for connectivity state.

+
+ +
+
+ +
+
+ +
+
+ + def control_sytem_id : String | Nil + + # +
+ +
+ +

The system this module is bound to (logic modules only).

+
+ +
+
+ +
+
+ +
+
+ + def custom_name : String | Nil + + # +
+ +
+ +

The modules class name (Display, Lighting etc) if it should differ from the +default defined in the driver.

+
+ +
+
+ +
+
+ +
+
+ + def driver_id : String + + # +
+ +
+ +

The driver that defines this module.

+
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+ +

A universally unique identifier for the module.

+
+ +
+
+ +
+
+ +
+
+ + def ignore_connected : Bool + + # +
+ +
+ +

If enabled, system metrics ignore connectivity state.

+
+ +
+
+ +
+
+ +
+
+ + def ignore_startstop : Bool + + # +
+ +
+ +

If enabled, system level start and stop actions are ignored. This is +recommended for modules shared by many systems (e.g. a lighting gateway).

+
+ +
+
+ +
+
+ +
+
+ + def ip : String | Nil + + # +
+ +
+ +

IP address or resolvable hostname of the device this module connects to.

+
+ +
+
+ +
+
+ +
+
+ + def makebreak : Bool + + # +
+ +
+ +

If enabled, provides an ephemeral connection that disconnects during idle +periods.

+
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+ +

Driver's default name for the module

+
+ +
+
+ +
+
+ +
+
+ + def port : Int32 | Nil + + # +
+ +
+ +

The TCP or UDP port that the associated device communicates on.

+
+ +
+
+ +
+
+ +
+
+ + def role : Role + + # +
+ +
+ +

The associated driver type.

+
+ +
+
+ +
+
+ +
+
+ + def running : Bool + + # +
+ +
+ +

Module start/stop state.

+
+ +
+
+ +
+
+ +
+
+ + def tls : Bool | Nil + + # +
+ +
+ +

True if the device communicates securely.

+
+ +
+
+ +
+
+ +
+
+ + def udp : Bool | Nil + + # +
+ +
+ +

Protocol uses UDP rather that TCP.

+
+ +
+
+ +
+
+ +
+
+ + def uri : URI | Nil + + # +
+ +
+ +

The based URI of the remote service (service modules only).

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/OAuthApplication.html b/PlaceOS/Client/API/Models/OAuthApplication.html new file mode 100644 index 0000000..e344e61 --- /dev/null +++ b/PlaceOS/Client/API/Models/OAuthApplication.html @@ -0,0 +1,990 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::OAuthApplication - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::OAuthApplication + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/oauth_application.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

Instance methods inherited from module PlaceOS::Client::API::Models::Timestamps

+ + + + created_at : Time + created_at, + + + + updated_at : Time + updated_at + + + + + + + + + + + + + + + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def confidential : Bool + + # +
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+
+ +
+
+ +
+
+ + def owner_id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def redirect_uri : String + + # +
+ +
+
+ +
+
+ +
+
+ + def revoked_at : Time + + # +
+ +
+
+ +
+
+ +
+
+ + def scopes : String + + # +
+ +
+
+ +
+
+ +
+
+ + def secret : String + + # +
+ +
+
+ +
+
+ +
+
+ + def skip_authorization : Bool + + # +
+ +
+
+ +
+
+ +
+
+ + def uid : String + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/OAuthAuthentication.html b/PlaceOS/Client/API/Models/OAuthAuthentication.html new file mode 100644 index 0000000..de336f6 --- /dev/null +++ b/PlaceOS/Client/API/Models/OAuthAuthentication.html @@ -0,0 +1,1112 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::OAuthAuthentication - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::OAuthAuthentication + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/auths/oauth.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

Instance methods inherited from module PlaceOS::Client::API::Models::Timestamps

+ + + + created_at : Time + created_at, + + + + updated_at : Time + updated_at + + + + + + + + + + + + + + + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def auth_scheme : String + + # +
+ +
+ +

If not set it defaults to "request_body", others include "basic_auth"

+
+ +
+
+ +
+
+ +
+
+ + def authority_id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def authorize_url : String + + # +
+ +
+ +

The SSO providers URL for authorization, defaults to: oauth/authorize +Google is /o/oauth2/auth

+
+ +
+
+ +
+
+ +
+
+ + def client_id : String + + # +
+ +
+ +

The client ID and secret configured for this application

+
+ +
+
+ +
+
+ +
+
+ + def client_secret : String + + # +
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def info_mappings : Hash(String, String) + + # +
+ +
+ +

Maps an expected key to a provided key i.e. {used_in_engine => used_by_remote}

+
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+
+ +
+
+ +
+
+ + def raw_info_url : String + + # +
+ +
+ +

URL to call with a valid token to obtain the users profile data (name, email etc)

+
+ +
+
+ +
+
+ +
+
+ + def scope : String + + # +
+ +
+ +

Space seperated scope strings +i.e. https://www.googleapis.com/auth/devstorage.readonly https://www.googleapis.com/auth/prediction

+
+ +
+
+ +
+
+ +
+
+ + def site : String + + # +
+ +
+ +

The HTTP URL of the SSO provider

+
+ +
+
+ +
+
+ +
+
+ + def token_method : String + + # +
+ +
+ +

If not set it defaults to "post"

+
+ +
+
+ +
+
+ +
+
+ + def token_url : String + + # +
+ +
+ +

defaults to: oauth/token however google is: /o/oauth2/token

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Ping.html b/PlaceOS/Client/API/Models/Ping.html new file mode 100644 index 0000000..4676360 --- /dev/null +++ b/PlaceOS/Client/API/Models/Ping.html @@ -0,0 +1,835 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Ping - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Ping + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/ping.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def exception : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def host : String + + # +
+ +
+
+ +
+
+ +
+
+ + def pingable : Bool + + # +
+ +
+
+ +
+
+ +
+
+ + def warning : String | Nil + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Repository.html b/PlaceOS/Client/API/Models/Repository.html new file mode 100644 index 0000000..8b8d951 --- /dev/null +++ b/PlaceOS/Client/API/Models/Repository.html @@ -0,0 +1,737 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Repository - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Repository + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/repository.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + + +
+ + + diff --git a/PlaceOS/Client/API/Models/ResourceToken.html b/PlaceOS/Client/API/Models/ResourceToken.html new file mode 100644 index 0000000..593a71c --- /dev/null +++ b/PlaceOS/Client/API/Models/ResourceToken.html @@ -0,0 +1,797 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::ResourceToken - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::ResourceToken + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/user.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def expires : Int64 | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def token : String + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Role.html b/PlaceOS/Client/API/Models/Role.html new file mode 100644 index 0000000..26651ee --- /dev/null +++ b/PlaceOS/Client/API/Models/Role.html @@ -0,0 +1,617 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Role - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + alias PlaceOS::Client::API::Models::Role + +

+ + + + + + + +

+ + + + Alias Definition +

+ PlaceOS::Model::Driver::Role + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/role.cr + +
+ + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ + + diff --git a/PlaceOS/Client/API/Models/SamlAuthentication.html b/PlaceOS/Client/API/Models/SamlAuthentication.html new file mode 100644 index 0000000..15efb00 --- /dev/null +++ b/PlaceOS/Client/API/Models/SamlAuthentication.html @@ -0,0 +1,1196 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::SamlAuthentication - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::SamlAuthentication + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/auths/saml.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

Instance methods inherited from module PlaceOS::Client::API::Models::Timestamps

+ + + + created_at : Time + created_at, + + + + updated_at : Time + updated_at + + + + + + + + + + + + + + + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def assertion_consumer_service_url : String + + # +
+ +
+ +

The URL at which the SAML assertion should be received (SSO Service => Engine URL)

+
+ +
+
+ +
+
+ +
+
+ + def authority_id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def getter_service_name : String + + # +
+ +
+ +

Name for the getter service (Defaults to Required getters)

+
+ +
+
+ +
+
+ +
+
+ + def getter_statements : Hash(String, Array(String)) + + # +
+ +
+ +

Used to map getter Names in a SAMLResponse to entries in the OmniAuth info hash

+
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def idp_cert : String + + # +
+ +
+ +

The identity provider's certificate in PEM format (this or fingerprint is required)

+
+ +
+
+ +
+
+ +
+
+ + def idp_cert_fingerprint : String + + # +
+ +
+ +

The SHA1 fingerprint of the certificate

+
+ +
+
+ +
+
+ +
+
+ + def idp_slo_target_url : String + + # +
+ +
+ +

The URL to which the single logout request and response should be sent

+
+ +
+
+ +
+
+ +
+
+ + def idp_sso_target_url : String + + # +
+ +
+ +

The URL to which the authentication request should be sent (Engine => SSO Service)

+
+ +
+
+ +
+
+ +
+
+ + def idp_sso_target_url_runtime_params : Hash(String, String) + + # +
+ +
+ +

mapping of request params that exist during the request phase of OmniAuth that should to be sent to the IdP

+
+ +
+
+ +
+
+ +
+
+ + def issuer : String + + # +
+ +
+ +

The name of your application

+
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+
+ +
+
+ +
+
+ + def name_identifier_format : String + + # +
+ +
+ +

Describes the format of the username required by this application

+
+ +
+
+ +
+
+ +
+
+ + def request_getters : Array(NamedTuple(name: String, name_format: String, friendly_name: String)) + + # +
+ +
+ +

Used to map getter Names in a SAMLResponse to entries in the OmniAuth info hash

+
+ +
+
+ +
+
+ +
+
+ + def slo_default_relay_state : String + + # +
+ +
+ +

The value to use as default RelayState for single log outs

+
+ +
+
+ +
+
+ +
+
+ + def uid_getter : String + + # +
+ +
+ +

getter that uniquely identifies the user +(If unset, the name identifier returned by the IdP is used.)

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Settings.html b/PlaceOS/Client/API/Models/Settings.html new file mode 100644 index 0000000..3359e52 --- /dev/null +++ b/PlaceOS/Client/API/Models/Settings.html @@ -0,0 +1,873 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Settings - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Settings + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/settings.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def encryption_level : Encryption::Level + + # +
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def keys : Array(String) + + # +
+ +
+
+ +
+
+ +
+
+ + def parent_id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def parent_type : String + + # +
+ +
+
+ +
+
+ +
+
+ + def settings_string : String + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/System.html b/PlaceOS/Client/API/Models/System.html new file mode 100644 index 0000000..a49cc1b --- /dev/null +++ b/PlaceOS/Client/API/Models/System.html @@ -0,0 +1,1294 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::System - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::System + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/system.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

Instance methods inherited from module PlaceOS::Client::API::Models::Timestamps

+ + + + created_at : Time + created_at, + + + + updated_at : Time + updated_at + + + + + + + + + + + + + + + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def bookable : Bool + + # +
+ +
+ +

Flag for signifying the space as reservable.

+
+ +
+
+ +
+
+ +
+
+ + def capacity : Int32 + + # +
+ +
+ +

Number of people that can be accommodated in this space.

+
+ +
+
+ +
+
+ +
+
+ + def code : String | Nil + + # +
+ +
+ +

the room identification code, like 3-04 etc.

+
+ +
+
+ +
+
+ +
+
+ + def description : String | Nil + + # +
+ +
+ +

Markdown formatted text that describes the system.

+
+ +
+
+ +
+
+ +
+
+ + def display_name : String | Nil + + # +
+ +
+ +

an alternative to the full name that is easier to read.

+
+ +
+
+ +
+
+ +
+
+ + def email : String | Nil + + # +
+ +
+ +

Calendar URI that is associated with this system.

+
+ +
+
+ +
+
+ +
+
+ + def features : Set(String) + + # +
+ +
+ +

List of features in the room for searching and filtering spaces.

+
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+ +

A universally unique identifier for the system.

+
+ +
+
+ +
+
+ +
+
+ + def images : Array(String) | Nil + + # +
+ +
+ +

images of this room

+
+ +
+
+ +
+
+ +
+
+ + def installed_ui_devices : Int32 + + # +
+ +
+ +

Expected number of fixed installation touch panels.

+
+ +
+
+ +
+
+ +
+
+ + def map_id : String | Nil + + # +
+ +
+ +

a map identifier that can be used to locate this system.

+
+ +
+
+ +
+
+ +
+
+ + def modules : Array(String) + + # +
+ +
+ +

Module ID's that this system contains.

+
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+ +

A human readable identifier.

+
+ +
+
+ +
+
+ +
+
+ + def public : Bool | Nil + + # +
+ +
+ +

is the system intended for public access?

+
+ +
+
+ +
+
+ +
+
+ + def support_url : String | Nil + + # +
+ +
+ +

A URL linking to the primary interface for controlling this system.

+
+ +
+
+ +
+
+ +
+
+ + def timezone : String | Nil + + # +
+ +
+ +

timezone the system is located

+
+ +
+
+ +
+
+ +
+
+ + def type : String | Nil + + # +
+ +
+ +

the system type, like a small meeting room etc.

+
+ +
+
+ +
+
+ +
+
+ + def version : Int32 + + # +
+ +
+ +

Incrementing counter for handling stale updates.

+
+ +
+
+ +
+
+ +
+
+ + def zones : Array(String) + + # +
+ +
+ +

Zone IDs that this system is a member of.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Timestamps.html b/PlaceOS/Client/API/Models/Timestamps.html new file mode 100644 index 0000000..f39dce4 --- /dev/null +++ b/PlaceOS/Client/API/Models/Timestamps.html @@ -0,0 +1,711 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Timestamps - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + module PlaceOS::Client::API::Models::Timestamps + +

+ + + + + + + + + + + + + + + +

+ + + + Direct including types +

+ + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/response.cr + +
+ + + + + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ +
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def created_at : Time + + # +
+ +
+ +

Creation time.

+
+ +
+
+ +
+
+ +
+
+ + def updated_at : Time + + # +
+ +
+ +

Update time.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Trigger.html b/PlaceOS/Client/API/Models/Trigger.html new file mode 100644 index 0000000..34b222c --- /dev/null +++ b/PlaceOS/Client/API/Models/Trigger.html @@ -0,0 +1,937 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Trigger - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Trigger + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/trigger.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def actions : Actions + + # +
+ +
+
+ +
+
+ +
+
+ + def conditions : Conditions + + # +
+ +
+
+ +
+
+ +
+
+ + def control_system_id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def debounce_period : Int32 + + # +
+ +
+ +

In milliseconds

+
+ +
+
+ +
+
+ +
+
+ + def description : String + + # +
+ +
+
+ +
+
+ +
+
+ + def enable_webhook : Bool + + # +
+ +
+
+ +
+
+ +
+
+ + def important : Bool + + # +
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+
+ +
+
+ +
+
+ + def supported_methods : Array(String) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Trigger/Actions.html b/PlaceOS/Client/API/Models/Trigger/Actions.html new file mode 100644 index 0000000..ded2269 --- /dev/null +++ b/PlaceOS/Client/API/Models/Trigger/Actions.html @@ -0,0 +1,797 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Trigger::Actions - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Trigger::Actions + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/trigger.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def functions : Array(Function) + + # +
+ +
+
+ +
+
+ +
+
+ + def mailers : Array(Email) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Trigger/Actions/Email.html b/PlaceOS/Client/API/Models/Trigger/Actions/Email.html new file mode 100644 index 0000000..e5da868 --- /dev/null +++ b/PlaceOS/Client/API/Models/Trigger/Actions/Email.html @@ -0,0 +1,797 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Trigger::Actions::Email - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Trigger::Actions::Email + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/trigger.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def content : String + + # +
+ +
+
+ +
+
+ +
+
+ + def emails : Array(String) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Trigger/Actions/Function.html b/PlaceOS/Client/API/Models/Trigger/Actions/Function.html new file mode 100644 index 0000000..2367e65 --- /dev/null +++ b/PlaceOS/Client/API/Models/Trigger/Actions/Function.html @@ -0,0 +1,816 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Trigger::Actions::Function - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Trigger::Actions::Function + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/trigger.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def args : Hash(String, JSON::Any) + + # +
+ +
+
+ +
+
+ +
+
+ + def method : String + + # +
+ +
+
+ +
+
+ +
+
+ + def mod : String + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Trigger/Conditions.html b/PlaceOS/Client/API/Models/Trigger/Conditions.html new file mode 100644 index 0000000..33362da --- /dev/null +++ b/PlaceOS/Client/API/Models/Trigger/Conditions.html @@ -0,0 +1,797 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Trigger::Conditions - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Trigger::Conditions + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/trigger.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def comparisons : Array(Comparison) + + # +
+ +
+
+ +
+
+ +
+
+ + def time_dependents : Array(TimeDependent) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison.html b/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison.html new file mode 100644 index 0000000..6f2b55e --- /dev/null +++ b/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison.html @@ -0,0 +1,835 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Trigger::Conditions::Comparison - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Trigger::Conditions::Comparison + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/trigger.cr + +
+ + + + + +

+ + + + Constant Summary +

+ +
+ +
+ OPERATORS = {"equal", "not_equal", "greater_than", "greater_than_or_equal", "less_than", "less_than_or_equal", "and", "or", "exclusive_or"} +
+ + +
+ + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def left : Value + + # +
+ +
+
+ +
+
+ +
+
+ + def operator : String + + # +
+ +
+
+ +
+
+ +
+
+ + def right : Value + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Constant.html b/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Constant.html new file mode 100644 index 0000000..118fb84 --- /dev/null +++ b/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Constant.html @@ -0,0 +1,628 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Trigger::Conditions::Comparison::Constant - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + alias PlaceOS::Client::API::Models::Trigger::Conditions::Comparison::Constant + +

+ + + + + +

+ + + + Overview +

+ +

Constant value

+ + + +

+ + + + Alias Definition +

+ Bool | Float64 | Int64 | String + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/trigger.cr + +
+ + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/StatusVariable.html b/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/StatusVariable.html new file mode 100644 index 0000000..5304b3f --- /dev/null +++ b/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/StatusVariable.html @@ -0,0 +1,628 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Trigger::Conditions::Comparison::StatusVariable - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + alias PlaceOS::Client::API::Models::Trigger::Conditions::Comparison::StatusVariable + +

+ + + + + +

+ + + + Overview +

+ +

Status of a Module

+ + + +

+ + + + Alias Definition +

+ {mod: String, status: String, keys: Array(String)} + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/trigger.cr + +
+ + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Value.html b/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Value.html new file mode 100644 index 0000000..8bf1d35 --- /dev/null +++ b/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Value.html @@ -0,0 +1,617 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Trigger::Conditions::Comparison::Value - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + alias PlaceOS::Client::API::Models::Trigger::Conditions::Comparison::Value + +

+ + + + + + + +

+ + + + Alias Definition +

+ Bool | Float64 | Int64 | {mod: String, status: String, keys: Array(String)} | String + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/trigger.cr + +
+ + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent.html b/PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent.html new file mode 100644 index 0000000..90ffa0f --- /dev/null +++ b/PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent.html @@ -0,0 +1,816 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Trigger::Conditions::TimeDependent - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Trigger::Conditions::TimeDependent + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/trigger.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def cron : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def time : Time | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def type : Type + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent/Type.html b/PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent/Type.html new file mode 100644 index 0000000..7850e52 --- /dev/null +++ b/PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent/Type.html @@ -0,0 +1,743 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Trigger::Conditions::TimeDependent::Type - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + enum PlaceOS::Client::API::Models::Trigger::Conditions::TimeDependent::Type + +

+ + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/trigger.cr + +
+ + + + + +

+ + + + Enum Members +

+ +
+ +
+ At = 0 +
+ + +
+ Cron = 1 +
+ + +
+ + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def at? + + # +
+ +
+
+ +
+
+ +
+
+ + def cron? + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/TriggerInstance.html b/PlaceOS/Client/API/Models/TriggerInstance.html new file mode 100644 index 0000000..662b21d --- /dev/null +++ b/PlaceOS/Client/API/Models/TriggerInstance.html @@ -0,0 +1,930 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::TriggerInstance - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::TriggerInstance + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/trigger_instance.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def control_system_id : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def enabled : Bool + + # +
+ +
+
+ +
+
+ +
+
+ + def exec_enabled : Bool + + # +
+ +
+
+ +
+
+ +
+
+ + def important : Bool + + # +
+ +
+
+ +
+
+ +
+
+ + def trigger_count : Int32 + + # +
+ +
+
+ +
+
+ +
+
+ + def trigger_id : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def triggered : Bool + + # +
+ +
+
+ +
+
+ +
+
+ + def webhook_secret : String + + # +
+ +
+
+ +
+
+ +
+
+ + def zone_id : String | Nil + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/User.html b/PlaceOS/Client/API/Models/User.html new file mode 100644 index 0000000..1ea0bc4 --- /dev/null +++ b/PlaceOS/Client/API/Models/User.html @@ -0,0 +1,1316 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::User - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::User + +

+ + + + + + + +

+ + + + Overview +

+ +

Metadata about the current user

+ + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/user.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+ +

Metadata about the current user

+
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def associated_metadata : Hash(String, Metadata) | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def authority_id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def building : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def card_number : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def country : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def created_at : Time + + # +
+ +
+
+ +
+
+ +
+
+ + def deleted : Bool | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def department : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def email : String + + # +
+ +
+
+ +
+
+ +
+
+ + def email_digest : String + + # +
+ +
+
+ +
+
+ +
+
+ + def first_name : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def groups : Array(String) | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+
+ +
+
+ +
+
+ + def image : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def last_name : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def login_name : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def metadata : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def misc : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+
+ +
+
+ +
+
+ + def nickname : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def phone : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def preferred_language : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def staff_id : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def support : Bool | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def sys_admin : Bool | Nil + + # +
+ +
+ +

Admin only fields

+
+ +
+
+ +
+
+ +
+
+ + def ui_theme : String | Nil + + # +
+ +
+
+ +
+
+ +
+
+ + def work_overrides : Hash(String, PlaceOS::Model::User::WorktimePreference) + + # +
+ +
+
+ +
+
+ +
+
+ + def work_preferences : Array(PlaceOS::Model::User::WorktimePreference) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Version.html b/PlaceOS/Client/API/Models/Version.html new file mode 100644 index 0000000..3da4be5 --- /dev/null +++ b/PlaceOS/Client/API/Models/Version.html @@ -0,0 +1,863 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Version - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Version + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/version.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def app : String + + # +
+ +
+ +

The PlaceOS application name

+
+ +
+
+ +
+
+ +
+
+ + def build_time : String + + # +
+ +
+ +

The build time of the docker container

+
+ +
+
+ +
+
+ +
+
+ + def commit : String + + # +
+ +
+ +

the commit hash for the running build

+
+ +
+
+ +
+
+ +
+
+ + def version : String + + # +
+ +
+ +

The version in the shard yml

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Websocket.html b/PlaceOS/Client/API/Models/Websocket.html new file mode 100644 index 0000000..93bf7d6 --- /dev/null +++ b/PlaceOS/Client/API/Models/Websocket.html @@ -0,0 +1,607 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Websocket - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + module PlaceOS::Client::API::Models::Websocket + +

+ + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/websocket/request.cr + +
+ + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Websocket/Request.html b/PlaceOS/Client/API/Models/Websocket/Request.html new file mode 100644 index 0000000..dccfe2f --- /dev/null +++ b/PlaceOS/Client/API/Models/Websocket/Request.html @@ -0,0 +1,921 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Websocket::Request - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Websocket::Request + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/websocket/request.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def args : Array(JSON::Any::Type) | Nil + + # +
+ +
+ +

Associated arguments for the command.

+
+ +
+
+ +
+
+ +
+
+ + def cmd : Type + + # +
+ +
+ +

The command type.

+
+ +
+
+ +
+
+ +
+
+ + def id : String | Int32 | Int64 + + # +
+ +
+ +

A unique identifier to associate with the command. This will be returned as +part of the response.

+
+ +
+
+ +
+
+ +
+
+ + def index : Int32 | Nil + + # +
+ +
+ +

The module index the command targets. Defaults to 1.

+
+ +
+
+ +
+
+ +
+
+ + def mod : String + + # +
+ +
+ +

The module name the command targets.

+
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+ +

Name of the status variable of method being interacted with.

+
+ +
+
+ +
+
+ +
+
+ + def sys : String + + # +
+ +
+ +

The system identified the command targets.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Websocket/Request/Type.html b/PlaceOS/Client/API/Models/Websocket/Request/Type.html new file mode 100644 index 0000000..280f8de --- /dev/null +++ b/PlaceOS/Client/API/Models/Websocket/Request/Type.html @@ -0,0 +1,815 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Websocket::Request::Type - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + enum PlaceOS::Client::API::Models::Websocket::Request::Type + +

+ + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/websocket/request.cr + +
+ + + + + +

+ + + + Enum Members +

+ +
+ +
+ Bind = 0 +
+ + +
+ Unbind = 1 +
+ + +
+ Exec = 2 +
+ + +
+ Debug = 3 +
+ + +
+ Ignore = 4 +
+ + +
+ + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def bind? + + # +
+ +
+
+ +
+
+ +
+
+ + def debug? + + # +
+ +
+
+ +
+
+ +
+
+ + def exec? + + # +
+ +
+
+ +
+
+ +
+
+ + def ignore? + + # +
+ +
+
+ +
+
+ +
+
+ + def unbind? + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Websocket/Response.html b/PlaceOS/Client/API/Models/Websocket/Response.html new file mode 100644 index 0000000..e67ebb2 --- /dev/null +++ b/PlaceOS/Client/API/Models/Websocket/Response.html @@ -0,0 +1,781 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Websocket::Response - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Websocket::Response + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/websocket/response.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + +

+ + + + Class Method Summary +

+ + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new + + # +
+ +
+
+ +
+
+ + + + +

+ + + + Class Method Detail +

+ +
+
+ + def self.from_json(input) + + # +
+ +
+ +

Parses a websocket response into a concrete response type.

+

FIXME currently this is parsing twice - this is a quick hack to get things +going. When time allows this should be refactored to work as a single pass, +or provide a more efficient method for identifying the message type.

+
+ +
+
+ +
+
+ + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def initialize + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Websocket/Response/Debug.html b/PlaceOS/Client/API/Models/Websocket/Response/Debug.html new file mode 100644 index 0000000..936aae9 --- /dev/null +++ b/PlaceOS/Client/API/Models/Websocket/Response/Debug.html @@ -0,0 +1,868 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Websocket::Response::Debug - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Websocket::Response::Debug + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/websocket/response/debug.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def id : String | Int32 | Int64 + + # +
+ +
+ +

The identifier included with the original request.

+
+ +
+
+ +
+
+ +
+
+ + def klass : String + + # +
+ +
+ +

Class of the originating message source.

+
+ +
+
+ +
+
+ +
+
+ + def level : Level + + # +
+ +
+ +

Message verbosity level.

+
+ +
+
+ +
+
+ +
+
+ + def mod : String + + # +
+ +
+ +

ID of the module the event originated from.

+
+ +
+
+ +
+
+ +
+
+ + def msg : String + + # +
+ +
+ +

Log message.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Websocket/Response/Debug/Level.html b/PlaceOS/Client/API/Models/Websocket/Response/Debug/Level.html new file mode 100644 index 0000000..61e3de6 --- /dev/null +++ b/PlaceOS/Client/API/Models/Websocket/Response/Debug/Level.html @@ -0,0 +1,839 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Websocket::Response::Debug::Level - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + enum PlaceOS::Client::API::Models::Websocket::Response::Debug::Level + +

+ + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/websocket/response/debug.cr + +
+ + + + + +

+ + + + Enum Members +

+ +
+ +
+ Unknown = 0 +
+ + +
+ Fatal = 1 +
+ + +
+ Error = 2 +
+ + +
+ Warn = 3 +
+ + +
+ Info = 4 +
+ + +
+ Debug = 5 +
+ + +
+ + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def debug? + + # +
+ +
+
+ +
+
+ +
+
+ + def error? + + # +
+ +
+
+ +
+
+ +
+
+ + def fatal? + + # +
+ +
+
+ +
+
+ +
+
+ + def info? + + # +
+ +
+
+ +
+
+ +
+
+ + def unknown? + + # +
+ +
+
+ +
+
+ +
+
+ + def warn? + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Websocket/Response/Error.html b/PlaceOS/Client/API/Models/Websocket/Response/Error.html new file mode 100644 index 0000000..e7963f9 --- /dev/null +++ b/PlaceOS/Client/API/Models/Websocket/Response/Error.html @@ -0,0 +1,816 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Websocket::Response::Error - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Websocket::Response::Error + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/websocket/response/error.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def code : Code + + # +
+ +
+ +

Error type.

+
+ +
+
+ +
+
+ +
+
+ + def id : String | Int32 | Int64 + + # +
+ +
+ +

The identifier included with the original request.

+
+ +
+
+ +
+
+ +
+
+ + def msg : String + + # +
+ +
+ +

Additional error info.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Websocket/Response/Error/Code.html b/PlaceOS/Client/API/Models/Websocket/Response/Error/Code.html new file mode 100644 index 0000000..3ad197c --- /dev/null +++ b/PlaceOS/Client/API/Models/Websocket/Response/Error/Code.html @@ -0,0 +1,887 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Websocket::Response::Error::Code - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + enum PlaceOS::Client::API::Models::Websocket::Response::Error::Code + +

+ + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/websocket/response/error.cr + +
+ + + + + +

+ + + + Enum Members +

+ +
+ +
+ ParseError = 0 +
+ + +
+ BadRequest = 1 +
+ + +
+ AccessDenied = 2 +
+ + +
+ RequestFailed = 3 +
+ + +
+ UnknownCommand = 4 +
+ + +
+ SystemNotFound = 5 +
+ + +
+ ModuleNotFound = 6 +
+ + +
+ UnexpectedFailure = 7 +
+ + +
+ + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def access_denied? + + # +
+ +
+
+ +
+
+ +
+
+ + def bad_request? + + # +
+ +
+
+ +
+
+ +
+
+ + def module_not_found? + + # +
+ +
+
+ +
+
+ +
+
+ + def parse_error? + + # +
+ +
+
+ +
+
+ +
+
+ + def request_failed? + + # +
+ +
+
+ +
+
+ +
+
+ + def system_not_found? + + # +
+ +
+
+ +
+
+ +
+
+ + def unexpected_failure? + + # +
+ +
+
+ +
+
+ +
+
+ + def unknown_command? + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Websocket/Response/Meta.html b/PlaceOS/Client/API/Models/Websocket/Response/Meta.html new file mode 100644 index 0000000..9c72c57 --- /dev/null +++ b/PlaceOS/Client/API/Models/Websocket/Response/Meta.html @@ -0,0 +1,842 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Websocket::Response::Meta - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Websocket::Response::Meta + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/websocket/response/meta.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def index : Int32 + + # +
+ +
+ +

Module index.

+
+ +
+
+ +
+
+ +
+
+ + def mod : String + + # +
+ +
+ +

Module name.

+
+ +
+
+ +
+
+ +
+
+ + def name : String | Nil + + # +
+ +
+ +

Name of the method or status key.

+
+ +
+
+ +
+
+ +
+
+ + def sys : String + + # +
+ +
+ +

The system ID.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Websocket/Response/Notify.html b/PlaceOS/Client/API/Models/Websocket/Response/Notify.html new file mode 100644 index 0000000..65b6e30 --- /dev/null +++ b/PlaceOS/Client/API/Models/Websocket/Response/Notify.html @@ -0,0 +1,827 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Websocket::Response::Notify - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Websocket::Response::Notify + +

+ + + + + + + +

+ + + + Overview +

+ +

Asyncronous state update from an active binding.

+ + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/websocket/response/notify.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def id : String | Int32 | Int64 + + # +
+ +
+ +

The identifier included with the original request.

+
+ +
+
+ +
+
+ +
+
+ + def meta : Meta | Nil + + # +
+ +
+ +

Associated metadata.

+
+ +
+
+ +
+
+ +
+
+ + def value : JSON::Any + + # +
+ +
+ +

New status value

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Websocket/Response/Success.html b/PlaceOS/Client/API/Models/Websocket/Response/Success.html new file mode 100644 index 0000000..737827f --- /dev/null +++ b/PlaceOS/Client/API/Models/Websocket/Response/Success.html @@ -0,0 +1,790 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Websocket::Response::Success - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Websocket::Response::Success + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/websocket/response/success.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def id : String | Int32 | Int64 + + # +
+ +
+ +

The identifier included with the original request.

+
+ +
+
+ +
+
+ +
+
+ + def meta : Meta | Nil + + # +
+ +
+ +

Associated metadata.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Websocket/Response/Type.html b/PlaceOS/Client/API/Models/Websocket/Response/Type.html new file mode 100644 index 0000000..68edcfc --- /dev/null +++ b/PlaceOS/Client/API/Models/Websocket/Response/Type.html @@ -0,0 +1,810 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Websocket::Response::Type - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + enum PlaceOS::Client::API::Models::Websocket::Response::Type + +

+ + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/websocket/response.cr + +
+ + + + + +

+ + + + Enum Members +

+ +
+ +
+ Success = 0 +
+ + +
+ Error = 1 +
+ + +
+ Notify = 2 +
+ + +
+ Debug = 3 +
+ + +
+ + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def debug? + + # +
+ +
+
+ +
+
+ +
+
+ + def error? + + # +
+ +
+
+ +
+
+ +
+
+ + def model + + # +
+ +
+
+ +
+
+ +
+
+ + def notify? + + # +
+ +
+
+ +
+
+ +
+
+ + def success? + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/API/Models/Zone.html b/PlaceOS/Client/API/Models/Zone.html new file mode 100644 index 0000000..d2e45ad --- /dev/null +++ b/PlaceOS/Client/API/Models/Zone.html @@ -0,0 +1,1190 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::API::Models::Zone - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + struct PlaceOS::Client::API::Models::Zone + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api/models/zone.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

Instance methods inherited from module PlaceOS::Client::API::Models::Timestamps

+ + + + created_at : Time + created_at, + + + + updated_at : Time + updated_at + + + + + + + + + + + + + + + + + + + +

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

+ + + + new(pull : JSON::PullParser) + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(pull : JSON::PullParser) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def capacity : Int32 + + # +
+ +
+ +

Could be used as people capacity

+
+ +
+
+ +
+
+ +
+
+ + def code : String | Nil + + # +
+ +
+ +

Could be used as floor code or building code etc

+
+ +
+
+ +
+
+ +
+
+ + def count : Int32 + + # +
+ +
+ +

Could be used as desk count for a level

+
+ +
+
+ +
+
+ +
+
+ + def description : String | Nil + + # +
+ +
+ +

Markdown formatted text that describes the zone.

+
+ +
+
+ +
+
+ +
+
+ + def display_name : String | Nil + + # +
+ +
+ +

A human readable identifier for displaying on interfaces

+
+ +
+
+ +
+
+ +
+
+ + def id : String + + # +
+ +
+ +

A universally unique identifier for the zone.

+
+ +
+
+ +
+
+ +
+
+ + def location : String | Nil + + # +
+ +
+ +

Geo-location string (lat,long) or any other location

+
+ +
+
+ +
+
+ +
+
+ + def map_id : String | Nil + + # +
+ +
+ +

Map identifier, could be a URL or id

+
+ +
+
+ +
+
+ +
+
+ + def name : String + + # +
+ +
+ +

A human readable identifier.

+
+ +
+
+ +
+
+ +
+
+ + def parent_id : String | Nil + + # +
+ +
+ +

Parent id

+
+ +
+
+ +
+
+ +
+
+ + def tags : Array(String) + + # +
+ +
+ +

Space seperated list of tags for categorizing the zone.

+
+ +
+
+ +
+
+ +
+
+ + def timezone : Time::Location | Nil + + # +
+ +
+ +

Timezone location of the zone

+
+ +
+
+ +
+
+ +
+
+ + def trigger_data : Array(Trigger) | Nil + + # +
+ +
+ +

Trigger data returned when param complete is true

+
+ +
+
+ +
+
+ +
+
+ + def triggers : Array(String) + + # +
+ +
+ +

List of trigger ID's to be applied to all systems that associate with this zone.

+
+ +
+
+ +
+
+ +
+
+ + def type : String | Nil + + # +
+ +
+ +

Could be used as floor type or building type etc

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper.html b/PlaceOS/Client/APIWrapper.html new file mode 100644 index 0000000..da031e1 --- /dev/null +++ b/PlaceOS/Client/APIWrapper.html @@ -0,0 +1,763 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(uri : URI | String, host_header : String | Nil = nil, insecure : Bool = false, &authenticate : HTTP::Client -> ) + + # +
+ +
+
+ +
+
+ +
+
+ + def self.new(uri : URI | String, host_header : String | Nil = nil, insecure : Bool = false) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def connection(&) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/APIKeys.html b/PlaceOS/Client/APIWrapper/APIKeys.html new file mode 100644 index 0000000..c36d9c5 --- /dev/null +++ b/PlaceOS/Client/APIWrapper/APIKeys.html @@ -0,0 +1,975 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::APIKeys - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::APIKeys + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/api_keys.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + 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::APIKey)

+ + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(client : APIWrapper) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

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

The base route for the endpoint

+
+ +
+
+ +
+
+ +
+
+ + def create(name : String, user_id : String, description : String | Nil = nil, scopes : Array(String) | Nil = nil, permissions : PlaceOS::Model::UserJWT::Permissions | Nil = nil) + + # +
+ +
+ +

Creates a new zone.

+
+ +
+
+ +
+
+ +
+
+ + def inspect_jwt + + # +
+ +
+ +

Get a clear text version of the JWT token

+
+ +
+
+ +
+
+ +
+
+ + def search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil) + + # +
+ +
+ +

List or search for zones.

+

Results maybe filtered by specifying a query - q - to search across zone +attributes. A small query language is supported within this:

+

Operator | Action +-------- | ------ ++ | Matches both terms +| | Matches either terms +- | Negates a single token +" | Wraps tokens to form a phrase +( ) | Provides precedence +~N | Specifies edit distance (fuzziness) after a word +~N | Specifies slop amount (deviation) after a phrase

+

Up to limit zones will be returned, with a paging based on offset.

+

Results my also also be limited to those associated with specific tags.

+
+ +
+
+ +
+
+ +
+
+ + def update(id : String, name : String | Nil = nil, user_id : String | Nil = nil, description : String | Nil = nil, scopes : Array(String) | Nil = nil, permissions : PlaceOS::Model::UserJWT::Permissions | Nil = nil) + + # +
+ +
+ +

Updates zone attributes or configuration.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/AssetInstances.html b/PlaceOS/Client/APIWrapper/AssetInstances.html new file mode 100644 index 0000000..bb16ed0 --- /dev/null +++ b/PlaceOS/Client/APIWrapper/AssetInstances.html @@ -0,0 +1,888 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::AssetInstances - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + 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

+
+ +
+
+ +
+
+ +
+
+ + def create(name : String, usage_start : Time, usage_end : Time) + + # +
+ +
+ +

Creates a new asset instance.

+
+ +
+
+ +
+
+ +
+
+ + def search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0) + + # +
+ +
+
+ +
+
+ +
+
+ + 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.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Assets.html b/PlaceOS/Client/APIWrapper/Assets.html new file mode 100644 index 0000000..af2660d --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Assets.html @@ -0,0 +1,907 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Assets - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Assets + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/assets.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::Asset)

+ + + + 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 asset_instances(id : String) + + # +
+ +
+
+ +
+
+ +
+
+ + def base : String + + # +
+ +
+ +
+ Description copied from class PlaceOS::Client::APIWrapper::Endpoint +
+ +

The base route for the endpoint

+
+ +
+
+ +
+
+ +
+
+ + def create(name : String, purchase_date : Time, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil) + + # +
+ +
+ +

Creates a new asset.

+
+ +
+
+ +
+
+ +
+
+ + def search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, parent : String | Nil = nil) + + # +
+ +
+
+ +
+
+ +
+
+ + def update(id : String, name : String | Nil = nil, purchase_date : Time | Nil = nil, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil) + + # +
+ +
+ +

Updates asset attributes or configuration.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/AuthBase.html b/PlaceOS/Client/APIWrapper/AuthBase.html new file mode 100644 index 0000000..c0eae65 --- /dev/null +++ b/PlaceOS/Client/APIWrapper/AuthBase.html @@ -0,0 +1,922 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::AuthBase(Model) - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + abstract class PlaceOS::Client::APIWrapper::AuthBase(Model) + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + +

+ + + + Direct Known Subclasses +

+ + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/auths/base.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + 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(Model)

+ + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(client : APIWrapper) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def create(**args) : Model + + # +
+ +
+
+ +
+
+ +
+
+ + def search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil) + + # +
+ +
+ +

List or search.

+

Results maybe filtered by specifying a query - q - to search across +attributes. A small query language is supported within this:

+

Operator | Action +-------- | ------ ++ | Matches both terms +| | Matches either terms +- | Negates a single token +" | Wraps tokens to form a phrase +( ) | Provides precedence +~N | Specifies edit distance (fuzziness) after a word +~N | Specifies slop amount (deviation) after a phrase

+

Up to limit documents will be returned, with a paging based on offset.

+
+ +
+
+ +
+
+ +
+
+ + def update(**args) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Authority.html b/PlaceOS/Client/APIWrapper/Authority.html new file mode 100644 index 0000000..c456e8b --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Authority.html @@ -0,0 +1,783 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Authority - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Authority + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/authority.cr + +
+ + + + + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

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

+
+ +
+
+ +
+
+ +
+
+ + def fetch + + # +
+ +
+ +

Gets the authority metadata for the attached instance.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Cluster.html b/PlaceOS/Client/APIWrapper/Cluster.html new file mode 100644 index 0000000..94b9c58 --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Cluster.html @@ -0,0 +1,757 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Cluster - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Cluster + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/cluster.cr + +
+ + + + + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

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

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Domains.html b/PlaceOS/Client/APIWrapper/Domains.html new file mode 100644 index 0000000..ff4df73 --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Domains.html @@ -0,0 +1,817 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Domains - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Domains + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/domains.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::APIWrapper::Authority)

+ + + + 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

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Drivers.html b/PlaceOS/Client/APIWrapper/Drivers.html new file mode 100644 index 0000000..d908aff --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Drivers.html @@ -0,0 +1,893 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Drivers - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Drivers + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/drivers.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::Driver)

+ + + + 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

+
+ +
+
+ +
+
+ +
+
+ + def create(name : String, role : Role, commit : String, file_name : String, module_name : String, repository_id : String, default_uri : String | Nil = nil, default_port : Int32 | Nil = nil, description : String | Nil = nil, ignore_connected : Bool | Nil = nil) + + # +
+ +
+
+ +
+
+ +
+
+ + def search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0) + + # +
+ +
+ +

List or search for drivers.

+

Results maybe filtered by specifying a query - q - to search across driver +attributes. A small query language is supported within this:

+

Operator | Action +-------- | ------ ++ | Matches both terms +| | Matches either terms +- | Negates a single token +" | Wraps tokens to form a phrase +( ) | Provides precedence +~N | Specifies edit distance (fuzziness) after a word +~N | Specifies slop amount (deviation) after a phrase

+

Up to limit drivers will be returned, with a paging based on offset.

+
+ +
+
+ +
+
+ +
+
+ + def update(id : String, name : String | Nil = nil, role : Role | Nil = nil, commit : String | Nil = nil, file_name : String | Nil = nil, module_name : String | Nil = nil, default_uri : String | Nil = nil, default_port : Int32 | Nil = nil, description : String | Nil = nil, ignore_connected : Bool | Nil = nil) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Ldap.html b/PlaceOS/Client/APIWrapper/Ldap.html new file mode 100644 index 0000000..1ab0d88 --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Ldap.html @@ -0,0 +1,921 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Ldap - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Ldap + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/auths/ldap.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

Instance methods inherited from class PlaceOS::Client::APIWrapper::AuthBase(PlaceOS::Client::API::Models::LdapAuthentication)

+ + + + create(**args) : Model + create, + + + + search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil) + search, + + + + update(**args) + update + + + + + + +

Constructor methods inherited from class PlaceOS::Client::APIWrapper::AuthBase(PlaceOS::Client::API::Models::LdapAuthentication)

+ + + + new(client : APIWrapper) + new + + + + + + + + + + + + + +

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::LdapAuthentication)

+ + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(client : APIWrapper) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

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

The base route for the endpoint

+
+ +
+
+ +
+
+ +
+
+ + def create(name : String, authority_id : String, host : String, base : String, port : Int32 | Nil = nil, auth_method : String | Nil = nil, uid : String | Nil = nil, bind_dn : String | Nil = nil, password : String | Nil = nil, filter : String | Nil = nil) + + # +
+ +
+
+ +
+
+ +
+
+ + def update(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, port : Int32 | Nil = nil, auth_method : String | Nil = nil, uid : String | Nil = nil, host : String | Nil = nil, base : String | Nil = nil, bind_dn : String | Nil = nil, password : String | Nil = nil, filter : String | Nil = nil) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Metadata.html b/PlaceOS/Client/APIWrapper/Metadata.html new file mode 100644 index 0000000..0a02d67 --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Metadata.html @@ -0,0 +1,852 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Metadata - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Metadata + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/metadata.cr + +
+ + + + + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

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

+
+ +
+
+ +
+
+ +
+
+ + def children(id : String, name : String | Nil = nil) + + # +
+ +
+
+ +
+
+ +
+
+ + def destroy(id : String, name : String) + + # +
+ +
+
+ +
+
+ +
+
+ + def fetch(id : String, name : String | Nil = nil) + + # +
+ +
+
+ +
+
+ +
+
+ + def merge(id : String, name : String, details : JSON::Any | Hash | NamedTuple | Array, description : String | Nil = nil) + + # +
+ +
+
+ +
+
+ +
+
+ + def update(id : String, name : String, details : JSON::Any | Hash | NamedTuple | Array, description : String | Nil = nil) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Modules.html b/PlaceOS/Client/APIWrapper/Modules.html new file mode 100644 index 0000000..c4ac59c --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Modules.html @@ -0,0 +1,1014 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Modules - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Modules + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/modules.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::Module)

+ + + + 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

+
+ +
+
+ +
+
+ +
+
+ + def create(driver_id : String, control_system_id : String | Nil = nil, ip : String | Nil = nil, udp : Bool | Nil = nil, port : Int | Nil = nil, makebreak : Bool | Nil = nil, uri : String | Nil = nil, custom_name : String | Nil = nil, settings : Settings | Nil = nil, notes : String | Nil = nil, ignore_connected : Bool | Nil = nil, ignore_startstop : Bool | Nil = nil) + + # +
+ +
+ +

Creates a new module.

+
+ +
+
+ +
+
+ +
+
+ + def ping(id : String) + + # +
+ +
+ +

Performs a connectivity check with the associated device or service.

+
+ +
+
+ +
+
+ +
+
+ + def search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, control_system_id : String | Nil = nil, driver_id : String | Nil = nil) + + # +
+ +
+ +

List or search for modules.

+

Results maybe filtered by specifying a query - q - to search across module +attributes. A small query language is supported within this:

+

Operator | Action +-------- | ------ ++ | Matches both terms +| | Matches either terms +- | Negates a single token +" | Wraps tokens to form a phrase +( ) | Provides precedence +~N | Specifies edit distance (fuzziness) after a word +~N | Specifies slop amount (deviation) after a phrase

+

Up to limit systems will be returned, with a paging based on offset.

+

Results my also also be limited to those associated with a specific +system_id, that are instances of a driver_id, or any combination of +these.

+
+ +
+
+ +
+
+ +
+
+ + def start(id : String) + + # +
+ +
+ +

Starts a module.

+
+ +
+
+ +
+
+ +
+
+ + def state(id : String, lookup : String | Nil = nil) + + # +
+ +
+ +

Queries the state exposed by a module.

+
+ +
+
+ +
+
+ +
+
+ + def stop(id : String) + + # +
+ +
+ +

Stops a module.

+
+ +
+
+ +
+
+ +
+
+ + def update(id : String, control_system_id : String | Nil = nil, ip : String | Nil = nil, udp : Bool | Nil = nil, port : Int | Nil = nil, makebreak : Bool | Nil = nil, uri : String | Nil = nil, custom_name : String | Nil = nil, settings : Settings | Nil = nil, notes : String | Nil = nil, ignore_connected : Bool | Nil = nil, ignore_startstop : Bool | Nil = nil) + + # +
+ +
+ +

Updates module attributes or configuration.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/OAuth.html b/PlaceOS/Client/APIWrapper/OAuth.html new file mode 100644 index 0000000..318804d --- /dev/null +++ b/PlaceOS/Client/APIWrapper/OAuth.html @@ -0,0 +1,921 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::OAuth - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::OAuth + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/auths/oauth.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

Instance methods inherited from class PlaceOS::Client::APIWrapper::AuthBase(PlaceOS::Client::API::Models::OAuthAuthentication)

+ + + + create(**args) : Model + create, + + + + search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil) + search, + + + + update(**args) + update + + + + + + +

Constructor methods inherited from class PlaceOS::Client::APIWrapper::AuthBase(PlaceOS::Client::API::Models::OAuthAuthentication)

+ + + + new(client : APIWrapper) + new + + + + + + + + + + + + + +

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::OAuthAuthentication)

+ + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(client : APIWrapper) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

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

The base route for the endpoint

+
+ +
+
+ +
+
+ +
+
+ + def create(name : String, authority_id : String, client_id : String | Nil = nil, client_secret : String | Nil = nil, info_mappings : Hash(String, String) | Nil = nil, site : String | Nil = nil, authorize_url : String | Nil = nil, token_method : String | Nil = nil, auth_scheme : String | Nil = nil, token_url : String | Nil = nil, scope : String | Nil = nil, raw_info_url : String | Nil = nil) + + # +
+ +
+
+ +
+
+ +
+
+ + def update(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, client_id : String | Nil = nil, client_secret : String | Nil = nil, info_mappings : Hash(String, String) | Nil = nil, site : String | Nil = nil, authorize_url : String | Nil = nil, token_method : String | Nil = nil, auth_scheme : String | Nil = nil, token_url : String | Nil = nil, scope : String | Nil = nil, raw_info_url : String | Nil = nil) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/OAuthApplications.html b/PlaceOS/Client/APIWrapper/OAuthApplications.html new file mode 100644 index 0000000..341b600 --- /dev/null +++ b/PlaceOS/Client/APIWrapper/OAuthApplications.html @@ -0,0 +1,893 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::OAuthApplications - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::OAuthApplications + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/oauth_applications.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::OAuthApplication)

+ + + + 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

+
+ +
+
+ +
+
+ +
+
+ + def create(name : String, uid : String | Nil = nil, secret : String | Nil = nil, scopes : String | Nil = nil, owner_id : String | Nil = nil, redirect_uri : String | Nil = nil, skip_authorization : Bool | Nil = nil, confidential : Bool | Nil = nil, revoked_at : Time | Nil = nil) + + # +
+ +
+
+ +
+
+ +
+
+ + def search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority : String | Nil = nil) + + # +
+ +
+ +

List or search for applications.

+

Results maybe filtered by specifying a query - q - to search across application +attributes. A small query language is supported within this:

+

Operator | Action +-------- | ------ ++ | Matches both terms +| | Matches either terms +- | Negates a single token +" | Wraps tokens to form a phrase +( ) | Provides precedence +~N | Specifies edit distance (fuzziness) after a word +~N | Specifies slop amount (deviation) after a phrase

+

Up to limit application will be returned, with a paging based on offset.

+
+ +
+
+ +
+
+ +
+
+ + def update(id : String, name : String | Nil = nil, uid : String | Nil = nil, secret : String | Nil = nil, scopes : String | Nil = nil, owner_id : String | Nil = nil, redirect_uri : String | Nil = nil, skip_authorization : Bool | Nil = nil, confidential : Bool | Nil = nil, revoked_at : Time | Nil = nil) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Repositories.html b/PlaceOS/Client/APIWrapper/Repositories.html new file mode 100644 index 0000000..fad57f0 --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Repositories.html @@ -0,0 +1,817 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Repositories - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Repositories + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/repositories.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::Repository)

+ + + + 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

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Root.html b/PlaceOS/Client/APIWrapper/Root.html new file mode 100644 index 0000000..ca61092 --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Root.html @@ -0,0 +1,802 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Root - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Root + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/root.cr + +
+ + + + + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

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

+
+ +
+
+ +
+
+ +
+
+ + def signal(channel : String, payload) + + # +
+ +
+ +

send data to listening drivers

+
+ +
+
+ +
+
+ +
+
+ + def version + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Saml.html b/PlaceOS/Client/APIWrapper/Saml.html new file mode 100644 index 0000000..7a2f49a --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Saml.html @@ -0,0 +1,921 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Saml - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Saml + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/auths/saml.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

Instance methods inherited from class PlaceOS::Client::APIWrapper::AuthBase(PlaceOS::Client::API::Models::SamlAuthentication)

+ + + + create(**args) : Model + create, + + + + search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil) + search, + + + + update(**args) + update + + + + + + +

Constructor methods inherited from class PlaceOS::Client::APIWrapper::AuthBase(PlaceOS::Client::API::Models::SamlAuthentication)

+ + + + new(client : APIWrapper) + new + + + + + + + + + + + + + +

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::SamlAuthentication)

+ + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(client : APIWrapper) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

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

The base route for the endpoint

+
+ +
+
+ +
+
+ +
+
+ + def create(name : String, authority_id : String, issuer : String, idp_sso_target_url : String, name_identifier_format : String, assertion_consumer_service_url : String, request_attributes : Array(NamedTuple(name: String, name_format: String, friendly_name: String)), idp_sso_target_url_runtime_params : Hash(String, String) | Nil = nil, uid_getter : String | Nil = nil, idp_cert : String | Nil = nil, idp_cert_fingerprint : String | Nil = nil, getter_service_name : String | Nil = nil, getter_statements : Hash(String, Array(String)) | Nil = nil, idp_slo_target_url : String | Nil = nil, slo_default_relay_state : String | Nil = nil) + + # +
+ +
+
+ +
+
+ +
+
+ + def update(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, issuer : String | Nil = nil, idp_sso_target_url : String | Nil = nil, name_identifier_format : String | Nil = nil, assertion_consumer_service_url : String | Nil = nil, request_attributes : Array(NamedTuple(name: String, name_format: String, friendly_name: String)) | Nil = nil, idp_sso_target_url_runtime_params : Hash(String, String) | Nil = nil, uid_getter : String | Nil = nil, idp_cert : String | Nil = nil, idp_cert_fingerprint : String | Nil = nil, getter_service_name : String | Nil = nil, getter_statements : Hash(String, Array(String)) | Nil = nil, idp_slo_target_url : String | Nil = nil, slo_default_relay_state : String | Nil = nil) + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Settings.html b/PlaceOS/Client/APIWrapper/Settings.html new file mode 100644 index 0000000..41e5a5f --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Settings.html @@ -0,0 +1,914 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Settings - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + 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

+
+ +
+
+ +
+
+ +
+
+ + def create(parent_id : String, settings_string : String, encryption_level : Encryption::Level = Encryption::Level::Support) + + # +
+ +
+ +

Create new settings.

+
+ +
+
+ +
+
+ +
+
+ + def search(parent_ids : Array(String)) + + # +
+ +
+
+ +
+
+ +
+
+ + def search(q : String | Nil = nil, limit : Int = 1000, offset : Int = 0, parent_id : String | Nil = nil) + + # +
+ +
+ +

List or search for systems.

+
+ +
+
+ +
+
+ +
+
+ + def update(id : String, settings_string : String) + + # +
+ +
+ +

Update settings.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/SystemTriggers.html b/PlaceOS/Client/APIWrapper/SystemTriggers.html new file mode 100644 index 0000000..aa1de04 --- /dev/null +++ b/PlaceOS/Client/APIWrapper/SystemTriggers.html @@ -0,0 +1,753 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::SystemTriggers - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::SystemTriggers + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/system_triggers.cr + +
+ + + + + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + +

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 + + # +
+ +
+ +

SystemTriggers are embedded beneath a systems route

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Systems.html b/PlaceOS/Client/APIWrapper/Systems.html new file mode 100644 index 0000000..37241fc --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Systems.html @@ -0,0 +1,1182 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Systems - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Systems + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/systems.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + 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::System)

+ + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(client : APIWrapper) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

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

The base route for the endpoint

+
+ +
+
+ +
+
+ +
+
+ + def count(id : String, module_name : String) : Int32 | Nil + + # +
+ +
+ +

Gets the number of module_name instances available in system id.

+
+ +
+
+ +
+
+ +
+
+ + def create(name : String, zones : Array(String), description : String | Nil = nil, email : String | Nil = nil, capacity : Int | Nil = nil, bookable : Bool | Nil = nil, installed_ui_devices : Int | Nil = nil, modules : Array(String) | Nil = nil, support_url : String | Nil = nil, display_name : String | Nil = nil, timezone : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, map_id : String | Nil = nil, images : Array(String) | Nil = nil, features : Array(String) | Nil = nil, public : Bool | Nil = nil) + + # +
+ +
+ +

Creates a new system.

+

Systems must be given a unique name within the PlaceOS instance they are +running from. Additionally, a system must be a member of at least one +zone. All other attributes are optional at the time of creation.

+
+ +
+
+ +
+
+ +
+
+ + def execute(id : String, module_name : String, method : String, index : Int32 = 1, *args : Array(JSON::Any::Type)) + + # +
+ +
+ +

Executes a behaviour exposed by a module within the passed system id.

+
+ +
+
+ +
+
+ +
+
+ + def functions(id : String, module_name : String, index : Int = 1) + + # +
+ +
+ +

Queries the behaviour exposed by a module within system id.

+
+ +
+
+ +
+
+ +
+
+ + def search(q : String | Nil = nil, limit : Int = 1000, offset : Int = 0, zone_id : String | Nil = nil, module_id : String | Nil = nil, features : String | Nil = nil, capacity : Int32 | Nil = nil, bookable : Bool | Nil = nil) + + # +
+ +
+ +

List or search for systems.

+

Results maybe filtered by specifying a query - q - to search across system +attributes. A small query language is supported within this:

+

Operator | Action +-------- | ------ ++ | Matches both terms +| | Matches either terms +- | Negates a single token +" | Wraps tokens to form a phrase +( ) | Provides precedence +~N | Specifies edit distance (fuzziness) after a word +~N | Specifies slop amount (deviation) after a phrase

+

Up to limit systems will be returned, with a paging based on offset.

+
+ +
+
+ +
+
+ +
+
+ + def settings(id : String) + + # +
+ +
+
+ +
+
+ +
+
+ + def start(id : String) + + # +
+ +
+ +

Start all modules within a system.

+
+ +
+
+ +
+
+ +
+
+ + def state(id : String, module_name : String, index : Int = 1, lookup : String | Nil = nil) + + # +
+ +
+ +

Queries the state exposed by a module within the passed system id.

+
+ +
+
+ +
+
+ +
+
+ + def stop(id : String) + + # +
+ +
+ +

Stops all modules within a system.

+
+ +
+
+ +
+
+ +
+
+ + def types(id : String) + + # +
+ +
+ +

Queries the types of modules available in system id.

+
+ +
+
+ +
+
+ +
+
+ + def update(id : String, version : Int, name : String | Nil = nil, zones : Array(String) | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, capacity : Int | Nil = nil, bookable : Bool | Nil = nil, installed_ui_devices : Int | Nil = nil, modules : Array(String) | Nil = nil, support_url : String | Nil = nil, display_name : String | Nil = nil, timezone : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, map_id : String | Nil = nil, images : Array(String) | Nil = nil, features : Array(String) | Nil = nil, public : Bool | Nil = nil) + + # +
+ +
+ +

Requests a change to an existing system.

+

In addition to specifying the ID of the system to update, you must reference +the the current system metadata version for the update to be allowed. This +must match the current version attribute of the system and will be +incrememented following a successful update.

+
+ +
+
+ +
+
+ +
+
+ + def with_emails(list : Array(String) | String) + + # +
+ +
+ +

Returns systems with a specified email address(es)

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Triggers.html b/PlaceOS/Client/APIWrapper/Triggers.html new file mode 100644 index 0000000..a693d4a --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Triggers.html @@ -0,0 +1,817 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Triggers - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Triggers + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/triggers.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::Trigger)

+ + + + 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

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Users.html b/PlaceOS/Client/APIWrapper/Users.html new file mode 100644 index 0000000..fd1d088 --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Users.html @@ -0,0 +1,909 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Users - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Users + +

+ + + + + + + +

+ + + + Overview +

+ +

TODO

+ + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/users.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::User)

+ + + + 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

+
+ +
+
+ +
+
+ +
+
+ + def current + + # +
+ +
+
+ +
+
+ +
+
+ + def resource_token + + # +
+ +
+
+ +
+
+ +
+
+ + def search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil, include_deleted : Bool = false, include_metadata : Bool = false) + + # +
+ +
+ +

List or search for users.

+

Results maybe filtered by specifying a query - q - to search across zone +attributes. A small query language is supported within this:

+

Operator | Action +-------- | ------ ++ | Matches both terms +| | Matches either terms +- | Negates a single token +" | Wraps tokens to form a phrase +( ) | Provides precedence +~N | Specifies edit distance (fuzziness) after a word +~N | Specifies slop amount (deviation) after a phrase

+

Up to limit zones will be returned, with a paging based on offset.

+

Results my also also be limited to those associated with specific tags.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/PlaceOS/Client/APIWrapper/Zones.html b/PlaceOS/Client/APIWrapper/Zones.html new file mode 100644 index 0000000..53fcb9c --- /dev/null +++ b/PlaceOS/Client/APIWrapper/Zones.html @@ -0,0 +1,968 @@ + + + + + + + + + + + + + + + + + PlaceOS::Client::APIWrapper::Zones - placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class PlaceOS::Client::APIWrapper::Zones + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + placeos/api_wrapper/zones.cr + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + 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::Zone)

+ + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(client : APIWrapper) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

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

The base route for the endpoint

+
+ +
+
+ +
+
+ +
+
+ + def create(name : String, description : String | Nil = nil, tags : Array(String) | Nil = nil, settings : Settings | Nil = nil, triggers : Array(String) | Nil = nil, display_name : String | Nil = nil, location : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, count : Int32 | Nil = nil, capacity : Int32 | Nil = nil, map_id : String | Nil = nil, parent_id : String | Nil = nil) + + # +
+ +
+ +

Creates a new zone.

+
+ +
+
+ +
+
+ +
+
+ + def execute(id : String, method : String, module_name : String, index : Int32 = 1, args = nil) + + # +
+ +
+
+ +
+
+ +
+
+ + def search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, parent_id : String | Nil = nil, tags : Array(String) | String | Nil = nil) + + # +
+ +
+ +

List or search for zones.

+

Results maybe filtered by specifying a query - q - to search across zone +attributes. A small query language is supported within this:

+

Operator | Action +-------- | ------ ++ | Matches both terms +| | Matches either terms +- | Negates a single token +" | Wraps tokens to form a phrase +( ) | Provides precedence +~N | Specifies edit distance (fuzziness) after a word +~N | Specifies slop amount (deviation) after a phrase

+

Up to limit zones will be returned, with a paging based on offset.

+

Results my also also be limited to those associated with specific tags.

+
+ +
+
+ +
+
+ +
+
+ + def update(id : String, name : String | Nil = nil, description : String | Nil = nil, tags : Array(String) | Nil = nil, settings : Settings | Nil = nil, triggers : Array(String) | Nil = nil, display_name : String | Nil = nil, location : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, count : Int32 | Nil = nil, capacity : Int32 | Nil = nil, map_id : String | Nil = nil, parent_id : String | Nil = nil) + + # +
+ +
+ +

Updates zone attributes or configuration.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/css/style.css b/css/style.css new file mode 100644 index 0000000..3d0a8a5 --- /dev/null +++ b/css/style.css @@ -0,0 +1,980 @@ +:root { + color-scheme: light dark; +} + +html, body { + background: #FFFFFF; + position: relative; + margin: 0; + padding: 0; + width: 100%; + height: 100%; + overflow: hidden; +} + +body { + font-family: "Avenir", "Tahoma", "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; + color: #333; + line-height: 1.5; +} + +a { + color: #263F6C; +} + +a:visited { + color: #112750; +} + +h1, h2, h3, h4, h5, h6 { + margin: 35px 0 25px; + color: #444444; +} + +h1.type-name { + color: #47266E; + margin: 20px 0 30px; + background-color: #F8F8F8; + padding: 10px 12px; + border: 1px solid #EBEBEB; + border-radius: 2px; +} + +h2 { + border-bottom: 1px solid #E6E6E6; + padding-bottom: 5px; +} + +body { + display: flex; +} + +.sidebar, .main-content { + overflow: auto; +} + +.sidebar { + width: 30em; + color: #F8F4FD; + background-color: #2E1052; + padding: 0 0 30px; + box-shadow: inset -3px 0 4px rgba(0,0,0,.35); + line-height: 1.2; + z-index: 0; +} + +.sidebar .search-box { + padding: 13px 9px; +} + +.sidebar input { + display: block; + box-sizing: border-box; + margin: 0; + padding: 5px; + font: inherit; + font-family: inherit; + line-height: 1.2; + width: 100%; + border: 0; + outline: 0; + border-radius: 2px; + box-shadow: 0px 3px 5px rgba(0,0,0,.25); + transition: box-shadow .12s; +} + +.sidebar input:focus { + box-shadow: 0px 5px 6px rgba(0,0,0,.5); +} + +.sidebar input::-webkit-input-placeholder { /* Chrome/Opera/Safari */ + color: #757575; + font-size: 14px; + text-indent: 2px; +} + +.sidebar input::-moz-placeholder { /* Firefox 19+ */ + color: #757575; + font-size: 14px; + text-indent: 2px; +} + +.sidebar input:-ms-input-placeholder { /* IE 10+ */ + color: #757575; + font-size: 14px; + text-indent: 2px; +} + +.sidebar input:-moz-placeholder { /* Firefox 18- */ + color: #757575; + font-size: 14px; + text-indent: 2px; +} + +.project-summary { + padding: 9px 15px 30px 30px; +} + +.project-name { + font-size: 1.4rem; + margin: 0; + color: #f4f4f4; + font-weight: 600; +} + +.project-version { + margin-top: 5px; + display: inline-block; + position: relative; +} + +.project-version > form::after { + position: absolute; + right: 0; + top: 0; + content: "\25BC"; + font-size: .6em; + line-height: 1.2rem; + z-index: -1; +} + +.project-versions-nav { + cursor: pointer; + margin: 0; + padding: 0 .9em 0 0; + border: none; + -moz-appearance: none; + -webkit-appearance: none; + appearance: none; + background-color: transparent; + color: inherit; + font-family: inherit; + font-size: inherit; + line-height: inherit; +} +.project-versions-nav:focus { + outline: none; +} + +.project-versions-nav > option { + color: initial; +} + +.sidebar ul { + margin: 0; + padding: 0; + list-style: none outside; +} + +.sidebar li { + display: block; + position: relative; +} + +.types-list li.hide { + display: none; +} + +.sidebar a { + text-decoration: none; + color: inherit; + transition: color .14s; +} +.types-list a { + display: block; + padding: 5px 15px 5px 30px; +} + +.types-list { + display: block; +} + +.sidebar a:focus { + outline: 1px solid #D1B7F1; +} + +.types-list a { + padding: 5px 15px 5px 30px; +} + +.sidebar .current > a, +.sidebar a:hover { + color: #866BA6; +} + +.types-list li ul { + overflow: hidden; + height: 0; + max-height: 0; + transition: 1s ease-in-out; +} + +.types-list li.parent { + padding-left: 30px; +} + +.types-list li.parent::before { + box-sizing: border-box; + content: "â–¼"; + display: block; + width: 30px; + height: 30px; + position: absolute; + top: 0; + left: 0; + text-align: center; + color: white; + font-size: 8px; + line-height: 30px; + transform: rotateZ(-90deg); + cursor: pointer; + transition: .2s linear; +} + + +.types-list li.parent > a { + padding-left: 0; +} + +.types-list li.parent.open::before { + transform: rotateZ(0); +} + +.types-list li.open > ul { + height: auto; + max-height: 1000em; +} + +.main-content { + padding: 0 30px 30px 30px; + width: 100%; +} + +.kind { + font-size: 60%; + color: #866BA6; +} + +.superclass-hierarchy { + margin: -15px 0 30px 0; + padding: 0; + list-style: none outside; + font-size: 80%; +} + +.superclass-hierarchy .superclass { + display: inline-block; + margin: 0 7px 0 0; + padding: 0; +} + +.superclass-hierarchy .superclass + .superclass::before { + content: "<"; + margin-right: 7px; +} + +.other-types-list li { + display: inline-block; +} + +.other-types-list, +.list-summary { + margin: 0 0 30px 0; + padding: 0; + list-style: none outside; +} + +.entry-const { + font-family: Menlo, Monaco, Consolas, 'Courier New', Courier, monospace; +} + +.entry-const code { + white-space: pre-wrap; +} + +.entry-summary { + padding-bottom: 4px; +} + +.superclass-hierarchy .superclass a, +.other-type a, +.entry-summary .signature { + padding: 4px 8px; + margin-bottom: 4px; + display: inline-block; + background-color: #f8f8f8; + color: #47266E; + border: 1px solid #f0f0f0; + text-decoration: none; + border-radius: 3px; + font-family: Menlo, Monaco, Consolas, 'Courier New', Courier, monospace; + transition: background .15s, border-color .15s; +} + +.superclass-hierarchy .superclass a:hover, +.other-type a:hover, +.entry-summary .signature:hover { + background: #D5CAE3; + border-color: #624288; +} + +.entry-summary .summary { + padding-left: 32px; +} + +.entry-summary .summary p { + margin: 12px 0 16px; +} + +.entry-summary a { + text-decoration: none; +} + +.entry-detail { + padding: 30px 0; +} + +.entry-detail .signature { + position: relative; + padding: 5px 15px; + margin-bottom: 10px; + display: block; + border-radius: 5px; + background-color: #f8f8f8; + color: #47266E; + border: 1px solid #f0f0f0; + font-family: Menlo, Monaco, Consolas, 'Courier New', Courier, monospace; + transition: .2s ease-in-out; +} + +.entry-detail:target .signature { + background-color: #D5CAE3; + border: 1px solid #624288; +} + +.entry-detail .signature .method-permalink { + position: absolute; + top: 0; + left: -35px; + padding: 5px 15px; + text-decoration: none; + font-weight: bold; + color: #624288; + opacity: .4; + transition: opacity .2s; +} + +.entry-detail .signature .method-permalink:hover { + opacity: 1; +} + +.entry-detail:target .signature .method-permalink { + opacity: 1; +} + +.methods-inherited { + padding-right: 10%; + line-height: 1.5em; +} + +.methods-inherited h3 { + margin-bottom: 4px; +} + +.methods-inherited a { + display: inline-block; + text-decoration: none; + color: #47266E; +} + +.methods-inherited a:hover { + text-decoration: underline; + color: #6C518B; +} + +.methods-inherited .tooltip>span { + background: #D5CAE3; + padding: 4px 8px; + border-radius: 3px; + margin: -4px -8px; +} + +.methods-inherited .tooltip * { + color: #47266E; +} + +pre { + padding: 10px 20px; + margin-top: 4px; + border-radius: 3px; + line-height: 1.45; + overflow: auto; + color: #333; + background: #fdfdfd; + font-size: 14px; + border: 1px solid #eee; +} + +code { + font-family: Menlo, Monaco, Consolas, 'Courier New', Courier, monospace; +} + +:not(pre) > code { + background-color: rgba(40,35,30,0.05); + padding: 0.2em 0.4em; + font-size: 85%; + border-radius: 3px; +} + +span.flag { + padding: 2px 4px 1px; + border-radius: 3px; + margin-right: 3px; + font-size: 11px; + border: 1px solid transparent; +} + +span.flag.orange { + background-color: #EE8737; + color: #FCEBDD; + border-color: #EB7317; +} + +span.flag.yellow { + background-color: #E4B91C; + color: #FCF8E8; + border-color: #B69115; +} + +span.flag.green { + background-color: #469C14; + color: #E2F9D3; + border-color: #34700E; +} + +span.flag.red { + background-color: #BF1919; + color: #F9ECEC; + border-color: #822C2C; +} + +span.flag.purple { + background-color: #2E1052; + color: #ECE1F9; + border-color: #1F0B37; +} + +span.flag.lime { + background-color: #a3ff00; + color: #222222; + border-color: #00ff1e; +} + +.tooltip>span { + position: absolute; + opacity: 0; + display: none; + pointer-events: none; +} + +.tooltip:hover>span { + display: inline-block; + opacity: 1; +} + +.c { + color: #969896; +} + +.n { + color: #0086b3; +} + +.t { + color: #0086b3; +} + +.s { + color: #183691; +} + +.i { + color: #7f5030; +} + +.k { + color: #a71d5d; +} + +.o { + color: #a71d5d; +} + +.m { + color: #795da3; +} + +.hidden { + display: none; +} +.search-results { + font-size: 90%; + line-height: 1.3; +} + +.search-results mark { + color: inherit; + background: transparent; + font-weight: bold; +} +.search-result { + padding: 5px 8px 5px 5px; + cursor: pointer; + border-left: 5px solid transparent; + transform: translateX(-3px); + transition: all .2s, background-color 0s, border .02s; + min-height: 3.2em; +} +.search-result.current { + border-left-color: #ddd; + background-color: rgba(200,200,200,0.4); + transform: translateX(0); + transition: all .2s, background-color .5s, border 0s; +} +.search-result.current:hover, +.search-result.current:focus { + border-left-color: #866BA6; +} +.search-result:not(.current):nth-child(2n) { + background-color: rgba(255,255,255,.06); +} +.search-result__title { + font-size: 105%; + word-break: break-all; + line-height: 1.1; + padding: 3px 0; +} +.search-result__title strong { + font-weight: normal; +} +.search-results .search-result__title > a { + padding: 0; + display: block; +} +.search-result__title > a > .args { + color: #dddddd; + font-weight: 300; + transition: inherit; + font-size: 88%; + line-height: 1.2; + letter-spacing: -.02em; +} +.search-result__title > a > .args * { + color: inherit; +} + +.search-result a, +.search-result a:hover { + color: inherit; +} +.search-result:not(.current):hover .search-result__title > a, +.search-result:not(.current):focus .search-result__title > a, +.search-result__title > a:focus { + color: #866BA6; +} +.search-result:not(.current):hover .args, +.search-result:not(.current):focus .args { + color: #6a5a7d; +} + +.search-result__type { + color: #e8e8e8; + font-weight: 300; +} +.search-result__doc { + color: #bbbbbb; + font-size: 90%; +} +.search-result__doc p { + margin: 0; + text-overflow: ellipsis; + display: -webkit-box; + -webkit-box-orient: vertical; + -webkit-line-clamp: 2; + overflow: hidden; + line-height: 1.2em; + max-height: 2.4em; +} + +.js-modal-visible .modal-background { + display: flex; +} +.main-content { + position: relative; +} +.modal-background { + position: absolute; + display: none; + height: 100%; + width: 100%; + background: rgba(120,120,120,.4); + z-index: 100; + align-items: center; + justify-content: center; +} +.usage-modal { + max-width: 90%; + background: #fff; + border: 2px solid #ccc; + border-radius: 9px; + padding: 5px 15px 20px; + min-width: 50%; + color: #555; + position: relative; + transform: scale(.5); + transition: transform 200ms; +} +.js-modal-visible .usage-modal { + transform: scale(1); +} +.usage-modal > .close-button { + position: absolute; + right: 15px; + top: 8px; + color: #aaa; + font-size: 27px; + cursor: pointer; +} +.usage-modal > .close-button:hover { + text-shadow: 2px 2px 2px #ccc; + color: #999; +} +.modal-title { + margin: 0; + text-align: center; + font-weight: normal; + color: #666; + border-bottom: 2px solid #ddd; + padding: 10px; +} +.usage-list { + padding: 0; + margin: 13px; +} +.usage-list > li { + padding: 5px 2px; + overflow: auto; + padding-left: 100px; + min-width: 12em; +} +.usage-modal kbd { + background: #eee; + border: 1px solid #ccc; + border-bottom-width: 2px; + border-radius: 3px; + padding: 3px 8px; + font-family: monospace; + margin-right: 2px; + display: inline-block; +} +.usage-key { + float: left; + clear: left; + margin-left: -100px; + margin-right: 12px; +} +.doc-inherited { + font-weight: bold; +} + +.anchor { + float: left; + padding-right: 4px; + margin-left: -20px; +} + +.main-content .anchor .octicon-link { + width: 16px; + height: 16px; +} + +.main-content .anchor:focus { + outline: none +} + +.main-content h1:hover .anchor, +.main-content h2:hover .anchor, +.main-content h3:hover .anchor, +.main-content h4:hover .anchor, +.main-content h5:hover .anchor, +.main-content h6:hover .anchor { + text-decoration: none +} + +.main-content h1 .octicon-link, +.main-content h2 .octicon-link, +.main-content h3 .octicon-link, +.main-content h4 .octicon-link, +.main-content h5 .octicon-link, +.main-content h6 .octicon-link { + visibility: hidden +} + +.main-content h1:hover .anchor .octicon-link, +.main-content h2:hover .anchor .octicon-link, +.main-content h3:hover .anchor .octicon-link, +.main-content h4:hover .anchor .octicon-link, +.main-content h5:hover .anchor .octicon-link, +.main-content h6:hover .anchor .octicon-link { + visibility: visible +} + +img { + max-width: 100%; +} + +table { + font-size: 14px; + display: block; + max-width: -moz-fit-content; + max-width: fit-content; + overflow-x: auto; + white-space: nowrap; + background: #fdfdfd; + text-align: center; + border: 1px solid #eee; + border-collapse: collapse; + padding: 0px 5px 0px 5px; +} + +table th { + padding: 10px; + letter-spacing: 1px; + border-bottom: 1px solid #eee; +} + +table td { + padding: 10px; +} + +#sidebar-btn { + height: 32px; + width: 32px; +} + +#sidebar-btn-label { + height: 2em; + width: 2em; +} + +#sidebar-btn, #sidebar-btn-label { + display: none; + margin: .7rem; + appearance: none; + color: black; + cursor: pointer; +} + +@media only screen and (max-width: 635px) { + .sidebar, .main-content { + /* svg size + vertical margin - .search-box padding-top */ + padding-top: calc(2em + 2 * 0.7rem - 13px); + } + + #sidebar-btn, #sidebar-btn-label { + display: block; + position: absolute; + z-index: 50; + transition-duration: 200ms; + left: 0; + } + + #sidebar-btn:not(:checked) ~ #sidebar-btn-label > .close, + #sidebar-btn:checked ~ #sidebar-btn-label > .open, + #sidebar-btn:checked ~ .main-content { + display: none; + } + + #sidebar-btn:checked { + left: calc(100% - 32px - (2 * 0.7rem)); + } + + #sidebar-btn:checked ~ #sidebar-btn-label { + color: white; + /* 100% - svg size - horizontal margin */ + left: calc(100% - 2em - (2 * 0.7rem)); + } + + #sidebar-btn~.sidebar { + width: 0%; + } + + #sidebar-btn:checked~.sidebar { + visibility: visible; + width: 100%; + } + + .sidebar { + transition-duration: 200ms; + max-width: 100vw; + visibility: hidden; + } +} + +@media (prefers-color-scheme: dark) { + html, body { + background: #1b1b1b; + } + + body { + color: white; + } + + a { + color: #8cb4ff; + } + + .main-content a:visited { + color: #5f8de3; + } + + h1, h2, h3, h4, h5, h6 { + color: white; + } + + h1.type-name { + color: white; + background-color: #202020; + border: 1px solid #353535; + } + + .project-versions-nav > option { + background-color: #222; + } + + .superclass-hierarchy .superclass a, + .superclass-hierarchy .superclass a:visited, + .other-type a, + .other-type a:visited, + .entry-summary .signature, + .entry-summary a:visited { + background-color: #202020; + color: white; + border: 1px solid #353535; + } + + .superclass-hierarchy .superclass a:hover, + .other-type a:hover, + .entry-summary .signature:hover { + background: #443d4d; + border-color: #b092d4; + } + + .kind { + color: #b092d4; + } + + .n { + color: #00ade6; + } + + .t { + color: #00ade6; + } + + .k { + color: #ff66ae; + } + + .o { + color: #ff66ae; + } + + .s { + color: #7799ff; + } + + .i { + color: #b38668; + } + + .m { + color: #b9a5d6; + } + + .c { + color: #a1a1a1; + } + + .methods-inherited a, .methods-inherited a:visited { + color: #B290D9; + } + + .methods-inherited a:hover { + color: #D4B7F4; + } + + .methods-inherited .tooltip>span { + background: #443d4d; + } + + .methods-inherited .tooltip * { + color: white; + } + + .entry-detail:target .signature { + background-color: #443d4d; + border: 1px solid #b092d4; + } + + .entry-detail .signature { + background-color: #202020; + color: white; + border: 1px solid #353535; + } + + .entry-detail .signature .method-permalink { + color: #b092d4; + } + + :not(pre)>code { + background-color: #202020; + } + + span.flag.purple { + background-color: #443d4d; + color: #ECE1F9; + border-color: #b092d4; + } + + .sidebar input::-webkit-input-placeholder { /* Chrome/Opera/Safari */ + color: white; + } + + .sidebar input::-moz-placeholder { /* Firefox 19+ */ + color: white; + } + + .sidebar input:-ms-input-placeholder { /* IE 10+ */ + color: white; + } + + .sidebar input:-moz-placeholder { /* Firefox 18- */ + color: white; + } + + pre, + table { + color: white; + background: #202020; + border: 1px solid #353535; + } + + table th { + border-bottom: 1px solid #353535; + } + + #sidebar-btn, #sidebar-btn-label { + color: white; + } +} diff --git a/index.html b/index.html new file mode 100644 index 0000000..86fa6fb --- /dev/null +++ b/index.html @@ -0,0 +1,620 @@ + + + + + + + + + + + + + + + + + placeos 2.11.8 + + + + + + + +
+
+
+ +
+ +
+

+ + placeos + +

+ + + 2.11.8 + +
+
+ + + +
+ + +
+
+ + +
+

+PlaceOS Crystal SDK

+

GitHub release +CI

+

A library for building crystal applications that utilise PlaceOS.

+

+ +Installation

+
    +
  1. +

    Add the dependency to your shard.yml:

    +
    dependencies:
+  placeos:
+    github: placeos/crystal-client
+    version: ~> 1.0
    +
    2. +
  2. +

    Run shards install

    +
    3. +
+

+ +Usage

+

When initialialized via the host environment, the key PLACE_URI is expected.

+

+ +Authentication

+ +

+ +Development

+

Run crystal spec

+

+ +Contributing

+
    +
  1. Fork it
    2. +
  2. Create your feature branch (git checkout -b my-new-feature)
    3. +
  3. Commit your changes (git commit -am 'Add some feature')
    4. +
  4. Push to the branch (git push origin my-new-feature)
    5. +
  5. Create a new Pull Request
    6. +
+

+ +Contributors

+ +
+ + diff --git a/index.json b/index.json new file mode 100644 index 0000000..c3ecef3 --- /dev/null +++ b/index.json @@ -0,0 +1 @@ +{"repository_name":"placeos","body":"# PlaceOS Crystal SDK\n\n[![GitHub release](https://img.shields.io/github/release/placeos/crystal-client.svg)](https://github.com/placeos/crystal-client/releases)\n[![CI](https://github.com/PlaceOS/crystal-client/actions/workflows/ci.yml/badge.svg)](https://github.com/PlaceOS/crystal-client/actions/workflows/ci.yml)\n\nA library for building [crystal](crystal-lang.org/) applications that utilise PlaceOS.\n\n## Installation\n\n1. Add the dependency to your `shard.yml`:\n\n ```yaml\n dependencies:\n placeos:\n github: placeos/crystal-client\n version: ~> 1.0\n ```\n\n2. Run `shards install`\n\n## Usage\n\nWhen initialialized via the host environment, the key `PLACE_URI` is expected.\n\n### Authentication\n\n- *from environment*\n\n ```crystal\n require \"placeos\"\n\n # Extracts user credentials from the following environment keys...\n # - PLACE_URI\n # - PLACE_EMAIL\n # - PLACE_PASSWORD\n # - PLACE_AUTH_CLIENT_ID\n # - PLACE_AUTH_SECRET\n client = PlaceOS::Client.from_environment_user\n ```\n\n## Development\n\nRun `crystal spec`\n\n## Contributing\n\n1. [Fork it](https://github.com/placeos/crystal-client/fork)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## Contributors\n\n- [Kim Burgess](https://github.com/kimburgess) - creator and maintainer\n- [Caspian Baska](https://github.com/caspiano) - contributor and maintainer\n","program":{"html_id":"placeos/toplevel","path":"toplevel.html","kind":"module","full_name":"Top Level Namespace","name":"Top Level Namespace","abstract":false,"locations":[],"repository_name":"placeos","program":true,"enum":false,"alias":false,"const":false,"types":[{"html_id":"placeos/PlaceOS","path":"PlaceOS.html","kind":"module","full_name":"PlaceOS","name":"PlaceOS","abstract":false,"locations":[{"filename":"lib/placeos-models/src/placeos-models/error.cr","line_number":1,"url":null},{"filename":"src/placeos.cr","line_number":1,"url":null},{"filename":"src/placeos/api_wrapper.cr","line_number":17,"url":null},{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":4,"url":null},{"filename":"src/placeos/api_wrapper/asset_instances.cr","line_number":4,"url":null},{"filename":"src/placeos/api_wrapper/assets.cr","line_number":4,"url":null},{"filename":"src/placeos/api_wrapper/authority.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/auths/base.cr","line_number":4,"url":null},{"filename":"src/placeos/api_wrapper/auths/ldap.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/auths/oauth.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/auths/saml.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/cluster.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/domains.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/drivers.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/endpoint.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":4,"url":null},{"filename":"src/placeos/api_wrapper/modules.cr","line_number":6,"url":null},{"filename":"src/placeos/api_wrapper/oauth_applications.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/repositories.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/root.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/settings.cr","line_number":4,"url":null},{"filename":"src/placeos/api_wrapper/system_triggers.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/systems.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/triggers.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/users.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/zones.cr","line_number":4,"url":null},{"filename":"src/placeos/client.cr","line_number":9,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"doc":"Low-level wrapper for the PlaceOS API.\n\nEach method maps one-to-one with an API endpoint. All invocations will either\nprovide a type-safe response object, or raise an `PlaceOS::Client::API::Error`.\n\nIt's possible to use this class directly if you require the extra flexibility,\nhowever in most cases the abstractions provided by the higher-level\n`PlaceOS::Client` may be the better choice.","summary":"

Low-level wrapper for the PlaceOS API.

","types":[{"html_id":"placeos/PlaceOS/Client","path":"PlaceOS/Client.html","kind":"class","full_name":"PlaceOS::Client","name":"Client","abstract":false,"superclass":{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/client.cr","line_number":10,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"API_ROOT","name":"API_ROOT","value":"\"/api/engine/v2\""},{"id":"AUTH_API_ROOT","name":"AUTH_API_ROOT","value":"\"/auth\""},{"id":"VERSION","name":"VERSION","value":"{{ (`shards version \\\"/__w/crystal-client/crystal-client/src/placeos\\\"`).chomp.stringify.downcase }}"}],"namespace":{"html_id":"placeos/PlaceOS","kind":"module","full_name":"PlaceOS","name":"PlaceOS"},"class_methods":[{"html_id":"from_environment_user-class-method","name":"from_environment_user","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":23,"url":null},"def":{"name":"from_environment_user","visibility":"Public","body":"environment = {\"PLACE_URI\", \"PLACE_EMAIL\", \"PLACE_PASSWORD\", \"PLACE_AUTH_CLIENT_ID\", \"PLACE_AUTH_SECRET\"}.map do |key|\n ENV[key]? || (abort(\"missing #{key} in environment\"))\nend\nuri, email, password, client_id, client_secret = environment\nnew(uri, email: email, password: password, client_id: client_id, client_secret: client_secret)\n"}},{"html_id":"from_environment_user(&)-class-method","name":"from_environment_user","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":32,"url":null},"def":{"name":"from_environment_user","yields":1,"block_arity":1,"visibility":"Public","body":"begin\n client = self.from_environment_user\n yield client\nensure\n client.close\nend"}}],"constructors":[{"html_id":"new(base_uri:URI|String,email:String|Nil=nil,password:String|Nil=nil,client_id:String|Nil=nil,client_secret:String|Nil=nil,token:OAuth2::AccessToken|Nil=nil,host_header:String|Nil=nil,insecure:Bool=false,x_api_key:String|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"base_uri","external_name":"base_uri","restriction":"URI | String"},{"name":"email","default_value":"nil","external_name":"email","restriction":"String | ::Nil"},{"name":"password","default_value":"nil","external_name":"password","restriction":"String | ::Nil"},{"name":"client_id","default_value":"nil","external_name":"client_id","restriction":"String | ::Nil"},{"name":"client_secret","default_value":"nil","external_name":"client_secret","restriction":"String | ::Nil"},{"name":"token","default_value":"nil","external_name":"token","restriction":"OAuth2::AccessToken | ::Nil"},{"name":"host_header","default_value":"nil","external_name":"host_header","restriction":"String | ::Nil"},{"name":"insecure","default_value":"false","external_name":"insecure","restriction":"Bool"},{"name":"x_api_key","default_value":"nil","external_name":"x_api_key","restriction":"String | ::Nil"}],"args_string":"(base_uri : URI | String, email : String | Nil = nil, password : String | Nil = nil, client_id : String | Nil = nil, client_secret : String | Nil = nil, token : OAuth2::AccessToken | Nil = nil, host_header : String | Nil = nil, insecure : Bool = false, x_api_key : String | Nil = nil)","args_html":"(base_uri : URI | String, email : String | Nil = nil, password : String | Nil = nil, client_id : String | Nil = nil, client_secret : String | Nil = nil, token : OAuth2::AccessToken | Nil = nil, host_header : String | Nil = nil, insecure : Bool = false, x_api_key : String | Nil = nil)","location":{"filename":"src/placeos/client.cr","line_number":39,"url":null},"def":{"name":"new","args":[{"name":"base_uri","external_name":"base_uri","restriction":"URI | String"},{"name":"email","default_value":"nil","external_name":"email","restriction":"String | ::Nil"},{"name":"password","default_value":"nil","external_name":"password","restriction":"String | ::Nil"},{"name":"client_id","default_value":"nil","external_name":"client_id","restriction":"String | ::Nil"},{"name":"client_secret","default_value":"nil","external_name":"client_secret","restriction":"String | ::Nil"},{"name":"token","default_value":"nil","external_name":"token","restriction":"OAuth2::AccessToken | ::Nil"},{"name":"host_header","default_value":"nil","external_name":"host_header","restriction":"String | ::Nil"},{"name":"insecure","default_value":"false","external_name":"insecure","restriction":"Bool"},{"name":"x_api_key","default_value":"nil","external_name":"x_api_key","restriction":"String | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(base_uri, email, password, client_id, client_secret, token, host_header, insecure, x_api_key)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"api_wrapper:APIWrapper-instance-method","name":"api_wrapper","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":19,"url":null},"def":{"name":"api_wrapper","return_type":"APIWrapper","visibility":"Public","body":"@api_wrapper"}},{"html_id":"apikeys:APIWrapper::APIKeys-instance-method","name":"apikeys","doc":"Provide an object for managing APIKeys. See `PlaceOS::Client::APIWrapper::APIKeys`.","summary":"

Provide an object for managing APIKeys.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"apikeys","return_type":"APIWrapper::APIKeys","visibility":"Public","body":"@apikeys || (@apikeys = APIWrapper::APIKeys.new(api_wrapper))"}},{"html_id":"authenticated?-instance-method","name":"authenticated?","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":57,"url":null},"def":{"name":"authenticated?","visibility":"Public","body":"if @session || @x_api_key\n return true\nend\n!(((@email.nil? || @password.nil?) || @client_id.nil?) || @client_secret.nil?)\n"}},{"html_id":"authority:APIWrapper::Authority-instance-method","name":"authority","doc":"Provide an object for managing Authority. See `PlaceOS::Client::APIWrapper::Authority`.","summary":"

Provide an object for managing Authority.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"authority","return_type":"APIWrapper::Authority","visibility":"Public","body":"@authority || (@authority = APIWrapper::Authority.new(api_wrapper))"}},{"html_id":"close(*args,**options)-instance-method","name":"close","abstract":false,"args":[{"name":"args","external_name":"args","restriction":""}],"args_string":"(*args, **options)","args_html":"(*args, **options)","location":{"filename":"src/placeos/client.cr","line_number":21,"url":null},"def":{"name":"close","args":[{"name":"args","external_name":"args","restriction":""}],"double_splat":{"name":"options","external_name":"options","restriction":""},"splat_index":0,"visibility":"Public","body":"api_wrapper.close(*args, **options)"}},{"html_id":"close(*args,**options,&)-instance-method","name":"close","abstract":false,"args":[{"name":"args","external_name":"args","restriction":""}],"args_string":"(*args, **options, &)","args_html":"(*args, **options, &)","location":{"filename":"src/placeos/client.cr","line_number":21,"url":null},"def":{"name":"close","args":[{"name":"args","external_name":"args","restriction":""}],"double_splat":{"name":"options","external_name":"options","restriction":""},"splat_index":0,"yields":1,"block_arity":1,"visibility":"Public","body":"api_wrapper.close(*args, **options) do |*yield_args|\n yield *yield_args\nend"}},{"html_id":"cluster:APIWrapper::Cluster-instance-method","name":"cluster","doc":"Provide an object for managing Cluster. See `PlaceOS::Client::APIWrapper::Cluster`.","summary":"

Provide an object for managing Cluster.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"cluster","return_type":"APIWrapper::Cluster","visibility":"Public","body":"@cluster || (@cluster = APIWrapper::Cluster.new(api_wrapper))"}},{"html_id":"domains:APIWrapper::Domains-instance-method","name":"domains","doc":"Provide an object for managing Domains. See `PlaceOS::Client::APIWrapper::Domains`.","summary":"

Provide an object for managing Domains.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"domains","return_type":"APIWrapper::Domains","visibility":"Public","body":"@domains || (@domains = APIWrapper::Domains.new(api_wrapper))"}},{"html_id":"drivers:APIWrapper::Drivers-instance-method","name":"drivers","doc":"Provide an object for managing Drivers. See `PlaceOS::Client::APIWrapper::Drivers`.","summary":"

Provide an object for managing Drivers.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"drivers","return_type":"APIWrapper::Drivers","visibility":"Public","body":"@drivers || (@drivers = APIWrapper::Drivers.new(api_wrapper))"}},{"html_id":"ldap:APIWrapper::Ldap-instance-method","name":"ldap","doc":"Provide an object for managing Ldap. See `PlaceOS::Client::APIWrapper::Ldap`.","summary":"

Provide an object for managing Ldap.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"ldap","return_type":"APIWrapper::Ldap","visibility":"Public","body":"@ldap || (@ldap = APIWrapper::Ldap.new(api_wrapper))"}},{"html_id":"metadata:APIWrapper::Metadata-instance-method","name":"metadata","doc":"Provide an object for managing Metadata. See `PlaceOS::Client::APIWrapper::Metadata`.","summary":"

Provide an object for managing Metadata.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"metadata","return_type":"APIWrapper::Metadata","visibility":"Public","body":"@metadata || (@metadata = APIWrapper::Metadata.new(api_wrapper))"}},{"html_id":"modules:APIWrapper::Modules-instance-method","name":"modules","doc":"Provide an object for managing Modules. See `PlaceOS::Client::APIWrapper::Modules`.","summary":"

Provide an object for managing Modules.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"modules","return_type":"APIWrapper::Modules","visibility":"Public","body":"@modules || (@modules = APIWrapper::Modules.new(api_wrapper))"}},{"html_id":"oauth:APIWrapper::OAuth-instance-method","name":"oauth","doc":"Provide an object for managing OAuth. See `PlaceOS::Client::APIWrapper::OAuth`.","summary":"

Provide an object for managing OAuth.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"oauth","return_type":"APIWrapper::OAuth","visibility":"Public","body":"@oauth || (@oauth = APIWrapper::OAuth.new(api_wrapper))"}},{"html_id":"oauthapplications:APIWrapper::OAuthApplications-instance-method","name":"oauthapplications","doc":"Provide an object for managing OAuthApplications. See `PlaceOS::Client::APIWrapper::OAuthApplications`.","summary":"

Provide an object for managing OAuthApplications.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"oauthapplications","return_type":"APIWrapper::OAuthApplications","visibility":"Public","body":"@oauthapplications || (@oauthapplications = APIWrapper::OAuthApplications.new(api_wrapper))"}},{"html_id":"root:APIWrapper::Root-instance-method","name":"root","doc":"Provide an object for managing Root. See `PlaceOS::Client::APIWrapper::Root`.","summary":"

Provide an object for managing Root.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"root","return_type":"APIWrapper::Root","visibility":"Public","body":"@root || (@root = APIWrapper::Root.new(api_wrapper))"}},{"html_id":"saml:APIWrapper::Saml-instance-method","name":"saml","doc":"Provide an object for managing Saml. See `PlaceOS::Client::APIWrapper::Saml`.","summary":"

Provide an object for managing Saml.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"saml","return_type":"APIWrapper::Saml","visibility":"Public","body":"@saml || (@saml = APIWrapper::Saml.new(api_wrapper))"}},{"html_id":"settings:APIWrapper::Settings-instance-method","name":"settings","doc":"Provide an object for managing Settings. See `PlaceOS::Client::APIWrapper::Settings`.","summary":"

Provide an object for managing Settings.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"settings","return_type":"APIWrapper::Settings","visibility":"Public","body":"@settings || (@settings = APIWrapper::Settings.new(api_wrapper))"}},{"html_id":"systems:APIWrapper::Systems-instance-method","name":"systems","doc":"Provide an object for managing Systems. See `PlaceOS::Client::APIWrapper::Systems`.","summary":"

Provide an object for managing Systems.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"systems","return_type":"APIWrapper::Systems","visibility":"Public","body":"@systems || (@systems = APIWrapper::Systems.new(api_wrapper))"}},{"html_id":"uri:URI-instance-method","name":"uri","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":18,"url":null},"def":{"name":"uri","return_type":"URI","visibility":"Public","body":"@uri"}},{"html_id":"users:APIWrapper::Users-instance-method","name":"users","doc":"Provide an object for managing Users. See `PlaceOS::Client::APIWrapper::Users`.","summary":"

Provide an object for managing Users.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"users","return_type":"APIWrapper::Users","visibility":"Public","body":"@users || (@users = APIWrapper::Users.new(api_wrapper))"}},{"html_id":"zones:APIWrapper::Zones-instance-method","name":"zones","doc":"Provide an object for managing Zones. See `PlaceOS::Client::APIWrapper::Zones`.","summary":"

Provide an object for managing Zones.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"zones","return_type":"APIWrapper::Zones","visibility":"Public","body":"@zones || (@zones = APIWrapper::Zones.new(api_wrapper))"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API","path":"PlaceOS/Client/API.html","kind":"module","full_name":"PlaceOS::Client::API","name":"API","abstract":false,"locations":[{"filename":"src/placeos/api/error.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client","kind":"class","full_name":"PlaceOS::Client","name":"Client"},"types":[{"html_id":"placeos/PlaceOS/Client/API/Error","path":"PlaceOS/Client/API/Error.html","kind":"class","full_name":"PlaceOS::Client::API::Error","name":"Error","abstract":false,"superclass":{"html_id":"placeos/Exception","kind":"class","full_name":"Exception","name":"Exception"},"ancestors":[{"html_id":"placeos/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/error.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API","kind":"module","full_name":"PlaceOS::Client::API","name":"API"},"class_methods":[{"html_id":"from_response(response:HTTP::Client::Response)-class-method","name":"from_response","abstract":false,"args":[{"name":"response","external_name":"response","restriction":"HTTP::Client::Response"}],"args_string":"(response : HTTP::Client::Response)","args_html":"(response : HTTP::Client::Response)","location":{"filename":"src/placeos/api/error.cr","line_number":4,"url":null},"def":{"name":"from_response","args":[{"name":"response","external_name":"response","restriction":"HTTP::Client::Response"}],"visibility":"Public","body":"if response.success?\n raise(ArgumentError.new(\"response is valid\"))\nelse\n if response.status_message\n new(\"#{response.status_message}\\n#{response.body}\")\n else\n new(\"HTTP error #{response.status_code}\\n#{response.body}\")\n end\nend"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models","path":"PlaceOS/Client/API/Models.html","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models","abstract":false,"locations":[{"filename":"src/placeos/api/models.cr","line_number":1,"url":null},{"filename":"src/placeos/api/models/api_key.cr","line_number":4,"url":null},{"filename":"src/placeos/api/models/asset.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/asset_instance.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/authority.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/auths/saml.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/cluster.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/driver.cr","line_number":4,"url":null},{"filename":"src/placeos/api/models/function.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/metadata.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/module.cr","line_number":4,"url":null},{"filename":"src/placeos/api/models/oauth_application.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/ping.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/repository.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/response.cr","line_number":4,"url":null},{"filename":"src/placeos/api/models/role.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/settings.cr","line_number":5,"url":null},{"filename":"src/placeos/api/models/system.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/trigger.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/user.cr","line_number":4,"url":null},{"filename":"src/placeos/api/models/version.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/zone.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"including_types":[{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API","kind":"module","full_name":"PlaceOS::Client::API","name":"API"},"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/APIKey","path":"PlaceOS/Client/API/Models/APIKey.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::APIKey","name":"APIKey","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/api_key.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/api_key.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"authority:Authority-instance-method","name":"authority","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":32,"url":null},"def":{"name":"authority","return_type":"Authority","visibility":"Public","body":"@authority"}},{"html_id":"authority_id:String-instance-method","name":"authority_id","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":30,"url":null},"def":{"name":"authority_id","return_type":"String","visibility":"Public","body":"@authority_id"}},{"html_id":"description:String|Nil-instance-method","name":"description","doc":"Markdown formatted text that describes the zone.","summary":"

Markdown formatted text that describes the zone.

","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":18,"url":null},"def":{"name":"description","return_type":"String | ::Nil","visibility":"Public","body":"@description"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier for the zone.","summary":"

A universally unique identifier for the zone.

","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":9,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"name:String-instance-method","name":"name","doc":"A human readable identifier.","summary":"

A human readable identifier.

","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":12,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"permissions:PlaceOS::Model::UserJWT::Permissions-instance-method","name":"permissions","doc":"The permission level of the user","summary":"

The permission level of the user

","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":24,"url":null},"def":{"name":"permissions","return_type":"::PlaceOS::Model::UserJWT::Permissions","visibility":"Public","body":"@permissions"}},{"html_id":"scopes:Array(String)-instance-method","name":"scopes","doc":"API scopes","summary":"

API scopes

","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":21,"url":null},"def":{"name":"scopes","return_type":"Array(String)","visibility":"Public","body":"@scopes"}},{"html_id":"user:User-instance-method","name":"user","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":28,"url":null},"def":{"name":"user","return_type":"User","visibility":"Public","body":"@user"}},{"html_id":"user_id:String-instance-method","name":"user_id","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":26,"url":null},"def":{"name":"user_id","return_type":"String","visibility":"Public","body":"@user_id"}},{"html_id":"x_api_key:String-instance-method","name":"x_api_key","doc":"The auth key, only returned on create","summary":"

The auth key, only returned on create

","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":15,"url":null},"def":{"name":"x_api_key","return_type":"String","visibility":"Public","body":"@x_api_key"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Asset","path":"PlaceOS/Client/API/Models/Asset.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Asset","name":"Asset","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/asset.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/asset.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"brand:String|Nil-instance-method","name":"brand","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":20,"url":null},"def":{"name":"brand","return_type":"String | ::Nil","visibility":"Public","body":"@brand"}},{"html_id":"category:String|Nil-instance-method","name":"category","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":11,"url":null},"def":{"name":"category","return_type":"String | ::Nil","visibility":"Public","body":"@category"}},{"html_id":"description:String|Nil-instance-method","name":"description","doc":"Markdown formatted text that describes the asset.","summary":"

Markdown formatted text that describes the asset.

","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":14,"url":null},"def":{"name":"description","return_type":"String | ::Nil","visibility":"Public","body":"@description"}},{"html_id":"good_until_date:Time|Nil-instance-method","name":"good_until_date","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":17,"url":null},"def":{"name":"good_until_date","return_type":"Time | ::Nil","visibility":"Public","body":"@good_until_date"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier for the Asset.","summary":"

A universally unique identifier for the Asset.

","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":6,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"identifier:String|Nil-instance-method","name":"identifier","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":19,"url":null},"def":{"name":"identifier","return_type":"String | ::Nil","visibility":"Public","body":"@identifier"}},{"html_id":"images:Array(String)-instance-method","name":"images","doc":"Array of URLs to images for an asset","summary":"

Array of URLs to images for an asset

","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":26,"url":null},"def":{"name":"images","return_type":"Array(String)","visibility":"Public","body":"@images"}},{"html_id":"in_use:Int32-instance-method","name":"in_use","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":32,"url":null},"def":{"name":"in_use","return_type":"Int32","visibility":"Public","body":"@in_use"}},{"html_id":"invoice:String|Nil-instance-method","name":"invoice","doc":"URL of downloadable receipt","summary":"

URL of downloadable receipt

","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":29,"url":null},"def":{"name":"invoice","return_type":"String | ::Nil","visibility":"Public","body":"@invoice"}},{"html_id":"name:String-instance-method","name":"name","doc":"A human readable identifier.","summary":"

A human readable identifier.

","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":9,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"other_data:JSON::Any-instance-method","name":"other_data","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":34,"url":null},"def":{"name":"other_data","return_type":"JSON::Any","visibility":"Public","body":"@other_data"}},{"html_id":"parent_id:String|Nil-instance-method","name":"parent_id","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":36,"url":null},"def":{"name":"parent_id","return_type":"String | ::Nil","visibility":"Public","body":"@parent_id"}},{"html_id":"purchase_date:Time-instance-method","name":"purchase_date","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":16,"url":null},"def":{"name":"purchase_date","return_type":"Time","visibility":"Public","body":"@purchase_date"}},{"html_id":"purchase_price:Int32|Nil-instance-method","name":"purchase_price","doc":"TODO: define currency for `purchase_price`","summary":"

TODO define currency for #purchase_price

","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":23,"url":null},"def":{"name":"purchase_price","return_type":"Int32 | ::Nil","visibility":"Public","body":"@purchase_price"}},{"html_id":"quantity:Int32-instance-method","name":"quantity","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":31,"url":null},"def":{"name":"quantity","return_type":"Int32","visibility":"Public","body":"@quantity"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/AssetInstance","path":"PlaceOS/Client/API/Models/AssetInstance.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::AssetInstance","name":"AssetInstance","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/asset_instance.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"approval:Bool-instance-method","name":"approval","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":18,"url":null},"def":{"name":"approval","return_type":"Bool","visibility":"Public","body":"@approval"}},{"html_id":"asset_id:String-instance-method","name":"asset_id","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":20,"url":null},"def":{"name":"asset_id","return_type":"String","visibility":"Public","body":"@asset_id"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier for the Asset.","summary":"

A universally unique identifier for the Asset.

","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":13,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":15,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"requester_id:String|Nil-instance-method","name":"requester_id","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":21,"url":null},"def":{"name":"requester_id","return_type":"String | ::Nil","visibility":"Public","body":"@requester_id"}},{"html_id":"tracking:Tracking-instance-method","name":"tracking","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":17,"url":null},"def":{"name":"tracking","return_type":"Tracking","visibility":"Public","body":"@tracking"}},{"html_id":"usage_end:Time|Nil-instance-method","name":"usage_end","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":25,"url":null},"def":{"name":"usage_end","return_type":"Time | ::Nil","visibility":"Public","body":"@usage_end"}},{"html_id":"usage_start:Time|Nil-instance-method","name":"usage_start","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":24,"url":null},"def":{"name":"usage_start","return_type":"Time | ::Nil","visibility":"Public","body":"@usage_start"}},{"html_id":"zone_id:String|Nil-instance-method","name":"zone_id","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":22,"url":null},"def":{"name":"zone_id","return_type":"String | ::Nil","visibility":"Public","body":"@zone_id"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/AssetInstance/Tracking","path":"PlaceOS/Client/API/Models/AssetInstance/Tracking.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::AssetInstance::Tracking","name":"Tracking","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/asset_instance.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"InStorage","name":"InStorage","value":"0"},{"id":"OnTheWay","name":"OnTheWay","value":"1"},{"id":"InRoom","name":"InRoom","value":"2"},{"id":"Returned","name":"Returned","value":"3"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/AssetInstance","kind":"struct","full_name":"PlaceOS::Client::API::Models::AssetInstance","name":"AssetInstance"},"instance_methods":[{"html_id":"in_room?-instance-method","name":"in_room?","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":8,"url":null},"def":{"name":"in_room?","visibility":"Public","body":"self == InRoom"}},{"html_id":"in_storage?-instance-method","name":"in_storage?","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":6,"url":null},"def":{"name":"in_storage?","visibility":"Public","body":"self == InStorage"}},{"html_id":"on_the_way?-instance-method","name":"on_the_way?","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":7,"url":null},"def":{"name":"on_the_way?","visibility":"Public","body":"self == OnTheWay"}},{"html_id":"returned?-instance-method","name":"returned?","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":9,"url":null},"def":{"name":"returned?","visibility":"Public","body":"self == Returned"}}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Authority","path":"PlaceOS/Client/API/Models/Authority.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Authority","name":"Authority","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/authority.cr","line_number":8,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"doc":"Metadata about the PlaceOS instance connected to.\n\nThis provides information that may be of relevance for authentication or\nproviding client-side configuration information.","summary":"

Metadata about the PlaceOS instance connected to.

","constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","doc":"Metadata about the PlaceOS instance connected to.\n\nThis provides information that may be of relevance for authentication or\nproviding client-side configuration information.","summary":"

Metadata about the PlaceOS instance connected to.

","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/authority.cr","line_number":8,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"config:Hash(String,JSON::Any)-instance-method","name":"config","doc":"Additional configuration / context for clients.","summary":"

Additional configuration / context for clients.

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":28,"url":null},"def":{"name":"config","return_type":"Hash(String, ::JSON::Any)","visibility":"Public","body":"@config"}},{"html_id":"description:String|Nil-instance-method","name":"description","doc":"Authority description (markdown).","summary":"

Authority description (markdown).

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":19,"url":null},"def":{"name":"description","return_type":"String | ::Nil","visibility":"Public","body":"@description"}},{"html_id":"domain:String-instance-method","name":"domain","doc":"FQDN or IP address this authority serves.","summary":"

FQDN or IP address this authority serves.

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":16,"url":null},"def":{"name":"domain","return_type":"String","visibility":"Public","body":"@domain"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier that represents the Authority.","summary":"

A universally unique identifier that represents the Authority.

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":10,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"login_url:String-instance-method","name":"login_url","doc":"Path that clients should use for initiating authentication.","summary":"

Path that clients should use for initiating authentication.

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":22,"url":null},"def":{"name":"login_url","return_type":"String","visibility":"Public","body":"@login_url"}},{"html_id":"logout_url:String-instance-method","name":"logout_url","doc":"Path that clients should use for revoking authentication.","summary":"

Path that clients should use for revoking authentication.

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":25,"url":null},"def":{"name":"logout_url","return_type":"String","visibility":"Public","body":"@logout_url"}},{"html_id":"name:String-instance-method","name":"name","doc":"Human readable name","summary":"

Human readable name

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":13,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"version:String-instance-method","name":"version","doc":"Version of application","summary":"

Version of application

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":31,"url":null},"def":{"name":"version","return_type":"String","visibility":"Public","body":"@version"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Cluster","path":"PlaceOS/Client/API/Models/Cluster.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Cluster","name":"Cluster","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/cluster.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/cluster.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Driver","path":"PlaceOS/Client/API/Models/Driver.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Driver","name":"Driver","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/driver.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/driver.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"commit:String-instance-method","name":"commit","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":25,"url":null},"def":{"name":"commit","return_type":"String","visibility":"Public","body":"@commit"}},{"html_id":"default_port:Int32|Nil-instance-method","name":"default_port","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":14,"url":null},"def":{"name":"default_port","return_type":"Int32 | ::Nil","visibility":"Public","body":"@default_port"}},{"html_id":"default_uri:String|Nil-instance-method","name":"default_uri","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":13,"url":null},"def":{"name":"default_uri","return_type":"String | ::Nil","visibility":"Public","body":"@default_uri"}},{"html_id":"description:String|Nil-instance-method","name":"description","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":11,"url":null},"def":{"name":"description","return_type":"String | ::Nil","visibility":"Public","body":"@description"}},{"html_id":"file_name:String-instance-method","name":"file_name","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":24,"url":null},"def":{"name":"file_name","return_type":"String","visibility":"Public","body":"@file_name"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":8,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"ignore_connected:Bool-instance-method","name":"ignore_connected","doc":"Don't include this module in statistics or disconnected searches\nMight be a device that commonly goes offline (like a PC or Display that only supports Wake on Lan)","summary":"

Don't include this module in statistics or disconnected searches Might be a device that commonly goes offline (like a PC or Display that only supports Wake on Lan)

","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":34,"url":null},"def":{"name":"ignore_connected","return_type":"Bool","visibility":"Public","body":"@ignore_connected"}},{"html_id":"module_name:String-instance-method","name":"module_name","doc":"Module instance configuration","summary":"

Module instance configuration

","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":30,"url":null},"def":{"name":"module_name","return_type":"String","visibility":"Public","body":"@module_name"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":10,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"repository_id:String-instance-method","name":"repository_id","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":27,"url":null},"def":{"name":"repository_id","return_type":"String","visibility":"Public","body":"@repository_id"}},{"html_id":"role:Role-instance-method","name":"role","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":18,"url":null},"def":{"name":"role","return_type":"Role","visibility":"Public","body":"Role.from_value(@role)"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Function","path":"PlaceOS/Client/API/Models/Function.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Function","name":"Function","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/function.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"doc":"Invocation information for interaction with an exposed driver behaviour.","summary":"

Invocation information for interaction with an exposed driver behaviour.

","constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","doc":"Invocation information for interaction with an exposed driver behaviour.","summary":"

Invocation information for interaction with an exposed driver behaviour.

","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/function.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"arity:Int32-instance-method","name":"arity","doc":"The number of parameters that the function accepts.","summary":"

The number of parameters that the function accepts.

","abstract":false,"location":{"filename":"src/placeos/api/models/function.cr","line_number":7,"url":null},"def":{"name":"arity","return_type":"Int32","visibility":"Public","body":"@arity"}},{"html_id":"params:Array(Parameter)-instance-method","name":"params","doc":"Parameter information.","summary":"

Parameter information.

","abstract":false,"location":{"filename":"src/placeos/api/models/function.cr","line_number":25,"url":null},"def":{"name":"params","return_type":"Array(Parameter)","visibility":"Public","body":"@params"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Function/Parameter","path":"PlaceOS/Client/API/Models/Function/Parameter.html","kind":"alias","full_name":"PlaceOS::Client::API::Models::Function::Parameter","name":"Parameter","abstract":false,"locations":[{"filename":"src/placeos/api/models/function.cr","line_number":22,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":true,"aliased":"Tuple(PlaceOS::Client::API::Models::Function::ParameterKind, String)","aliased_html":"{PlaceOS::Client::API::Models::Function::ParameterKind, String}","const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Function","kind":"struct","full_name":"PlaceOS::Client::API::Models::Function","name":"Function"},"doc":"Parameter information as {kind, name}.","summary":"

Parameter information as {kind, name}.

"},{"html_id":"placeos/PlaceOS/Client/API/Models/Function/ParameterKind","path":"PlaceOS/Client/API/Models/Function/ParameterKind.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::Function::ParameterKind","name":"ParameterKind","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/function.cr","line_number":10,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"Req","name":"Req","value":"0","doc":"Required","summary":"

Required

"},{"id":"Opt","name":"Opt","value":"1","doc":"Optional","summary":"

Optional

"},{"id":"Rest","name":"Rest","value":"2","doc":"A capture all for all trailing arguments.","summary":"

A capture all for all trailing arguments.

"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Function","kind":"struct","full_name":"PlaceOS::Client::API::Models::Function","name":"Function"},"doc":"Possible parameter kinds.","summary":"

Possible parameter kinds.

","instance_methods":[{"html_id":"opt?-instance-method","name":"opt?","abstract":false,"location":{"filename":"src/placeos/api/models/function.cr","line_number":15,"url":null},"def":{"name":"opt?","visibility":"Public","body":"self == Opt"}},{"html_id":"req?-instance-method","name":"req?","abstract":false,"location":{"filename":"src/placeos/api/models/function.cr","line_number":12,"url":null},"def":{"name":"req?","visibility":"Public","body":"self == Req"}},{"html_id":"rest?-instance-method","name":"rest?","abstract":false,"location":{"filename":"src/placeos/api/models/function.cr","line_number":18,"url":null},"def":{"name":"rest?","visibility":"Public","body":"self == Rest"}}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/LdapAuthentication","path":"PlaceOS/Client/API/Models/LdapAuthentication.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::LdapAuthentication","name":"LdapAuthentication","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"auth_method:String-instance-method","name":"auth_method","doc":"Options are: plain, ssl, tls","summary":"

Options are: plain, ssl, tls

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":13,"url":null},"def":{"name":"auth_method","return_type":"String","visibility":"Public","body":"@auth_method"}},{"html_id":"authority_id:String-instance-method","name":"authority_id","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":9,"url":null},"def":{"name":"authority_id","return_type":"String","visibility":"Public","body":"@authority_id"}},{"html_id":"base:String-instance-method","name":"base","doc":"BaseDN such as dc=intridea, dc=com","summary":"

BaseDN such as dc=intridea, dc=com

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":18,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"bind_dn:String-instance-method","name":"bind_dn","doc":":bind_dn and :password is the default credentials to perform user lookup","summary":"

:bind_dn and :password is the default credentials to perform user lookup

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":21,"url":null},"def":{"name":"bind_dn","return_type":"String","visibility":"Public","body":"@bind_dn"}},{"html_id":"filter:String-instance-method","name":"filter","doc":"LDAP filter like: (&(uid=%{username})(memberOf=cn=myapp-users,ou=groups,dc=example,dc=com))\nCan be used instead of UID","summary":"

LDAP filter like: (&(uid=%{username})(memberOf=cn=myapp-users,ou=groups,dc=example,dc=com)) Can be used instead of UID

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":26,"url":null},"def":{"name":"filter","return_type":"String","visibility":"Public","body":"@filter"}},{"html_id":"host:String-instance-method","name":"host","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":15,"url":null},"def":{"name":"host","return_type":"String","visibility":"Public","body":"@host"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":7,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":8,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"password:String-instance-method","name":"password","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":22,"url":null},"def":{"name":"password","return_type":"String","visibility":"Public","body":"@password"}},{"html_id":"port:Int32-instance-method","name":"port","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":10,"url":null},"def":{"name":"port","return_type":"Int32","visibility":"Public","body":"@port"}},{"html_id":"uid:String-instance-method","name":"uid","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":14,"url":null},"def":{"name":"uid","return_type":"String","visibility":"Public","body":"@uid"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Metadata","path":"PlaceOS/Client/API/Models/Metadata.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Metadata","name":"Metadata","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/metadata.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/metadata.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"description:String-instance-method","name":"description","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":6,"url":null},"def":{"name":"description","return_type":"String","visibility":"Public","body":"@description"}},{"html_id":"details:JSON::Any-instance-method","name":"details","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":7,"url":null},"def":{"name":"details","return_type":"JSON::Any","visibility":"Public","body":"@details"}},{"html_id":"editors:Array(String)|Nil-instance-method","name":"editors","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":10,"url":null},"def":{"name":"editors","return_type":"Array(String) | ::Nil","visibility":"Public","body":"@editors"}},{"html_id":"modified_by_id:String|Nil-instance-method","name":"modified_by_id","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":11,"url":null},"def":{"name":"modified_by_id","return_type":"String | ::Nil","visibility":"Public","body":"@modified_by_id"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":5,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"parent_id:String-instance-method","name":"parent_id","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":8,"url":null},"def":{"name":"parent_id","return_type":"String","visibility":"Public","body":"@parent_id"}},{"html_id":"schema_id:String|Nil-instance-method","name":"schema_id","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":9,"url":null},"def":{"name":"schema_id","return_type":"String | ::Nil","visibility":"Public","body":"@schema_id"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Module","path":"PlaceOS/Client/API/Models/Module.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Module","name":"Module","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/module.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/module.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"connected:Bool-instance-method","name":"connected","doc":"Flag for connectivity state.","summary":"

Flag for connectivity state.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":48,"url":null},"def":{"name":"connected","return_type":"Bool","visibility":"Public","body":"@connected"}},{"html_id":"control_sytem_id:String|Nil-instance-method","name":"control_sytem_id","doc":"The system this module is bound to (logic modules only).","summary":"

The system this module is bound to (logic modules only).

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":15,"url":null},"def":{"name":"control_sytem_id","return_type":"String | ::Nil","visibility":"Public","body":"@control_sytem_id"}},{"html_id":"custom_name:String|Nil-instance-method","name":"custom_name","doc":"The modules class name (Display, Lighting etc) if it should differ from the\ndefault defined in the driver.","summary":"

The modules class name (Display, Lighting etc) if it should differ from the default defined in the driver.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":38,"url":null},"def":{"name":"custom_name","return_type":"String | ::Nil","visibility":"Public","body":"@custom_name"}},{"html_id":"driver_id:String-instance-method","name":"driver_id","doc":"The driver that defines this module.","summary":"

The driver that defines this module.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":12,"url":null},"def":{"name":"driver_id","return_type":"String","visibility":"Public","body":"@driver_id"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier for the module.","summary":"

A universally unique identifier for the module.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":9,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"ignore_connected:Bool-instance-method","name":"ignore_connected","doc":"If enabled, system metrics ignore connectivity state.","summary":"

If enabled, system metrics ignore connectivity state.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":54,"url":null},"def":{"name":"ignore_connected","return_type":"Bool","visibility":"Public","body":"@ignore_connected"}},{"html_id":"ignore_startstop:Bool-instance-method","name":"ignore_startstop","doc":"If enabled, system level start and stop actions are ignored. This is\nrecommended for modules shared by many systems (e.g. a lighting gateway).","summary":"

If enabled, system level start and stop actions are ignored.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":58,"url":null},"def":{"name":"ignore_startstop","return_type":"Bool","visibility":"Public","body":"@ignore_startstop"}},{"html_id":"ip:String|Nil-instance-method","name":"ip","doc":"IP address or resolvable hostname of the device this module connects to.","summary":"

IP address or resolvable hostname of the device this module connects to.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":18,"url":null},"def":{"name":"ip","return_type":"String | ::Nil","visibility":"Public","body":"@ip"}},{"html_id":"makebreak:Bool-instance-method","name":"makebreak","doc":"If enabled, provides an ephemeral connection that disconnects during idle\nperiods.","summary":"

If enabled, provides an ephemeral connection that disconnects during idle periods.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":31,"url":null},"def":{"name":"makebreak","return_type":"Bool","visibility":"Public","body":"@makebreak"}},{"html_id":"name:String-instance-method","name":"name","doc":"Driver's default name for the module","summary":"

Driver's default name for the module

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":41,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"port:Int32|Nil-instance-method","name":"port","doc":"The TCP or UDP port that the associated device communicates on.","summary":"

The TCP or UDP port that the associated device communicates on.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":27,"url":null},"def":{"name":"port","return_type":"Int32 | ::Nil","visibility":"Public","body":"@port"}},{"html_id":"role:Role-instance-method","name":"role","doc":"The associated driver type.","summary":"

The associated driver type.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":45,"url":null},"def":{"name":"role","return_type":"Role","visibility":"Public","body":"@role"}},{"html_id":"running:Bool-instance-method","name":"running","doc":"Module start/stop state.","summary":"

Module start/stop state.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":51,"url":null},"def":{"name":"running","return_type":"Bool","visibility":"Public","body":"@running"}},{"html_id":"tls:Bool|Nil-instance-method","name":"tls","doc":"True if the device communicates securely.","summary":"

True if the device communicates securely.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":21,"url":null},"def":{"name":"tls","return_type":"Bool | ::Nil","visibility":"Public","body":"@tls"}},{"html_id":"udp:Bool|Nil-instance-method","name":"udp","doc":"Protocol uses UDP rather that TCP.","summary":"

Protocol uses UDP rather that TCP.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":24,"url":null},"def":{"name":"udp","return_type":"Bool | ::Nil","visibility":"Public","body":"@udp"}},{"html_id":"uri:URI|Nil-instance-method","name":"uri","doc":"The based URI of the remote service (service modules only).","summary":"

The based URI of the remote service (service modules only).

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":34,"url":null},"def":{"name":"uri","return_type":"URI | ::Nil","visibility":"Public","body":"@uri"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/OAuthApplication","path":"PlaceOS/Client/API/Models/OAuthApplication.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::OAuthApplication","name":"OAuthApplication","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/oauth_application.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"confidential:Bool-instance-method","name":"confidential","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":14,"url":null},"def":{"name":"confidential","return_type":"Bool","visibility":"Public","body":"@confidential"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":6,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":7,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"owner_id:String-instance-method","name":"owner_id","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":11,"url":null},"def":{"name":"owner_id","return_type":"String","visibility":"Public","body":"@owner_id"}},{"html_id":"redirect_uri:String-instance-method","name":"redirect_uri","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":12,"url":null},"def":{"name":"redirect_uri","return_type":"String","visibility":"Public","body":"@redirect_uri"}},{"html_id":"revoked_at:Time-instance-method","name":"revoked_at","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":16,"url":null},"def":{"name":"revoked_at","return_type":"Time","visibility":"Public","body":"@revoked_at"}},{"html_id":"scopes:String-instance-method","name":"scopes","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":10,"url":null},"def":{"name":"scopes","return_type":"String","visibility":"Public","body":"@scopes"}},{"html_id":"secret:String-instance-method","name":"secret","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":9,"url":null},"def":{"name":"secret","return_type":"String","visibility":"Public","body":"@secret"}},{"html_id":"skip_authorization:Bool-instance-method","name":"skip_authorization","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":13,"url":null},"def":{"name":"skip_authorization","return_type":"Bool","visibility":"Public","body":"@skip_authorization"}},{"html_id":"uid:String-instance-method","name":"uid","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":8,"url":null},"def":{"name":"uid","return_type":"String","visibility":"Public","body":"@uid"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/OAuthAuthentication","path":"PlaceOS/Client/API/Models/OAuthAuthentication.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::OAuthAuthentication","name":"OAuthAuthentication","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"auth_scheme:String-instance-method","name":"auth_scheme","doc":"If not set it defaults to \"request_body\", others include \"basic_auth\"","summary":"

If not set it defaults to "request_body", others include "basic_auth"

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":29,"url":null},"def":{"name":"auth_scheme","return_type":"String","visibility":"Public","body":"@auth_scheme"}},{"html_id":"authority_id:String-instance-method","name":"authority_id","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":9,"url":null},"def":{"name":"authority_id","return_type":"String","visibility":"Public","body":"@authority_id"}},{"html_id":"authorize_url:String-instance-method","name":"authorize_url","doc":"The SSO providers URL for authorization, defaults to: `oauth/authorize`\nGoogle is `/o/oauth2/auth`","summary":"

The SSO providers URL for authorization, defaults to: oauth/authorize Google is /o/oauth2/auth

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":23,"url":null},"def":{"name":"authorize_url","return_type":"String","visibility":"Public","body":"@authorize_url"}},{"html_id":"client_id:String-instance-method","name":"client_id","doc":"The client ID and secret configured for this application","summary":"

The client ID and secret configured for this application

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":12,"url":null},"def":{"name":"client_id","return_type":"String","visibility":"Public","body":"@client_id"}},{"html_id":"client_secret:String-instance-method","name":"client_secret","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":13,"url":null},"def":{"name":"client_secret","return_type":"String","visibility":"Public","body":"@client_secret"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":7,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"info_mappings:Hash(String,String)-instance-method","name":"info_mappings","doc":"Maps an expected key to a provided key i.e. {used_in_engine => used_by_remote}","summary":"

Maps an expected key to a provided key i.e.

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":16,"url":null},"def":{"name":"info_mappings","return_type":"Hash(String, String)","visibility":"Public","body":"@info_mappings"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":8,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"raw_info_url:String-instance-method","name":"raw_info_url","doc":"URL to call with a valid token to obtain the users profile data (name, email etc)","summary":"

URL to call with a valid token to obtain the users profile data (name, email etc)

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":39,"url":null},"def":{"name":"raw_info_url","return_type":"String","visibility":"Public","body":"@raw_info_url"}},{"html_id":"scope:String-instance-method","name":"scope","doc":"Space seperated scope strings\ni.e. `https://www.googleapis.com/auth/devstorage.readonly https://www.googleapis.com/auth/prediction`","summary":"

Space seperated scope strings i.e.

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":36,"url":null},"def":{"name":"scope","return_type":"String","visibility":"Public","body":"@scope"}},{"html_id":"site:String-instance-method","name":"site","doc":"The HTTP URL of the SSO provider","summary":"

The HTTP URL of the SSO provider

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":19,"url":null},"def":{"name":"site","return_type":"String","visibility":"Public","body":"@site"}},{"html_id":"token_method:String-instance-method","name":"token_method","doc":"If not set it defaults to \"post\"","summary":"

If not set it defaults to "post"

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":26,"url":null},"def":{"name":"token_method","return_type":"String","visibility":"Public","body":"@token_method"}},{"html_id":"token_url:String-instance-method","name":"token_url","doc":"defaults to: `oauth/token` however google is: `/o/oauth2/token`","summary":"

defaults to: oauth/token however google is: /o/oauth2/token

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":32,"url":null},"def":{"name":"token_url","return_type":"String","visibility":"Public","body":"@token_url"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Ping","path":"PlaceOS/Client/API/Models/Ping.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Ping","name":"Ping","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/ping.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/ping.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"exception:String|Nil-instance-method","name":"exception","abstract":false,"location":{"filename":"src/placeos/api/models/ping.cr","line_number":8,"url":null},"def":{"name":"exception","return_type":"String | ::Nil","visibility":"Public","body":"@exception"}},{"html_id":"host:String-instance-method","name":"host","abstract":false,"location":{"filename":"src/placeos/api/models/ping.cr","line_number":5,"url":null},"def":{"name":"host","return_type":"String","visibility":"Public","body":"@host"}},{"html_id":"pingable:Bool-instance-method","name":"pingable","abstract":false,"location":{"filename":"src/placeos/api/models/ping.cr","line_number":6,"url":null},"def":{"name":"pingable","return_type":"Bool","visibility":"Public","body":"@pingable"}},{"html_id":"warning:String|Nil-instance-method","name":"warning","abstract":false,"location":{"filename":"src/placeos/api/models/ping.cr","line_number":7,"url":null},"def":{"name":"warning","return_type":"String | ::Nil","visibility":"Public","body":"@warning"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Repository","path":"PlaceOS/Client/API/Models/Repository.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Repository","name":"Repository","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/repository.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/repository.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/ResourceToken","path":"PlaceOS/Client/API/Models/ResourceToken.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::ResourceToken","name":"ResourceToken","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/user.cr","line_number":42,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/user.cr","line_number":42,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"expires:Int64|Nil-instance-method","name":"expires","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":44,"url":null},"def":{"name":"expires","return_type":"Int64 | ::Nil","visibility":"Public","body":"@expires"}},{"html_id":"token:String-instance-method","name":"token","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":43,"url":null},"def":{"name":"token","return_type":"String","visibility":"Public","body":"@token"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Role","path":"PlaceOS/Client/API/Models/Role.html","kind":"alias","full_name":"PlaceOS::Client::API::Models::Role","name":"Role","abstract":false,"locations":[{"filename":"src/placeos/api/models/role.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":true,"aliased":"PlaceOS::Model::Driver::Role","aliased_html":"PlaceOS::Model::Driver::Role","const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"}},{"html_id":"placeos/PlaceOS/Client/API/Models/SamlAuthentication","path":"PlaceOS/Client/API/Models/SamlAuthentication.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::SamlAuthentication","name":"SamlAuthentication","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/auths/saml.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"assertion_consumer_service_url:String-instance-method","name":"assertion_consumer_service_url","doc":"The URL at which the SAML assertion should be received (SSO Service => Engine URL)","summary":"

The URL at which the SAML assertion should be received (SSO Service => Engine URL)

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":25,"url":null},"def":{"name":"assertion_consumer_service_url","return_type":"String","visibility":"Public","body":"@assertion_consumer_service_url"}},{"html_id":"authority_id:String-instance-method","name":"authority_id","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":9,"url":null},"def":{"name":"authority_id","return_type":"String","visibility":"Public","body":"@authority_id"}},{"html_id":"getter_service_name:String-instance-method","name":"getter_service_name","doc":"Name for the getter service (Defaults to Required getters)","summary":"

Name for the getter service (Defaults to Required getters)

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":37,"url":null},"def":{"name":"getter_service_name","return_type":"String","visibility":"Public","body":"@getter_service_name"}},{"html_id":"getter_statements:Hash(String,Array(String))-instance-method","name":"getter_statements","doc":"Used to map getter Names in a SAMLResponse to entries in the OmniAuth info hash","summary":"

Used to map getter Names in a SAMLResponse to entries in the OmniAuth info hash

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":40,"url":null},"def":{"name":"getter_statements","return_type":"Hash(String, Array(String))","visibility":"Public","body":"@getter_statements"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":7,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"idp_cert:String-instance-method","name":"idp_cert","doc":"The identity provider's certificate in PEM format (this or fingerprint is required)","summary":"

The identity provider's certificate in PEM format (this or fingerprint is required)

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":31,"url":null},"def":{"name":"idp_cert","return_type":"String","visibility":"Public","body":"@idp_cert"}},{"html_id":"idp_cert_fingerprint:String-instance-method","name":"idp_cert_fingerprint","doc":"The SHA1 fingerprint of the certificate","summary":"

The SHA1 fingerprint of the certificate

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":34,"url":null},"def":{"name":"idp_cert_fingerprint","return_type":"String","visibility":"Public","body":"@idp_cert_fingerprint"}},{"html_id":"idp_slo_target_url:String-instance-method","name":"idp_slo_target_url","doc":"The URL to which the single logout request and response should be sent","summary":"

The URL to which the single logout request and response should be sent

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":46,"url":null},"def":{"name":"idp_slo_target_url","return_type":"String","visibility":"Public","body":"@idp_slo_target_url"}},{"html_id":"idp_sso_target_url:String-instance-method","name":"idp_sso_target_url","doc":"The URL to which the authentication request should be sent (Engine => SSO Service)","summary":"

The URL to which the authentication request should be sent (Engine => SSO Service)

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":28,"url":null},"def":{"name":"idp_sso_target_url","return_type":"String","visibility":"Public","body":"@idp_sso_target_url"}},{"html_id":"idp_sso_target_url_runtime_params:Hash(String,String)-instance-method","name":"idp_sso_target_url_runtime_params","doc":"mapping of request params that exist during the request phase of OmniAuth that should to be sent to the IdP","summary":"

mapping of request params that exist during the request phase of OmniAuth that should to be sent to the IdP

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":15,"url":null},"def":{"name":"idp_sso_target_url_runtime_params","return_type":"Hash(String, String)","visibility":"Public","body":"@idp_sso_target_url_runtime_params"}},{"html_id":"issuer:String-instance-method","name":"issuer","doc":"The name of your application","summary":"

The name of your application

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":12,"url":null},"def":{"name":"issuer","return_type":"String","visibility":"Public","body":"@issuer"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":8,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"name_identifier_format:String-instance-method","name":"name_identifier_format","doc":"Describes the format of the username required by this application","summary":"

Describes the format of the username required by this application

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":18,"url":null},"def":{"name":"name_identifier_format","return_type":"String","visibility":"Public","body":"@name_identifier_format"}},{"html_id":"request_getters:Array(NamedTuple(name:String,name_format:String,friendly_name:String))-instance-method","name":"request_getters","doc":"Used to map getter Names in a SAMLResponse to entries in the OmniAuth info hash","summary":"

Used to map getter Names in a SAMLResponse to entries in the OmniAuth info hash

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":43,"url":null},"def":{"name":"request_getters","return_type":"Array(NamedTuple(name: String, name_format: String, friendly_name: String))","visibility":"Public","body":"@request_getters"}},{"html_id":"slo_default_relay_state:String-instance-method","name":"slo_default_relay_state","doc":"The value to use as default RelayState for single log outs","summary":"

The value to use as default RelayState for single log outs

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":49,"url":null},"def":{"name":"slo_default_relay_state","return_type":"String","visibility":"Public","body":"@slo_default_relay_state"}},{"html_id":"uid_getter:String-instance-method","name":"uid_getter","doc":"getter that uniquely identifies the user\n(If unset, the name identifier returned by the IdP is used.)","summary":"

getter that uniquely identifies the user (If unset, the name identifier returned by the IdP is used.)

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":22,"url":null},"def":{"name":"uid_getter","return_type":"String","visibility":"Public","body":"@uid_getter"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Settings","path":"PlaceOS/Client/API/Models/Settings.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Settings","name":"Settings","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/settings.cr","line_number":6,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/settings.cr","line_number":6,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"encryption_level:Encryption::Level-instance-method","name":"encryption_level","abstract":false,"location":{"filename":"src/placeos/api/models/settings.cr","line_number":9,"url":null},"def":{"name":"encryption_level","return_type":"Encryption::Level","visibility":"Public","body":"@encryption_level"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/settings.cr","line_number":7,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"keys:Array(String)-instance-method","name":"keys","abstract":false,"location":{"filename":"src/placeos/api/models/settings.cr","line_number":11,"url":null},"def":{"name":"keys","return_type":"Array(String)","visibility":"Public","body":"@keys"}},{"html_id":"parent_id:String-instance-method","name":"parent_id","abstract":false,"location":{"filename":"src/placeos/api/models/settings.cr","line_number":12,"url":null},"def":{"name":"parent_id","return_type":"String","visibility":"Public","body":"@parent_id"}},{"html_id":"parent_type:String-instance-method","name":"parent_type","abstract":false,"location":{"filename":"src/placeos/api/models/settings.cr","line_number":13,"url":null},"def":{"name":"parent_type","return_type":"String","visibility":"Public","body":"@parent_type"}},{"html_id":"settings_string:String-instance-method","name":"settings_string","abstract":false,"location":{"filename":"src/placeos/api/models/settings.cr","line_number":10,"url":null},"def":{"name":"settings_string","return_type":"String","visibility":"Public","body":"@settings_string"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/System","path":"PlaceOS/Client/API/Models/System.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::System","name":"System","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/system.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/system.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"bookable:Bool-instance-method","name":"bookable","doc":"Flag for signifying the space as reservable.","summary":"

Flag for signifying the space as reservable.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":50,"url":null},"def":{"name":"bookable","return_type":"Bool","visibility":"Public","body":"@bookable"}},{"html_id":"capacity:Int32-instance-method","name":"capacity","doc":"Number of people that can be accommodated in this space.","summary":"

Number of people that can be accommodated in this space.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":44,"url":null},"def":{"name":"capacity","return_type":"Int32","visibility":"Public","body":"@capacity"}},{"html_id":"code:String|Nil-instance-method","name":"code","doc":"the room identification code, like 3-04 etc.","summary":"

the room identification code, like 3-04 etc.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":32,"url":null},"def":{"name":"code","return_type":"String | ::Nil","visibility":"Public","body":"@code"}},{"html_id":"description:String|Nil-instance-method","name":"description","doc":"Markdown formatted text that describes the system.","summary":"

Markdown formatted text that describes the system.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":20,"url":null},"def":{"name":"description","return_type":"String | ::Nil","visibility":"Public","body":"@description"}},{"html_id":"display_name:String|Nil-instance-method","name":"display_name","doc":"an alternative to the full name that is easier to read.","summary":"

an alternative to the full name that is easier to read.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":26,"url":null},"def":{"name":"display_name","return_type":"String | ::Nil","visibility":"Public","body":"@display_name"}},{"html_id":"email:String|Nil-instance-method","name":"email","doc":"Calendar URI that is associated with this system.","summary":"

Calendar URI that is associated with this system.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":23,"url":null},"def":{"name":"email","return_type":"String | ::Nil","visibility":"Public","body":"@email"}},{"html_id":"features:Set(String)-instance-method","name":"features","doc":"List of features in the room for searching and filtering spaces.","summary":"

List of features in the room for searching and filtering spaces.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":47,"url":null},"def":{"name":"features","return_type":"Set(String)","visibility":"Public","body":"@features"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier for the system.","summary":"

A universally unique identifier for the system.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":8,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"images:Array(String)|Nil-instance-method","name":"images","doc":"images of this room","summary":"

images of this room

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":41,"url":null},"def":{"name":"images","return_type":"Array(String) | ::Nil","visibility":"Public","body":"@images"}},{"html_id":"installed_ui_devices:Int32-instance-method","name":"installed_ui_devices","doc":"Expected number of fixed installation touch panels.","summary":"

Expected number of fixed installation touch panels.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":56,"url":null},"def":{"name":"installed_ui_devices","return_type":"Int32","visibility":"Public","body":"@installed_ui_devices"}},{"html_id":"map_id:String|Nil-instance-method","name":"map_id","doc":"a map identifier that can be used to locate this system.","summary":"

a map identifier that can be used to locate this system.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":38,"url":null},"def":{"name":"map_id","return_type":"String | ::Nil","visibility":"Public","body":"@map_id"}},{"html_id":"modules:Array(String)-instance-method","name":"modules","doc":"Module ID's that this system contains.","summary":"

Module ID's that this system contains.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":17,"url":null},"def":{"name":"modules","return_type":"Array(String)","visibility":"Public","body":"@modules"}},{"html_id":"name:String-instance-method","name":"name","doc":"A human readable identifier.","summary":"

A human readable identifier.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":11,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"public:Bool|Nil-instance-method","name":"public","doc":"is the system intended for public access?","summary":"

is the system intended for public access?

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":53,"url":null},"def":{"name":"public","return_type":"Bool | ::Nil","visibility":"Public","body":"@public"}},{"html_id":"support_url:String|Nil-instance-method","name":"support_url","doc":"A URL linking to the primary interface for controlling this system.","summary":"

A URL linking to the primary interface for controlling this system.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":59,"url":null},"def":{"name":"support_url","return_type":"String | ::Nil","visibility":"Public","body":"@support_url"}},{"html_id":"timezone:String|Nil-instance-method","name":"timezone","doc":"timezone the system is located","summary":"

timezone the system is located

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":29,"url":null},"def":{"name":"timezone","return_type":"String | ::Nil","visibility":"Public","body":"@timezone"}},{"html_id":"type:String|Nil-instance-method","name":"type","doc":"the system type, like a small meeting room etc.","summary":"

the system type, like a small meeting room etc.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":35,"url":null},"def":{"name":"type","return_type":"String | ::Nil","visibility":"Public","body":"@type"}},{"html_id":"version:Int32-instance-method","name":"version","doc":"Incrementing counter for handling stale updates.","summary":"

Incrementing counter for handling stale updates.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":62,"url":null},"def":{"name":"version","return_type":"Int32","visibility":"Public","body":"@version"}},{"html_id":"zones:Array(String)-instance-method","name":"zones","doc":"Zone IDs that this system is a member of.","summary":"

Zone IDs that this system is a member of.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":14,"url":null},"def":{"name":"zones","return_type":"Array(String)","visibility":"Public","body":"@zones"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","path":"PlaceOS/Client/API/Models/Timestamps.html","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps","abstract":false,"locations":[{"filename":"src/placeos/api/models/response.cr","line_number":29,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"including_types":[{"html_id":"placeos/PlaceOS/Client/API/Models/APIKey","kind":"struct","full_name":"PlaceOS::Client::API::Models::APIKey","name":"APIKey"},{"html_id":"placeos/PlaceOS/Client/API/Models/Driver","kind":"struct","full_name":"PlaceOS::Client::API::Models::Driver","name":"Driver"},{"html_id":"placeos/PlaceOS/Client/API/Models/LdapAuthentication","kind":"struct","full_name":"PlaceOS::Client::API::Models::LdapAuthentication","name":"LdapAuthentication"},{"html_id":"placeos/PlaceOS/Client/API/Models/Module","kind":"struct","full_name":"PlaceOS::Client::API::Models::Module","name":"Module"},{"html_id":"placeos/PlaceOS/Client/API/Models/OAuthApplication","kind":"struct","full_name":"PlaceOS::Client::API::Models::OAuthApplication","name":"OAuthApplication"},{"html_id":"placeos/PlaceOS/Client/API/Models/OAuthAuthentication","kind":"struct","full_name":"PlaceOS::Client::API::Models::OAuthAuthentication","name":"OAuthAuthentication"},{"html_id":"placeos/PlaceOS/Client/API/Models/SamlAuthentication","kind":"struct","full_name":"PlaceOS::Client::API::Models::SamlAuthentication","name":"SamlAuthentication"},{"html_id":"placeos/PlaceOS/Client/API/Models/System","kind":"struct","full_name":"PlaceOS::Client::API::Models::System","name":"System"},{"html_id":"placeos/PlaceOS/Client/API/Models/Zone","kind":"struct","full_name":"PlaceOS::Client::API::Models::Zone","name":"Zone"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"instance_methods":[{"html_id":"created_at:Time-instance-method","name":"created_at","doc":"Creation time.","summary":"

Creation time.

","abstract":false,"location":{"filename":"src/placeos/api/models/response.cr","line_number":32,"url":null},"def":{"name":"created_at","return_type":"Time","visibility":"Public","body":"@created_at"}},{"html_id":"updated_at:Time-instance-method","name":"updated_at","doc":"Update time.","summary":"

Update time.

","abstract":false,"location":{"filename":"src/placeos/api/models/response.cr","line_number":36,"url":null},"def":{"name":"updated_at","return_type":"Time","visibility":"Public","body":"@updated_at"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger","path":"PlaceOS/Client/API/Models/Trigger.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger","name":"Trigger","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"actions:Actions-instance-method","name":"actions","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":9,"url":null},"def":{"name":"actions","return_type":"Actions","visibility":"Public","body":"@actions"}},{"html_id":"conditions:Conditions-instance-method","name":"conditions","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":10,"url":null},"def":{"name":"conditions","return_type":"Conditions","visibility":"Public","body":"@conditions"}},{"html_id":"control_system_id:String-instance-method","name":"control_system_id","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":7,"url":null},"def":{"name":"control_system_id","return_type":"String","visibility":"Public","body":"@control_system_id"}},{"html_id":"debounce_period:Int32-instance-method","name":"debounce_period","doc":"In milliseconds","summary":"

In milliseconds

","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":13,"url":null},"def":{"name":"debounce_period","return_type":"Int32","visibility":"Public","body":"@debounce_period"}},{"html_id":"description:String-instance-method","name":"description","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":6,"url":null},"def":{"name":"description","return_type":"String","visibility":"Public","body":"@description"}},{"html_id":"enable_webhook:Bool-instance-method","name":"enable_webhook","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":16,"url":null},"def":{"name":"enable_webhook","return_type":"Bool","visibility":"Public","body":"@enable_webhook"}},{"html_id":"important:Bool-instance-method","name":"important","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":14,"url":null},"def":{"name":"important","return_type":"Bool","visibility":"Public","body":"@important"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":5,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"supported_methods:Array(String)-instance-method","name":"supported_methods","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":17,"url":null},"def":{"name":"supported_methods","return_type":"Array(String)","visibility":"Public","body":"@supported_methods"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Actions","path":"PlaceOS/Client/API/Models/Trigger/Actions.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Actions","name":"Actions","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":19,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger","name":"Trigger"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":19,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"functions:Array(Function)-instance-method","name":"functions","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":20,"url":null},"def":{"name":"functions","return_type":"Array(Function)","visibility":"Public","body":"@functions"}},{"html_id":"mailers:Array(Email)-instance-method","name":"mailers","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":21,"url":null},"def":{"name":"mailers","return_type":"Array(Email)","visibility":"Public","body":"@mailers"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Actions/Email","path":"PlaceOS/Client/API/Models/Trigger/Actions/Email.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Actions::Email","name":"Email","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":23,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Actions","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Actions","name":"Actions"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":23,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"content:String-instance-method","name":"content","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":25,"url":null},"def":{"name":"content","return_type":"String","visibility":"Public","body":"@content"}},{"html_id":"emails:Array(String)-instance-method","name":"emails","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":24,"url":null},"def":{"name":"emails","return_type":"Array(String)","visibility":"Public","body":"@emails"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Actions/Function","path":"PlaceOS/Client/API/Models/Trigger/Actions/Function.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Actions::Function","name":"Function","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":28,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Actions","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Actions","name":"Actions"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":28,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"args:Hash(String,JSON::Any)-instance-method","name":"args","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":31,"url":null},"def":{"name":"args","return_type":"Hash(String, JSON::Any)","visibility":"Public","body":"@args"}},{"html_id":"method:String-instance-method","name":"method","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":30,"url":null},"def":{"name":"method","return_type":"String","visibility":"Public","body":"@method"}},{"html_id":"mod:String-instance-method","name":"mod","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":29,"url":null},"def":{"name":"mod","return_type":"String","visibility":"Public","body":"@mod"}}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions","path":"PlaceOS/Client/API/Models/Trigger/Conditions.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions","name":"Conditions","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":35,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger","name":"Trigger"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":35,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"comparisons:Array(Comparison)-instance-method","name":"comparisons","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":36,"url":null},"def":{"name":"comparisons","return_type":"Array(Comparison)","visibility":"Public","body":"@comparisons"}},{"html_id":"time_dependents:Array(TimeDependent)-instance-method","name":"time_dependents","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":37,"url":null},"def":{"name":"time_dependents","return_type":"Array(TimeDependent)","visibility":"Public","body":"@time_dependents"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison","path":"PlaceOS/Client/API/Models/Trigger/Conditions/Comparison.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison","name":"Comparison","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":39,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"OPERATORS","name":"OPERATORS","value":"{\"equal\", \"not_equal\", \"greater_than\", \"greater_than_or_equal\", \"less_than\", \"less_than_or_equal\", \"and\", \"or\", \"exclusive_or\"}"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions","name":"Conditions"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":39,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"left:Value-instance-method","name":"left","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":40,"url":null},"def":{"name":"left","return_type":"Value","visibility":"Public","body":"@left"}},{"html_id":"operator:String-instance-method","name":"operator","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":41,"url":null},"def":{"name":"operator","return_type":"String","visibility":"Public","body":"@operator"}},{"html_id":"right:Value-instance-method","name":"right","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":42,"url":null},"def":{"name":"right","return_type":"Value","visibility":"Public","body":"@right"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Constant","path":"PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Constant.html","kind":"alias","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison::Constant","name":"Constant","abstract":false,"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":47,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":true,"aliased":"(Bool | Float64 | Int64 | String)","aliased_html":"Bool | Float64 | Int64 | String","const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison","name":"Comparison"},"doc":"Constant value","summary":"

Constant value

"},{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/StatusVariable","path":"PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/StatusVariable.html","kind":"alias","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison::StatusVariable","name":"StatusVariable","abstract":false,"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":50,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":true,"aliased":"NamedTuple(mod: String, status: String, keys: Array(String))","aliased_html":"{mod: String, status: String, keys: Array(String)}","const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison","name":"Comparison"},"doc":"Status of a Module","summary":"

Status of a Module

"},{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Value","path":"PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Value.html","kind":"alias","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison::Value","name":"Value","abstract":false,"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":44,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":true,"aliased":"(Bool | Float64 | Int64 | NamedTuple(mod: String, status: String, keys: Array(String)) | String)","aliased_html":"Bool | Float64 | Int64 | {mod: String, status: String, keys: Array(String)} | String","const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison","name":"Comparison"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent","path":"PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::TimeDependent","name":"TimeDependent","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":65,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions","name":"Conditions"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":65,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"cron:String|Nil-instance-method","name":"cron","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":76,"url":null},"def":{"name":"cron","return_type":"String | ::Nil","visibility":"Public","body":"@cron"}},{"html_id":"time:Time|Nil-instance-method","name":"time","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":74,"url":null},"def":{"name":"time","return_type":"Time | ::Nil","visibility":"Public","body":"@time"}},{"html_id":"type:Type-instance-method","name":"type","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":71,"url":null},"def":{"name":"type","return_type":"Type","visibility":"Public","body":"@type"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent/Type","path":"PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent/Type.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::TimeDependent::Type","name":"Type","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":66,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"At","name":"At","value":"0"},{"id":"Cron","name":"Cron","value":"1"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::TimeDependent","name":"TimeDependent"},"instance_methods":[{"html_id":"at?-instance-method","name":"at?","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":67,"url":null},"def":{"name":"at?","visibility":"Public","body":"self == At"}},{"html_id":"cron?-instance-method","name":"cron?","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":68,"url":null},"def":{"name":"cron?","visibility":"Public","body":"self == Cron"}}]}]}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/TriggerInstance","path":"PlaceOS/Client/API/Models/TriggerInstance.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::TriggerInstance","name":"TriggerInstance","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"control_system_id:String|Nil-instance-method","name":"control_system_id","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":5,"url":null},"def":{"name":"control_system_id","return_type":"String | ::Nil","visibility":"Public","body":"@control_system_id"}},{"html_id":"enabled:Bool-instance-method","name":"enabled","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":9,"url":null},"def":{"name":"enabled","return_type":"Bool","visibility":"Public","body":"@enabled"}},{"html_id":"exec_enabled:Bool-instance-method","name":"exec_enabled","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":12,"url":null},"def":{"name":"exec_enabled","return_type":"Bool","visibility":"Public","body":"@exec_enabled"}},{"html_id":"important:Bool-instance-method","name":"important","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":11,"url":null},"def":{"name":"important","return_type":"Bool","visibility":"Public","body":"@important"}},{"html_id":"trigger_count:Int32-instance-method","name":"trigger_count","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":15,"url":null},"def":{"name":"trigger_count","return_type":"Int32","visibility":"Public","body":"@trigger_count"}},{"html_id":"trigger_id:String|Nil-instance-method","name":"trigger_id","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":6,"url":null},"def":{"name":"trigger_id","return_type":"String | ::Nil","visibility":"Public","body":"@trigger_id"}},{"html_id":"triggered:Bool-instance-method","name":"triggered","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":10,"url":null},"def":{"name":"triggered","return_type":"Bool","visibility":"Public","body":"@triggered"}},{"html_id":"webhook_secret:String-instance-method","name":"webhook_secret","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":14,"url":null},"def":{"name":"webhook_secret","return_type":"String","visibility":"Public","body":"@webhook_secret"}},{"html_id":"zone_id:String|Nil-instance-method","name":"zone_id","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":7,"url":null},"def":{"name":"zone_id","return_type":"String | ::Nil","visibility":"Public","body":"@zone_id"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/User","path":"PlaceOS/Client/API/Models/User.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::User","name":"User","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/user.cr","line_number":6,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"doc":"Metadata about the current user","summary":"

Metadata about the current user

","constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","doc":"Metadata about the current user","summary":"

Metadata about the current user

","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/user.cr","line_number":6,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"associated_metadata:Hash(String,Metadata)|Nil-instance-method","name":"associated_metadata","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":39,"url":null},"def":{"name":"associated_metadata","return_type":"Hash(String, Metadata) | ::Nil","visibility":"Public","body":"@associated_metadata"}},{"html_id":"authority_id:String-instance-method","name":"authority_id","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":20,"url":null},"def":{"name":"authority_id","return_type":"String","visibility":"Public","body":"@authority_id"}},{"html_id":"building:String|Nil-instance-method","name":"building","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":18,"url":null},"def":{"name":"building","return_type":"String | ::Nil","visibility":"Public","body":"@building"}},{"html_id":"card_number:String|Nil-instance-method","name":"card_number","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":36,"url":null},"def":{"name":"card_number","return_type":"String | ::Nil","visibility":"Public","body":"@card_number"}},{"html_id":"country:String|Nil-instance-method","name":"country","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":17,"url":null},"def":{"name":"country","return_type":"String | ::Nil","visibility":"Public","body":"@country"}},{"html_id":"created_at:Time-instance-method","name":"created_at","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":8,"url":null},"def":{"name":"created_at","return_type":"Time","visibility":"Public","body":"@created_at"}},{"html_id":"deleted:Bool|Nil-instance-method","name":"deleted","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":21,"url":null},"def":{"name":"deleted","return_type":"Bool | ::Nil","visibility":"Public","body":"@deleted"}},{"html_id":"department:String|Nil-instance-method","name":"department","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":22,"url":null},"def":{"name":"department","return_type":"String | ::Nil","visibility":"Public","body":"@department"}},{"html_id":"email:String-instance-method","name":"email","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":30,"url":null},"def":{"name":"email","return_type":"String","visibility":"Public","body":"@email"}},{"html_id":"email_digest:String-instance-method","name":"email_digest","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":11,"url":null},"def":{"name":"email_digest","return_type":"String","visibility":"Public","body":"@email_digest"}},{"html_id":"first_name:String|Nil-instance-method","name":"first_name","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":14,"url":null},"def":{"name":"first_name","return_type":"String | ::Nil","visibility":"Public","body":"@first_name"}},{"html_id":"groups:Array(String)|Nil-instance-method","name":"groups","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":16,"url":null},"def":{"name":"groups","return_type":"Array(String) | ::Nil","visibility":"Public","body":"@groups"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":10,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"image:String|Nil-instance-method","name":"image","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":19,"url":null},"def":{"name":"image","return_type":"String | ::Nil","visibility":"Public","body":"@image"}},{"html_id":"last_name:String|Nil-instance-method","name":"last_name","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":15,"url":null},"def":{"name":"last_name","return_type":"String | ::Nil","visibility":"Public","body":"@last_name"}},{"html_id":"login_name:String|Nil-instance-method","name":"login_name","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":34,"url":null},"def":{"name":"login_name","return_type":"String | ::Nil","visibility":"Public","body":"@login_name"}},{"html_id":"metadata:String|Nil-instance-method","name":"metadata","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":33,"url":null},"def":{"name":"metadata","return_type":"String | ::Nil","visibility":"Public","body":"@metadata"}},{"html_id":"misc:String|Nil-instance-method","name":"misc","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":37,"url":null},"def":{"name":"misc","return_type":"String | ::Nil","visibility":"Public","body":"@misc"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":13,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"nickname:String|Nil-instance-method","name":"nickname","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":12,"url":null},"def":{"name":"nickname","return_type":"String | ::Nil","visibility":"Public","body":"@nickname"}},{"html_id":"phone:String|Nil-instance-method","name":"phone","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":31,"url":null},"def":{"name":"phone","return_type":"String | ::Nil","visibility":"Public","body":"@phone"}},{"html_id":"preferred_language:String|Nil-instance-method","name":"preferred_language","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":23,"url":null},"def":{"name":"preferred_language","return_type":"String | ::Nil","visibility":"Public","body":"@preferred_language"}},{"html_id":"staff_id:String|Nil-instance-method","name":"staff_id","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":35,"url":null},"def":{"name":"staff_id","return_type":"String | ::Nil","visibility":"Public","body":"@staff_id"}},{"html_id":"support:Bool|Nil-instance-method","name":"support","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":29,"url":null},"def":{"name":"support","return_type":"Bool | ::Nil","visibility":"Public","body":"@support"}},{"html_id":"sys_admin:Bool|Nil-instance-method","name":"sys_admin","doc":"Admin only fields","summary":"

Admin only fields

","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":28,"url":null},"def":{"name":"sys_admin","return_type":"Bool | ::Nil","visibility":"Public","body":"@sys_admin"}},{"html_id":"ui_theme:String|Nil-instance-method","name":"ui_theme","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":32,"url":null},"def":{"name":"ui_theme","return_type":"String | ::Nil","visibility":"Public","body":"@ui_theme"}},{"html_id":"work_overrides:Hash(String,PlaceOS::Model::User::WorktimePreference)-instance-method","name":"work_overrides","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":25,"url":null},"def":{"name":"work_overrides","return_type":"Hash(String, PlaceOS::Model::User::WorktimePreference)","visibility":"Public","body":"@work_overrides"}},{"html_id":"work_preferences:Array(PlaceOS::Model::User::WorktimePreference)-instance-method","name":"work_preferences","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":24,"url":null},"def":{"name":"work_preferences","return_type":"Array(PlaceOS::Model::User::WorktimePreference)","visibility":"Public","body":"@work_preferences"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Version","path":"PlaceOS/Client/API/Models/Version.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Version","name":"Version","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/version.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/version.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"app:String-instance-method","name":"app","doc":"The PlaceOS application name","summary":"

The PlaceOS application name

","abstract":false,"location":{"filename":"src/placeos/api/models/version.cr","line_number":6,"url":null},"def":{"name":"app","return_type":"String","visibility":"Public","body":"@app"}},{"html_id":"build_time:String-instance-method","name":"build_time","doc":"The build time of the docker container","summary":"

The build time of the docker container

","abstract":false,"location":{"filename":"src/placeos/api/models/version.cr","line_number":15,"url":null},"def":{"name":"build_time","return_type":"String","visibility":"Public","body":"@build_time"}},{"html_id":"commit:String-instance-method","name":"commit","doc":"the commit hash for the running build","summary":"

the commit hash for the running build

","abstract":false,"location":{"filename":"src/placeos/api/models/version.cr","line_number":12,"url":null},"def":{"name":"commit","return_type":"String","visibility":"Public","body":"@commit"}},{"html_id":"version:String-instance-method","name":"version","doc":"The version in the shard yml","summary":"

The version in the shard yml

","abstract":false,"location":{"filename":"src/placeos/api/models/version.cr","line_number":9,"url":null},"def":{"name":"version","return_type":"String","visibility":"Public","body":"@version"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket","path":"PlaceOS/Client/API/Models/Websocket.html","kind":"module","full_name":"PlaceOS::Client::API::Models::Websocket","name":"Websocket","abstract":false,"locations":[{"filename":"src/placeos/api/models/websocket/request.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Request","path":"PlaceOS/Client/API/Models/Websocket/Request.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Request","name":"Request","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/request.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket","kind":"module","full_name":"PlaceOS::Client::API::Models::Websocket","name":"Websocket"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"args:Array(JSON::Any::Type)|Nil-instance-method","name":"args","doc":"Associated arguments for the command.","summary":"

Associated arguments for the command.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":34,"url":null},"def":{"name":"args","return_type":"Array(::JSON::Any::Type) | ::Nil","visibility":"Public","body":"@args"}},{"html_id":"cmd:Type-instance-method","name":"cmd","doc":"The command type.","summary":"

The command type.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":19,"url":null},"def":{"name":"cmd","return_type":"Type","visibility":"Public","body":"@cmd"}},{"html_id":"id:String|Int32|Int64-instance-method","name":"id","doc":"A unique identifier to associate with the command. This will be returned as\npart of the response.","summary":"

A unique identifier to associate with the command.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":16,"url":null},"def":{"name":"id","return_type":"String | Int32 | Int64","visibility":"Public","body":"@id"}},{"html_id":"index:Int32|Nil-instance-method","name":"index","doc":"The module index the command targets. Defaults to 1.","summary":"

The module index the command targets.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":28,"url":null},"def":{"name":"index","return_type":"Int32 | ::Nil","visibility":"Public","body":"@index"}},{"html_id":"mod:String-instance-method","name":"mod","doc":"The module name the command targets.","summary":"

The module name the command targets.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":25,"url":null},"def":{"name":"mod","return_type":"String","visibility":"Public","body":"@mod"}},{"html_id":"name:String-instance-method","name":"name","doc":"Name of the status variable of method being interacted with.","summary":"

Name of the status variable of method being interacted with.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":31,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"sys:String-instance-method","name":"sys","doc":"The system identified the command targets.","summary":"

The system identified the command targets.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":22,"url":null},"def":{"name":"sys","return_type":"String","visibility":"Public","body":"@sys"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Request/Type","path":"PlaceOS/Client/API/Models/Websocket/Request/Type.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::Websocket::Request::Type","name":"Type","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/request.cr","line_number":6,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"Bind","name":"Bind","value":"0"},{"id":"Unbind","name":"Unbind","value":"1"},{"id":"Exec","name":"Exec","value":"2"},{"id":"Debug","name":"Debug","value":"3"},{"id":"Ignore","name":"Ignore","value":"4"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Request","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Request","name":"Request"},"instance_methods":[{"html_id":"bind?-instance-method","name":"bind?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":7,"url":null},"def":{"name":"bind?","visibility":"Public","body":"self == Bind"}},{"html_id":"debug?-instance-method","name":"debug?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":10,"url":null},"def":{"name":"debug?","visibility":"Public","body":"self == Debug"}},{"html_id":"exec?-instance-method","name":"exec?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":9,"url":null},"def":{"name":"exec?","visibility":"Public","body":"self == Exec"}},{"html_id":"ignore?-instance-method","name":"ignore?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":11,"url":null},"def":{"name":"ignore?","visibility":"Public","body":"self == Ignore"}},{"html_id":"unbind?-instance-method","name":"unbind?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":8,"url":null},"def":{"name":"unbind?","visibility":"Public","body":"self == Unbind"}}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","path":"PlaceOS/Client/API/Models/Websocket/Response.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket","kind":"module","full_name":"PlaceOS::Client::API::Models::Websocket","name":"Websocket"},"class_methods":[{"html_id":"from_json(input)-class-method","name":"from_json","doc":"Parses a websocket response into a concrete response type.\n\nFIXME: currently this is parsing twice - this is a quick hack to get things\ngoing. When time allows this should be refactored to work as a single pass,\nor provide a more efficient method for identifying the message type.","summary":"

Parses a websocket response into a concrete response type.

","abstract":false,"args":[{"name":"input","external_name":"input","restriction":""}],"args_string":"(input)","args_html":"(input)","location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":30,"url":null},"def":{"name":"from_json","args":[{"name":"input","external_name":"input","restriction":""}],"visibility":"Public","body":"json = JSON.parse(input)\ntype = Type.parse(json[\"type\"].as_s)\ntype.model.from_json(input)\n"}}],"constructors":[{"html_id":"new-class-method","name":"new","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":3,"url":null},"def":{"name":"new","visibility":"Public","body":"x = allocate\nif x.responds_to?(:finalize)\n ::GC.add_finalizer(x)\nend\nx\n"}}],"instance_methods":[{"html_id":"initialize-instance-method","name":"initialize","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":3,"url":null},"def":{"name":"initialize","visibility":"Public","body":""}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Debug","path":"PlaceOS/Client/API/Models/Websocket/Response/Debug.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Debug","name":"Debug","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"id:String|Int32|Int64-instance-method","name":"id","doc":"The identifier included with the original request.","summary":"

The identifier included with the original request.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":17,"url":null},"def":{"name":"id","return_type":"String | Int32 | Int64","visibility":"Public","body":"@id"}},{"html_id":"klass:String-instance-method","name":"klass","doc":"Class of the originating message source.","summary":"

Class of the originating message source.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":23,"url":null},"def":{"name":"klass","return_type":"String","visibility":"Public","body":"@klass"}},{"html_id":"level:Level-instance-method","name":"level","doc":"Message verbosity level.","summary":"

Message verbosity level.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":26,"url":null},"def":{"name":"level","return_type":"Level","visibility":"Public","body":"@level"}},{"html_id":"mod:String-instance-method","name":"mod","doc":"ID of the module the event originated from.","summary":"

ID of the module the event originated from.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":20,"url":null},"def":{"name":"mod","return_type":"String","visibility":"Public","body":"@mod"}},{"html_id":"msg:String-instance-method","name":"msg","doc":"Log message.","summary":"

Log message.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":29,"url":null},"def":{"name":"msg","return_type":"String","visibility":"Public","body":"@msg"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Debug/Level","path":"PlaceOS/Client/API/Models/Websocket/Response/Debug/Level.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Debug::Level","name":"Level","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":7,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"Unknown","name":"Unknown","value":"0"},{"id":"Fatal","name":"Fatal","value":"1"},{"id":"Error","name":"Error","value":"2"},{"id":"Warn","name":"Warn","value":"3"},{"id":"Info","name":"Info","value":"4"},{"id":"Debug","name":"Debug","value":"5"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Debug","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Debug","name":"Debug"},"instance_methods":[{"html_id":"debug?-instance-method","name":"debug?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":13,"url":null},"def":{"name":"debug?","visibility":"Public","body":"self == Debug"}},{"html_id":"error?-instance-method","name":"error?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":10,"url":null},"def":{"name":"error?","visibility":"Public","body":"self == Error"}},{"html_id":"fatal?-instance-method","name":"fatal?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":9,"url":null},"def":{"name":"fatal?","visibility":"Public","body":"self == Fatal"}},{"html_id":"info?-instance-method","name":"info?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":12,"url":null},"def":{"name":"info?","visibility":"Public","body":"self == Info"}},{"html_id":"unknown?-instance-method","name":"unknown?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":8,"url":null},"def":{"name":"unknown?","visibility":"Public","body":"self == Unknown"}},{"html_id":"warn?-instance-method","name":"warn?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":11,"url":null},"def":{"name":"warn?","visibility":"Public","body":"self == Warn"}}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Error","path":"PlaceOS/Client/API/Models/Websocket/Response/Error.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Error","name":"Error","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"code:Code-instance-method","name":"code","doc":"Error type.","summary":"

Error type.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":21,"url":null},"def":{"name":"code","return_type":"Code","visibility":"Public","body":"@code"}},{"html_id":"id:String|Int32|Int64-instance-method","name":"id","doc":"The identifier included with the original request.","summary":"

The identifier included with the original request.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":18,"url":null},"def":{"name":"id","return_type":"String | Int32 | Int64","visibility":"Public","body":"@id"}},{"html_id":"msg:String-instance-method","name":"msg","doc":"Additional error info.","summary":"

Additional error info.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":24,"url":null},"def":{"name":"msg","return_type":"String","visibility":"Public","body":"@msg"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Error/Code","path":"PlaceOS/Client/API/Models/Websocket/Response/Error/Code.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Error::Code","name":"Code","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":6,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"ParseError","name":"ParseError","value":"0"},{"id":"BadRequest","name":"BadRequest","value":"1"},{"id":"AccessDenied","name":"AccessDenied","value":"2"},{"id":"RequestFailed","name":"RequestFailed","value":"3"},{"id":"UnknownCommand","name":"UnknownCommand","value":"4"},{"id":"SystemNotFound","name":"SystemNotFound","value":"5"},{"id":"ModuleNotFound","name":"ModuleNotFound","value":"6"},{"id":"UnexpectedFailure","name":"UnexpectedFailure","value":"7"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Error","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Error","name":"Error"},"instance_methods":[{"html_id":"access_denied?-instance-method","name":"access_denied?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":9,"url":null},"def":{"name":"access_denied?","visibility":"Public","body":"self == AccessDenied"}},{"html_id":"bad_request?-instance-method","name":"bad_request?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":8,"url":null},"def":{"name":"bad_request?","visibility":"Public","body":"self == BadRequest"}},{"html_id":"module_not_found?-instance-method","name":"module_not_found?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":13,"url":null},"def":{"name":"module_not_found?","visibility":"Public","body":"self == ModuleNotFound"}},{"html_id":"parse_error?-instance-method","name":"parse_error?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":7,"url":null},"def":{"name":"parse_error?","visibility":"Public","body":"self == ParseError"}},{"html_id":"request_failed?-instance-method","name":"request_failed?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":10,"url":null},"def":{"name":"request_failed?","visibility":"Public","body":"self == RequestFailed"}},{"html_id":"system_not_found?-instance-method","name":"system_not_found?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":12,"url":null},"def":{"name":"system_not_found?","visibility":"Public","body":"self == SystemNotFound"}},{"html_id":"unexpected_failure?-instance-method","name":"unexpected_failure?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":14,"url":null},"def":{"name":"unexpected_failure?","visibility":"Public","body":"self == UnexpectedFailure"}},{"html_id":"unknown_command?-instance-method","name":"unknown_command?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":11,"url":null},"def":{"name":"unknown_command?","visibility":"Public","body":"self == UnknownCommand"}}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Meta","path":"PlaceOS/Client/API/Models/Websocket/Response/Meta.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Meta","name":"Meta","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/meta.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/websocket/response/meta.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"index:Int32-instance-method","name":"index","doc":"Module index.","summary":"

Module index.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/meta.cr","line_number":13,"url":null},"def":{"name":"index","return_type":"Int32","visibility":"Public","body":"@index"}},{"html_id":"mod:String-instance-method","name":"mod","doc":"Module name.","summary":"

Module name.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/meta.cr","line_number":10,"url":null},"def":{"name":"mod","return_type":"String","visibility":"Public","body":"@mod"}},{"html_id":"name:String|Nil-instance-method","name":"name","doc":"Name of the method or status key.","summary":"

Name of the method or status key.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/meta.cr","line_number":16,"url":null},"def":{"name":"name","return_type":"String | ::Nil","visibility":"Public","body":"@name"}},{"html_id":"sys:String-instance-method","name":"sys","doc":"The system ID.","summary":"

The system ID.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/meta.cr","line_number":7,"url":null},"def":{"name":"sys","return_type":"String","visibility":"Public","body":"@sys"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Notify","path":"PlaceOS/Client/API/Models/Websocket/Response/Notify.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Notify","name":"Notify","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/notify.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response"},"doc":"Asyncronous state update from an active binding.","summary":"

Asyncronous state update from an active binding.

","constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/websocket/response/notify.cr","line_number":6,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"id:String|Int32|Int64-instance-method","name":"id","doc":"The identifier included with the original request.","summary":"

The identifier included with the original request.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/notify.cr","line_number":9,"url":null},"def":{"name":"id","return_type":"String | Int32 | Int64","visibility":"Public","body":"@id"}},{"html_id":"meta:Meta|Nil-instance-method","name":"meta","doc":"Associated metadata.","summary":"

Associated metadata.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/notify.cr","line_number":15,"url":null},"def":{"name":"meta","return_type":"Meta | ::Nil","visibility":"Public","body":"@meta"}},{"html_id":"value:JSON::Any-instance-method","name":"value","doc":"New status value","summary":"

New status value

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/notify.cr","line_number":12,"url":null},"def":{"name":"value","return_type":"::JSON::Any","visibility":"Public","body":"@value"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Success","path":"PlaceOS/Client/API/Models/Websocket/Response/Success.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Success","name":"Success","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/success.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/websocket/response/success.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"id:String|Int32|Int64-instance-method","name":"id","doc":"The identifier included with the original request.","summary":"

The identifier included with the original request.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/success.cr","line_number":8,"url":null},"def":{"name":"id","return_type":"String | Int32 | Int64","visibility":"Public","body":"@id"}},{"html_id":"meta:Meta|Nil-instance-method","name":"meta","doc":"Associated metadata.","summary":"

Associated metadata.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/success.cr","line_number":11,"url":null},"def":{"name":"meta","return_type":"Meta | ::Nil","visibility":"Public","body":"@meta"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Type","path":"PlaceOS/Client/API/Models/Websocket/Response/Type.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Type","name":"Type","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"Success","name":"Success","value":"0"},{"id":"Error","name":"Error","value":"1"},{"id":"Notify","name":"Notify","value":"2"},{"id":"Debug","name":"Debug","value":"3"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response"},"instance_methods":[{"html_id":"debug?-instance-method","name":"debug?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":8,"url":null},"def":{"name":"debug?","visibility":"Public","body":"self == Debug"}},{"html_id":"error?-instance-method","name":"error?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":6,"url":null},"def":{"name":"error?","visibility":"Public","body":"self == Error"}},{"html_id":"model-instance-method","name":"model","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":10,"url":null},"def":{"name":"model","visibility":"Public","body":"{% if true %}\n case self\n {% for type in @type.constants %}\n when {{ type }} then Response::{{ type }}\n {% end %}\n else\n # Will never happen, but required to stop nil for sneaking into the\n # returned type union.\n raise \"\"\n end\n {% end %}"}},{"html_id":"notify?-instance-method","name":"notify?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":7,"url":null},"def":{"name":"notify?","visibility":"Public","body":"self == Notify"}},{"html_id":"success?-instance-method","name":"success?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":5,"url":null},"def":{"name":"success?","visibility":"Public","body":"self == Success"}}]}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Zone","path":"PlaceOS/Client/API/Models/Zone.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Zone","name":"Zone","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/zone.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/zone.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"capacity:Int32-instance-method","name":"capacity","doc":"Could be used as people capacity","summary":"

Could be used as people capacity

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":33,"url":null},"def":{"name":"capacity","return_type":"Int32","visibility":"Public","body":"@capacity"}},{"html_id":"code:String|Nil-instance-method","name":"code","doc":"Could be used as floor code or building code etc","summary":"

Could be used as floor code or building code etc

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":24,"url":null},"def":{"name":"code","return_type":"String | ::Nil","visibility":"Public","body":"@code"}},{"html_id":"count:Int32-instance-method","name":"count","doc":"Could be used as desk count for a level","summary":"

Could be used as desk count for a level

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":30,"url":null},"def":{"name":"count","return_type":"Int32","visibility":"Public","body":"@count"}},{"html_id":"description:String|Nil-instance-method","name":"description","doc":"Markdown formatted text that describes the zone.","summary":"

Markdown formatted text that describes the zone.

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":21,"url":null},"def":{"name":"description","return_type":"String | ::Nil","visibility":"Public","body":"@description"}},{"html_id":"display_name:String|Nil-instance-method","name":"display_name","doc":"A human readable identifier for displaying on interfaces","summary":"

A human readable identifier for displaying on interfaces

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":15,"url":null},"def":{"name":"display_name","return_type":"String | ::Nil","visibility":"Public","body":"@display_name"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier for the zone.","summary":"

A universally unique identifier for the zone.

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":9,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"location:String|Nil-instance-method","name":"location","doc":"Geo-location string (lat,long) or any other location","summary":"

Geo-location string (lat,long) or any other location

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":18,"url":null},"def":{"name":"location","return_type":"String | ::Nil","visibility":"Public","body":"@location"}},{"html_id":"map_id:String|Nil-instance-method","name":"map_id","doc":"Map identifier, could be a URL or id","summary":"

Map identifier, could be a URL or id

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":36,"url":null},"def":{"name":"map_id","return_type":"String | ::Nil","visibility":"Public","body":"@map_id"}},{"html_id":"name:String-instance-method","name":"name","doc":"A human readable identifier.","summary":"

A human readable identifier.

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":12,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"parent_id:String|Nil-instance-method","name":"parent_id","doc":"Parent id","summary":"

Parent id

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":45,"url":null},"def":{"name":"parent_id","return_type":"String | ::Nil","visibility":"Public","body":"@parent_id"}},{"html_id":"tags:Array(String)-instance-method","name":"tags","doc":"Space seperated list of tags for categorizing the zone.","summary":"

Space seperated list of tags for categorizing the zone.

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":39,"url":null},"def":{"name":"tags","return_type":"Array(String)","visibility":"Public","body":"@tags"}},{"html_id":"timezone:Time::Location|Nil-instance-method","name":"timezone","doc":"Timezone location of the zone","summary":"

Timezone location of the zone

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":52,"url":null},"def":{"name":"timezone","return_type":"Time::Location | ::Nil","visibility":"Public","body":"@timezone"}},{"html_id":"trigger_data:Array(Trigger)|Nil-instance-method","name":"trigger_data","doc":"Trigger data returned when param `complete` is `true`","summary":"

Trigger data returned when param complete is true

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":48,"url":null},"def":{"name":"trigger_data","return_type":"Array(Trigger) | ::Nil","visibility":"Public","body":"@trigger_data"}},{"html_id":"triggers:Array(String)-instance-method","name":"triggers","doc":"List of trigger ID's to be applied to all systems that associate with this zone.","summary":"

List of trigger ID's to be applied to all systems that associate with this zone.

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":42,"url":null},"def":{"name":"triggers","return_type":"Array(String)","visibility":"Public","body":"@triggers"}},{"html_id":"type:String|Nil-instance-method","name":"type","doc":"Could be used as floor type or building type etc","summary":"

Could be used as floor type or building type etc

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":27,"url":null},"def":{"name":"type","return_type":"String | ::Nil","visibility":"Public","body":"@type"}}]}]}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper","path":"PlaceOS/Client/APIWrapper.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper","abstract":false,"superclass":{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper.cr","line_number":18,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"}],"namespace":{"html_id":"placeos/PlaceOS/Client","kind":"class","full_name":"PlaceOS::Client","name":"Client"},"constructors":[{"html_id":"new(uri:URI|String,host_header:String|Nil=nil,insecure:Bool=false,&authenticate:HTTP::Client->)-class-method","name":"new","abstract":false,"args":[{"name":"uri","external_name":"uri","restriction":"URI | String"},{"name":"host_header","default_value":"nil","external_name":"host_header","restriction":"String | ::Nil"},{"name":"insecure","default_value":"false","external_name":"insecure","restriction":"::Bool"}],"args_string":"(uri : URI | String, host_header : String | Nil = nil, insecure : Bool = false, &authenticate : HTTP::Client -> )","args_html":"(uri : URI | String, host_header : String | Nil = nil, insecure : Bool = false, &authenticate : HTTP::Client -> )","location":{"filename":"src/placeos/api_wrapper.cr","line_number":31,"url":null},"def":{"name":"new","args":[{"name":"uri","external_name":"uri","restriction":"URI | String"},{"name":"host_header","default_value":"nil","external_name":"host_header","restriction":"String | ::Nil"},{"name":"insecure","default_value":"false","external_name":"insecure","restriction":"::Bool"}],"yields":1,"block_arity":1,"block_arg":{"name":"authenticate","external_name":"authenticate","restriction":"(HTTP::Client ->)"},"visibility":"Public","body":"_ = allocate\n_.initialize(uri, host_header, insecure, &authenticate) do |_arg0|\n yield _arg0\nend\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}},{"html_id":"new(uri:URI|String,host_header:String|Nil=nil,insecure:Bool=false)-class-method","name":"new","abstract":false,"args":[{"name":"uri","external_name":"uri","restriction":"URI | String"},{"name":"host_header","default_value":"nil","external_name":"host_header","restriction":"String | ::Nil"},{"name":"insecure","default_value":"false","external_name":"insecure","restriction":"::Bool"}],"args_string":"(uri : URI | String, host_header : String | Nil = nil, insecure : Bool = false)","args_html":"(uri : URI | String, host_header : String | Nil = nil, insecure : Bool = false)","location":{"filename":"src/placeos/api_wrapper.cr","line_number":36,"url":null},"def":{"name":"new","args":[{"name":"uri","external_name":"uri","restriction":"URI | String"},{"name":"host_header","default_value":"nil","external_name":"host_header","restriction":"String | ::Nil"},{"name":"insecure","default_value":"false","external_name":"insecure","restriction":"::Bool"}],"visibility":"Public","body":"_ = allocate\n_.initialize(uri, host_header, insecure)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"connection(&)-instance-method","name":"connection","abstract":false,"location":{"filename":"src/placeos/api_wrapper.cr","line_number":40,"url":null},"def":{"name":"connection","yields":1,"block_arity":1,"visibility":"Public","body":"HTTP::Client.new(uri) do |client|\n if insecure\n client.tls?.try(&.verify_mode = :NONE)\n end\n authenticate.call(client)\n yield client\nend"}}],"types":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/APIKeys","path":"PlaceOS/Client/APIWrapper/APIKeys.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::APIKeys","name":"APIKeys","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":74,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":9,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,user_id:String,description:String|Nil=nil,scopes:Array(String)|Nil=nil,permissions:PlaceOS::Model::UserJWT::Permissions|Nil=nil)-instance-method","name":"create","doc":"Creates a new zone.","summary":"

Creates a new zone.

","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"user_id","external_name":"user_id","restriction":"String"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"Array(String) | ::Nil"},{"name":"permissions","default_value":"nil","external_name":"permissions","restriction":"::PlaceOS::Model::UserJWT::Permissions | ::Nil"}],"args_string":"(name : String, user_id : String, description : String | Nil = nil, scopes : Array(String) | Nil = nil, permissions : PlaceOS::Model::UserJWT::Permissions | Nil = nil)","args_html":"(name : String, user_id : String, description : String | Nil = nil, scopes : Array(String) | Nil = nil, permissions : PlaceOS::Model::UserJWT::Permissions | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":15,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"user_id","external_name":"user_id","restriction":"String"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"Array(String) | ::Nil"},{"name":"permissions","default_value":"nil","external_name":"permissions","restriction":"::PlaceOS::Model::UserJWT::Permissions | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: API::Models::APIKey)"}},{"html_id":"inspect_jwt-instance-method","name":"inspect_jwt","doc":"Get a clear text version of the JWT token","summary":"

Get a clear text version of the JWT token

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":38,"url":null},"def":{"name":"inspect_jwt","visibility":"Public","body":"get(\"#{base}/inspect\", as: ::PlaceOS::Model::UserJWT)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,authority_id:String|Nil=nil)-instance-method","name":"search","doc":"List or search for zones.\n\nResults maybe filtered by specifying a query - *q* - to search across zone\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* zones will be returned, with a paging based on *offset*.\n\nResults my also also be limited to those associated with specific *tags*.","summary":"

List or search for zones.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":63,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::APIKey))"}},{"html_id":"update(id:String,name:String|Nil=nil,user_id:String|Nil=nil,description:String|Nil=nil,scopes:Array(String)|Nil=nil,permissions:PlaceOS::Model::UserJWT::Permissions|Nil=nil)-instance-method","name":"update","doc":"Updates zone attributes or configuration.","summary":"

Updates zone attributes or configuration.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"user_id","default_value":"nil","external_name":"user_id","restriction":"String | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"Array(String) | ::Nil"},{"name":"permissions","default_value":"nil","external_name":"permissions","restriction":"::PlaceOS::Model::UserJWT::Permissions | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, user_id : String | Nil = nil, description : String | Nil = nil, scopes : Array(String) | Nil = nil, permissions : PlaceOS::Model::UserJWT::Permissions | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, user_id : String | Nil = nil, description : String | Nil = nil, scopes : Array(String) | Nil = nil, permissions : PlaceOS::Model::UserJWT::Permissions | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":26,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"user_id","default_value":"nil","external_name":"user_id","restriction":"String | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"Array(String) | ::Nil"},{"name":"permissions","default_value":"nil","external_name":"permissions","restriction":"::PlaceOS::Model::UserJWT::Permissions | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: API::Models::APIKey)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/AssetInstances","path":"PlaceOS/Client/APIWrapper/AssetInstances.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AssetInstances","name":"AssetInstances","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/asset_instances.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/asset_instances.cr","line_number":9,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,usage_start:Time,usage_end:Time)-instance-method","name":"create","doc":"Creates a new asset instance.","summary":"

Creates a new asset instance.

","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"usage_start","external_name":"usage_start","restriction":"Time"},{"name":"usage_end","external_name":"usage_end","restriction":"Time"}],"args_string":"(name : String, usage_start : Time, usage_end : Time)","args_html":"(name : String, usage_start : Time, usage_end : Time)","location":{"filename":"src/placeos/api_wrapper/asset_instances.cr","line_number":15,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"usage_start","external_name":"usage_start","restriction":"Time"},{"name":"usage_end","external_name":"usage_end","restriction":"Time"}],"visibility":"Public","body":"post(base, body: from_args, as: API::Models::AssetInstance)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0)-instance-method","name":"search","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0)","location":{"filename":"src/placeos/api_wrapper/asset_instances.cr","line_number":55,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::AssetInstance))"}},{"html_id":"update(id:String,name:String|Nil=nil,purchase_date:Time|Nil=nil,identifier:String|Nil=nil,purchase_price:Int32|Nil=nil)-instance-method","name":"update","doc":"Updates asset instance attributes or configuration.","summary":"

Updates asset instance attributes or configuration.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"purchase_date","default_value":"nil","external_name":"purchase_date","restriction":"Time | ::Nil"},{"name":"identifier","default_value":"nil","external_name":"identifier","restriction":"String | ::Nil"},{"name":"purchase_price","default_value":"nil","external_name":"purchase_price","restriction":"Int32 | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, purchase_date : Time | Nil = nil, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, purchase_date : Time | Nil = nil, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/asset_instances.cr","line_number":24,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"purchase_date","default_value":"nil","external_name":"purchase_date","restriction":"Time | ::Nil"},{"name":"identifier","default_value":"nil","external_name":"identifier","restriction":"String | ::Nil"},{"name":"purchase_price","default_value":"nil","external_name":"purchase_price","restriction":"Int32 | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: API::Models::AssetInstance)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Assets","path":"PlaceOS/Client/APIWrapper/Assets.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Assets","name":"Assets","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/assets.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"asset_instances(id:String)-instance-method","name":"asset_instances","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/assets.cr","line_number":35,"url":null},"def":{"name":"asset_instances","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"get(\"#{base}/#{id}/asset_instances\", as: Array(API::Models::AssetInstance))"}},{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/assets.cr","line_number":9,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,purchase_date:Time,identifier:String|Nil=nil,purchase_price:Int32|Nil=nil)-instance-method","name":"create","doc":"Creates a new asset.","summary":"

Creates a new asset.

","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"purchase_date","external_name":"purchase_date","restriction":"Time"},{"name":"identifier","default_value":"nil","external_name":"identifier","restriction":"String | ::Nil"},{"name":"purchase_price","default_value":"nil","external_name":"purchase_price","restriction":"Int32 | ::Nil"}],"args_string":"(name : String, purchase_date : Time, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil)","args_html":"(name : String, purchase_date : Time, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/assets.cr","line_number":15,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"purchase_date","external_name":"purchase_date","restriction":"Time"},{"name":"identifier","default_value":"nil","external_name":"identifier","restriction":"String | ::Nil"},{"name":"purchase_price","default_value":"nil","external_name":"purchase_price","restriction":"Int32 | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: API::Models::Asset)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,parent:String|Nil=nil)-instance-method","name":"search","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"parent","default_value":"nil","external_name":"parent","restriction":"String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, parent : String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, parent : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/assets.cr","line_number":60,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"parent","default_value":"nil","external_name":"parent","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::Asset))"}},{"html_id":"update(id:String,name:String|Nil=nil,purchase_date:Time|Nil=nil,identifier:String|Nil=nil,purchase_price:Int32|Nil=nil)-instance-method","name":"update","doc":"Updates asset attributes or configuration.","summary":"

Updates asset attributes or configuration.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"purchase_date","default_value":"nil","external_name":"purchase_date","restriction":"Time | ::Nil"},{"name":"identifier","default_value":"nil","external_name":"identifier","restriction":"String | ::Nil"},{"name":"purchase_price","default_value":"nil","external_name":"purchase_price","restriction":"Int32 | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, purchase_date : Time | Nil = nil, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, purchase_date : Time | Nil = nil, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/assets.cr","line_number":25,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"purchase_date","default_value":"nil","external_name":"purchase_date","restriction":"Time | ::Nil"},{"name":"identifier","default_value":"nil","external_name":"identifier","restriction":"String | ::Nil"},{"name":"purchase_price","default_value":"nil","external_name":"purchase_price","restriction":"Int32 | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: API::Models::Asset)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","path":"PlaceOS/Client/APIWrapper/AuthBase.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase(Model)","name":"AuthBase","abstract":true,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/auths/base.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"subclasses":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Ldap","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Ldap","name":"Ldap"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/OAuth","kind":"class","full_name":"PlaceOS::Client::APIWrapper::OAuth","name":"OAuth"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Saml","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Saml","name":"Saml"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/endpoint.cr","line_number":11,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = AuthBase(Model).allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"create(**args):Model-instance-method","name":"create","abstract":false,"location":{"filename":"src/placeos/api_wrapper/auths/base.cr","line_number":38,"url":null},"def":{"name":"create","double_splat":{"name":"args","external_name":"args","restriction":""},"return_type":"Model","visibility":"Public","body":"post(base, body: from_args, as: Model)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,authority_id:String|Nil=nil)-instance-method","name":"search","doc":"List or search.\n\nResults maybe filtered by specifying a query - *q* - to search across\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* documents will be returned, with a paging based on *offset*.","summary":"

List or search.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/base.cr","line_number":25,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(Model))"}},{"html_id":"update(**args)-instance-method","name":"update","abstract":false,"location":{"filename":"src/placeos/api_wrapper/auths/base.cr","line_number":34,"url":null},"def":{"name":"update","double_splat":{"name":"args","external_name":"args","restriction":""},"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: Model)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Authority","path":"PlaceOS/Client/APIWrapper/Authority.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Authority","name":"Authority","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/authority.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/authority.cr","line_number":5,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"fetch-instance-method","name":"fetch","doc":"Gets the authority metadata for the attached instance.","summary":"

Gets the authority metadata for the attached instance.

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/authority.cr","line_number":8,"url":null},"def":{"name":"fetch","visibility":"Public","body":"get(base, as: API::Models::Authority)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Cluster","path":"PlaceOS/Client/APIWrapper/Cluster.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Cluster","name":"Cluster","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/cluster.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/cluster.cr","line_number":5,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Domains","path":"PlaceOS/Client/APIWrapper/Domains.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Domains","name":"Domains","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/domains.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/domains.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Drivers","path":"PlaceOS/Client/APIWrapper/Drivers.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Drivers","name":"Drivers","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/drivers.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/drivers.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,role:Role,commit:String,file_name:String,module_name:String,repository_id:String,default_uri:String|Nil=nil,default_port:Int32|Nil=nil,description:String|Nil=nil,ignore_connected:Bool|Nil=nil)-instance-method","name":"create","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"role","external_name":"role","restriction":"Role"},{"name":"commit","external_name":"commit","restriction":"String"},{"name":"file_name","external_name":"file_name","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"repository_id","external_name":"repository_id","restriction":"String"},{"name":"default_uri","default_value":"nil","external_name":"default_uri","restriction":"String | ::Nil"},{"name":"default_port","default_value":"nil","external_name":"default_port","restriction":"Int32 | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"}],"args_string":"(name : String, role : Role, commit : String, file_name : String, module_name : String, repository_id : String, default_uri : String | Nil = nil, default_port : Int32 | Nil = nil, description : String | Nil = nil, ignore_connected : Bool | Nil = nil)","args_html":"(name : String, role : Role, commit : String, file_name : String, module_name : String, repository_id : String, default_uri : String | Nil = nil, default_port : Int32 | Nil = nil, description : String | Nil = nil, ignore_connected : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/drivers.cr","line_number":30,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"role","external_name":"role","restriction":"Role"},{"name":"commit","external_name":"commit","restriction":"String"},{"name":"file_name","external_name":"file_name","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"repository_id","external_name":"repository_id","restriction":"String"},{"name":"default_uri","default_value":"nil","external_name":"default_uri","restriction":"String | ::Nil"},{"name":"default_port","default_value":"nil","external_name":"default_port","restriction":"Int32 | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: Driver)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0)-instance-method","name":"search","doc":"List or search for drivers.\n\nResults maybe filtered by specifying a query - *q* - to search across driver\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* drivers will be returned, with a paging based on *offset*.","summary":"

List or search for drivers.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0)","location":{"filename":"src/placeos/api_wrapper/drivers.cr","line_number":26,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(Driver))"}},{"html_id":"update(id:String,name:String|Nil=nil,role:Role|Nil=nil,commit:String|Nil=nil,file_name:String|Nil=nil,module_name:String|Nil=nil,default_uri:String|Nil=nil,default_port:Int32|Nil=nil,description:String|Nil=nil,ignore_connected:Bool|Nil=nil)-instance-method","name":"update","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"role","default_value":"nil","external_name":"role","restriction":"Role | ::Nil"},{"name":"commit","default_value":"nil","external_name":"commit","restriction":"String | ::Nil"},{"name":"file_name","default_value":"nil","external_name":"file_name","restriction":"String | ::Nil"},{"name":"module_name","default_value":"nil","external_name":"module_name","restriction":"String | ::Nil"},{"name":"default_uri","default_value":"nil","external_name":"default_uri","restriction":"String | ::Nil"},{"name":"default_port","default_value":"nil","external_name":"default_port","restriction":"Int32 | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, role : Role | Nil = nil, commit : String | Nil = nil, file_name : String | Nil = nil, module_name : String | Nil = nil, default_uri : String | Nil = nil, default_port : Int32 | Nil = nil, description : String | Nil = nil, ignore_connected : Bool | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, role : Role | Nil = nil, commit : String | Nil = nil, file_name : String | Nil = nil, module_name : String | Nil = nil, default_uri : String | Nil = nil, default_port : Int32 | Nil = nil, description : String | Nil = nil, ignore_connected : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/drivers.cr","line_number":45,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"role","default_value":"nil","external_name":"role","restriction":"Role | ::Nil"},{"name":"commit","default_value":"nil","external_name":"commit","restriction":"String | ::Nil"},{"name":"file_name","default_value":"nil","external_name":"file_name","restriction":"String | ::Nil"},{"name":"module_name","default_value":"nil","external_name":"module_name","restriction":"String | ::Nil"},{"name":"default_uri","default_value":"nil","external_name":"default_uri","restriction":"String | ::Nil"},{"name":"default_port","default_value":"nil","external_name":"default_port","restriction":"Int32 | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: Driver)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Ldap","path":"PlaceOS/Client/APIWrapper/Ldap.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Ldap","name":"Ldap","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase","name":"AuthBase"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase","name":"AuthBase"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/auths/ldap.cr","line_number":7,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/endpoint.cr","line_number":11,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/auths/ldap.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,authority_id:String,host:String,base:String,port:Int32|Nil=nil,auth_method:String|Nil=nil,uid:String|Nil=nil,bind_dn:String|Nil=nil,password:String|Nil=nil,filter:String|Nil=nil)-instance-method","name":"create","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"authority_id","external_name":"authority_id","restriction":"String"},{"name":"host","external_name":"host","restriction":"String"},{"name":"base","external_name":"base","restriction":"String"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int32 | ::Nil"},{"name":"auth_method","default_value":"nil","external_name":"auth_method","restriction":"String | ::Nil"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"bind_dn","default_value":"nil","external_name":"bind_dn","restriction":"String | ::Nil"},{"name":"password","default_value":"nil","external_name":"password","restriction":"String | ::Nil"},{"name":"filter","default_value":"nil","external_name":"filter","restriction":"String | ::Nil"}],"args_string":"(name : String, authority_id : String, host : String, base : String, port : Int32 | Nil = nil, auth_method : String | Nil = nil, uid : String | Nil = nil, bind_dn : String | Nil = nil, password : String | Nil = nil, filter : String | Nil = nil)","args_html":"(name : String, authority_id : String, host : String, base : String, port : Int32 | Nil = nil, auth_method : String | Nil = nil, uid : String | Nil = nil, bind_dn : String | Nil = nil, password : String | Nil = nil, filter : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/ldap.cr","line_number":10,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"authority_id","external_name":"authority_id","restriction":"String"},{"name":"host","external_name":"host","restriction":"String"},{"name":"base","external_name":"base","restriction":"String"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int32 | ::Nil"},{"name":"auth_method","default_value":"nil","external_name":"auth_method","restriction":"String | ::Nil"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"bind_dn","default_value":"nil","external_name":"bind_dn","restriction":"String | ::Nil"},{"name":"password","default_value":"nil","external_name":"password","restriction":"String | ::Nil"},{"name":"filter","default_value":"nil","external_name":"filter","restriction":"String | ::Nil"}],"visibility":"Public","body":"super(**args)"}},{"html_id":"update(id:String,name:String|Nil=nil,authority_id:String|Nil=nil,port:Int32|Nil=nil,auth_method:String|Nil=nil,uid:String|Nil=nil,host:String|Nil=nil,base:String|Nil=nil,bind_dn:String|Nil=nil,password:String|Nil=nil,filter:String|Nil=nil)-instance-method","name":"update","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int32 | ::Nil"},{"name":"auth_method","default_value":"nil","external_name":"auth_method","restriction":"String | ::Nil"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"host","default_value":"nil","external_name":"host","restriction":"String | ::Nil"},{"name":"base","default_value":"nil","external_name":"base","restriction":"String | ::Nil"},{"name":"bind_dn","default_value":"nil","external_name":"bind_dn","restriction":"String | ::Nil"},{"name":"password","default_value":"nil","external_name":"password","restriction":"String | ::Nil"},{"name":"filter","default_value":"nil","external_name":"filter","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, port : Int32 | Nil = nil, auth_method : String | Nil = nil, uid : String | Nil = nil, host : String | Nil = nil, base : String | Nil = nil, bind_dn : String | Nil = nil, password : String | Nil = nil, filter : String | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, port : Int32 | Nil = nil, auth_method : String | Nil = nil, uid : String | Nil = nil, host : String | Nil = nil, base : String | Nil = nil, bind_dn : String | Nil = nil, password : String | Nil = nil, filter : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/ldap.cr","line_number":25,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int32 | ::Nil"},{"name":"auth_method","default_value":"nil","external_name":"auth_method","restriction":"String | ::Nil"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"host","default_value":"nil","external_name":"host","restriction":"String | ::Nil"},{"name":"base","default_value":"nil","external_name":"base","restriction":"String | ::Nil"},{"name":"bind_dn","default_value":"nil","external_name":"bind_dn","restriction":"String | ::Nil"},{"name":"password","default_value":"nil","external_name":"password","restriction":"String | ::Nil"},{"name":"filter","default_value":"nil","external_name":"filter","restriction":"String | ::Nil"}],"visibility":"Public","body":"super(**args)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Metadata","path":"PlaceOS/Client/APIWrapper/Metadata.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Metadata","name":"Metadata","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":6,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"children(id:String,name:String|Nil=nil)-instance-method","name":"children","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil)","args_html":"(id : String, name : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":12,"url":null},"def":{"name":"children","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(\"#{base}/#{id}/children\", params: from_args, as: Array(NamedTuple(zone: API::Models::Zone, metadata: Hash(String, API::Models::Metadata))))"}},{"html_id":"destroy(id:String,name:String)-instance-method","name":"destroy","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","external_name":"name","restriction":"String"}],"args_string":"(id : String, name : String)","args_html":"(id : String, name : String)","location":{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":38,"url":null},"def":{"name":"destroy","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","external_name":"name","restriction":"String"}],"visibility":"Public","body":"delete(\"#{base}/#{id}\", params: from_args)\nnil\n"}},{"html_id":"fetch(id:String,name:String|Nil=nil)-instance-method","name":"fetch","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil)","args_html":"(id : String, name : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":8,"url":null},"def":{"name":"fetch","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(\"#{base}/#{id}\", params: from_args, as: Hash(String, API::Models::Metadata))"}},{"html_id":"merge(id:String,name:String,details:JSON::Any|Hash|NamedTuple|Array,description:String|Nil=nil)-instance-method","name":"merge","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","external_name":"name","restriction":"String"},{"name":"details","external_name":"details","restriction":"JSON::Any | Hash | NamedTuple | Array"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String, details : JSON::Any | Hash | NamedTuple | Array, description : String | Nil = nil)","args_html":"(id : String, name : String, details : JSON::Any | Hash | NamedTuple | Array, description : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":27,"url":null},"def":{"name":"merge","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","external_name":"name","restriction":"String"},{"name":"details","external_name":"details","restriction":"JSON::Any | Hash | NamedTuple | Array"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"}],"visibility":"Public","body":"params = HTTP::Params {\"name\" => name}\nbody = {name: name, description: description, details: details, parent_id: id}\npatch(\"#{base}/#{id}?#{params}\", body: body, as: API::Models::Metadata)\n"}},{"html_id":"update(id:String,name:String,details:JSON::Any|Hash|NamedTuple|Array,description:String|Nil=nil)-instance-method","name":"update","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","external_name":"name","restriction":"String"},{"name":"details","external_name":"details","restriction":"JSON::Any | Hash | NamedTuple | Array"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String, details : JSON::Any | Hash | NamedTuple | Array, description : String | Nil = nil)","args_html":"(id : String, name : String, details : JSON::Any | Hash | NamedTuple | Array, description : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":16,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","external_name":"name","restriction":"String"},{"name":"details","external_name":"details","restriction":"JSON::Any | Hash | NamedTuple | Array"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"}],"visibility":"Public","body":"params = HTTP::Params {\"name\" => name}\nbody = {name: name, description: description, details: details, parent_id: id}\nput(\"#{base}/#{id}?#{params}\", body: body, as: API::Models::Metadata)\n"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Modules","path":"PlaceOS/Client/APIWrapper/Modules.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Modules","name":"Modules","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/modules.cr","line_number":7,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":11,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(driver_id:String,control_system_id:String|Nil=nil,ip:String|Nil=nil,udp:Bool|Nil=nil,port:Int|Nil=nil,makebreak:Bool|Nil=nil,uri:String|Nil=nil,custom_name:String|Nil=nil,settings:Settings|Nil=nil,notes:String|Nil=nil,ignore_connected:Bool|Nil=nil,ignore_startstop:Bool|Nil=nil)-instance-method","name":"create","doc":"Creates a new module.","summary":"

Creates a new module.

","abstract":false,"args":[{"name":"driver_id","external_name":"driver_id","restriction":"String"},{"name":"control_system_id","default_value":"nil","external_name":"control_system_id","restriction":"String | ::Nil"},{"name":"ip","default_value":"nil","external_name":"ip","restriction":"String | ::Nil"},{"name":"udp","default_value":"nil","external_name":"udp","restriction":"Bool | ::Nil"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int | ::Nil"},{"name":"makebreak","default_value":"nil","external_name":"makebreak","restriction":"Bool | ::Nil"},{"name":"uri","default_value":"nil","external_name":"uri","restriction":"String | ::Nil"},{"name":"custom_name","default_value":"nil","external_name":"custom_name","restriction":"String | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"notes","default_value":"nil","external_name":"notes","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"},{"name":"ignore_startstop","default_value":"nil","external_name":"ignore_startstop","restriction":"Bool | ::Nil"}],"args_string":"(driver_id : String, control_system_id : String | Nil = nil, ip : String | Nil = nil, udp : Bool | Nil = nil, port : Int | Nil = nil, makebreak : Bool | Nil = nil, uri : String | Nil = nil, custom_name : String | Nil = nil, settings : Settings | Nil = nil, notes : String | Nil = nil, ignore_connected : Bool | Nil = nil, ignore_startstop : Bool | Nil = nil)","args_html":"(driver_id : String, control_system_id : String | Nil = nil, ip : String | Nil = nil, udp : Bool | Nil = nil, port : Int | Nil = nil, makebreak : Bool | Nil = nil, uri : String | Nil = nil, custom_name : String | Nil = nil, settings : Settings | Nil = nil, notes : String | Nil = nil, ignore_connected : Bool | Nil = nil, ignore_startstop : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":78,"url":null},"def":{"name":"create","args":[{"name":"driver_id","external_name":"driver_id","restriction":"String"},{"name":"control_system_id","default_value":"nil","external_name":"control_system_id","restriction":"String | ::Nil"},{"name":"ip","default_value":"nil","external_name":"ip","restriction":"String | ::Nil"},{"name":"udp","default_value":"nil","external_name":"udp","restriction":"Bool | ::Nil"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int | ::Nil"},{"name":"makebreak","default_value":"nil","external_name":"makebreak","restriction":"Bool | ::Nil"},{"name":"uri","default_value":"nil","external_name":"uri","restriction":"String | ::Nil"},{"name":"custom_name","default_value":"nil","external_name":"custom_name","restriction":"String | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"notes","default_value":"nil","external_name":"notes","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"},{"name":"ignore_startstop","default_value":"nil","external_name":"ignore_startstop","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: API::Models::Module)"}},{"html_id":"ping(id:String)-instance-method","name":"ping","doc":"Performs a connectivity check with the associated device or service.","summary":"

Performs a connectivity check with the associated device or service.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":29,"url":null},"def":{"name":"ping","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"post(\"#{base}/#{id}/ping\", as: API::Models::Ping)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,control_system_id:String|Nil=nil,driver_id:String|Nil=nil)-instance-method","name":"search","doc":"List or search for modules.\n\nResults maybe filtered by specifying a query - *q* - to search across module\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* systems will be returned, with a paging based on *offset*.\n\nResults my also also be limited to those associated with a specific\n*system_id*, that are instances of a *driver_id*, or any combination of\nthese.","summary":"

List or search for modules.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"control_system_id","default_value":"nil","external_name":"control_system_id","restriction":"String | ::Nil"},{"name":"driver_id","default_value":"nil","external_name":"driver_id","restriction":"String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, control_system_id : String | Nil = nil, driver_id : String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, control_system_id : String | Nil = nil, driver_id : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":64,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"control_system_id","default_value":"nil","external_name":"control_system_id","restriction":"String | ::Nil"},{"name":"driver_id","default_value":"nil","external_name":"driver_id","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::Module))"}},{"html_id":"start(id:String)-instance-method","name":"start","doc":"Starts a module.","summary":"

Starts a module.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":17,"url":null},"def":{"name":"start","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"post(\"#{base}/#{id}/start\")\nnil\n"}},{"html_id":"state(id:String,lookup:String|Nil=nil)-instance-method","name":"state","doc":"Queries the state exposed by a module.","summary":"

Queries the state exposed by a module.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"lookup","default_value":"nil","external_name":"lookup","restriction":"String | ::Nil"}],"args_string":"(id : String, lookup : String | Nil = nil)","args_html":"(id : String, lookup : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":34,"url":null},"def":{"name":"state","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"lookup","default_value":"nil","external_name":"lookup","restriction":"String | ::Nil"}],"visibility":"Public","body":"path = \"#{base}/#{id}/state\"\nif lookup\n path = path + \"/#{lookup}\"\nend\nget(path)\n"}},{"html_id":"stop(id:String)-instance-method","name":"stop","doc":"Stops a module.","summary":"

Stops a module.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":23,"url":null},"def":{"name":"stop","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"post(\"#{base}/#{id}/stop\")\nnil\n"}},{"html_id":"update(id:String,control_system_id:String|Nil=nil,ip:String|Nil=nil,udp:Bool|Nil=nil,port:Int|Nil=nil,makebreak:Bool|Nil=nil,uri:String|Nil=nil,custom_name:String|Nil=nil,settings:Settings|Nil=nil,notes:String|Nil=nil,ignore_connected:Bool|Nil=nil,ignore_startstop:Bool|Nil=nil)-instance-method","name":"update","doc":"Updates module attributes or configuration.","summary":"

Updates module attributes or configuration.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"control_system_id","default_value":"nil","external_name":"control_system_id","restriction":"String | ::Nil"},{"name":"ip","default_value":"nil","external_name":"ip","restriction":"String | ::Nil"},{"name":"udp","default_value":"nil","external_name":"udp","restriction":"Bool | ::Nil"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int | ::Nil"},{"name":"makebreak","default_value":"nil","external_name":"makebreak","restriction":"Bool | ::Nil"},{"name":"uri","default_value":"nil","external_name":"uri","restriction":"String | ::Nil"},{"name":"custom_name","default_value":"nil","external_name":"custom_name","restriction":"String | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"notes","default_value":"nil","external_name":"notes","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"},{"name":"ignore_startstop","default_value":"nil","external_name":"ignore_startstop","restriction":"Bool | ::Nil"}],"args_string":"(id : String, control_system_id : String | Nil = nil, ip : String | Nil = nil, udp : Bool | Nil = nil, port : Int | Nil = nil, makebreak : Bool | Nil = nil, uri : String | Nil = nil, custom_name : String | Nil = nil, settings : Settings | Nil = nil, notes : String | Nil = nil, ignore_connected : Bool | Nil = nil, ignore_startstop : Bool | Nil = nil)","args_html":"(id : String, control_system_id : String | Nil = nil, ip : String | Nil = nil, udp : Bool | Nil = nil, port : Int | Nil = nil, makebreak : Bool | Nil = nil, uri : String | Nil = nil, custom_name : String | Nil = nil, settings : Settings | Nil = nil, notes : String | Nil = nil, ignore_connected : Bool | Nil = nil, ignore_startstop : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":96,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"control_system_id","default_value":"nil","external_name":"control_system_id","restriction":"String | ::Nil"},{"name":"ip","default_value":"nil","external_name":"ip","restriction":"String | ::Nil"},{"name":"udp","default_value":"nil","external_name":"udp","restriction":"Bool | ::Nil"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int | ::Nil"},{"name":"makebreak","default_value":"nil","external_name":"makebreak","restriction":"Bool | ::Nil"},{"name":"uri","default_value":"nil","external_name":"uri","restriction":"String | ::Nil"},{"name":"custom_name","default_value":"nil","external_name":"custom_name","restriction":"String | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"notes","default_value":"nil","external_name":"notes","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"},{"name":"ignore_startstop","default_value":"nil","external_name":"ignore_startstop","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: API::Models::Module)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/OAuth","path":"PlaceOS/Client/APIWrapper/OAuth.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::OAuth","name":"OAuth","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase","name":"AuthBase"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase","name":"AuthBase"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/auths/oauth.cr","line_number":7,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/endpoint.cr","line_number":11,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/auths/oauth.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,authority_id:String,client_id:String|Nil=nil,client_secret:String|Nil=nil,info_mappings:Hash(String,String)|Nil=nil,site:String|Nil=nil,authorize_url:String|Nil=nil,token_method:String|Nil=nil,auth_scheme:String|Nil=nil,token_url:String|Nil=nil,scope:String|Nil=nil,raw_info_url:String|Nil=nil)-instance-method","name":"create","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"authority_id","external_name":"authority_id","restriction":"String"},{"name":"client_id","default_value":"nil","external_name":"client_id","restriction":"String | ::Nil"},{"name":"client_secret","default_value":"nil","external_name":"client_secret","restriction":"String | ::Nil"},{"name":"info_mappings","default_value":"nil","external_name":"info_mappings","restriction":"Hash(String, String) | ::Nil"},{"name":"site","default_value":"nil","external_name":"site","restriction":"String | ::Nil"},{"name":"authorize_url","default_value":"nil","external_name":"authorize_url","restriction":"String | ::Nil"},{"name":"token_method","default_value":"nil","external_name":"token_method","restriction":"String | ::Nil"},{"name":"auth_scheme","default_value":"nil","external_name":"auth_scheme","restriction":"String | ::Nil"},{"name":"token_url","default_value":"nil","external_name":"token_url","restriction":"String | ::Nil"},{"name":"scope","default_value":"nil","external_name":"scope","restriction":"String | ::Nil"},{"name":"raw_info_url","default_value":"nil","external_name":"raw_info_url","restriction":"String | ::Nil"}],"args_string":"(name : String, authority_id : String, client_id : String | Nil = nil, client_secret : String | Nil = nil, info_mappings : Hash(String, String) | Nil = nil, site : String | Nil = nil, authorize_url : String | Nil = nil, token_method : String | Nil = nil, auth_scheme : String | Nil = nil, token_url : String | Nil = nil, scope : String | Nil = nil, raw_info_url : String | Nil = nil)","args_html":"(name : String, authority_id : String, client_id : String | Nil = nil, client_secret : String | Nil = nil, info_mappings : Hash(String, String) | Nil = nil, site : String | Nil = nil, authorize_url : String | Nil = nil, token_method : String | Nil = nil, auth_scheme : String | Nil = nil, token_url : String | Nil = nil, scope : String | Nil = nil, raw_info_url : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/oauth.cr","line_number":10,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"authority_id","external_name":"authority_id","restriction":"String"},{"name":"client_id","default_value":"nil","external_name":"client_id","restriction":"String | ::Nil"},{"name":"client_secret","default_value":"nil","external_name":"client_secret","restriction":"String | ::Nil"},{"name":"info_mappings","default_value":"nil","external_name":"info_mappings","restriction":"Hash(String, String) | ::Nil"},{"name":"site","default_value":"nil","external_name":"site","restriction":"String | ::Nil"},{"name":"authorize_url","default_value":"nil","external_name":"authorize_url","restriction":"String | ::Nil"},{"name":"token_method","default_value":"nil","external_name":"token_method","restriction":"String | ::Nil"},{"name":"auth_scheme","default_value":"nil","external_name":"auth_scheme","restriction":"String | ::Nil"},{"name":"token_url","default_value":"nil","external_name":"token_url","restriction":"String | ::Nil"},{"name":"scope","default_value":"nil","external_name":"scope","restriction":"String | ::Nil"},{"name":"raw_info_url","default_value":"nil","external_name":"raw_info_url","restriction":"String | ::Nil"}],"visibility":"Public","body":"super(**args)"}},{"html_id":"update(id:String,name:String|Nil=nil,authority_id:String|Nil=nil,client_id:String|Nil=nil,client_secret:String|Nil=nil,info_mappings:Hash(String,String)|Nil=nil,site:String|Nil=nil,authorize_url:String|Nil=nil,token_method:String|Nil=nil,auth_scheme:String|Nil=nil,token_url:String|Nil=nil,scope:String|Nil=nil,raw_info_url:String|Nil=nil)-instance-method","name":"update","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"client_id","default_value":"nil","external_name":"client_id","restriction":"String | ::Nil"},{"name":"client_secret","default_value":"nil","external_name":"client_secret","restriction":"String | ::Nil"},{"name":"info_mappings","default_value":"nil","external_name":"info_mappings","restriction":"Hash(String, String) | ::Nil"},{"name":"site","default_value":"nil","external_name":"site","restriction":"String | ::Nil"},{"name":"authorize_url","default_value":"nil","external_name":"authorize_url","restriction":"String | ::Nil"},{"name":"token_method","default_value":"nil","external_name":"token_method","restriction":"String | ::Nil"},{"name":"auth_scheme","default_value":"nil","external_name":"auth_scheme","restriction":"String | ::Nil"},{"name":"token_url","default_value":"nil","external_name":"token_url","restriction":"String | ::Nil"},{"name":"scope","default_value":"nil","external_name":"scope","restriction":"String | ::Nil"},{"name":"raw_info_url","default_value":"nil","external_name":"raw_info_url","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, client_id : String | Nil = nil, client_secret : String | Nil = nil, info_mappings : Hash(String, String) | Nil = nil, site : String | Nil = nil, authorize_url : String | Nil = nil, token_method : String | Nil = nil, auth_scheme : String | Nil = nil, token_url : String | Nil = nil, scope : String | Nil = nil, raw_info_url : String | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, client_id : String | Nil = nil, client_secret : String | Nil = nil, info_mappings : Hash(String, String) | Nil = nil, site : String | Nil = nil, authorize_url : String | Nil = nil, token_method : String | Nil = nil, auth_scheme : String | Nil = nil, token_url : String | Nil = nil, scope : String | Nil = nil, raw_info_url : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/oauth.cr","line_number":27,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"client_id","default_value":"nil","external_name":"client_id","restriction":"String | ::Nil"},{"name":"client_secret","default_value":"nil","external_name":"client_secret","restriction":"String | ::Nil"},{"name":"info_mappings","default_value":"nil","external_name":"info_mappings","restriction":"Hash(String, String) | ::Nil"},{"name":"site","default_value":"nil","external_name":"site","restriction":"String | ::Nil"},{"name":"authorize_url","default_value":"nil","external_name":"authorize_url","restriction":"String | ::Nil"},{"name":"token_method","default_value":"nil","external_name":"token_method","restriction":"String | ::Nil"},{"name":"auth_scheme","default_value":"nil","external_name":"auth_scheme","restriction":"String | ::Nil"},{"name":"token_url","default_value":"nil","external_name":"token_url","restriction":"String | ::Nil"},{"name":"scope","default_value":"nil","external_name":"scope","restriction":"String | ::Nil"},{"name":"raw_info_url","default_value":"nil","external_name":"raw_info_url","restriction":"String | ::Nil"}],"visibility":"Public","body":"super(**args)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/OAuthApplications","path":"PlaceOS/Client/APIWrapper/OAuthApplications.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::OAuthApplications","name":"OAuthApplications","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/oauth_applications.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/oauth_applications.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,uid:String|Nil=nil,secret:String|Nil=nil,scopes:String|Nil=nil,owner_id:String|Nil=nil,redirect_uri:String|Nil=nil,skip_authorization:Bool|Nil=nil,confidential:Bool|Nil=nil,revoked_at:Time|Nil=nil)-instance-method","name":"create","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"secret","default_value":"nil","external_name":"secret","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"String | ::Nil"},{"name":"owner_id","default_value":"nil","external_name":"owner_id","restriction":"String | ::Nil"},{"name":"redirect_uri","default_value":"nil","external_name":"redirect_uri","restriction":"String | ::Nil"},{"name":"skip_authorization","default_value":"nil","external_name":"skip_authorization","restriction":"Bool | ::Nil"},{"name":"confidential","default_value":"nil","external_name":"confidential","restriction":"Bool | ::Nil"},{"name":"revoked_at","default_value":"nil","external_name":"revoked_at","restriction":"Time | ::Nil"}],"args_string":"(name : String, uid : String | Nil = nil, secret : String | Nil = nil, scopes : String | Nil = nil, owner_id : String | Nil = nil, redirect_uri : String | Nil = nil, skip_authorization : Bool | Nil = nil, confidential : Bool | Nil = nil, revoked_at : Time | Nil = nil)","args_html":"(name : String, uid : String | Nil = nil, secret : String | Nil = nil, scopes : String | Nil = nil, owner_id : String | Nil = nil, redirect_uri : String | Nil = nil, skip_authorization : Bool | Nil = nil, confidential : Bool | Nil = nil, revoked_at : Time | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/oauth_applications.cr","line_number":50,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"secret","default_value":"nil","external_name":"secret","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"String | ::Nil"},{"name":"owner_id","default_value":"nil","external_name":"owner_id","restriction":"String | ::Nil"},{"name":"redirect_uri","default_value":"nil","external_name":"redirect_uri","restriction":"String | ::Nil"},{"name":"skip_authorization","default_value":"nil","external_name":"skip_authorization","restriction":"Bool | ::Nil"},{"name":"confidential","default_value":"nil","external_name":"confidential","restriction":"Bool | ::Nil"},{"name":"revoked_at","default_value":"nil","external_name":"revoked_at","restriction":"Time | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: OAuthApplication)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,authority:String|Nil=nil)-instance-method","name":"search","doc":"List or search for applications.\n\nResults maybe filtered by specifying a query - *q* - to search across application\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* application will be returned, with a paging based on *offset*.","summary":"

List or search for applications.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority","default_value":"nil","external_name":"authority","restriction":"String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority : String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/oauth_applications.cr","line_number":26,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority","default_value":"nil","external_name":"authority","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(OAuthApplication))"}},{"html_id":"update(id:String,name:String|Nil=nil,uid:String|Nil=nil,secret:String|Nil=nil,scopes:String|Nil=nil,owner_id:String|Nil=nil,redirect_uri:String|Nil=nil,skip_authorization:Bool|Nil=nil,confidential:Bool|Nil=nil,revoked_at:Time|Nil=nil)-instance-method","name":"update","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"secret","default_value":"nil","external_name":"secret","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"String | ::Nil"},{"name":"owner_id","default_value":"nil","external_name":"owner_id","restriction":"String | ::Nil"},{"name":"redirect_uri","default_value":"nil","external_name":"redirect_uri","restriction":"String | ::Nil"},{"name":"skip_authorization","default_value":"nil","external_name":"skip_authorization","restriction":"Bool | ::Nil"},{"name":"confidential","default_value":"nil","external_name":"confidential","restriction":"Bool | ::Nil"},{"name":"revoked_at","default_value":"nil","external_name":"revoked_at","restriction":"Time | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, uid : String | Nil = nil, secret : String | Nil = nil, scopes : String | Nil = nil, owner_id : String | Nil = nil, redirect_uri : String | Nil = nil, skip_authorization : Bool | Nil = nil, confidential : Bool | Nil = nil, revoked_at : Time | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, uid : String | Nil = nil, secret : String | Nil = nil, scopes : String | Nil = nil, owner_id : String | Nil = nil, redirect_uri : String | Nil = nil, skip_authorization : Bool | Nil = nil, confidential : Bool | Nil = nil, revoked_at : Time | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/oauth_applications.cr","line_number":35,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"secret","default_value":"nil","external_name":"secret","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"String | ::Nil"},{"name":"owner_id","default_value":"nil","external_name":"owner_id","restriction":"String | ::Nil"},{"name":"redirect_uri","default_value":"nil","external_name":"redirect_uri","restriction":"String | ::Nil"},{"name":"skip_authorization","default_value":"nil","external_name":"skip_authorization","restriction":"Bool | ::Nil"},{"name":"confidential","default_value":"nil","external_name":"confidential","restriction":"Bool | ::Nil"},{"name":"revoked_at","default_value":"nil","external_name":"revoked_at","restriction":"Time | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: OAuthApplication)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Repositories","path":"PlaceOS/Client/APIWrapper/Repositories.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Repositories","name":"Repositories","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/repositories.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/repositories.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Root","path":"PlaceOS/Client/APIWrapper/Root.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Root","name":"Root","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/root.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/root.cr","line_number":5,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"signal(channel:String,payload)-instance-method","name":"signal","doc":"send data to listening drivers","summary":"

send data to listening drivers

","abstract":false,"args":[{"name":"channel","external_name":"channel","restriction":"String"},{"name":"payload","external_name":"payload","restriction":""}],"args_string":"(channel : String, payload)","args_html":"(channel : String, payload)","location":{"filename":"src/placeos/api_wrapper/root.cr","line_number":8,"url":null},"def":{"name":"signal","args":[{"name":"channel","external_name":"channel","restriction":"String"},{"name":"payload","external_name":"payload","restriction":""}],"visibility":"Public","body":"post(\"#{base}/signal?channel=#{channel}\", body: payload)"}},{"html_id":"version-instance-method","name":"version","abstract":false,"location":{"filename":"src/placeos/api_wrapper/root.cr","line_number":15,"url":null},"def":{"name":"version","visibility":"Public","body":"get(\"#{base}/version\", as: API::Models::Version)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Saml","path":"PlaceOS/Client/APIWrapper/Saml.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Saml","name":"Saml","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase","name":"AuthBase"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase","name":"AuthBase"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/auths/saml.cr","line_number":7,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/endpoint.cr","line_number":11,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/auths/saml.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,authority_id:String,issuer:String,idp_sso_target_url:String,name_identifier_format:String,assertion_consumer_service_url:String,request_attributes:Array(NamedTuple(name:String,name_format:String,friendly_name:String)),idp_sso_target_url_runtime_params:Hash(String,String)|Nil=nil,uid_getter:String|Nil=nil,idp_cert:String|Nil=nil,idp_cert_fingerprint:String|Nil=nil,getter_service_name:String|Nil=nil,getter_statements:Hash(String,Array(String))|Nil=nil,idp_slo_target_url:String|Nil=nil,slo_default_relay_state:String|Nil=nil)-instance-method","name":"create","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"authority_id","external_name":"authority_id","restriction":"String"},{"name":"issuer","external_name":"issuer","restriction":"String"},{"name":"idp_sso_target_url","external_name":"idp_sso_target_url","restriction":"String"},{"name":"name_identifier_format","external_name":"name_identifier_format","restriction":"String"},{"name":"assertion_consumer_service_url","external_name":"assertion_consumer_service_url","restriction":"String"},{"name":"request_attributes","external_name":"request_attributes","restriction":"Array(NamedTuple(name: String, name_format: String, friendly_name: String))"},{"name":"idp_sso_target_url_runtime_params","default_value":"nil","external_name":"idp_sso_target_url_runtime_params","restriction":"Hash(String, String) | ::Nil"},{"name":"uid_getter","default_value":"nil","external_name":"uid_getter","restriction":"String | ::Nil"},{"name":"idp_cert","default_value":"nil","external_name":"idp_cert","restriction":"String | ::Nil"},{"name":"idp_cert_fingerprint","default_value":"nil","external_name":"idp_cert_fingerprint","restriction":"String | ::Nil"},{"name":"getter_service_name","default_value":"nil","external_name":"getter_service_name","restriction":"String | ::Nil"},{"name":"getter_statements","default_value":"nil","external_name":"getter_statements","restriction":"Hash(String, Array(String)) | ::Nil"},{"name":"idp_slo_target_url","default_value":"nil","external_name":"idp_slo_target_url","restriction":"String | ::Nil"},{"name":"slo_default_relay_state","default_value":"nil","external_name":"slo_default_relay_state","restriction":"String | ::Nil"}],"args_string":"(name : String, authority_id : String, issuer : String, idp_sso_target_url : String, name_identifier_format : String, assertion_consumer_service_url : String, request_attributes : Array(NamedTuple(name: String, name_format: String, friendly_name: String)), idp_sso_target_url_runtime_params : Hash(String, String) | Nil = nil, uid_getter : String | Nil = nil, idp_cert : String | Nil = nil, idp_cert_fingerprint : String | Nil = nil, getter_service_name : String | Nil = nil, getter_statements : Hash(String, Array(String)) | Nil = nil, idp_slo_target_url : String | Nil = nil, slo_default_relay_state : String | Nil = nil)","args_html":"(name : String, authority_id : String, issuer : String, idp_sso_target_url : String, name_identifier_format : String, assertion_consumer_service_url : String, request_attributes : Array(NamedTuple(name: String, name_format: String, friendly_name: String)), idp_sso_target_url_runtime_params : Hash(String, String) | Nil = nil, uid_getter : String | Nil = nil, idp_cert : String | Nil = nil, idp_cert_fingerprint : String | Nil = nil, getter_service_name : String | Nil = nil, getter_statements : Hash(String, Array(String)) | Nil = nil, idp_slo_target_url : String | Nil = nil, slo_default_relay_state : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/saml.cr","line_number":10,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"authority_id","external_name":"authority_id","restriction":"String"},{"name":"issuer","external_name":"issuer","restriction":"String"},{"name":"idp_sso_target_url","external_name":"idp_sso_target_url","restriction":"String"},{"name":"name_identifier_format","external_name":"name_identifier_format","restriction":"String"},{"name":"assertion_consumer_service_url","external_name":"assertion_consumer_service_url","restriction":"String"},{"name":"request_attributes","external_name":"request_attributes","restriction":"Array(NamedTuple(name: String, name_format: String, friendly_name: String))"},{"name":"idp_sso_target_url_runtime_params","default_value":"nil","external_name":"idp_sso_target_url_runtime_params","restriction":"Hash(String, String) | ::Nil"},{"name":"uid_getter","default_value":"nil","external_name":"uid_getter","restriction":"String | ::Nil"},{"name":"idp_cert","default_value":"nil","external_name":"idp_cert","restriction":"String | ::Nil"},{"name":"idp_cert_fingerprint","default_value":"nil","external_name":"idp_cert_fingerprint","restriction":"String | ::Nil"},{"name":"getter_service_name","default_value":"nil","external_name":"getter_service_name","restriction":"String | ::Nil"},{"name":"getter_statements","default_value":"nil","external_name":"getter_statements","restriction":"Hash(String, Array(String)) | ::Nil"},{"name":"idp_slo_target_url","default_value":"nil","external_name":"idp_slo_target_url","restriction":"String | ::Nil"},{"name":"slo_default_relay_state","default_value":"nil","external_name":"slo_default_relay_state","restriction":"String | ::Nil"}],"visibility":"Public","body":"super(**args)"}},{"html_id":"update(id:String,name:String|Nil=nil,authority_id:String|Nil=nil,issuer:String|Nil=nil,idp_sso_target_url:String|Nil=nil,name_identifier_format:String|Nil=nil,assertion_consumer_service_url:String|Nil=nil,request_attributes:Array(NamedTuple(name:String,name_format:String,friendly_name:String))|Nil=nil,idp_sso_target_url_runtime_params:Hash(String,String)|Nil=nil,uid_getter:String|Nil=nil,idp_cert:String|Nil=nil,idp_cert_fingerprint:String|Nil=nil,getter_service_name:String|Nil=nil,getter_statements:Hash(String,Array(String))|Nil=nil,idp_slo_target_url:String|Nil=nil,slo_default_relay_state:String|Nil=nil)-instance-method","name":"update","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"issuer","default_value":"nil","external_name":"issuer","restriction":"String | ::Nil"},{"name":"idp_sso_target_url","default_value":"nil","external_name":"idp_sso_target_url","restriction":"String | ::Nil"},{"name":"name_identifier_format","default_value":"nil","external_name":"name_identifier_format","restriction":"String | ::Nil"},{"name":"assertion_consumer_service_url","default_value":"nil","external_name":"assertion_consumer_service_url","restriction":"String | ::Nil"},{"name":"request_attributes","default_value":"nil","external_name":"request_attributes","restriction":"Array(NamedTuple(name: String, name_format: String, friendly_name: String)) | ::Nil"},{"name":"idp_sso_target_url_runtime_params","default_value":"nil","external_name":"idp_sso_target_url_runtime_params","restriction":"Hash(String, String) | ::Nil"},{"name":"uid_getter","default_value":"nil","external_name":"uid_getter","restriction":"String | ::Nil"},{"name":"idp_cert","default_value":"nil","external_name":"idp_cert","restriction":"String | ::Nil"},{"name":"idp_cert_fingerprint","default_value":"nil","external_name":"idp_cert_fingerprint","restriction":"String | ::Nil"},{"name":"getter_service_name","default_value":"nil","external_name":"getter_service_name","restriction":"String | ::Nil"},{"name":"getter_statements","default_value":"nil","external_name":"getter_statements","restriction":"Hash(String, Array(String)) | ::Nil"},{"name":"idp_slo_target_url","default_value":"nil","external_name":"idp_slo_target_url","restriction":"String | ::Nil"},{"name":"slo_default_relay_state","default_value":"nil","external_name":"slo_default_relay_state","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, issuer : String | Nil = nil, idp_sso_target_url : String | Nil = nil, name_identifier_format : String | Nil = nil, assertion_consumer_service_url : String | Nil = nil, request_attributes : Array(NamedTuple(name: String, name_format: String, friendly_name: String)) | Nil = nil, idp_sso_target_url_runtime_params : Hash(String, String) | Nil = nil, uid_getter : String | Nil = nil, idp_cert : String | Nil = nil, idp_cert_fingerprint : String | Nil = nil, getter_service_name : String | Nil = nil, getter_statements : Hash(String, Array(String)) | Nil = nil, idp_slo_target_url : String | Nil = nil, slo_default_relay_state : String | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, issuer : String | Nil = nil, idp_sso_target_url : String | Nil = nil, name_identifier_format : String | Nil = nil, assertion_consumer_service_url : String | Nil = nil, request_attributes : Array(NamedTuple(name: String, name_format: String, friendly_name: String)) | Nil = nil, idp_sso_target_url_runtime_params : Hash(String, String) | Nil = nil, uid_getter : String | Nil = nil, idp_cert : String | Nil = nil, idp_cert_fingerprint : String | Nil = nil, getter_service_name : String | Nil = nil, getter_statements : Hash(String, Array(String)) | Nil = nil, idp_slo_target_url : String | Nil = nil, slo_default_relay_state : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/saml.cr","line_number":30,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"issuer","default_value":"nil","external_name":"issuer","restriction":"String | ::Nil"},{"name":"idp_sso_target_url","default_value":"nil","external_name":"idp_sso_target_url","restriction":"String | ::Nil"},{"name":"name_identifier_format","default_value":"nil","external_name":"name_identifier_format","restriction":"String | ::Nil"},{"name":"assertion_consumer_service_url","default_value":"nil","external_name":"assertion_consumer_service_url","restriction":"String | ::Nil"},{"name":"request_attributes","default_value":"nil","external_name":"request_attributes","restriction":"Array(NamedTuple(name: String, name_format: String, friendly_name: String)) | ::Nil"},{"name":"idp_sso_target_url_runtime_params","default_value":"nil","external_name":"idp_sso_target_url_runtime_params","restriction":"Hash(String, String) | ::Nil"},{"name":"uid_getter","default_value":"nil","external_name":"uid_getter","restriction":"String | ::Nil"},{"name":"idp_cert","default_value":"nil","external_name":"idp_cert","restriction":"String | ::Nil"},{"name":"idp_cert_fingerprint","default_value":"nil","external_name":"idp_cert_fingerprint","restriction":"String | ::Nil"},{"name":"getter_service_name","default_value":"nil","external_name":"getter_service_name","restriction":"String | ::Nil"},{"name":"getter_statements","default_value":"nil","external_name":"getter_statements","restriction":"Hash(String, Array(String)) | ::Nil"},{"name":"idp_slo_target_url","default_value":"nil","external_name":"idp_slo_target_url","restriction":"String | ::Nil"},{"name":"slo_default_relay_state","default_value":"nil","external_name":"slo_default_relay_state","restriction":"String | ::Nil"}],"visibility":"Public","body":"super(**args)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Settings","path":"PlaceOS/Client/APIWrapper/Settings.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Settings","name":"Settings","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/settings.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/settings.cr","line_number":56,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(parent_id:String,settings_string:String,encryption_level:Encryption::Level=Encryption::Level::Support)-instance-method","name":"create","doc":"Create new settings.","summary":"

Create new settings.

","abstract":false,"args":[{"name":"parent_id","external_name":"parent_id","restriction":"String"},{"name":"settings_string","external_name":"settings_string","restriction":"String"},{"name":"encryption_level","default_value":"Encryption::Level::Support","external_name":"encryption_level","restriction":"Encryption::Level"}],"args_string":"(parent_id : String, settings_string : String, encryption_level : Encryption::Level = Encryption::Level::Support)","args_html":"(parent_id : String, settings_string : String, encryption_level : Encryption::Level = Encryption::Level::Support)","location":{"filename":"src/placeos/api_wrapper/settings.cr","line_number":13,"url":null},"def":{"name":"create","args":[{"name":"parent_id","external_name":"parent_id","restriction":"String"},{"name":"settings_string","external_name":"settings_string","restriction":"String"},{"name":"encryption_level","default_value":"Encryption::Level::Support","external_name":"encryption_level","restriction":"Encryption::Level"}],"visibility":"Public","body":"YAML.parse(settings_string)\ncreate_actual(parent_id, settings_string, encryption_level.to_i)\n"}},{"html_id":"search(parent_ids:Array(String))-instance-method","name":"search","abstract":false,"args":[{"name":"parent_ids","external_name":"parent_ids","restriction":"Array(String)"}],"args_string":"(parent_ids : Array(String))","args_html":"(parent_ids : Array(String))","location":{"filename":"src/placeos/api_wrapper/settings.cr","line_number":42,"url":null},"def":{"name":"search","args":[{"name":"parent_ids","external_name":"parent_ids","restriction":"Array(String)"}],"visibility":"Public","body":"search(parent_id: parent_ids.join(\",\"))"}},{"html_id":"search(q:String|Nil=nil,limit:Int=1000,offset:Int=0,parent_id:String|Nil=nil)-instance-method","name":"search","doc":"List or search for systems.","summary":"

List or search for systems.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"1000","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 1000, offset : Int = 0, parent_id : String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 1000, offset : Int = 0, parent_id : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/settings.cr","line_number":47,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"1000","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::Settings))"}},{"html_id":"update(id:String,settings_string:String)-instance-method","name":"update","doc":"Update settings.","summary":"

Update settings.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"settings_string","external_name":"settings_string","restriction":"String"}],"args_string":"(id : String, settings_string : String)","args_html":"(id : String, settings_string : String)","location":{"filename":"src/placeos/api_wrapper/settings.cr","line_number":31,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"settings_string","external_name":"settings_string","restriction":"String"}],"visibility":"Public","body":"YAML.parse(settings_string)\nput(\"#{base}/#{id}\", body: from_args, as: API::Models::Settings)\n"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Systems","path":"PlaceOS/Client/APIWrapper/Systems.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Systems","name":"Systems","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/systems.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":163,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":7,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"count(id:String,module_name:String):Int32|Nil-instance-method","name":"count","doc":"Gets the number of *module_name* instances available in system *id*.","summary":"

Gets the number of module_name instances available in system id.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"}],"args_string":"(id : String, module_name : String) : Int32 | Nil","args_html":"(id : String, module_name : String) : Int32 | Nil","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":48,"url":null},"def":{"name":"count","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"}],"return_type":"Int32 | ::Nil","visibility":"Public","body":"(types(id))[module_name]?"}},{"html_id":"create(name:String,zones:Array(String),description:String|Nil=nil,email:String|Nil=nil,capacity:Int|Nil=nil,bookable:Bool|Nil=nil,installed_ui_devices:Int|Nil=nil,modules:Array(String)|Nil=nil,support_url:String|Nil=nil,display_name:String|Nil=nil,timezone:String|Nil=nil,code:String|Nil=nil,type:String|Nil=nil,map_id:String|Nil=nil,images:Array(String)|Nil=nil,features:Array(String)|Nil=nil,public:Bool|Nil=nil)-instance-method","name":"create","doc":"Creates a new system.\n\nSystems must be given a unique *name* within the PlaceOS instance they are\nrunning from. Additionally, a system must be a member of at least one\n*zone*. All other attributes are optional at the time of creation.","summary":"

Creates a new system.

","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"zones","external_name":"zones","restriction":"Array(String)"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"email","default_value":"nil","external_name":"email","restriction":"String | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int | ::Nil"},{"name":"bookable","default_value":"nil","external_name":"bookable","restriction":"Bool | ::Nil"},{"name":"installed_ui_devices","default_value":"nil","external_name":"installed_ui_devices","restriction":"Int | ::Nil"},{"name":"modules","default_value":"nil","external_name":"modules","restriction":"Array(String) | ::Nil"},{"name":"support_url","default_value":"nil","external_name":"support_url","restriction":"String | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"timezone","default_value":"nil","external_name":"timezone","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"images","default_value":"nil","external_name":"images","restriction":"Array(String) | ::Nil"},{"name":"features","default_value":"nil","external_name":"features","restriction":"Array(String) | ::Nil"},{"name":"public","default_value":"nil","external_name":"public","restriction":"Bool | ::Nil"}],"args_string":"(name : String, zones : Array(String), description : String | Nil = nil, email : String | Nil = nil, capacity : Int | Nil = nil, bookable : Bool | Nil = nil, installed_ui_devices : Int | Nil = nil, modules : Array(String) | Nil = nil, support_url : String | Nil = nil, display_name : String | Nil = nil, timezone : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, map_id : String | Nil = nil, images : Array(String) | Nil = nil, features : Array(String) | Nil = nil, public : Bool | Nil = nil)","args_html":"(name : String, zones : Array(String), description : String | Nil = nil, email : String | Nil = nil, capacity : Int | Nil = nil, bookable : Bool | Nil = nil, installed_ui_devices : Int | Nil = nil, modules : Array(String) | Nil = nil, support_url : String | Nil = nil, display_name : String | Nil = nil, timezone : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, map_id : String | Nil = nil, images : Array(String) | Nil = nil, features : Array(String) | Nil = nil, public : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":69,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"zones","external_name":"zones","restriction":"Array(String)"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"email","default_value":"nil","external_name":"email","restriction":"String | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int | ::Nil"},{"name":"bookable","default_value":"nil","external_name":"bookable","restriction":"Bool | ::Nil"},{"name":"installed_ui_devices","default_value":"nil","external_name":"installed_ui_devices","restriction":"Int | ::Nil"},{"name":"modules","default_value":"nil","external_name":"modules","restriction":"Array(String) | ::Nil"},{"name":"support_url","default_value":"nil","external_name":"support_url","restriction":"String | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"timezone","default_value":"nil","external_name":"timezone","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"images","default_value":"nil","external_name":"images","restriction":"Array(String) | ::Nil"},{"name":"features","default_value":"nil","external_name":"features","restriction":"Array(String) | ::Nil"},{"name":"public","default_value":"nil","external_name":"public","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: System)"}},{"html_id":"execute(id:String,module_name:String,method:String,index:Int32=1,*args:Array(JSON::Any::Type))-instance-method","name":"execute","doc":"Executes a behaviour exposed by a module within the passed system *id*.","summary":"

Executes a behaviour exposed by a module within the passed system id.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"method","external_name":"method","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int32"},{"name":"args","external_name":"args","restriction":"Array(JSON::Any::Type)"}],"args_string":"(id : String, module_name : String, method : String, index : Int32 = 1, *args : Array(JSON::Any::Type))","args_html":"(id : String, module_name : String, method : String, index : Int32 = 1, *args : Array(JSON::Any::Type))","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":25,"url":null},"def":{"name":"execute","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"method","external_name":"method","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int32"},{"name":"args","external_name":"args","restriction":"Array(JSON::Any::Type)"}],"splat_index":4,"visibility":"Public","body":"post(\"#{base}/#{id}/#{module_name}_#{index}/#{method}\", body: args)"}},{"html_id":"functions(id:String,module_name:String,index:Int=1)-instance-method","name":"functions","doc":"Queries the behaviour exposed by a module within system *id*.","summary":"

Queries the behaviour exposed by a module within system id.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int"}],"args_string":"(id : String, module_name : String, index : Int = 1)","args_html":"(id : String, module_name : String, index : Int = 1)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":43,"url":null},"def":{"name":"functions","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int"}],"visibility":"Public","body":"get(\"#{base}/#{id}/functions/#{module_name}_#{index}\", as: Hash(String, Function))"}},{"html_id":"search(q:String|Nil=nil,limit:Int=1000,offset:Int=0,zone_id:String|Nil=nil,module_id:String|Nil=nil,features:String|Nil=nil,capacity:Int32|Nil=nil,bookable:Bool|Nil=nil)-instance-method","name":"search","doc":"List or search for systems.\n\nResults maybe filtered by specifying a query - *q* - to search across system\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* systems will be returned, with a paging based on *offset*.","summary":"

List or search for systems.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"1000","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"zone_id","default_value":"nil","external_name":"zone_id","restriction":"String | ::Nil"},{"name":"module_id","default_value":"nil","external_name":"module_id","restriction":"String | ::Nil"},{"name":"features","default_value":"nil","external_name":"features","restriction":"String | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int32 | ::Nil"},{"name":"bookable","default_value":"nil","external_name":"bookable","restriction":"Bool | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 1000, offset : Int = 0, zone_id : String | Nil = nil, module_id : String | Nil = nil, features : String | Nil = nil, capacity : Int32 | Nil = nil, bookable : Bool | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 1000, offset : Int = 0, zone_id : String | Nil = nil, module_id : String | Nil = nil, features : String | Nil = nil, capacity : Int32 | Nil = nil, bookable : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":140,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"1000","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"zone_id","default_value":"nil","external_name":"zone_id","restriction":"String | ::Nil"},{"name":"module_id","default_value":"nil","external_name":"module_id","restriction":"String | ::Nil"},{"name":"features","default_value":"nil","external_name":"features","restriction":"String | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int32 | ::Nil"},{"name":"bookable","default_value":"nil","external_name":"bookable","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(System))"}},{"html_id":"settings(id:String)-instance-method","name":"settings","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":57,"url":null},"def":{"name":"settings","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"get(\"#{base}/#{id}/settings\", as: Array(Settings))"}},{"html_id":"start(id:String)-instance-method","name":"start","doc":"Start all modules within a system.","summary":"

Start all modules within a system.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":13,"url":null},"def":{"name":"start","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"post(\"#{base}/#{id}/start\")\nnil\n"}},{"html_id":"state(id:String,module_name:String,index:Int=1,lookup:String|Nil=nil)-instance-method","name":"state","doc":"Queries the state exposed by a module within the passed system *id*.","summary":"

Queries the state exposed by a module within the passed system id.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int"},{"name":"lookup","default_value":"nil","external_name":"lookup","restriction":"String | ::Nil"}],"args_string":"(id : String, module_name : String, index : Int = 1, lookup : String | Nil = nil)","args_html":"(id : String, module_name : String, index : Int = 1, lookup : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":36,"url":null},"def":{"name":"state","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int"},{"name":"lookup","default_value":"nil","external_name":"lookup","restriction":"String | ::Nil"}],"visibility":"Public","body":"path = \"#{base}/#{id}/#{module_name}_#{index}\"\nif lookup.nil?\nelse\n path = path + \"/#{lookup}\"\nend\nget(path)\n"}},{"html_id":"stop(id:String)-instance-method","name":"stop","doc":"Stops all modules within a system.","summary":"

Stops all modules within a system.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":19,"url":null},"def":{"name":"stop","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"post(\"#{base}/#{id}/stop\")\nnil\n"}},{"html_id":"types(id:String)-instance-method","name":"types","doc":"Queries the types of modules available in system *id*.","summary":"

Queries the types of modules available in system id.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":53,"url":null},"def":{"name":"types","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"get(\"#{base}/#{id}/types\", as: Hash(String, Int32))"}},{"html_id":"update(id:String,version:Int,name:String|Nil=nil,zones:Array(String)|Nil=nil,description:String|Nil=nil,email:String|Nil=nil,capacity:Int|Nil=nil,bookable:Bool|Nil=nil,installed_ui_devices:Int|Nil=nil,modules:Array(String)|Nil=nil,support_url:String|Nil=nil,display_name:String|Nil=nil,timezone:String|Nil=nil,code:String|Nil=nil,type:String|Nil=nil,map_id:String|Nil=nil,images:Array(String)|Nil=nil,features:Array(String)|Nil=nil,public:Bool|Nil=nil)-instance-method","name":"update","doc":"Requests a change to an existing system.\n\nIn addition to specifying the ID of the system to update, you must reference\nthe the current system metadata *version* for the update to be allowed. This\nmust match the current version attribute of the system and will be\nincrememented following a successful update.","summary":"

Requests a change to an existing system.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"version","external_name":"version","restriction":"Int"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"zones","default_value":"nil","external_name":"zones","restriction":"Array(String) | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"email","default_value":"nil","external_name":"email","restriction":"String | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int | ::Nil"},{"name":"bookable","default_value":"nil","external_name":"bookable","restriction":"Bool | ::Nil"},{"name":"installed_ui_devices","default_value":"nil","external_name":"installed_ui_devices","restriction":"Int | ::Nil"},{"name":"modules","default_value":"nil","external_name":"modules","restriction":"Array(String) | ::Nil"},{"name":"support_url","default_value":"nil","external_name":"support_url","restriction":"String | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"timezone","default_value":"nil","external_name":"timezone","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"images","default_value":"nil","external_name":"images","restriction":"Array(String) | ::Nil"},{"name":"features","default_value":"nil","external_name":"features","restriction":"Array(String) | ::Nil"},{"name":"public","default_value":"nil","external_name":"public","restriction":"Bool | ::Nil"}],"args_string":"(id : String, version : Int, name : String | Nil = nil, zones : Array(String) | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, capacity : Int | Nil = nil, bookable : Bool | Nil = nil, installed_ui_devices : Int | Nil = nil, modules : Array(String) | Nil = nil, support_url : String | Nil = nil, display_name : String | Nil = nil, timezone : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, map_id : String | Nil = nil, images : Array(String) | Nil = nil, features : Array(String) | Nil = nil, public : Bool | Nil = nil)","args_html":"(id : String, version : Int, name : String | Nil = nil, zones : Array(String) | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, capacity : Int | Nil = nil, bookable : Bool | Nil = nil, installed_ui_devices : Int | Nil = nil, modules : Array(String) | Nil = nil, support_url : String | Nil = nil, display_name : String | Nil = nil, timezone : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, map_id : String | Nil = nil, images : Array(String) | Nil = nil, features : Array(String) | Nil = nil, public : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":97,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"version","external_name":"version","restriction":"Int"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"zones","default_value":"nil","external_name":"zones","restriction":"Array(String) | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"email","default_value":"nil","external_name":"email","restriction":"String | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int | ::Nil"},{"name":"bookable","default_value":"nil","external_name":"bookable","restriction":"Bool | ::Nil"},{"name":"installed_ui_devices","default_value":"nil","external_name":"installed_ui_devices","restriction":"Int | ::Nil"},{"name":"modules","default_value":"nil","external_name":"modules","restriction":"Array(String) | ::Nil"},{"name":"support_url","default_value":"nil","external_name":"support_url","restriction":"String | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"timezone","default_value":"nil","external_name":"timezone","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"images","default_value":"nil","external_name":"images","restriction":"Array(String) | ::Nil"},{"name":"features","default_value":"nil","external_name":"features","restriction":"Array(String) | ::Nil"},{"name":"public","default_value":"nil","external_name":"public","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", params: \"version=#{version}\", body: from_args, as: System)"}},{"html_id":"with_emails(list:Array(String)|String)-instance-method","name":"with_emails","doc":"Returns systems with a specified email address(es)\n","summary":"

Returns systems with a specified email address(es)

","abstract":false,"args":[{"name":"list","external_name":"list","restriction":"Array(String) | String"}],"args_string":"(list : Array(String) | String)","args_html":"(list : Array(String) | String)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":155,"url":null},"def":{"name":"with_emails","args":[{"name":"list","external_name":"list","restriction":"Array(String) | String"}],"visibility":"Public","body":"query = list.is_a?(Array) ? list.join(',') : list\nget(\"#{base}/with_emails\", params: HTTP::Params {\"in\" => query}, as: Array(System))\n"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/SystemTriggers","path":"PlaceOS/Client/APIWrapper/SystemTriggers.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::SystemTriggers","name":"SystemTriggers","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/system_triggers.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"SystemTriggers are embedded beneath a systems route","summary":"

SystemTriggers are embedded beneath a systems route

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/system_triggers.cr","line_number":6,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Triggers","path":"PlaceOS/Client/APIWrapper/Triggers.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Triggers","name":"Triggers","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/triggers.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/triggers.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Users","path":"PlaceOS/Client/APIWrapper/Users.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Users","name":"Users","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/users.cr","line_number":7,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"doc":"TODO:\n- create\n- update","summary":"

TODO - create - update

","instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/users.cr","line_number":11,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"current-instance-method","name":"current","abstract":false,"location":{"filename":"src/placeos/api_wrapper/users.cr","line_number":13,"url":null},"def":{"name":"current","visibility":"Public","body":"get(\"#{base}/current\", as: User)"}},{"html_id":"resource_token-instance-method","name":"resource_token","abstract":false,"location":{"filename":"src/placeos/api_wrapper/users.cr","line_number":17,"url":null},"def":{"name":"resource_token","visibility":"Public","body":"post(\"#{base}/resource_token\", as: ResourceToken)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,authority_id:String|Nil=nil,include_deleted:Bool=false,include_metadata:Bool=false)-instance-method","name":"search","doc":"List or search for users.\n\nResults maybe filtered by specifying a query - *q* - to search across zone\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* zones will be returned, with a paging based on *offset*.\n\nResults my also also be limited to those associated with specific *tags*.","summary":"

List or search for users.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"include_deleted","default_value":"false","external_name":"include_deleted","restriction":"Bool"},{"name":"include_metadata","default_value":"false","external_name":"include_metadata","restriction":"Bool"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil, include_deleted : Bool = false, include_metadata : Bool = false)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil, include_deleted : Bool = false, include_metadata : Bool = false)","location":{"filename":"src/placeos/api_wrapper/users.cr","line_number":39,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"include_deleted","default_value":"false","external_name":"include_deleted","restriction":"Bool"},{"name":"include_metadata","default_value":"false","external_name":"include_metadata","restriction":"Bool"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::User))"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Zones","path":"PlaceOS/Client/APIWrapper/Zones.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Zones","name":"Zones","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/zones.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/zones.cr","line_number":99,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/zones.cr","line_number":9,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,description:String|Nil=nil,tags:Array(String)|Nil=nil,settings:Settings|Nil=nil,triggers:Array(String)|Nil=nil,display_name:String|Nil=nil,location:String|Nil=nil,code:String|Nil=nil,type:String|Nil=nil,count:Int32|Nil=nil,capacity:Int32|Nil=nil,map_id:String|Nil=nil,parent_id:String|Nil=nil)-instance-method","name":"create","doc":"Creates a new zone.","summary":"

Creates a new zone.

","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"tags","default_value":"nil","external_name":"tags","restriction":"Array(String) | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"triggers","default_value":"nil","external_name":"triggers","restriction":"Array(String) | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"location","default_value":"nil","external_name":"location","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"count","default_value":"nil","external_name":"count","restriction":"Int32 | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int32 | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"}],"args_string":"(name : String, description : String | Nil = nil, tags : Array(String) | Nil = nil, settings : Settings | Nil = nil, triggers : Array(String) | Nil = nil, display_name : String | Nil = nil, location : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, count : Int32 | Nil = nil, capacity : Int32 | Nil = nil, map_id : String | Nil = nil, parent_id : String | Nil = nil)","args_html":"(name : String, description : String | Nil = nil, tags : Array(String) | Nil = nil, settings : Settings | Nil = nil, triggers : Array(String) | Nil = nil, display_name : String | Nil = nil, location : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, count : Int32 | Nil = nil, capacity : Int32 | Nil = nil, map_id : String | Nil = nil, parent_id : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/zones.cr","line_number":28,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"tags","default_value":"nil","external_name":"tags","restriction":"Array(String) | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"triggers","default_value":"nil","external_name":"triggers","restriction":"Array(String) | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"location","default_value":"nil","external_name":"location","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"count","default_value":"nil","external_name":"count","restriction":"Int32 | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int32 | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: API::Models::Zone)"}},{"html_id":"execute(id:String,method:String,module_name:String,index:Int32=1,args=nil)-instance-method","name":"execute","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"method","external_name":"method","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int32"},{"name":"args","default_value":"nil","external_name":"args","restriction":""}],"args_string":"(id : String, method : String, module_name : String, index : Int32 = 1, args = nil)","args_html":"(id : String, method : String, module_name : String, index : Int32 = 1, args = nil)","location":{"filename":"src/placeos/api_wrapper/zones.cr","line_number":14,"url":null},"def":{"name":"execute","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"method","external_name":"method","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int32"},{"name":"args","default_value":"nil","external_name":"args","restriction":""}],"visibility":"Public","body":"post(\"#{base}/#{id}/#{module_name}_#{index}/#{method}\", body: args)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,parent_id:String|Nil=nil,tags:Array(String)|String|Nil=nil)-instance-method","name":"search","doc":"List or search for zones.\n\nResults maybe filtered by specifying a query - *q* - to search across zone\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* zones will be returned, with a paging based on *offset*.\n\nResults my also also be limited to those associated with specific *tags*.","summary":"

List or search for zones.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"},{"name":"tags","default_value":"nil","external_name":"tags","restriction":"Array(String) | String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, parent_id : String | Nil = nil, tags : Array(String) | String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, parent_id : String | Nil = nil, tags : Array(String) | String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/zones.cr","line_number":87,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"},{"name":"tags","default_value":"nil","external_name":"tags","restriction":"Array(String) | String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::Zone))"}},{"html_id":"update(id:String,name:String|Nil=nil,description:String|Nil=nil,tags:Array(String)|Nil=nil,settings:Settings|Nil=nil,triggers:Array(String)|Nil=nil,display_name:String|Nil=nil,location:String|Nil=nil,code:String|Nil=nil,type:String|Nil=nil,count:Int32|Nil=nil,capacity:Int32|Nil=nil,map_id:String|Nil=nil,parent_id:String|Nil=nil)-instance-method","name":"update","doc":"Updates zone attributes or configuration.","summary":"

Updates zone attributes or configuration.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"tags","default_value":"nil","external_name":"tags","restriction":"Array(String) | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"triggers","default_value":"nil","external_name":"triggers","restriction":"Array(String) | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"location","default_value":"nil","external_name":"location","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"count","default_value":"nil","external_name":"count","restriction":"Int32 | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int32 | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, description : String | Nil = nil, tags : Array(String) | Nil = nil, settings : Settings | Nil = nil, triggers : Array(String) | Nil = nil, display_name : String | Nil = nil, location : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, count : Int32 | Nil = nil, capacity : Int32 | Nil = nil, map_id : String | Nil = nil, parent_id : String | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, description : String | Nil = nil, tags : Array(String) | Nil = nil, settings : Settings | Nil = nil, triggers : Array(String) | Nil = nil, display_name : String | Nil = nil, location : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, count : Int32 | Nil = nil, capacity : Int32 | Nil = nil, map_id : String | Nil = nil, parent_id : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/zones.cr","line_number":47,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"tags","default_value":"nil","external_name":"tags","restriction":"Array(String) | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"triggers","default_value":"nil","external_name":"triggers","restriction":"Array(String) | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"location","default_value":"nil","external_name":"location","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"count","default_value":"nil","external_name":"count","restriction":"Int32 | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int32 | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: API::Models::Zone)"}}]}]}]}]}]}} \ No newline at end of file diff --git a/js/doc.js b/js/doc.js new file mode 100644 index 0000000..eaedd5c --- /dev/null +++ b/js/doc.js @@ -0,0 +1,1099 @@ +window.CrystalDocs = (window.CrystalDocs || {}); + +CrystalDocs.base_path = (CrystalDocs.base_path || ""); + +CrystalDocs.searchIndex = (CrystalDocs.searchIndex || false); +CrystalDocs.MAX_RESULTS_DISPLAY = 140; + +CrystalDocs.runQuery = function(query) { + function searchType(type, query, results) { + var matches = []; + var matchedFields = []; + var name = type.full_name; + var i = name.lastIndexOf("::"); + if (i > 0) { + name = name.substring(i + 2); + } + var nameMatches = query.matches(name); + if (nameMatches){ + matches = matches.concat(nameMatches); + matchedFields.push("name"); + } + + var namespaceMatches = query.matchesNamespace(type.full_name); + if(namespaceMatches){ + matches = matches.concat(namespaceMatches); + matchedFields.push("name"); + } + + var docMatches = query.matches(type.doc); + if(docMatches){ + matches = matches.concat(docMatches); + matchedFields.push("doc"); + } + if (matches.length > 0) { + results.push({ + id: type.html_id, + result_type: "type", + kind: type.kind, + name: name, + full_name: type.full_name, + href: type.path, + summary: type.summary, + matched_fields: matchedFields, + matched_terms: matches + }); + } + + if (type.instance_methods) { + type.instance_methods.forEach(function(method) { + searchMethod(method, type, "instance_method", query, results); + }) + } + if (type.class_methods) { + type.class_methods.forEach(function(method) { + searchMethod(method, type, "class_method", query, results); + }) + } + if (type.constructors) { + type.constructors.forEach(function(constructor) { + searchMethod(constructor, type, "constructor", query, results); + }) + } + if (type.macros) { + type.macros.forEach(function(macro) { + searchMethod(macro, type, "macro", query, results); + }) + } + if (type.constants) { + type.constants.forEach(function(constant){ + searchConstant(constant, type, query, results); + }); + } + if (type.types) { + type.types.forEach(function(subtype){ + searchType(subtype, query, results); + }); + } + }; + + function searchMethod(method, type, kind, query, results) { + var matches = []; + var matchedFields = []; + var nameMatches = query.matchesMethod(method.name, kind, type); + if (nameMatches){ + matches = matches.concat(nameMatches); + matchedFields.push("name"); + } + + if (method.args) { + method.args.forEach(function(arg){ + var argMatches = query.matches(arg.external_name); + if (argMatches) { + matches = matches.concat(argMatches); + matchedFields.push("args"); + } + }); + } + + var docMatches = query.matches(type.doc); + if(docMatches){ + matches = matches.concat(docMatches); + matchedFields.push("doc"); + } + + if (matches.length > 0) { + var typeMatches = query.matches(type.full_name); + if (typeMatches) { + matchedFields.push("type"); + matches = matches.concat(typeMatches); + } + results.push({ + id: method.html_id, + type: type.full_name, + result_type: kind, + name: method.name, + full_name: type.full_name + "#" + method.name, + args_string: method.args_string, + summary: method.summary, + href: type.path + "#" + method.html_id, + matched_fields: matchedFields, + matched_terms: matches + }); + } + } + + function searchConstant(constant, type, query, results) { + var matches = []; + var matchedFields = []; + var nameMatches = query.matches(constant.name); + if (nameMatches){ + matches = matches.concat(nameMatches); + matchedFields.push("name"); + } + var docMatches = query.matches(constant.doc); + if(docMatches){ + matches = matches.concat(docMatches); + matchedFields.push("doc"); + } + if (matches.length > 0) { + var typeMatches = query.matches(type.full_name); + if (typeMatches) { + matchedFields.push("type"); + matches = matches.concat(typeMatches); + } + results.push({ + id: constant.id, + type: type.full_name, + result_type: "constant", + name: constant.name, + full_name: type.full_name + "#" + constant.name, + value: constant.value, + summary: constant.summary, + href: type.path + "#" + constant.id, + matched_fields: matchedFields, + matched_terms: matches + }); + } + } + + var results = []; + searchType(CrystalDocs.searchIndex.program, query, results); + return results; +}; + +CrystalDocs.rankResults = function(results, query) { + function uniqueArray(ar) { + var j = {}; + + ar.forEach(function(v) { + j[v + "::" + typeof v] = v; + }); + + return Object.keys(j).map(function(v) { + return j[v]; + }); + } + + results = results.sort(function(a, b) { + var matchedTermsDiff = uniqueArray(b.matched_terms).length - uniqueArray(a.matched_terms).length; + var aHasDocs = b.matched_fields.includes("doc"); + var bHasDocs = b.matched_fields.includes("doc"); + + var aOnlyDocs = aHasDocs && a.matched_fields.length == 1; + var bOnlyDocs = bHasDocs && b.matched_fields.length == 1; + + if (a.result_type == "type" && b.result_type != "type" && !aOnlyDocs) { + if(CrystalDocs.DEBUG) { console.log("a is type b not"); } + return -1; + } else if (b.result_type == "type" && a.result_type != "type" && !bOnlyDocs) { + if(CrystalDocs.DEBUG) { console.log("b is type, a not"); } + return 1; + } + if (a.matched_fields.includes("name")) { + if (b.matched_fields.includes("name")) { + var a_name = (CrystalDocs.prefixForType(a.result_type) || "") + ((a.result_type == "type") ? a.full_name : a.name); + var b_name = (CrystalDocs.prefixForType(b.result_type) || "") + ((b.result_type == "type") ? b.full_name : b.name); + a_name = a_name.toLowerCase(); + b_name = b_name.toLowerCase(); + for(var i = 0; i < query.normalizedTerms.length; i++) { + var term = query.terms[i].replace(/^::?|::?$/, ""); + var a_orig_index = a_name.indexOf(term); + var b_orig_index = b_name.indexOf(term); + if(CrystalDocs.DEBUG) { console.log("term: " + term + " a: " + a_name + " b: " + b_name); } + if(CrystalDocs.DEBUG) { console.log(a_orig_index, b_orig_index, a_orig_index - b_orig_index); } + if (a_orig_index >= 0) { + if (b_orig_index >= 0) { + if(CrystalDocs.DEBUG) { console.log("both have exact match", a_orig_index > b_orig_index ? -1 : 1); } + if(a_orig_index != b_orig_index) { + if(CrystalDocs.DEBUG) { console.log("both have exact match at different positions", a_orig_index > b_orig_index ? 1 : -1); } + return a_orig_index > b_orig_index ? 1 : -1; + } + } else { + if(CrystalDocs.DEBUG) { console.log("a has exact match, b not"); } + return -1; + } + } else if (b_orig_index >= 0) { + if(CrystalDocs.DEBUG) { console.log("b has exact match, a not"); } + return 1; + } + } + } else { + if(CrystalDocs.DEBUG) { console.log("a has match in name, b not"); } + return -1; + } + } else if ( + !a.matched_fields.includes("name") && + b.matched_fields.includes("name") + ) { + return 1; + } + + if (matchedTermsDiff != 0 || (aHasDocs != bHasDocs)) { + if(CrystalDocs.DEBUG) { console.log("matchedTermsDiff: " + matchedTermsDiff, aHasDocs, bHasDocs); } + return matchedTermsDiff; + } + + var matchedFieldsDiff = b.matched_fields.length - a.matched_fields.length; + if (matchedFieldsDiff != 0) { + if(CrystalDocs.DEBUG) { console.log("matched to different number of fields: " + matchedFieldsDiff); } + return matchedFieldsDiff > 0 ? 1 : -1; + } + + var nameCompare = a.name.localeCompare(b.name); + if(nameCompare != 0){ + if(CrystalDocs.DEBUG) { console.log("nameCompare resulted in: " + a.name + "<=>" + b.name + ": " + nameCompare); } + return nameCompare > 0 ? 1 : -1; + } + + if(a.matched_fields.includes("args") && b.matched_fields.includes("args")) { + for(var i = 0; i < query.terms.length; i++) { + var term = query.terms[i]; + var aIndex = a.args_string.indexOf(term); + var bIndex = b.args_string.indexOf(term); + if(CrystalDocs.DEBUG) { console.log("index of " + term + " in args_string: " + aIndex + " - " + bIndex); } + if(aIndex >= 0){ + if(bIndex >= 0){ + if(aIndex != bIndex){ + return aIndex > bIndex ? 1 : -1; + } + }else{ + return -1; + } + }else if(bIndex >= 0) { + return 1; + } + } + } + + return 0; + }); + + if (results.length > 1) { + // if we have more than two search terms, only include results with the most matches + var bestMatchedTerms = uniqueArray(results[0].matched_terms).length; + + results = results.filter(function(result) { + return uniqueArray(result.matched_terms).length + 1 >= bestMatchedTerms; + }); + } + return results; +}; + +CrystalDocs.prefixForType = function(type) { + switch (type) { + case "instance_method": + return "#"; + + case "class_method": + case "macro": + case "constructor": + return "."; + + default: + return false; + } +}; + +CrystalDocs.displaySearchResults = function(results, query) { + function sanitize(html){ + return html.replace(/<(?!\/?code)[^>]+>/g, ""); + } + + // limit results + if (results.length > CrystalDocs.MAX_RESULTS_DISPLAY) { + results = results.slice(0, CrystalDocs.MAX_RESULTS_DISPLAY); + } + + var $frag = document.createDocumentFragment(); + var $resultsElem = document.querySelector(".search-list"); + $resultsElem.innerHTML = ""; + + results.forEach(function(result, i) { + var url = CrystalDocs.base_path + result.href; + var type = false; + + var title = query.highlight(result.result_type == "type" ? result.full_name : result.name); + + var prefix = CrystalDocs.prefixForType(result.result_type); + if (prefix) { + title = "" + prefix + "" + title; + } + + title = "" + title + ""; + + if (result.args_string) { + title += + "" + query.highlight(result.args_string) + ""; + } + + $elem = document.createElement("li"); + $elem.className = "search-result search-result--" + result.result_type; + $elem.dataset.href = url; + $elem.setAttribute("title", result.full_name + " docs page"); + + var $title = document.createElement("div"); + $title.setAttribute("class", "search-result__title"); + var $titleLink = document.createElement("a"); + $titleLink.setAttribute("href", url); + + $titleLink.innerHTML = title; + $title.appendChild($titleLink); + $elem.appendChild($title); + $elem.addEventListener("click", function() { + $titleLink.click(); + }); + + if (result.result_type !== "type") { + var $type = document.createElement("div"); + $type.setAttribute("class", "search-result__type"); + $type.innerHTML = query.highlight(result.type); + $elem.appendChild($type); + } + + if(result.summary){ + var $doc = document.createElement("div"); + $doc.setAttribute("class", "search-result__doc"); + $doc.innerHTML = query.highlight(sanitize(result.summary)); + $elem.appendChild($doc); + } + + $elem.appendChild(document.createComment(JSON.stringify(result))); + $frag.appendChild($elem); + }); + + $resultsElem.appendChild($frag); + + CrystalDocs.toggleResultsList(true); +}; + +CrystalDocs.toggleResultsList = function(visible) { + if (visible) { + document.querySelector(".types-list").classList.add("hidden"); + document.querySelector(".search-results").classList.remove("hidden"); + } else { + document.querySelector(".types-list").classList.remove("hidden"); + document.querySelector(".search-results").classList.add("hidden"); + } +}; + +CrystalDocs.Query = function(string) { + this.original = string; + this.terms = string.split(/\s+/).filter(function(word) { + return CrystalDocs.Query.stripModifiers(word).length > 0; + }); + + var normalized = this.terms.map(CrystalDocs.Query.normalizeTerm); + this.normalizedTerms = normalized; + + function runMatcher(field, matcher) { + if (!field) { + return false; + } + var normalizedValue = CrystalDocs.Query.normalizeTerm(field); + + var matches = []; + normalized.forEach(function(term) { + if (matcher(normalizedValue, term)) { + matches.push(term); + } + }); + return matches.length > 0 ? matches : false; + } + + this.matches = function(field) { + return runMatcher(field, function(normalized, term) { + if (term[0] == "#" || term[0] == ".") { + return false; + } + return normalized.indexOf(term) >= 0; + }); + }; + + function namespaceMatcher(normalized, term){ + var i = term.indexOf(":"); + if(i >= 0){ + term = term.replace(/^::?|::?$/, ""); + var index = normalized.indexOf(term); + if((index == 0) || (index > 0 && normalized[index-1] == ":")){ + return true; + } + } + return false; + } + this.matchesMethod = function(name, kind, type) { + return runMatcher(name, function(normalized, term) { + var i = term.indexOf("#"); + if(i >= 0){ + if (kind != "instance_method") { + return false; + } + }else{ + i = term.indexOf("."); + if(i >= 0){ + if (kind != "class_method" && kind != "macro" && kind != "constructor") { + return false; + } + }else{ + //neither # nor . + if(term.indexOf(":") && namespaceMatcher(normalized, term)){ + return true; + } + } + } + + var methodName = term; + if(i >= 0){ + var termType = term.substring(0, i); + methodName = term.substring(i+1); + + if(termType != "") { + if(CrystalDocs.Query.normalizeTerm(type.full_name).indexOf(termType) < 0){ + return false; + } + } + } + return normalized.indexOf(methodName) >= 0; + }); + }; + + this.matchesNamespace = function(namespace){ + return runMatcher(namespace, namespaceMatcher); + }; + + this.highlight = function(string) { + if (typeof string == "undefined") { + return ""; + } + function escapeRegExp(s) { + return s.replace(/[.*+?\^${}()|\[\]\\]/g, "\\$&").replace(/^[#\.:]+/, ""); + } + return string.replace( + new RegExp("(" + this.normalizedTerms.map(escapeRegExp).join("|") + ")", "gi"), + "$1" + ); + }; +}; +CrystalDocs.Query.normalizeTerm = function(term) { + return term.toLowerCase(); +}; +CrystalDocs.Query.stripModifiers = function(term) { + switch (term[0]) { + case "#": + case ".": + case ":": + return term.substr(1); + + default: + return term; + } +} + +CrystalDocs.search = function(string) { + if(!CrystalDocs.searchIndex) { + console.log("CrystalDocs search index not initialized, delaying search"); + + document.addEventListener("CrystalDocs:loaded", function listener(){ + document.removeEventListener("CrystalDocs:loaded", listener); + CrystalDocs.search(string); + }); + return; + } + + document.dispatchEvent(new Event("CrystalDocs:searchStarted")); + + var query = new CrystalDocs.Query(string); + var results = CrystalDocs.runQuery(query); + results = CrystalDocs.rankResults(results, query); + CrystalDocs.displaySearchResults(results, query); + + document.dispatchEvent(new Event("CrystalDocs:searchPerformed")); +}; + +CrystalDocs.initializeIndex = function(data) { + CrystalDocs.searchIndex = data; + + document.dispatchEvent(new Event("CrystalDocs:loaded")); +}; + +CrystalDocs.loadIndex = function() { + function loadJSON(file, callback) { + var xobj = new XMLHttpRequest(); + xobj.overrideMimeType("application/json"); + xobj.open("GET", file, true); + xobj.onreadystatechange = function() { + if (xobj.readyState == 4 && xobj.status == "200") { + callback(xobj.responseText); + } + }; + xobj.send(null); + } + + function loadScript(file) { + script = document.createElement("script"); + script.src = file; + document.body.appendChild(script); + } + + function parseJSON(json) { + CrystalDocs.initializeIndex(JSON.parse(json)); + } + + for(var i = 0; i < document.scripts.length; i++){ + var script = document.scripts[i]; + if (script.src && script.src.indexOf("js/doc.js") >= 0) { + if (script.src.indexOf("file://") == 0) { + // We need to support JSONP files for the search to work on local file system. + var jsonPath = script.src.replace("js/doc.js", "search-index.js"); + loadScript(jsonPath); + return; + } else { + var jsonPath = script.src.replace("js/doc.js", "index.json"); + loadJSON(jsonPath, parseJSON); + return; + } + } + } + console.error("Could not find location of js/doc.js"); +}; + +// Callback for jsonp +function crystal_doc_search_index_callback(data) { + CrystalDocs.initializeIndex(data); +} + +Navigator = function(sidebar, searchInput, list, leaveSearchScope){ + this.list = list; + var self = this; + + var performingSearch = false; + + document.addEventListener('CrystalDocs:searchStarted', function(){ + performingSearch = true; + }); + document.addEventListener('CrystalDocs:searchDebounceStarted', function(){ + performingSearch = true; + }); + document.addEventListener('CrystalDocs:searchPerformed', function(){ + performingSearch = false; + }); + document.addEventListener('CrystalDocs:searchDebounceStopped', function(event){ + performingSearch = false; + }); + + function delayWhileSearching(callback) { + if(performingSearch){ + document.addEventListener('CrystalDocs:searchPerformed', function listener(){ + document.removeEventListener('CrystalDocs:searchPerformed', listener); + + // add some delay to let search results display kick in + setTimeout(callback, 100); + }); + }else{ + callback(); + } + } + + function clearMoveTimeout() { + clearTimeout(self.moveTimeout); + self.moveTimeout = null; + } + + function startMoveTimeout(upwards){ + /*if(self.moveTimeout) { + clearMoveTimeout(); + } + + var go = function() { + if (!self.moveTimeout) return; + self.move(upwards); + self.moveTimeout = setTimeout(go, 600); + }; + self.moveTimeout = setTimeout(go, 800);*/ + } + + function scrollCenter(element) { + var rect = element.getBoundingClientRect(); + var middle = sidebar.clientHeight / 2; + sidebar.scrollTop += rect.top + rect.height / 2 - middle; + } + + var move = this.move = function(upwards){ + if(!this.current){ + this.highlightFirst(); + return true; + } + var next = upwards ? this.current.previousElementSibling : this.current.nextElementSibling; + if(next && next.classList) { + this.highlight(next); + scrollCenter(next); + return true; + } + return false; + }; + + this.moveRight = function(){ + }; + this.moveLeft = function(){ + }; + + this.highlight = function(elem) { + if(!elem){ + return; + } + this.removeHighlight(); + + this.current = elem; + this.current.classList.add("current"); + }; + + this.highlightFirst = function(){ + this.highlight(this.list.querySelector('li:first-child')); + }; + + this.removeHighlight = function() { + if(this.current){ + this.current.classList.remove("current"); + } + this.current = null; + } + + this.openSelectedResult = function() { + if(this.current) { + this.current.click(); + } + } + + this.focus = function() { + searchInput.focus(); + searchInput.select(); + this.highlightFirst(); + } + + function handleKeyUp(event) { + switch(event.key) { + case "ArrowUp": + case "ArrowDown": + case "i": + case "j": + case "k": + case "l": + case "c": + case "h": + case "t": + case "n": + event.stopPropagation(); + clearMoveTimeout(); + } + } + + function handleKeyDown(event) { + switch(event.key) { + case "Enter": + event.stopPropagation(); + event.preventDefault(); + leaveSearchScope(); + self.openSelectedResult(); + break; + case "Escape": + event.stopPropagation(); + event.preventDefault(); + leaveSearchScope(); + break; + case "j": + case "c": + case "ArrowUp": + if(event.ctrlKey || event.key == "ArrowUp") { + event.stopPropagation(); + self.move(true); + startMoveTimeout(true); + } + break; + case "k": + case "h": + case "ArrowDown": + if(event.ctrlKey || event.key == "ArrowDown") { + event.stopPropagation(); + self.move(false); + startMoveTimeout(false); + } + break; + case "k": + case "t": + case "ArrowLeft": + if(event.ctrlKey || event.key == "ArrowLeft") { + event.stopPropagation(); + self.moveLeft(); + } + break; + case "l": + case "n": + case "ArrowRight": + if(event.ctrlKey || event.key == "ArrowRight") { + event.stopPropagation(); + self.moveRight(); + } + break; + } + } + + function handleInputKeyUp(event) { + switch(event.key) { + case "ArrowUp": + case "ArrowDown": + event.stopPropagation(); + event.preventDefault(); + clearMoveTimeout(); + } + } + + function handleInputKeyDown(event) { + switch(event.key) { + case "Enter": + event.stopPropagation(); + event.preventDefault(); + delayWhileSearching(function(){ + self.openSelectedResult(); + leaveSearchScope(); + }); + break; + case "Escape": + event.stopPropagation(); + event.preventDefault(); + // remove focus from search input + leaveSearchScope(); + sidebar.focus(); + break; + case "ArrowUp": + event.stopPropagation(); + event.preventDefault(); + self.move(true); + startMoveTimeout(true); + break; + + case "ArrowDown": + event.stopPropagation(); + event.preventDefault(); + self.move(false); + startMoveTimeout(false); + break; + } + } + + sidebar.tabIndex = 100; // set tabIndex to enable keylistener + sidebar.addEventListener('keyup', function(event) { + handleKeyUp(event); + }); + sidebar.addEventListener('keydown', function(event) { + handleKeyDown(event); + }); + searchInput.addEventListener('keydown', function(event) { + handleInputKeyDown(event); + }); + searchInput.addEventListener('keyup', function(event) { + handleInputKeyUp(event); + }); + this.move(); +}; + +CrystalDocs.initializeVersions = function () { + function loadJSON(file, callback) { + var xobj = new XMLHttpRequest(); + xobj.overrideMimeType("application/json"); + xobj.open("GET", file, true); + xobj.onreadystatechange = function() { + if (xobj.readyState == 4 && xobj.status == "200") { + callback(xobj.responseText); + } + }; + xobj.send(null); + } + + function parseJSON(json) { + CrystalDocs.loadConfig(JSON.parse(json)); + } + + $elem = document.querySelector("html > head > meta[name=\"crystal_docs.json_config_url\"]") + if ($elem == undefined) { + return + } + jsonURL = $elem.getAttribute("content") + if (jsonURL && jsonURL != "") { + loadJSON(jsonURL, parseJSON); + } +} + +CrystalDocs.loadConfig = function (config) { + var projectVersions = config["versions"] + var currentVersion = document.querySelector("html > head > meta[name=\"crystal_docs.project_version\"]").getAttribute("content") + + var currentVersionInList = projectVersions.find(function (element) { + return element.name == currentVersion + }) + + if (!currentVersionInList) { + projectVersions.unshift({ name: currentVersion, url: '#' }) + } + + $version = document.querySelector(".project-summary > .project-version") + $version.innerHTML = "" + + $select = document.createElement("select") + $select.classList.add("project-versions-nav") + $select.addEventListener("change", function () { + window.location.href = this.value + }) + projectVersions.forEach(function (version) { + $item = document.createElement("option") + $item.setAttribute("value", version.url) + $item.append(document.createTextNode(version.name)) + + if (version.name == currentVersion) { + $item.setAttribute("selected", true) + $item.setAttribute("disabled", true) + } + $select.append($item) + }); + $form = document.createElement("form") + $form.setAttribute("autocomplete", "off") + $form.append($select) + $version.append($form) +} + +document.addEventListener("DOMContentLoaded", function () { + CrystalDocs.initializeVersions() +}) + +var UsageModal = function(title, content) { + var $body = document.body; + var self = this; + var $modalBackground = document.createElement("div"); + $modalBackground.classList.add("modal-background"); + var $usageModal = document.createElement("div"); + $usageModal.classList.add("usage-modal"); + $modalBackground.appendChild($usageModal); + var $title = document.createElement("h3"); + $title.classList.add("modal-title"); + $title.innerHTML = title + $usageModal.appendChild($title); + var $closeButton = document.createElement("span"); + $closeButton.classList.add("close-button"); + $closeButton.setAttribute("title", "Close modal"); + $closeButton.innerText = '×'; + $usageModal.appendChild($closeButton); + $usageModal.insertAdjacentHTML("beforeend", content); + + $modalBackground.addEventListener('click', function(event) { + var element = event.target || event.srcElement; + + if(element == $modalBackground) { + self.hide(); + } + }); + $closeButton.addEventListener('click', function(event) { + self.hide(); + }); + + $body.insertAdjacentElement('beforeend', $modalBackground); + + this.show = function(){ + $body.classList.add("js-modal-visible"); + }; + this.hide = function(){ + $body.classList.remove("js-modal-visible"); + }; + this.isVisible = function(){ + return $body.classList.contains("js-modal-visible"); + } +} + + +document.addEventListener('DOMContentLoaded', function() { + var sessionStorage; + try { + sessionStorage = window.sessionStorage; + } catch (e) { } + if(!sessionStorage) { + sessionStorage = { + setItem: function() {}, + getItem: function() {}, + removeItem: function() {} + }; + } + + var repositoryName = document.querySelector('[name=repository-name]').getAttribute('content'); + var typesList = document.querySelector('.types-list'); + var searchInput = document.querySelector('.search-input'); + var parents = document.querySelectorAll('.types-list li.parent'); + + var scrollSidebarToOpenType = function(){ + var openTypes = typesList.querySelectorAll('.current'); + if (openTypes.length > 0) { + var lastOpenType = openTypes[openTypes.length - 1]; + lastOpenType.scrollIntoView(!(window.matchMedia('only screen and (max-width: 635px)')).matches); + } + } + + scrollSidebarToOpenType(); + + var setPersistentSearchQuery = function(value){ + sessionStorage.setItem(repositoryName + '::search-input:value', value); + } + + for(var i = 0; i < parents.length; i++) { + var _parent = parents[i]; + _parent.addEventListener('click', function(e) { + e.stopPropagation(); + + if(e.target.tagName.toLowerCase() == 'li') { + if(e.target.className.match(/open/)) { + sessionStorage.removeItem(e.target.getAttribute('data-id')); + e.target.className = e.target.className.replace(/ +open/g, ''); + } else { + sessionStorage.setItem(e.target.getAttribute('data-id'), '1'); + if(e.target.className.indexOf('open') == -1) { + e.target.className += ' open'; + } + } + } + }); + + if(sessionStorage.getItem(_parent.getAttribute('data-id')) == '1') { + _parent.className += ' open'; + } + } + + var leaveSearchScope = function(){ + CrystalDocs.toggleResultsList(false); + window.focus(); + } + + var navigator = new Navigator(document.querySelector('.types-list'), searchInput, document.querySelector(".search-results"), leaveSearchScope); + + CrystalDocs.loadIndex(); + var searchTimeout; + var lastSearchText = false; + var performSearch = function() { + document.dispatchEvent(new Event("CrystalDocs:searchDebounceStarted")); + + clearTimeout(searchTimeout); + searchTimeout = setTimeout(function() { + var text = searchInput.value; + + if(text == "") { + CrystalDocs.toggleResultsList(false); + }else if(text == lastSearchText){ + document.dispatchEvent(new Event("CrystalDocs:searchDebounceStopped")); + }else{ + CrystalDocs.search(text); + navigator.highlightFirst(); + searchInput.focus(); + } + lastSearchText = text; + setPersistentSearchQuery(text); + }, 200); + }; + + if(location.hash.length > 3 && location.hash.substring(0,3) == "#q="){ + // allows directly linking a search query which is then executed on the client + // this comes handy for establishing a custom browser search engine with https://crystal-lang.org/api/#q=%s as a search URL + // TODO: Add OpenSearch description + var searchQuery = location.hash.substring(3); + history.pushState({searchQuery: searchQuery}, "Search for " + searchQuery, location.href.replace(/#q=.*/, "")); + searchInput.value = decodeURIComponent(searchQuery); + document.addEventListener('CrystalDocs:loaded', performSearch); + } + + if (searchInput.value.length == 0) { + var searchText = sessionStorage.getItem(repositoryName + '::search-input:value'); + if(searchText){ + searchInput.value = searchText; + } + } + searchInput.addEventListener('keyup', performSearch); + searchInput.addEventListener('input', performSearch); + + var usageModal = new UsageModal('Keyboard Shortcuts', '' + + '' + ); + + function handleShortkeys(event) { + var element = event.target || event.srcElement; + + if(element.tagName == "INPUT" || element.tagName == "TEXTAREA" || element.parentElement.tagName == "TEXTAREA"){ + return; + } + + switch(event.key) { + case "?": + usageModal.show(); + break; + + case "Escape": + usageModal.hide(); + break; + + case "s": + case "/": + if(usageModal.isVisible()) { + return; + } + event.stopPropagation(); + navigator.focus(); + performSearch(); + break; + } + } + + document.addEventListener('keyup', handleShortkeys); + + var scrollToEntryFromLocationHash = function() { + var hash = window.location.hash; + if (hash) { + var targetAnchor = decodeURI(hash.substr(1)); + var targetEl = document.getElementById(targetAnchor) + if (targetEl) { + targetEl.offsetParent.scrollTop = targetEl.offsetTop; + } + } + }; + window.addEventListener("hashchange", scrollToEntryFromLocationHash, false); + scrollToEntryFromLocationHash(); +}); diff --git a/search-index.js b/search-index.js new file mode 100644 index 0000000..88f8850 --- /dev/null +++ b/search-index.js @@ -0,0 +1 @@ +crystal_doc_search_index_callback({"repository_name":"placeos","body":"# PlaceOS Crystal SDK\n\n[![GitHub release](https://img.shields.io/github/release/placeos/crystal-client.svg)](https://github.com/placeos/crystal-client/releases)\n[![CI](https://github.com/PlaceOS/crystal-client/actions/workflows/ci.yml/badge.svg)](https://github.com/PlaceOS/crystal-client/actions/workflows/ci.yml)\n\nA library for building [crystal](crystal-lang.org/) applications that utilise PlaceOS.\n\n## Installation\n\n1. Add the dependency to your `shard.yml`:\n\n ```yaml\n dependencies:\n placeos:\n github: placeos/crystal-client\n version: ~> 1.0\n ```\n\n2. Run `shards install`\n\n## Usage\n\nWhen initialialized via the host environment, the key `PLACE_URI` is expected.\n\n### Authentication\n\n- *from environment*\n\n ```crystal\n require \"placeos\"\n\n # Extracts user credentials from the following environment keys...\n # - PLACE_URI\n # - PLACE_EMAIL\n # - PLACE_PASSWORD\n # - PLACE_AUTH_CLIENT_ID\n # - PLACE_AUTH_SECRET\n client = PlaceOS::Client.from_environment_user\n ```\n\n## Development\n\nRun `crystal spec`\n\n## Contributing\n\n1. [Fork it](https://github.com/placeos/crystal-client/fork)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## Contributors\n\n- [Kim Burgess](https://github.com/kimburgess) - creator and maintainer\n- [Caspian Baska](https://github.com/caspiano) - contributor and maintainer\n","program":{"html_id":"placeos/toplevel","path":"toplevel.html","kind":"module","full_name":"Top Level Namespace","name":"Top Level Namespace","abstract":false,"locations":[],"repository_name":"placeos","program":true,"enum":false,"alias":false,"const":false,"types":[{"html_id":"placeos/PlaceOS","path":"PlaceOS.html","kind":"module","full_name":"PlaceOS","name":"PlaceOS","abstract":false,"locations":[{"filename":"lib/placeos-models/src/placeos-models/error.cr","line_number":1,"url":null},{"filename":"src/placeos.cr","line_number":1,"url":null},{"filename":"src/placeos/api_wrapper.cr","line_number":17,"url":null},{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":4,"url":null},{"filename":"src/placeos/api_wrapper/asset_instances.cr","line_number":4,"url":null},{"filename":"src/placeos/api_wrapper/assets.cr","line_number":4,"url":null},{"filename":"src/placeos/api_wrapper/authority.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/auths/base.cr","line_number":4,"url":null},{"filename":"src/placeos/api_wrapper/auths/ldap.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/auths/oauth.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/auths/saml.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/cluster.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/domains.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/drivers.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/endpoint.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":4,"url":null},{"filename":"src/placeos/api_wrapper/modules.cr","line_number":6,"url":null},{"filename":"src/placeos/api_wrapper/oauth_applications.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/repositories.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/root.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/settings.cr","line_number":4,"url":null},{"filename":"src/placeos/api_wrapper/system_triggers.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/systems.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/triggers.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/users.cr","line_number":3,"url":null},{"filename":"src/placeos/api_wrapper/zones.cr","line_number":4,"url":null},{"filename":"src/placeos/client.cr","line_number":9,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"doc":"Low-level wrapper for the PlaceOS API.\n\nEach method maps one-to-one with an API endpoint. All invocations will either\nprovide a type-safe response object, or raise an `PlaceOS::Client::API::Error`.\n\nIt's possible to use this class directly if you require the extra flexibility,\nhowever in most cases the abstractions provided by the higher-level\n`PlaceOS::Client` may be the better choice.","summary":"

Low-level wrapper for the PlaceOS API.

","types":[{"html_id":"placeos/PlaceOS/Client","path":"PlaceOS/Client.html","kind":"class","full_name":"PlaceOS::Client","name":"Client","abstract":false,"superclass":{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/client.cr","line_number":10,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"API_ROOT","name":"API_ROOT","value":"\"/api/engine/v2\""},{"id":"AUTH_API_ROOT","name":"AUTH_API_ROOT","value":"\"/auth\""},{"id":"VERSION","name":"VERSION","value":"{{ (`shards version \\\"/__w/crystal-client/crystal-client/src/placeos\\\"`).chomp.stringify.downcase }}"}],"namespace":{"html_id":"placeos/PlaceOS","kind":"module","full_name":"PlaceOS","name":"PlaceOS"},"class_methods":[{"html_id":"from_environment_user-class-method","name":"from_environment_user","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":23,"url":null},"def":{"name":"from_environment_user","visibility":"Public","body":"environment = {\"PLACE_URI\", \"PLACE_EMAIL\", \"PLACE_PASSWORD\", \"PLACE_AUTH_CLIENT_ID\", \"PLACE_AUTH_SECRET\"}.map do |key|\n ENV[key]? || (abort(\"missing #{key} in environment\"))\nend\nuri, email, password, client_id, client_secret = environment\nnew(uri, email: email, password: password, client_id: client_id, client_secret: client_secret)\n"}},{"html_id":"from_environment_user(&)-class-method","name":"from_environment_user","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":32,"url":null},"def":{"name":"from_environment_user","yields":1,"block_arity":1,"visibility":"Public","body":"begin\n client = self.from_environment_user\n yield client\nensure\n client.close\nend"}}],"constructors":[{"html_id":"new(base_uri:URI|String,email:String|Nil=nil,password:String|Nil=nil,client_id:String|Nil=nil,client_secret:String|Nil=nil,token:OAuth2::AccessToken|Nil=nil,host_header:String|Nil=nil,insecure:Bool=false,x_api_key:String|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"base_uri","external_name":"base_uri","restriction":"URI | String"},{"name":"email","default_value":"nil","external_name":"email","restriction":"String | ::Nil"},{"name":"password","default_value":"nil","external_name":"password","restriction":"String | ::Nil"},{"name":"client_id","default_value":"nil","external_name":"client_id","restriction":"String | ::Nil"},{"name":"client_secret","default_value":"nil","external_name":"client_secret","restriction":"String | ::Nil"},{"name":"token","default_value":"nil","external_name":"token","restriction":"OAuth2::AccessToken | ::Nil"},{"name":"host_header","default_value":"nil","external_name":"host_header","restriction":"String | ::Nil"},{"name":"insecure","default_value":"false","external_name":"insecure","restriction":"Bool"},{"name":"x_api_key","default_value":"nil","external_name":"x_api_key","restriction":"String | ::Nil"}],"args_string":"(base_uri : URI | String, email : String | Nil = nil, password : String | Nil = nil, client_id : String | Nil = nil, client_secret : String | Nil = nil, token : OAuth2::AccessToken | Nil = nil, host_header : String | Nil = nil, insecure : Bool = false, x_api_key : String | Nil = nil)","args_html":"(base_uri : URI | String, email : String | Nil = nil, password : String | Nil = nil, client_id : String | Nil = nil, client_secret : String | Nil = nil, token : OAuth2::AccessToken | Nil = nil, host_header : String | Nil = nil, insecure : Bool = false, x_api_key : String | Nil = nil)","location":{"filename":"src/placeos/client.cr","line_number":39,"url":null},"def":{"name":"new","args":[{"name":"base_uri","external_name":"base_uri","restriction":"URI | String"},{"name":"email","default_value":"nil","external_name":"email","restriction":"String | ::Nil"},{"name":"password","default_value":"nil","external_name":"password","restriction":"String | ::Nil"},{"name":"client_id","default_value":"nil","external_name":"client_id","restriction":"String | ::Nil"},{"name":"client_secret","default_value":"nil","external_name":"client_secret","restriction":"String | ::Nil"},{"name":"token","default_value":"nil","external_name":"token","restriction":"OAuth2::AccessToken | ::Nil"},{"name":"host_header","default_value":"nil","external_name":"host_header","restriction":"String | ::Nil"},{"name":"insecure","default_value":"false","external_name":"insecure","restriction":"Bool"},{"name":"x_api_key","default_value":"nil","external_name":"x_api_key","restriction":"String | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(base_uri, email, password, client_id, client_secret, token, host_header, insecure, x_api_key)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"api_wrapper:APIWrapper-instance-method","name":"api_wrapper","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":19,"url":null},"def":{"name":"api_wrapper","return_type":"APIWrapper","visibility":"Public","body":"@api_wrapper"}},{"html_id":"apikeys:APIWrapper::APIKeys-instance-method","name":"apikeys","doc":"Provide an object for managing APIKeys. See `PlaceOS::Client::APIWrapper::APIKeys`.","summary":"

Provide an object for managing APIKeys.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"apikeys","return_type":"APIWrapper::APIKeys","visibility":"Public","body":"@apikeys || (@apikeys = APIWrapper::APIKeys.new(api_wrapper))"}},{"html_id":"authenticated?-instance-method","name":"authenticated?","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":57,"url":null},"def":{"name":"authenticated?","visibility":"Public","body":"if @session || @x_api_key\n return true\nend\n!(((@email.nil? || @password.nil?) || @client_id.nil?) || @client_secret.nil?)\n"}},{"html_id":"authority:APIWrapper::Authority-instance-method","name":"authority","doc":"Provide an object for managing Authority. See `PlaceOS::Client::APIWrapper::Authority`.","summary":"

Provide an object for managing Authority.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"authority","return_type":"APIWrapper::Authority","visibility":"Public","body":"@authority || (@authority = APIWrapper::Authority.new(api_wrapper))"}},{"html_id":"close(*args,**options)-instance-method","name":"close","abstract":false,"args":[{"name":"args","external_name":"args","restriction":""}],"args_string":"(*args, **options)","args_html":"(*args, **options)","location":{"filename":"src/placeos/client.cr","line_number":21,"url":null},"def":{"name":"close","args":[{"name":"args","external_name":"args","restriction":""}],"double_splat":{"name":"options","external_name":"options","restriction":""},"splat_index":0,"visibility":"Public","body":"api_wrapper.close(*args, **options)"}},{"html_id":"close(*args,**options,&)-instance-method","name":"close","abstract":false,"args":[{"name":"args","external_name":"args","restriction":""}],"args_string":"(*args, **options, &)","args_html":"(*args, **options, &)","location":{"filename":"src/placeos/client.cr","line_number":21,"url":null},"def":{"name":"close","args":[{"name":"args","external_name":"args","restriction":""}],"double_splat":{"name":"options","external_name":"options","restriction":""},"splat_index":0,"yields":1,"block_arity":1,"visibility":"Public","body":"api_wrapper.close(*args, **options) do |*yield_args|\n yield *yield_args\nend"}},{"html_id":"cluster:APIWrapper::Cluster-instance-method","name":"cluster","doc":"Provide an object for managing Cluster. See `PlaceOS::Client::APIWrapper::Cluster`.","summary":"

Provide an object for managing Cluster.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"cluster","return_type":"APIWrapper::Cluster","visibility":"Public","body":"@cluster || (@cluster = APIWrapper::Cluster.new(api_wrapper))"}},{"html_id":"domains:APIWrapper::Domains-instance-method","name":"domains","doc":"Provide an object for managing Domains. See `PlaceOS::Client::APIWrapper::Domains`.","summary":"

Provide an object for managing Domains.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"domains","return_type":"APIWrapper::Domains","visibility":"Public","body":"@domains || (@domains = APIWrapper::Domains.new(api_wrapper))"}},{"html_id":"drivers:APIWrapper::Drivers-instance-method","name":"drivers","doc":"Provide an object for managing Drivers. See `PlaceOS::Client::APIWrapper::Drivers`.","summary":"

Provide an object for managing Drivers.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"drivers","return_type":"APIWrapper::Drivers","visibility":"Public","body":"@drivers || (@drivers = APIWrapper::Drivers.new(api_wrapper))"}},{"html_id":"ldap:APIWrapper::Ldap-instance-method","name":"ldap","doc":"Provide an object for managing Ldap. See `PlaceOS::Client::APIWrapper::Ldap`.","summary":"

Provide an object for managing Ldap.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"ldap","return_type":"APIWrapper::Ldap","visibility":"Public","body":"@ldap || (@ldap = APIWrapper::Ldap.new(api_wrapper))"}},{"html_id":"metadata:APIWrapper::Metadata-instance-method","name":"metadata","doc":"Provide an object for managing Metadata. See `PlaceOS::Client::APIWrapper::Metadata`.","summary":"

Provide an object for managing Metadata.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"metadata","return_type":"APIWrapper::Metadata","visibility":"Public","body":"@metadata || (@metadata = APIWrapper::Metadata.new(api_wrapper))"}},{"html_id":"modules:APIWrapper::Modules-instance-method","name":"modules","doc":"Provide an object for managing Modules. See `PlaceOS::Client::APIWrapper::Modules`.","summary":"

Provide an object for managing Modules.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"modules","return_type":"APIWrapper::Modules","visibility":"Public","body":"@modules || (@modules = APIWrapper::Modules.new(api_wrapper))"}},{"html_id":"oauth:APIWrapper::OAuth-instance-method","name":"oauth","doc":"Provide an object for managing OAuth. See `PlaceOS::Client::APIWrapper::OAuth`.","summary":"

Provide an object for managing OAuth.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"oauth","return_type":"APIWrapper::OAuth","visibility":"Public","body":"@oauth || (@oauth = APIWrapper::OAuth.new(api_wrapper))"}},{"html_id":"oauthapplications:APIWrapper::OAuthApplications-instance-method","name":"oauthapplications","doc":"Provide an object for managing OAuthApplications. See `PlaceOS::Client::APIWrapper::OAuthApplications`.","summary":"

Provide an object for managing OAuthApplications.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"oauthapplications","return_type":"APIWrapper::OAuthApplications","visibility":"Public","body":"@oauthapplications || (@oauthapplications = APIWrapper::OAuthApplications.new(api_wrapper))"}},{"html_id":"root:APIWrapper::Root-instance-method","name":"root","doc":"Provide an object for managing Root. See `PlaceOS::Client::APIWrapper::Root`.","summary":"

Provide an object for managing Root.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"root","return_type":"APIWrapper::Root","visibility":"Public","body":"@root || (@root = APIWrapper::Root.new(api_wrapper))"}},{"html_id":"saml:APIWrapper::Saml-instance-method","name":"saml","doc":"Provide an object for managing Saml. See `PlaceOS::Client::APIWrapper::Saml`.","summary":"

Provide an object for managing Saml.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"saml","return_type":"APIWrapper::Saml","visibility":"Public","body":"@saml || (@saml = APIWrapper::Saml.new(api_wrapper))"}},{"html_id":"settings:APIWrapper::Settings-instance-method","name":"settings","doc":"Provide an object for managing Settings. See `PlaceOS::Client::APIWrapper::Settings`.","summary":"

Provide an object for managing Settings.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"settings","return_type":"APIWrapper::Settings","visibility":"Public","body":"@settings || (@settings = APIWrapper::Settings.new(api_wrapper))"}},{"html_id":"systems:APIWrapper::Systems-instance-method","name":"systems","doc":"Provide an object for managing Systems. See `PlaceOS::Client::APIWrapper::Systems`.","summary":"

Provide an object for managing Systems.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"systems","return_type":"APIWrapper::Systems","visibility":"Public","body":"@systems || (@systems = APIWrapper::Systems.new(api_wrapper))"}},{"html_id":"uri:URI-instance-method","name":"uri","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":18,"url":null},"def":{"name":"uri","return_type":"URI","visibility":"Public","body":"@uri"}},{"html_id":"users:APIWrapper::Users-instance-method","name":"users","doc":"Provide an object for managing Users. See `PlaceOS::Client::APIWrapper::Users`.","summary":"

Provide an object for managing Users.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"users","return_type":"APIWrapper::Users","visibility":"Public","body":"@users || (@users = APIWrapper::Users.new(api_wrapper))"}},{"html_id":"zones:APIWrapper::Zones-instance-method","name":"zones","doc":"Provide an object for managing Zones. See `PlaceOS::Client::APIWrapper::Zones`.","summary":"

Provide an object for managing Zones.

","abstract":false,"location":{"filename":"src/placeos/client.cr","line_number":120,"url":null},"def":{"name":"zones","return_type":"APIWrapper::Zones","visibility":"Public","body":"@zones || (@zones = APIWrapper::Zones.new(api_wrapper))"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API","path":"PlaceOS/Client/API.html","kind":"module","full_name":"PlaceOS::Client::API","name":"API","abstract":false,"locations":[{"filename":"src/placeos/api/error.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client","kind":"class","full_name":"PlaceOS::Client","name":"Client"},"types":[{"html_id":"placeos/PlaceOS/Client/API/Error","path":"PlaceOS/Client/API/Error.html","kind":"class","full_name":"PlaceOS::Client::API::Error","name":"Error","abstract":false,"superclass":{"html_id":"placeos/Exception","kind":"class","full_name":"Exception","name":"Exception"},"ancestors":[{"html_id":"placeos/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/error.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API","kind":"module","full_name":"PlaceOS::Client::API","name":"API"},"class_methods":[{"html_id":"from_response(response:HTTP::Client::Response)-class-method","name":"from_response","abstract":false,"args":[{"name":"response","external_name":"response","restriction":"HTTP::Client::Response"}],"args_string":"(response : HTTP::Client::Response)","args_html":"(response : HTTP::Client::Response)","location":{"filename":"src/placeos/api/error.cr","line_number":4,"url":null},"def":{"name":"from_response","args":[{"name":"response","external_name":"response","restriction":"HTTP::Client::Response"}],"visibility":"Public","body":"if response.success?\n raise(ArgumentError.new(\"response is valid\"))\nelse\n if response.status_message\n new(\"#{response.status_message}\\n#{response.body}\")\n else\n new(\"HTTP error #{response.status_code}\\n#{response.body}\")\n end\nend"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models","path":"PlaceOS/Client/API/Models.html","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models","abstract":false,"locations":[{"filename":"src/placeos/api/models.cr","line_number":1,"url":null},{"filename":"src/placeos/api/models/api_key.cr","line_number":4,"url":null},{"filename":"src/placeos/api/models/asset.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/asset_instance.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/authority.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/auths/saml.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/cluster.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/driver.cr","line_number":4,"url":null},{"filename":"src/placeos/api/models/function.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/metadata.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/module.cr","line_number":4,"url":null},{"filename":"src/placeos/api/models/oauth_application.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/ping.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/repository.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/response.cr","line_number":4,"url":null},{"filename":"src/placeos/api/models/role.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/settings.cr","line_number":5,"url":null},{"filename":"src/placeos/api/models/system.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/trigger.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/user.cr","line_number":4,"url":null},{"filename":"src/placeos/api/models/version.cr","line_number":3,"url":null},{"filename":"src/placeos/api/models/zone.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"including_types":[{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API","kind":"module","full_name":"PlaceOS::Client::API","name":"API"},"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/APIKey","path":"PlaceOS/Client/API/Models/APIKey.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::APIKey","name":"APIKey","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/api_key.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/api_key.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"authority:Authority-instance-method","name":"authority","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":32,"url":null},"def":{"name":"authority","return_type":"Authority","visibility":"Public","body":"@authority"}},{"html_id":"authority_id:String-instance-method","name":"authority_id","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":30,"url":null},"def":{"name":"authority_id","return_type":"String","visibility":"Public","body":"@authority_id"}},{"html_id":"description:String|Nil-instance-method","name":"description","doc":"Markdown formatted text that describes the zone.","summary":"

Markdown formatted text that describes the zone.

","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":18,"url":null},"def":{"name":"description","return_type":"String | ::Nil","visibility":"Public","body":"@description"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier for the zone.","summary":"

A universally unique identifier for the zone.

","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":9,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"name:String-instance-method","name":"name","doc":"A human readable identifier.","summary":"

A human readable identifier.

","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":12,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"permissions:PlaceOS::Model::UserJWT::Permissions-instance-method","name":"permissions","doc":"The permission level of the user","summary":"

The permission level of the user

","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":24,"url":null},"def":{"name":"permissions","return_type":"::PlaceOS::Model::UserJWT::Permissions","visibility":"Public","body":"@permissions"}},{"html_id":"scopes:Array(String)-instance-method","name":"scopes","doc":"API scopes","summary":"

API scopes

","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":21,"url":null},"def":{"name":"scopes","return_type":"Array(String)","visibility":"Public","body":"@scopes"}},{"html_id":"user:User-instance-method","name":"user","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":28,"url":null},"def":{"name":"user","return_type":"User","visibility":"Public","body":"@user"}},{"html_id":"user_id:String-instance-method","name":"user_id","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":26,"url":null},"def":{"name":"user_id","return_type":"String","visibility":"Public","body":"@user_id"}},{"html_id":"x_api_key:String-instance-method","name":"x_api_key","doc":"The auth key, only returned on create","summary":"

The auth key, only returned on create

","abstract":false,"location":{"filename":"src/placeos/api/models/api_key.cr","line_number":15,"url":null},"def":{"name":"x_api_key","return_type":"String","visibility":"Public","body":"@x_api_key"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Asset","path":"PlaceOS/Client/API/Models/Asset.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Asset","name":"Asset","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/asset.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/asset.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"brand:String|Nil-instance-method","name":"brand","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":20,"url":null},"def":{"name":"brand","return_type":"String | ::Nil","visibility":"Public","body":"@brand"}},{"html_id":"category:String|Nil-instance-method","name":"category","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":11,"url":null},"def":{"name":"category","return_type":"String | ::Nil","visibility":"Public","body":"@category"}},{"html_id":"description:String|Nil-instance-method","name":"description","doc":"Markdown formatted text that describes the asset.","summary":"

Markdown formatted text that describes the asset.

","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":14,"url":null},"def":{"name":"description","return_type":"String | ::Nil","visibility":"Public","body":"@description"}},{"html_id":"good_until_date:Time|Nil-instance-method","name":"good_until_date","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":17,"url":null},"def":{"name":"good_until_date","return_type":"Time | ::Nil","visibility":"Public","body":"@good_until_date"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier for the Asset.","summary":"

A universally unique identifier for the Asset.

","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":6,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"identifier:String|Nil-instance-method","name":"identifier","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":19,"url":null},"def":{"name":"identifier","return_type":"String | ::Nil","visibility":"Public","body":"@identifier"}},{"html_id":"images:Array(String)-instance-method","name":"images","doc":"Array of URLs to images for an asset","summary":"

Array of URLs to images for an asset

","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":26,"url":null},"def":{"name":"images","return_type":"Array(String)","visibility":"Public","body":"@images"}},{"html_id":"in_use:Int32-instance-method","name":"in_use","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":32,"url":null},"def":{"name":"in_use","return_type":"Int32","visibility":"Public","body":"@in_use"}},{"html_id":"invoice:String|Nil-instance-method","name":"invoice","doc":"URL of downloadable receipt","summary":"

URL of downloadable receipt

","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":29,"url":null},"def":{"name":"invoice","return_type":"String | ::Nil","visibility":"Public","body":"@invoice"}},{"html_id":"name:String-instance-method","name":"name","doc":"A human readable identifier.","summary":"

A human readable identifier.

","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":9,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"other_data:JSON::Any-instance-method","name":"other_data","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":34,"url":null},"def":{"name":"other_data","return_type":"JSON::Any","visibility":"Public","body":"@other_data"}},{"html_id":"parent_id:String|Nil-instance-method","name":"parent_id","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":36,"url":null},"def":{"name":"parent_id","return_type":"String | ::Nil","visibility":"Public","body":"@parent_id"}},{"html_id":"purchase_date:Time-instance-method","name":"purchase_date","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":16,"url":null},"def":{"name":"purchase_date","return_type":"Time","visibility":"Public","body":"@purchase_date"}},{"html_id":"purchase_price:Int32|Nil-instance-method","name":"purchase_price","doc":"TODO: define currency for `purchase_price`","summary":"

TODO define currency for #purchase_price

","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":23,"url":null},"def":{"name":"purchase_price","return_type":"Int32 | ::Nil","visibility":"Public","body":"@purchase_price"}},{"html_id":"quantity:Int32-instance-method","name":"quantity","abstract":false,"location":{"filename":"src/placeos/api/models/asset.cr","line_number":31,"url":null},"def":{"name":"quantity","return_type":"Int32","visibility":"Public","body":"@quantity"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/AssetInstance","path":"PlaceOS/Client/API/Models/AssetInstance.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::AssetInstance","name":"AssetInstance","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/asset_instance.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"approval:Bool-instance-method","name":"approval","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":18,"url":null},"def":{"name":"approval","return_type":"Bool","visibility":"Public","body":"@approval"}},{"html_id":"asset_id:String-instance-method","name":"asset_id","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":20,"url":null},"def":{"name":"asset_id","return_type":"String","visibility":"Public","body":"@asset_id"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier for the Asset.","summary":"

A universally unique identifier for the Asset.

","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":13,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":15,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"requester_id:String|Nil-instance-method","name":"requester_id","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":21,"url":null},"def":{"name":"requester_id","return_type":"String | ::Nil","visibility":"Public","body":"@requester_id"}},{"html_id":"tracking:Tracking-instance-method","name":"tracking","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":17,"url":null},"def":{"name":"tracking","return_type":"Tracking","visibility":"Public","body":"@tracking"}},{"html_id":"usage_end:Time|Nil-instance-method","name":"usage_end","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":25,"url":null},"def":{"name":"usage_end","return_type":"Time | ::Nil","visibility":"Public","body":"@usage_end"}},{"html_id":"usage_start:Time|Nil-instance-method","name":"usage_start","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":24,"url":null},"def":{"name":"usage_start","return_type":"Time | ::Nil","visibility":"Public","body":"@usage_start"}},{"html_id":"zone_id:String|Nil-instance-method","name":"zone_id","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":22,"url":null},"def":{"name":"zone_id","return_type":"String | ::Nil","visibility":"Public","body":"@zone_id"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/AssetInstance/Tracking","path":"PlaceOS/Client/API/Models/AssetInstance/Tracking.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::AssetInstance::Tracking","name":"Tracking","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/asset_instance.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"InStorage","name":"InStorage","value":"0"},{"id":"OnTheWay","name":"OnTheWay","value":"1"},{"id":"InRoom","name":"InRoom","value":"2"},{"id":"Returned","name":"Returned","value":"3"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/AssetInstance","kind":"struct","full_name":"PlaceOS::Client::API::Models::AssetInstance","name":"AssetInstance"},"instance_methods":[{"html_id":"in_room?-instance-method","name":"in_room?","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":8,"url":null},"def":{"name":"in_room?","visibility":"Public","body":"self == InRoom"}},{"html_id":"in_storage?-instance-method","name":"in_storage?","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":6,"url":null},"def":{"name":"in_storage?","visibility":"Public","body":"self == InStorage"}},{"html_id":"on_the_way?-instance-method","name":"on_the_way?","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":7,"url":null},"def":{"name":"on_the_way?","visibility":"Public","body":"self == OnTheWay"}},{"html_id":"returned?-instance-method","name":"returned?","abstract":false,"location":{"filename":"src/placeos/api/models/asset_instance.cr","line_number":9,"url":null},"def":{"name":"returned?","visibility":"Public","body":"self == Returned"}}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Authority","path":"PlaceOS/Client/API/Models/Authority.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Authority","name":"Authority","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/authority.cr","line_number":8,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"doc":"Metadata about the PlaceOS instance connected to.\n\nThis provides information that may be of relevance for authentication or\nproviding client-side configuration information.","summary":"

Metadata about the PlaceOS instance connected to.

","constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","doc":"Metadata about the PlaceOS instance connected to.\n\nThis provides information that may be of relevance for authentication or\nproviding client-side configuration information.","summary":"

Metadata about the PlaceOS instance connected to.

","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/authority.cr","line_number":8,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"config:Hash(String,JSON::Any)-instance-method","name":"config","doc":"Additional configuration / context for clients.","summary":"

Additional configuration / context for clients.

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":28,"url":null},"def":{"name":"config","return_type":"Hash(String, ::JSON::Any)","visibility":"Public","body":"@config"}},{"html_id":"description:String|Nil-instance-method","name":"description","doc":"Authority description (markdown).","summary":"

Authority description (markdown).

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":19,"url":null},"def":{"name":"description","return_type":"String | ::Nil","visibility":"Public","body":"@description"}},{"html_id":"domain:String-instance-method","name":"domain","doc":"FQDN or IP address this authority serves.","summary":"

FQDN or IP address this authority serves.

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":16,"url":null},"def":{"name":"domain","return_type":"String","visibility":"Public","body":"@domain"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier that represents the Authority.","summary":"

A universally unique identifier that represents the Authority.

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":10,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"login_url:String-instance-method","name":"login_url","doc":"Path that clients should use for initiating authentication.","summary":"

Path that clients should use for initiating authentication.

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":22,"url":null},"def":{"name":"login_url","return_type":"String","visibility":"Public","body":"@login_url"}},{"html_id":"logout_url:String-instance-method","name":"logout_url","doc":"Path that clients should use for revoking authentication.","summary":"

Path that clients should use for revoking authentication.

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":25,"url":null},"def":{"name":"logout_url","return_type":"String","visibility":"Public","body":"@logout_url"}},{"html_id":"name:String-instance-method","name":"name","doc":"Human readable name","summary":"

Human readable name

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":13,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"version:String-instance-method","name":"version","doc":"Version of application","summary":"

Version of application

","abstract":false,"location":{"filename":"src/placeos/api/models/authority.cr","line_number":31,"url":null},"def":{"name":"version","return_type":"String","visibility":"Public","body":"@version"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Cluster","path":"PlaceOS/Client/API/Models/Cluster.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Cluster","name":"Cluster","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/cluster.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/cluster.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Driver","path":"PlaceOS/Client/API/Models/Driver.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Driver","name":"Driver","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/driver.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/driver.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"commit:String-instance-method","name":"commit","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":25,"url":null},"def":{"name":"commit","return_type":"String","visibility":"Public","body":"@commit"}},{"html_id":"default_port:Int32|Nil-instance-method","name":"default_port","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":14,"url":null},"def":{"name":"default_port","return_type":"Int32 | ::Nil","visibility":"Public","body":"@default_port"}},{"html_id":"default_uri:String|Nil-instance-method","name":"default_uri","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":13,"url":null},"def":{"name":"default_uri","return_type":"String | ::Nil","visibility":"Public","body":"@default_uri"}},{"html_id":"description:String|Nil-instance-method","name":"description","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":11,"url":null},"def":{"name":"description","return_type":"String | ::Nil","visibility":"Public","body":"@description"}},{"html_id":"file_name:String-instance-method","name":"file_name","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":24,"url":null},"def":{"name":"file_name","return_type":"String","visibility":"Public","body":"@file_name"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":8,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"ignore_connected:Bool-instance-method","name":"ignore_connected","doc":"Don't include this module in statistics or disconnected searches\nMight be a device that commonly goes offline (like a PC or Display that only supports Wake on Lan)","summary":"

Don't include this module in statistics or disconnected searches Might be a device that commonly goes offline (like a PC or Display that only supports Wake on Lan)

","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":34,"url":null},"def":{"name":"ignore_connected","return_type":"Bool","visibility":"Public","body":"@ignore_connected"}},{"html_id":"module_name:String-instance-method","name":"module_name","doc":"Module instance configuration","summary":"

Module instance configuration

","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":30,"url":null},"def":{"name":"module_name","return_type":"String","visibility":"Public","body":"@module_name"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":10,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"repository_id:String-instance-method","name":"repository_id","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":27,"url":null},"def":{"name":"repository_id","return_type":"String","visibility":"Public","body":"@repository_id"}},{"html_id":"role:Role-instance-method","name":"role","abstract":false,"location":{"filename":"src/placeos/api/models/driver.cr","line_number":18,"url":null},"def":{"name":"role","return_type":"Role","visibility":"Public","body":"Role.from_value(@role)"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Function","path":"PlaceOS/Client/API/Models/Function.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Function","name":"Function","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/function.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"doc":"Invocation information for interaction with an exposed driver behaviour.","summary":"

Invocation information for interaction with an exposed driver behaviour.

","constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","doc":"Invocation information for interaction with an exposed driver behaviour.","summary":"

Invocation information for interaction with an exposed driver behaviour.

","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/function.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"arity:Int32-instance-method","name":"arity","doc":"The number of parameters that the function accepts.","summary":"

The number of parameters that the function accepts.

","abstract":false,"location":{"filename":"src/placeos/api/models/function.cr","line_number":7,"url":null},"def":{"name":"arity","return_type":"Int32","visibility":"Public","body":"@arity"}},{"html_id":"params:Array(Parameter)-instance-method","name":"params","doc":"Parameter information.","summary":"

Parameter information.

","abstract":false,"location":{"filename":"src/placeos/api/models/function.cr","line_number":25,"url":null},"def":{"name":"params","return_type":"Array(Parameter)","visibility":"Public","body":"@params"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Function/Parameter","path":"PlaceOS/Client/API/Models/Function/Parameter.html","kind":"alias","full_name":"PlaceOS::Client::API::Models::Function::Parameter","name":"Parameter","abstract":false,"locations":[{"filename":"src/placeos/api/models/function.cr","line_number":22,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":true,"aliased":"Tuple(PlaceOS::Client::API::Models::Function::ParameterKind, String)","aliased_html":"{PlaceOS::Client::API::Models::Function::ParameterKind, String}","const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Function","kind":"struct","full_name":"PlaceOS::Client::API::Models::Function","name":"Function"},"doc":"Parameter information as {kind, name}.","summary":"

Parameter information as {kind, name}.

"},{"html_id":"placeos/PlaceOS/Client/API/Models/Function/ParameterKind","path":"PlaceOS/Client/API/Models/Function/ParameterKind.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::Function::ParameterKind","name":"ParameterKind","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/function.cr","line_number":10,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"Req","name":"Req","value":"0","doc":"Required","summary":"

Required

"},{"id":"Opt","name":"Opt","value":"1","doc":"Optional","summary":"

Optional

"},{"id":"Rest","name":"Rest","value":"2","doc":"A capture all for all trailing arguments.","summary":"

A capture all for all trailing arguments.

"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Function","kind":"struct","full_name":"PlaceOS::Client::API::Models::Function","name":"Function"},"doc":"Possible parameter kinds.","summary":"

Possible parameter kinds.

","instance_methods":[{"html_id":"opt?-instance-method","name":"opt?","abstract":false,"location":{"filename":"src/placeos/api/models/function.cr","line_number":15,"url":null},"def":{"name":"opt?","visibility":"Public","body":"self == Opt"}},{"html_id":"req?-instance-method","name":"req?","abstract":false,"location":{"filename":"src/placeos/api/models/function.cr","line_number":12,"url":null},"def":{"name":"req?","visibility":"Public","body":"self == Req"}},{"html_id":"rest?-instance-method","name":"rest?","abstract":false,"location":{"filename":"src/placeos/api/models/function.cr","line_number":18,"url":null},"def":{"name":"rest?","visibility":"Public","body":"self == Rest"}}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/LdapAuthentication","path":"PlaceOS/Client/API/Models/LdapAuthentication.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::LdapAuthentication","name":"LdapAuthentication","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"auth_method:String-instance-method","name":"auth_method","doc":"Options are: plain, ssl, tls","summary":"

Options are: plain, ssl, tls

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":13,"url":null},"def":{"name":"auth_method","return_type":"String","visibility":"Public","body":"@auth_method"}},{"html_id":"authority_id:String-instance-method","name":"authority_id","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":9,"url":null},"def":{"name":"authority_id","return_type":"String","visibility":"Public","body":"@authority_id"}},{"html_id":"base:String-instance-method","name":"base","doc":"BaseDN such as dc=intridea, dc=com","summary":"

BaseDN such as dc=intridea, dc=com

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":18,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"bind_dn:String-instance-method","name":"bind_dn","doc":":bind_dn and :password is the default credentials to perform user lookup","summary":"

:bind_dn and :password is the default credentials to perform user lookup

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":21,"url":null},"def":{"name":"bind_dn","return_type":"String","visibility":"Public","body":"@bind_dn"}},{"html_id":"filter:String-instance-method","name":"filter","doc":"LDAP filter like: (&(uid=%{username})(memberOf=cn=myapp-users,ou=groups,dc=example,dc=com))\nCan be used instead of UID","summary":"

LDAP filter like: (&(uid=%{username})(memberOf=cn=myapp-users,ou=groups,dc=example,dc=com)) Can be used instead of UID

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":26,"url":null},"def":{"name":"filter","return_type":"String","visibility":"Public","body":"@filter"}},{"html_id":"host:String-instance-method","name":"host","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":15,"url":null},"def":{"name":"host","return_type":"String","visibility":"Public","body":"@host"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":7,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":8,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"password:String-instance-method","name":"password","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":22,"url":null},"def":{"name":"password","return_type":"String","visibility":"Public","body":"@password"}},{"html_id":"port:Int32-instance-method","name":"port","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":10,"url":null},"def":{"name":"port","return_type":"Int32","visibility":"Public","body":"@port"}},{"html_id":"uid:String-instance-method","name":"uid","abstract":false,"location":{"filename":"src/placeos/api/models/auths/ldap.cr","line_number":14,"url":null},"def":{"name":"uid","return_type":"String","visibility":"Public","body":"@uid"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Metadata","path":"PlaceOS/Client/API/Models/Metadata.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Metadata","name":"Metadata","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/metadata.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/metadata.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"description:String-instance-method","name":"description","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":6,"url":null},"def":{"name":"description","return_type":"String","visibility":"Public","body":"@description"}},{"html_id":"details:JSON::Any-instance-method","name":"details","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":7,"url":null},"def":{"name":"details","return_type":"JSON::Any","visibility":"Public","body":"@details"}},{"html_id":"editors:Array(String)|Nil-instance-method","name":"editors","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":10,"url":null},"def":{"name":"editors","return_type":"Array(String) | ::Nil","visibility":"Public","body":"@editors"}},{"html_id":"modified_by_id:String|Nil-instance-method","name":"modified_by_id","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":11,"url":null},"def":{"name":"modified_by_id","return_type":"String | ::Nil","visibility":"Public","body":"@modified_by_id"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":5,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"parent_id:String-instance-method","name":"parent_id","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":8,"url":null},"def":{"name":"parent_id","return_type":"String","visibility":"Public","body":"@parent_id"}},{"html_id":"schema_id:String|Nil-instance-method","name":"schema_id","abstract":false,"location":{"filename":"src/placeos/api/models/metadata.cr","line_number":9,"url":null},"def":{"name":"schema_id","return_type":"String | ::Nil","visibility":"Public","body":"@schema_id"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Module","path":"PlaceOS/Client/API/Models/Module.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Module","name":"Module","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/module.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/module.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"connected:Bool-instance-method","name":"connected","doc":"Flag for connectivity state.","summary":"

Flag for connectivity state.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":48,"url":null},"def":{"name":"connected","return_type":"Bool","visibility":"Public","body":"@connected"}},{"html_id":"control_sytem_id:String|Nil-instance-method","name":"control_sytem_id","doc":"The system this module is bound to (logic modules only).","summary":"

The system this module is bound to (logic modules only).

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":15,"url":null},"def":{"name":"control_sytem_id","return_type":"String | ::Nil","visibility":"Public","body":"@control_sytem_id"}},{"html_id":"custom_name:String|Nil-instance-method","name":"custom_name","doc":"The modules class name (Display, Lighting etc) if it should differ from the\ndefault defined in the driver.","summary":"

The modules class name (Display, Lighting etc) if it should differ from the default defined in the driver.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":38,"url":null},"def":{"name":"custom_name","return_type":"String | ::Nil","visibility":"Public","body":"@custom_name"}},{"html_id":"driver_id:String-instance-method","name":"driver_id","doc":"The driver that defines this module.","summary":"

The driver that defines this module.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":12,"url":null},"def":{"name":"driver_id","return_type":"String","visibility":"Public","body":"@driver_id"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier for the module.","summary":"

A universally unique identifier for the module.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":9,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"ignore_connected:Bool-instance-method","name":"ignore_connected","doc":"If enabled, system metrics ignore connectivity state.","summary":"

If enabled, system metrics ignore connectivity state.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":54,"url":null},"def":{"name":"ignore_connected","return_type":"Bool","visibility":"Public","body":"@ignore_connected"}},{"html_id":"ignore_startstop:Bool-instance-method","name":"ignore_startstop","doc":"If enabled, system level start and stop actions are ignored. This is\nrecommended for modules shared by many systems (e.g. a lighting gateway).","summary":"

If enabled, system level start and stop actions are ignored.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":58,"url":null},"def":{"name":"ignore_startstop","return_type":"Bool","visibility":"Public","body":"@ignore_startstop"}},{"html_id":"ip:String|Nil-instance-method","name":"ip","doc":"IP address or resolvable hostname of the device this module connects to.","summary":"

IP address or resolvable hostname of the device this module connects to.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":18,"url":null},"def":{"name":"ip","return_type":"String | ::Nil","visibility":"Public","body":"@ip"}},{"html_id":"makebreak:Bool-instance-method","name":"makebreak","doc":"If enabled, provides an ephemeral connection that disconnects during idle\nperiods.","summary":"

If enabled, provides an ephemeral connection that disconnects during idle periods.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":31,"url":null},"def":{"name":"makebreak","return_type":"Bool","visibility":"Public","body":"@makebreak"}},{"html_id":"name:String-instance-method","name":"name","doc":"Driver's default name for the module","summary":"

Driver's default name for the module

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":41,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"port:Int32|Nil-instance-method","name":"port","doc":"The TCP or UDP port that the associated device communicates on.","summary":"

The TCP or UDP port that the associated device communicates on.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":27,"url":null},"def":{"name":"port","return_type":"Int32 | ::Nil","visibility":"Public","body":"@port"}},{"html_id":"role:Role-instance-method","name":"role","doc":"The associated driver type.","summary":"

The associated driver type.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":45,"url":null},"def":{"name":"role","return_type":"Role","visibility":"Public","body":"@role"}},{"html_id":"running:Bool-instance-method","name":"running","doc":"Module start/stop state.","summary":"

Module start/stop state.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":51,"url":null},"def":{"name":"running","return_type":"Bool","visibility":"Public","body":"@running"}},{"html_id":"tls:Bool|Nil-instance-method","name":"tls","doc":"True if the device communicates securely.","summary":"

True if the device communicates securely.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":21,"url":null},"def":{"name":"tls","return_type":"Bool | ::Nil","visibility":"Public","body":"@tls"}},{"html_id":"udp:Bool|Nil-instance-method","name":"udp","doc":"Protocol uses UDP rather that TCP.","summary":"

Protocol uses UDP rather that TCP.

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":24,"url":null},"def":{"name":"udp","return_type":"Bool | ::Nil","visibility":"Public","body":"@udp"}},{"html_id":"uri:URI|Nil-instance-method","name":"uri","doc":"The based URI of the remote service (service modules only).","summary":"

The based URI of the remote service (service modules only).

","abstract":false,"location":{"filename":"src/placeos/api/models/module.cr","line_number":34,"url":null},"def":{"name":"uri","return_type":"URI | ::Nil","visibility":"Public","body":"@uri"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/OAuthApplication","path":"PlaceOS/Client/API/Models/OAuthApplication.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::OAuthApplication","name":"OAuthApplication","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/oauth_application.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"confidential:Bool-instance-method","name":"confidential","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":14,"url":null},"def":{"name":"confidential","return_type":"Bool","visibility":"Public","body":"@confidential"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":6,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":7,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"owner_id:String-instance-method","name":"owner_id","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":11,"url":null},"def":{"name":"owner_id","return_type":"String","visibility":"Public","body":"@owner_id"}},{"html_id":"redirect_uri:String-instance-method","name":"redirect_uri","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":12,"url":null},"def":{"name":"redirect_uri","return_type":"String","visibility":"Public","body":"@redirect_uri"}},{"html_id":"revoked_at:Time-instance-method","name":"revoked_at","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":16,"url":null},"def":{"name":"revoked_at","return_type":"Time","visibility":"Public","body":"@revoked_at"}},{"html_id":"scopes:String-instance-method","name":"scopes","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":10,"url":null},"def":{"name":"scopes","return_type":"String","visibility":"Public","body":"@scopes"}},{"html_id":"secret:String-instance-method","name":"secret","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":9,"url":null},"def":{"name":"secret","return_type":"String","visibility":"Public","body":"@secret"}},{"html_id":"skip_authorization:Bool-instance-method","name":"skip_authorization","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":13,"url":null},"def":{"name":"skip_authorization","return_type":"Bool","visibility":"Public","body":"@skip_authorization"}},{"html_id":"uid:String-instance-method","name":"uid","abstract":false,"location":{"filename":"src/placeos/api/models/oauth_application.cr","line_number":8,"url":null},"def":{"name":"uid","return_type":"String","visibility":"Public","body":"@uid"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/OAuthAuthentication","path":"PlaceOS/Client/API/Models/OAuthAuthentication.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::OAuthAuthentication","name":"OAuthAuthentication","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"auth_scheme:String-instance-method","name":"auth_scheme","doc":"If not set it defaults to \"request_body\", others include \"basic_auth\"","summary":"

If not set it defaults to "request_body", others include "basic_auth"

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":29,"url":null},"def":{"name":"auth_scheme","return_type":"String","visibility":"Public","body":"@auth_scheme"}},{"html_id":"authority_id:String-instance-method","name":"authority_id","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":9,"url":null},"def":{"name":"authority_id","return_type":"String","visibility":"Public","body":"@authority_id"}},{"html_id":"authorize_url:String-instance-method","name":"authorize_url","doc":"The SSO providers URL for authorization, defaults to: `oauth/authorize`\nGoogle is `/o/oauth2/auth`","summary":"

The SSO providers URL for authorization, defaults to: oauth/authorize Google is /o/oauth2/auth

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":23,"url":null},"def":{"name":"authorize_url","return_type":"String","visibility":"Public","body":"@authorize_url"}},{"html_id":"client_id:String-instance-method","name":"client_id","doc":"The client ID and secret configured for this application","summary":"

The client ID and secret configured for this application

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":12,"url":null},"def":{"name":"client_id","return_type":"String","visibility":"Public","body":"@client_id"}},{"html_id":"client_secret:String-instance-method","name":"client_secret","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":13,"url":null},"def":{"name":"client_secret","return_type":"String","visibility":"Public","body":"@client_secret"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":7,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"info_mappings:Hash(String,String)-instance-method","name":"info_mappings","doc":"Maps an expected key to a provided key i.e. {used_in_engine => used_by_remote}","summary":"

Maps an expected key to a provided key i.e.

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":16,"url":null},"def":{"name":"info_mappings","return_type":"Hash(String, String)","visibility":"Public","body":"@info_mappings"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":8,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"raw_info_url:String-instance-method","name":"raw_info_url","doc":"URL to call with a valid token to obtain the users profile data (name, email etc)","summary":"

URL to call with a valid token to obtain the users profile data (name, email etc)

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":39,"url":null},"def":{"name":"raw_info_url","return_type":"String","visibility":"Public","body":"@raw_info_url"}},{"html_id":"scope:String-instance-method","name":"scope","doc":"Space seperated scope strings\ni.e. `https://www.googleapis.com/auth/devstorage.readonly https://www.googleapis.com/auth/prediction`","summary":"

Space seperated scope strings i.e.

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":36,"url":null},"def":{"name":"scope","return_type":"String","visibility":"Public","body":"@scope"}},{"html_id":"site:String-instance-method","name":"site","doc":"The HTTP URL of the SSO provider","summary":"

The HTTP URL of the SSO provider

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":19,"url":null},"def":{"name":"site","return_type":"String","visibility":"Public","body":"@site"}},{"html_id":"token_method:String-instance-method","name":"token_method","doc":"If not set it defaults to \"post\"","summary":"

If not set it defaults to "post"

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":26,"url":null},"def":{"name":"token_method","return_type":"String","visibility":"Public","body":"@token_method"}},{"html_id":"token_url:String-instance-method","name":"token_url","doc":"defaults to: `oauth/token` however google is: `/o/oauth2/token`","summary":"

defaults to: oauth/token however google is: /o/oauth2/token

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/oauth.cr","line_number":32,"url":null},"def":{"name":"token_url","return_type":"String","visibility":"Public","body":"@token_url"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Ping","path":"PlaceOS/Client/API/Models/Ping.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Ping","name":"Ping","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/ping.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/ping.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"exception:String|Nil-instance-method","name":"exception","abstract":false,"location":{"filename":"src/placeos/api/models/ping.cr","line_number":8,"url":null},"def":{"name":"exception","return_type":"String | ::Nil","visibility":"Public","body":"@exception"}},{"html_id":"host:String-instance-method","name":"host","abstract":false,"location":{"filename":"src/placeos/api/models/ping.cr","line_number":5,"url":null},"def":{"name":"host","return_type":"String","visibility":"Public","body":"@host"}},{"html_id":"pingable:Bool-instance-method","name":"pingable","abstract":false,"location":{"filename":"src/placeos/api/models/ping.cr","line_number":6,"url":null},"def":{"name":"pingable","return_type":"Bool","visibility":"Public","body":"@pingable"}},{"html_id":"warning:String|Nil-instance-method","name":"warning","abstract":false,"location":{"filename":"src/placeos/api/models/ping.cr","line_number":7,"url":null},"def":{"name":"warning","return_type":"String | ::Nil","visibility":"Public","body":"@warning"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Repository","path":"PlaceOS/Client/API/Models/Repository.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Repository","name":"Repository","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/repository.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/repository.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/ResourceToken","path":"PlaceOS/Client/API/Models/ResourceToken.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::ResourceToken","name":"ResourceToken","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/user.cr","line_number":42,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/user.cr","line_number":42,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"expires:Int64|Nil-instance-method","name":"expires","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":44,"url":null},"def":{"name":"expires","return_type":"Int64 | ::Nil","visibility":"Public","body":"@expires"}},{"html_id":"token:String-instance-method","name":"token","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":43,"url":null},"def":{"name":"token","return_type":"String","visibility":"Public","body":"@token"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Role","path":"PlaceOS/Client/API/Models/Role.html","kind":"alias","full_name":"PlaceOS::Client::API::Models::Role","name":"Role","abstract":false,"locations":[{"filename":"src/placeos/api/models/role.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":true,"aliased":"PlaceOS::Model::Driver::Role","aliased_html":"PlaceOS::Model::Driver::Role","const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"}},{"html_id":"placeos/PlaceOS/Client/API/Models/SamlAuthentication","path":"PlaceOS/Client/API/Models/SamlAuthentication.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::SamlAuthentication","name":"SamlAuthentication","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/auths/saml.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"assertion_consumer_service_url:String-instance-method","name":"assertion_consumer_service_url","doc":"The URL at which the SAML assertion should be received (SSO Service => Engine URL)","summary":"

The URL at which the SAML assertion should be received (SSO Service => Engine URL)

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":25,"url":null},"def":{"name":"assertion_consumer_service_url","return_type":"String","visibility":"Public","body":"@assertion_consumer_service_url"}},{"html_id":"authority_id:String-instance-method","name":"authority_id","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":9,"url":null},"def":{"name":"authority_id","return_type":"String","visibility":"Public","body":"@authority_id"}},{"html_id":"getter_service_name:String-instance-method","name":"getter_service_name","doc":"Name for the getter service (Defaults to Required getters)","summary":"

Name for the getter service (Defaults to Required getters)

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":37,"url":null},"def":{"name":"getter_service_name","return_type":"String","visibility":"Public","body":"@getter_service_name"}},{"html_id":"getter_statements:Hash(String,Array(String))-instance-method","name":"getter_statements","doc":"Used to map getter Names in a SAMLResponse to entries in the OmniAuth info hash","summary":"

Used to map getter Names in a SAMLResponse to entries in the OmniAuth info hash

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":40,"url":null},"def":{"name":"getter_statements","return_type":"Hash(String, Array(String))","visibility":"Public","body":"@getter_statements"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":7,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"idp_cert:String-instance-method","name":"idp_cert","doc":"The identity provider's certificate in PEM format (this or fingerprint is required)","summary":"

The identity provider's certificate in PEM format (this or fingerprint is required)

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":31,"url":null},"def":{"name":"idp_cert","return_type":"String","visibility":"Public","body":"@idp_cert"}},{"html_id":"idp_cert_fingerprint:String-instance-method","name":"idp_cert_fingerprint","doc":"The SHA1 fingerprint of the certificate","summary":"

The SHA1 fingerprint of the certificate

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":34,"url":null},"def":{"name":"idp_cert_fingerprint","return_type":"String","visibility":"Public","body":"@idp_cert_fingerprint"}},{"html_id":"idp_slo_target_url:String-instance-method","name":"idp_slo_target_url","doc":"The URL to which the single logout request and response should be sent","summary":"

The URL to which the single logout request and response should be sent

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":46,"url":null},"def":{"name":"idp_slo_target_url","return_type":"String","visibility":"Public","body":"@idp_slo_target_url"}},{"html_id":"idp_sso_target_url:String-instance-method","name":"idp_sso_target_url","doc":"The URL to which the authentication request should be sent (Engine => SSO Service)","summary":"

The URL to which the authentication request should be sent (Engine => SSO Service)

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":28,"url":null},"def":{"name":"idp_sso_target_url","return_type":"String","visibility":"Public","body":"@idp_sso_target_url"}},{"html_id":"idp_sso_target_url_runtime_params:Hash(String,String)-instance-method","name":"idp_sso_target_url_runtime_params","doc":"mapping of request params that exist during the request phase of OmniAuth that should to be sent to the IdP","summary":"

mapping of request params that exist during the request phase of OmniAuth that should to be sent to the IdP

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":15,"url":null},"def":{"name":"idp_sso_target_url_runtime_params","return_type":"Hash(String, String)","visibility":"Public","body":"@idp_sso_target_url_runtime_params"}},{"html_id":"issuer:String-instance-method","name":"issuer","doc":"The name of your application","summary":"

The name of your application

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":12,"url":null},"def":{"name":"issuer","return_type":"String","visibility":"Public","body":"@issuer"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":8,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"name_identifier_format:String-instance-method","name":"name_identifier_format","doc":"Describes the format of the username required by this application","summary":"

Describes the format of the username required by this application

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":18,"url":null},"def":{"name":"name_identifier_format","return_type":"String","visibility":"Public","body":"@name_identifier_format"}},{"html_id":"request_getters:Array(NamedTuple(name:String,name_format:String,friendly_name:String))-instance-method","name":"request_getters","doc":"Used to map getter Names in a SAMLResponse to entries in the OmniAuth info hash","summary":"

Used to map getter Names in a SAMLResponse to entries in the OmniAuth info hash

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":43,"url":null},"def":{"name":"request_getters","return_type":"Array(NamedTuple(name: String, name_format: String, friendly_name: String))","visibility":"Public","body":"@request_getters"}},{"html_id":"slo_default_relay_state:String-instance-method","name":"slo_default_relay_state","doc":"The value to use as default RelayState for single log outs","summary":"

The value to use as default RelayState for single log outs

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":49,"url":null},"def":{"name":"slo_default_relay_state","return_type":"String","visibility":"Public","body":"@slo_default_relay_state"}},{"html_id":"uid_getter:String-instance-method","name":"uid_getter","doc":"getter that uniquely identifies the user\n(If unset, the name identifier returned by the IdP is used.)","summary":"

getter that uniquely identifies the user (If unset, the name identifier returned by the IdP is used.)

","abstract":false,"location":{"filename":"src/placeos/api/models/auths/saml.cr","line_number":22,"url":null},"def":{"name":"uid_getter","return_type":"String","visibility":"Public","body":"@uid_getter"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Settings","path":"PlaceOS/Client/API/Models/Settings.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Settings","name":"Settings","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/settings.cr","line_number":6,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/settings.cr","line_number":6,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"encryption_level:Encryption::Level-instance-method","name":"encryption_level","abstract":false,"location":{"filename":"src/placeos/api/models/settings.cr","line_number":9,"url":null},"def":{"name":"encryption_level","return_type":"Encryption::Level","visibility":"Public","body":"@encryption_level"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/settings.cr","line_number":7,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"keys:Array(String)-instance-method","name":"keys","abstract":false,"location":{"filename":"src/placeos/api/models/settings.cr","line_number":11,"url":null},"def":{"name":"keys","return_type":"Array(String)","visibility":"Public","body":"@keys"}},{"html_id":"parent_id:String-instance-method","name":"parent_id","abstract":false,"location":{"filename":"src/placeos/api/models/settings.cr","line_number":12,"url":null},"def":{"name":"parent_id","return_type":"String","visibility":"Public","body":"@parent_id"}},{"html_id":"parent_type:String-instance-method","name":"parent_type","abstract":false,"location":{"filename":"src/placeos/api/models/settings.cr","line_number":13,"url":null},"def":{"name":"parent_type","return_type":"String","visibility":"Public","body":"@parent_type"}},{"html_id":"settings_string:String-instance-method","name":"settings_string","abstract":false,"location":{"filename":"src/placeos/api/models/settings.cr","line_number":10,"url":null},"def":{"name":"settings_string","return_type":"String","visibility":"Public","body":"@settings_string"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/System","path":"PlaceOS/Client/API/Models/System.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::System","name":"System","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/system.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/system.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"bookable:Bool-instance-method","name":"bookable","doc":"Flag for signifying the space as reservable.","summary":"

Flag for signifying the space as reservable.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":50,"url":null},"def":{"name":"bookable","return_type":"Bool","visibility":"Public","body":"@bookable"}},{"html_id":"capacity:Int32-instance-method","name":"capacity","doc":"Number of people that can be accommodated in this space.","summary":"

Number of people that can be accommodated in this space.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":44,"url":null},"def":{"name":"capacity","return_type":"Int32","visibility":"Public","body":"@capacity"}},{"html_id":"code:String|Nil-instance-method","name":"code","doc":"the room identification code, like 3-04 etc.","summary":"

the room identification code, like 3-04 etc.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":32,"url":null},"def":{"name":"code","return_type":"String | ::Nil","visibility":"Public","body":"@code"}},{"html_id":"description:String|Nil-instance-method","name":"description","doc":"Markdown formatted text that describes the system.","summary":"

Markdown formatted text that describes the system.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":20,"url":null},"def":{"name":"description","return_type":"String | ::Nil","visibility":"Public","body":"@description"}},{"html_id":"display_name:String|Nil-instance-method","name":"display_name","doc":"an alternative to the full name that is easier to read.","summary":"

an alternative to the full name that is easier to read.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":26,"url":null},"def":{"name":"display_name","return_type":"String | ::Nil","visibility":"Public","body":"@display_name"}},{"html_id":"email:String|Nil-instance-method","name":"email","doc":"Calendar URI that is associated with this system.","summary":"

Calendar URI that is associated with this system.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":23,"url":null},"def":{"name":"email","return_type":"String | ::Nil","visibility":"Public","body":"@email"}},{"html_id":"features:Set(String)-instance-method","name":"features","doc":"List of features in the room for searching and filtering spaces.","summary":"

List of features in the room for searching and filtering spaces.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":47,"url":null},"def":{"name":"features","return_type":"Set(String)","visibility":"Public","body":"@features"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier for the system.","summary":"

A universally unique identifier for the system.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":8,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"images:Array(String)|Nil-instance-method","name":"images","doc":"images of this room","summary":"

images of this room

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":41,"url":null},"def":{"name":"images","return_type":"Array(String) | ::Nil","visibility":"Public","body":"@images"}},{"html_id":"installed_ui_devices:Int32-instance-method","name":"installed_ui_devices","doc":"Expected number of fixed installation touch panels.","summary":"

Expected number of fixed installation touch panels.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":56,"url":null},"def":{"name":"installed_ui_devices","return_type":"Int32","visibility":"Public","body":"@installed_ui_devices"}},{"html_id":"map_id:String|Nil-instance-method","name":"map_id","doc":"a map identifier that can be used to locate this system.","summary":"

a map identifier that can be used to locate this system.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":38,"url":null},"def":{"name":"map_id","return_type":"String | ::Nil","visibility":"Public","body":"@map_id"}},{"html_id":"modules:Array(String)-instance-method","name":"modules","doc":"Module ID's that this system contains.","summary":"

Module ID's that this system contains.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":17,"url":null},"def":{"name":"modules","return_type":"Array(String)","visibility":"Public","body":"@modules"}},{"html_id":"name:String-instance-method","name":"name","doc":"A human readable identifier.","summary":"

A human readable identifier.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":11,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"public:Bool|Nil-instance-method","name":"public","doc":"is the system intended for public access?","summary":"

is the system intended for public access?

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":53,"url":null},"def":{"name":"public","return_type":"Bool | ::Nil","visibility":"Public","body":"@public"}},{"html_id":"support_url:String|Nil-instance-method","name":"support_url","doc":"A URL linking to the primary interface for controlling this system.","summary":"

A URL linking to the primary interface for controlling this system.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":59,"url":null},"def":{"name":"support_url","return_type":"String | ::Nil","visibility":"Public","body":"@support_url"}},{"html_id":"timezone:String|Nil-instance-method","name":"timezone","doc":"timezone the system is located","summary":"

timezone the system is located

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":29,"url":null},"def":{"name":"timezone","return_type":"String | ::Nil","visibility":"Public","body":"@timezone"}},{"html_id":"type:String|Nil-instance-method","name":"type","doc":"the system type, like a small meeting room etc.","summary":"

the system type, like a small meeting room etc.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":35,"url":null},"def":{"name":"type","return_type":"String | ::Nil","visibility":"Public","body":"@type"}},{"html_id":"version:Int32-instance-method","name":"version","doc":"Incrementing counter for handling stale updates.","summary":"

Incrementing counter for handling stale updates.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":62,"url":null},"def":{"name":"version","return_type":"Int32","visibility":"Public","body":"@version"}},{"html_id":"zones:Array(String)-instance-method","name":"zones","doc":"Zone IDs that this system is a member of.","summary":"

Zone IDs that this system is a member of.

","abstract":false,"location":{"filename":"src/placeos/api/models/system.cr","line_number":14,"url":null},"def":{"name":"zones","return_type":"Array(String)","visibility":"Public","body":"@zones"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","path":"PlaceOS/Client/API/Models/Timestamps.html","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps","abstract":false,"locations":[{"filename":"src/placeos/api/models/response.cr","line_number":29,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"including_types":[{"html_id":"placeos/PlaceOS/Client/API/Models/APIKey","kind":"struct","full_name":"PlaceOS::Client::API::Models::APIKey","name":"APIKey"},{"html_id":"placeos/PlaceOS/Client/API/Models/Driver","kind":"struct","full_name":"PlaceOS::Client::API::Models::Driver","name":"Driver"},{"html_id":"placeos/PlaceOS/Client/API/Models/LdapAuthentication","kind":"struct","full_name":"PlaceOS::Client::API::Models::LdapAuthentication","name":"LdapAuthentication"},{"html_id":"placeos/PlaceOS/Client/API/Models/Module","kind":"struct","full_name":"PlaceOS::Client::API::Models::Module","name":"Module"},{"html_id":"placeos/PlaceOS/Client/API/Models/OAuthApplication","kind":"struct","full_name":"PlaceOS::Client::API::Models::OAuthApplication","name":"OAuthApplication"},{"html_id":"placeos/PlaceOS/Client/API/Models/OAuthAuthentication","kind":"struct","full_name":"PlaceOS::Client::API::Models::OAuthAuthentication","name":"OAuthAuthentication"},{"html_id":"placeos/PlaceOS/Client/API/Models/SamlAuthentication","kind":"struct","full_name":"PlaceOS::Client::API::Models::SamlAuthentication","name":"SamlAuthentication"},{"html_id":"placeos/PlaceOS/Client/API/Models/System","kind":"struct","full_name":"PlaceOS::Client::API::Models::System","name":"System"},{"html_id":"placeos/PlaceOS/Client/API/Models/Zone","kind":"struct","full_name":"PlaceOS::Client::API::Models::Zone","name":"Zone"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"instance_methods":[{"html_id":"created_at:Time-instance-method","name":"created_at","doc":"Creation time.","summary":"

Creation time.

","abstract":false,"location":{"filename":"src/placeos/api/models/response.cr","line_number":32,"url":null},"def":{"name":"created_at","return_type":"Time","visibility":"Public","body":"@created_at"}},{"html_id":"updated_at:Time-instance-method","name":"updated_at","doc":"Update time.","summary":"

Update time.

","abstract":false,"location":{"filename":"src/placeos/api/models/response.cr","line_number":36,"url":null},"def":{"name":"updated_at","return_type":"Time","visibility":"Public","body":"@updated_at"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger","path":"PlaceOS/Client/API/Models/Trigger.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger","name":"Trigger","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"actions:Actions-instance-method","name":"actions","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":9,"url":null},"def":{"name":"actions","return_type":"Actions","visibility":"Public","body":"@actions"}},{"html_id":"conditions:Conditions-instance-method","name":"conditions","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":10,"url":null},"def":{"name":"conditions","return_type":"Conditions","visibility":"Public","body":"@conditions"}},{"html_id":"control_system_id:String-instance-method","name":"control_system_id","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":7,"url":null},"def":{"name":"control_system_id","return_type":"String","visibility":"Public","body":"@control_system_id"}},{"html_id":"debounce_period:Int32-instance-method","name":"debounce_period","doc":"In milliseconds","summary":"

In milliseconds

","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":13,"url":null},"def":{"name":"debounce_period","return_type":"Int32","visibility":"Public","body":"@debounce_period"}},{"html_id":"description:String-instance-method","name":"description","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":6,"url":null},"def":{"name":"description","return_type":"String","visibility":"Public","body":"@description"}},{"html_id":"enable_webhook:Bool-instance-method","name":"enable_webhook","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":16,"url":null},"def":{"name":"enable_webhook","return_type":"Bool","visibility":"Public","body":"@enable_webhook"}},{"html_id":"important:Bool-instance-method","name":"important","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":14,"url":null},"def":{"name":"important","return_type":"Bool","visibility":"Public","body":"@important"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":5,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"supported_methods:Array(String)-instance-method","name":"supported_methods","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":17,"url":null},"def":{"name":"supported_methods","return_type":"Array(String)","visibility":"Public","body":"@supported_methods"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Actions","path":"PlaceOS/Client/API/Models/Trigger/Actions.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Actions","name":"Actions","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":19,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger","name":"Trigger"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":19,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"functions:Array(Function)-instance-method","name":"functions","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":20,"url":null},"def":{"name":"functions","return_type":"Array(Function)","visibility":"Public","body":"@functions"}},{"html_id":"mailers:Array(Email)-instance-method","name":"mailers","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":21,"url":null},"def":{"name":"mailers","return_type":"Array(Email)","visibility":"Public","body":"@mailers"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Actions/Email","path":"PlaceOS/Client/API/Models/Trigger/Actions/Email.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Actions::Email","name":"Email","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":23,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Actions","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Actions","name":"Actions"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":23,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"content:String-instance-method","name":"content","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":25,"url":null},"def":{"name":"content","return_type":"String","visibility":"Public","body":"@content"}},{"html_id":"emails:Array(String)-instance-method","name":"emails","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":24,"url":null},"def":{"name":"emails","return_type":"Array(String)","visibility":"Public","body":"@emails"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Actions/Function","path":"PlaceOS/Client/API/Models/Trigger/Actions/Function.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Actions::Function","name":"Function","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":28,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Actions","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Actions","name":"Actions"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":28,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"args:Hash(String,JSON::Any)-instance-method","name":"args","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":31,"url":null},"def":{"name":"args","return_type":"Hash(String, JSON::Any)","visibility":"Public","body":"@args"}},{"html_id":"method:String-instance-method","name":"method","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":30,"url":null},"def":{"name":"method","return_type":"String","visibility":"Public","body":"@method"}},{"html_id":"mod:String-instance-method","name":"mod","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":29,"url":null},"def":{"name":"mod","return_type":"String","visibility":"Public","body":"@mod"}}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions","path":"PlaceOS/Client/API/Models/Trigger/Conditions.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions","name":"Conditions","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":35,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger","name":"Trigger"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":35,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"comparisons:Array(Comparison)-instance-method","name":"comparisons","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":36,"url":null},"def":{"name":"comparisons","return_type":"Array(Comparison)","visibility":"Public","body":"@comparisons"}},{"html_id":"time_dependents:Array(TimeDependent)-instance-method","name":"time_dependents","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":37,"url":null},"def":{"name":"time_dependents","return_type":"Array(TimeDependent)","visibility":"Public","body":"@time_dependents"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison","path":"PlaceOS/Client/API/Models/Trigger/Conditions/Comparison.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison","name":"Comparison","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":39,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"OPERATORS","name":"OPERATORS","value":"{\"equal\", \"not_equal\", \"greater_than\", \"greater_than_or_equal\", \"less_than\", \"less_than_or_equal\", \"and\", \"or\", \"exclusive_or\"}"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions","name":"Conditions"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":39,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"left:Value-instance-method","name":"left","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":40,"url":null},"def":{"name":"left","return_type":"Value","visibility":"Public","body":"@left"}},{"html_id":"operator:String-instance-method","name":"operator","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":41,"url":null},"def":{"name":"operator","return_type":"String","visibility":"Public","body":"@operator"}},{"html_id":"right:Value-instance-method","name":"right","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":42,"url":null},"def":{"name":"right","return_type":"Value","visibility":"Public","body":"@right"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Constant","path":"PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Constant.html","kind":"alias","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison::Constant","name":"Constant","abstract":false,"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":47,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":true,"aliased":"(Bool | Float64 | Int64 | String)","aliased_html":"Bool | Float64 | Int64 | String","const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison","name":"Comparison"},"doc":"Constant value","summary":"

Constant value

"},{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/StatusVariable","path":"PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/StatusVariable.html","kind":"alias","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison::StatusVariable","name":"StatusVariable","abstract":false,"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":50,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":true,"aliased":"NamedTuple(mod: String, status: String, keys: Array(String))","aliased_html":"{mod: String, status: String, keys: Array(String)}","const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison","name":"Comparison"},"doc":"Status of a Module","summary":"

Status of a Module

"},{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Value","path":"PlaceOS/Client/API/Models/Trigger/Conditions/Comparison/Value.html","kind":"alias","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison::Value","name":"Value","abstract":false,"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":44,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":true,"aliased":"(Bool | Float64 | Int64 | NamedTuple(mod: String, status: String, keys: Array(String)) | String)","aliased_html":"Bool | Float64 | Int64 | {mod: String, status: String, keys: Array(String)} | String","const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/Comparison","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::Comparison","name":"Comparison"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent","path":"PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::TimeDependent","name":"TimeDependent","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":65,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions","name":"Conditions"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger.cr","line_number":65,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"cron:String|Nil-instance-method","name":"cron","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":76,"url":null},"def":{"name":"cron","return_type":"String | ::Nil","visibility":"Public","body":"@cron"}},{"html_id":"time:Time|Nil-instance-method","name":"time","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":74,"url":null},"def":{"name":"time","return_type":"Time | ::Nil","visibility":"Public","body":"@time"}},{"html_id":"type:Type-instance-method","name":"type","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":71,"url":null},"def":{"name":"type","return_type":"Type","visibility":"Public","body":"@type"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent/Type","path":"PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent/Type.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::TimeDependent::Type","name":"Type","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger.cr","line_number":66,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"At","name":"At","value":"0"},{"id":"Cron","name":"Cron","value":"1"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Trigger/Conditions/TimeDependent","kind":"struct","full_name":"PlaceOS::Client::API::Models::Trigger::Conditions::TimeDependent","name":"TimeDependent"},"instance_methods":[{"html_id":"at?-instance-method","name":"at?","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":67,"url":null},"def":{"name":"at?","visibility":"Public","body":"self == At"}},{"html_id":"cron?-instance-method","name":"cron?","abstract":false,"location":{"filename":"src/placeos/api/models/trigger.cr","line_number":68,"url":null},"def":{"name":"cron?","visibility":"Public","body":"self == Cron"}}]}]}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/TriggerInstance","path":"PlaceOS/Client/API/Models/TriggerInstance.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::TriggerInstance","name":"TriggerInstance","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"control_system_id:String|Nil-instance-method","name":"control_system_id","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":5,"url":null},"def":{"name":"control_system_id","return_type":"String | ::Nil","visibility":"Public","body":"@control_system_id"}},{"html_id":"enabled:Bool-instance-method","name":"enabled","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":9,"url":null},"def":{"name":"enabled","return_type":"Bool","visibility":"Public","body":"@enabled"}},{"html_id":"exec_enabled:Bool-instance-method","name":"exec_enabled","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":12,"url":null},"def":{"name":"exec_enabled","return_type":"Bool","visibility":"Public","body":"@exec_enabled"}},{"html_id":"important:Bool-instance-method","name":"important","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":11,"url":null},"def":{"name":"important","return_type":"Bool","visibility":"Public","body":"@important"}},{"html_id":"trigger_count:Int32-instance-method","name":"trigger_count","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":15,"url":null},"def":{"name":"trigger_count","return_type":"Int32","visibility":"Public","body":"@trigger_count"}},{"html_id":"trigger_id:String|Nil-instance-method","name":"trigger_id","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":6,"url":null},"def":{"name":"trigger_id","return_type":"String | ::Nil","visibility":"Public","body":"@trigger_id"}},{"html_id":"triggered:Bool-instance-method","name":"triggered","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":10,"url":null},"def":{"name":"triggered","return_type":"Bool","visibility":"Public","body":"@triggered"}},{"html_id":"webhook_secret:String-instance-method","name":"webhook_secret","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":14,"url":null},"def":{"name":"webhook_secret","return_type":"String","visibility":"Public","body":"@webhook_secret"}},{"html_id":"zone_id:String|Nil-instance-method","name":"zone_id","abstract":false,"location":{"filename":"src/placeos/api/models/trigger_instance.cr","line_number":7,"url":null},"def":{"name":"zone_id","return_type":"String | ::Nil","visibility":"Public","body":"@zone_id"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/User","path":"PlaceOS/Client/API/Models/User.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::User","name":"User","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/user.cr","line_number":6,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"doc":"Metadata about the current user","summary":"

Metadata about the current user

","constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","doc":"Metadata about the current user","summary":"

Metadata about the current user

","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/user.cr","line_number":6,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"associated_metadata:Hash(String,Metadata)|Nil-instance-method","name":"associated_metadata","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":39,"url":null},"def":{"name":"associated_metadata","return_type":"Hash(String, Metadata) | ::Nil","visibility":"Public","body":"@associated_metadata"}},{"html_id":"authority_id:String-instance-method","name":"authority_id","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":20,"url":null},"def":{"name":"authority_id","return_type":"String","visibility":"Public","body":"@authority_id"}},{"html_id":"building:String|Nil-instance-method","name":"building","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":18,"url":null},"def":{"name":"building","return_type":"String | ::Nil","visibility":"Public","body":"@building"}},{"html_id":"card_number:String|Nil-instance-method","name":"card_number","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":36,"url":null},"def":{"name":"card_number","return_type":"String | ::Nil","visibility":"Public","body":"@card_number"}},{"html_id":"country:String|Nil-instance-method","name":"country","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":17,"url":null},"def":{"name":"country","return_type":"String | ::Nil","visibility":"Public","body":"@country"}},{"html_id":"created_at:Time-instance-method","name":"created_at","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":8,"url":null},"def":{"name":"created_at","return_type":"Time","visibility":"Public","body":"@created_at"}},{"html_id":"deleted:Bool|Nil-instance-method","name":"deleted","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":21,"url":null},"def":{"name":"deleted","return_type":"Bool | ::Nil","visibility":"Public","body":"@deleted"}},{"html_id":"department:String|Nil-instance-method","name":"department","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":22,"url":null},"def":{"name":"department","return_type":"String | ::Nil","visibility":"Public","body":"@department"}},{"html_id":"email:String-instance-method","name":"email","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":30,"url":null},"def":{"name":"email","return_type":"String","visibility":"Public","body":"@email"}},{"html_id":"email_digest:String-instance-method","name":"email_digest","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":11,"url":null},"def":{"name":"email_digest","return_type":"String","visibility":"Public","body":"@email_digest"}},{"html_id":"first_name:String|Nil-instance-method","name":"first_name","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":14,"url":null},"def":{"name":"first_name","return_type":"String | ::Nil","visibility":"Public","body":"@first_name"}},{"html_id":"groups:Array(String)|Nil-instance-method","name":"groups","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":16,"url":null},"def":{"name":"groups","return_type":"Array(String) | ::Nil","visibility":"Public","body":"@groups"}},{"html_id":"id:String-instance-method","name":"id","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":10,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"image:String|Nil-instance-method","name":"image","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":19,"url":null},"def":{"name":"image","return_type":"String | ::Nil","visibility":"Public","body":"@image"}},{"html_id":"last_name:String|Nil-instance-method","name":"last_name","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":15,"url":null},"def":{"name":"last_name","return_type":"String | ::Nil","visibility":"Public","body":"@last_name"}},{"html_id":"login_name:String|Nil-instance-method","name":"login_name","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":34,"url":null},"def":{"name":"login_name","return_type":"String | ::Nil","visibility":"Public","body":"@login_name"}},{"html_id":"metadata:String|Nil-instance-method","name":"metadata","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":33,"url":null},"def":{"name":"metadata","return_type":"String | ::Nil","visibility":"Public","body":"@metadata"}},{"html_id":"misc:String|Nil-instance-method","name":"misc","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":37,"url":null},"def":{"name":"misc","return_type":"String | ::Nil","visibility":"Public","body":"@misc"}},{"html_id":"name:String-instance-method","name":"name","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":13,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"nickname:String|Nil-instance-method","name":"nickname","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":12,"url":null},"def":{"name":"nickname","return_type":"String | ::Nil","visibility":"Public","body":"@nickname"}},{"html_id":"phone:String|Nil-instance-method","name":"phone","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":31,"url":null},"def":{"name":"phone","return_type":"String | ::Nil","visibility":"Public","body":"@phone"}},{"html_id":"preferred_language:String|Nil-instance-method","name":"preferred_language","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":23,"url":null},"def":{"name":"preferred_language","return_type":"String | ::Nil","visibility":"Public","body":"@preferred_language"}},{"html_id":"staff_id:String|Nil-instance-method","name":"staff_id","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":35,"url":null},"def":{"name":"staff_id","return_type":"String | ::Nil","visibility":"Public","body":"@staff_id"}},{"html_id":"support:Bool|Nil-instance-method","name":"support","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":29,"url":null},"def":{"name":"support","return_type":"Bool | ::Nil","visibility":"Public","body":"@support"}},{"html_id":"sys_admin:Bool|Nil-instance-method","name":"sys_admin","doc":"Admin only fields","summary":"

Admin only fields

","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":28,"url":null},"def":{"name":"sys_admin","return_type":"Bool | ::Nil","visibility":"Public","body":"@sys_admin"}},{"html_id":"ui_theme:String|Nil-instance-method","name":"ui_theme","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":32,"url":null},"def":{"name":"ui_theme","return_type":"String | ::Nil","visibility":"Public","body":"@ui_theme"}},{"html_id":"work_overrides:Hash(String,PlaceOS::Model::User::WorktimePreference)-instance-method","name":"work_overrides","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":25,"url":null},"def":{"name":"work_overrides","return_type":"Hash(String, PlaceOS::Model::User::WorktimePreference)","visibility":"Public","body":"@work_overrides"}},{"html_id":"work_preferences:Array(PlaceOS::Model::User::WorktimePreference)-instance-method","name":"work_preferences","abstract":false,"location":{"filename":"src/placeos/api/models/user.cr","line_number":24,"url":null},"def":{"name":"work_preferences","return_type":"Array(PlaceOS::Model::User::WorktimePreference)","visibility":"Public","body":"@work_preferences"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Version","path":"PlaceOS/Client/API/Models/Version.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Version","name":"Version","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/version.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/version.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"app:String-instance-method","name":"app","doc":"The PlaceOS application name","summary":"

The PlaceOS application name

","abstract":false,"location":{"filename":"src/placeos/api/models/version.cr","line_number":6,"url":null},"def":{"name":"app","return_type":"String","visibility":"Public","body":"@app"}},{"html_id":"build_time:String-instance-method","name":"build_time","doc":"The build time of the docker container","summary":"

The build time of the docker container

","abstract":false,"location":{"filename":"src/placeos/api/models/version.cr","line_number":15,"url":null},"def":{"name":"build_time","return_type":"String","visibility":"Public","body":"@build_time"}},{"html_id":"commit:String-instance-method","name":"commit","doc":"the commit hash for the running build","summary":"

the commit hash for the running build

","abstract":false,"location":{"filename":"src/placeos/api/models/version.cr","line_number":12,"url":null},"def":{"name":"commit","return_type":"String","visibility":"Public","body":"@commit"}},{"html_id":"version:String-instance-method","name":"version","doc":"The version in the shard yml","summary":"

The version in the shard yml

","abstract":false,"location":{"filename":"src/placeos/api/models/version.cr","line_number":9,"url":null},"def":{"name":"version","return_type":"String","visibility":"Public","body":"@version"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket","path":"PlaceOS/Client/API/Models/Websocket.html","kind":"module","full_name":"PlaceOS::Client::API::Models::Websocket","name":"Websocket","abstract":false,"locations":[{"filename":"src/placeos/api/models/websocket/request.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Request","path":"PlaceOS/Client/API/Models/Websocket/Request.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Request","name":"Request","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/request.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket","kind":"module","full_name":"PlaceOS::Client::API::Models::Websocket","name":"Websocket"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"args:Array(JSON::Any::Type)|Nil-instance-method","name":"args","doc":"Associated arguments for the command.","summary":"

Associated arguments for the command.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":34,"url":null},"def":{"name":"args","return_type":"Array(::JSON::Any::Type) | ::Nil","visibility":"Public","body":"@args"}},{"html_id":"cmd:Type-instance-method","name":"cmd","doc":"The command type.","summary":"

The command type.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":19,"url":null},"def":{"name":"cmd","return_type":"Type","visibility":"Public","body":"@cmd"}},{"html_id":"id:String|Int32|Int64-instance-method","name":"id","doc":"A unique identifier to associate with the command. This will be returned as\npart of the response.","summary":"

A unique identifier to associate with the command.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":16,"url":null},"def":{"name":"id","return_type":"String | Int32 | Int64","visibility":"Public","body":"@id"}},{"html_id":"index:Int32|Nil-instance-method","name":"index","doc":"The module index the command targets. Defaults to 1.","summary":"

The module index the command targets.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":28,"url":null},"def":{"name":"index","return_type":"Int32 | ::Nil","visibility":"Public","body":"@index"}},{"html_id":"mod:String-instance-method","name":"mod","doc":"The module name the command targets.","summary":"

The module name the command targets.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":25,"url":null},"def":{"name":"mod","return_type":"String","visibility":"Public","body":"@mod"}},{"html_id":"name:String-instance-method","name":"name","doc":"Name of the status variable of method being interacted with.","summary":"

Name of the status variable of method being interacted with.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":31,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"sys:String-instance-method","name":"sys","doc":"The system identified the command targets.","summary":"

The system identified the command targets.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":22,"url":null},"def":{"name":"sys","return_type":"String","visibility":"Public","body":"@sys"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Request/Type","path":"PlaceOS/Client/API/Models/Websocket/Request/Type.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::Websocket::Request::Type","name":"Type","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/request.cr","line_number":6,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"Bind","name":"Bind","value":"0"},{"id":"Unbind","name":"Unbind","value":"1"},{"id":"Exec","name":"Exec","value":"2"},{"id":"Debug","name":"Debug","value":"3"},{"id":"Ignore","name":"Ignore","value":"4"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Request","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Request","name":"Request"},"instance_methods":[{"html_id":"bind?-instance-method","name":"bind?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":7,"url":null},"def":{"name":"bind?","visibility":"Public","body":"self == Bind"}},{"html_id":"debug?-instance-method","name":"debug?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":10,"url":null},"def":{"name":"debug?","visibility":"Public","body":"self == Debug"}},{"html_id":"exec?-instance-method","name":"exec?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":9,"url":null},"def":{"name":"exec?","visibility":"Public","body":"self == Exec"}},{"html_id":"ignore?-instance-method","name":"ignore?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":11,"url":null},"def":{"name":"ignore?","visibility":"Public","body":"self == Ignore"}},{"html_id":"unbind?-instance-method","name":"unbind?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/request.cr","line_number":8,"url":null},"def":{"name":"unbind?","visibility":"Public","body":"self == Unbind"}}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","path":"PlaceOS/Client/API/Models/Websocket/Response.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket","kind":"module","full_name":"PlaceOS::Client::API::Models::Websocket","name":"Websocket"},"class_methods":[{"html_id":"from_json(input)-class-method","name":"from_json","doc":"Parses a websocket response into a concrete response type.\n\nFIXME: currently this is parsing twice - this is a quick hack to get things\ngoing. When time allows this should be refactored to work as a single pass,\nor provide a more efficient method for identifying the message type.","summary":"

Parses a websocket response into a concrete response type.

","abstract":false,"args":[{"name":"input","external_name":"input","restriction":""}],"args_string":"(input)","args_html":"(input)","location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":30,"url":null},"def":{"name":"from_json","args":[{"name":"input","external_name":"input","restriction":""}],"visibility":"Public","body":"json = JSON.parse(input)\ntype = Type.parse(json[\"type\"].as_s)\ntype.model.from_json(input)\n"}}],"constructors":[{"html_id":"new-class-method","name":"new","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":3,"url":null},"def":{"name":"new","visibility":"Public","body":"x = allocate\nif x.responds_to?(:finalize)\n ::GC.add_finalizer(x)\nend\nx\n"}}],"instance_methods":[{"html_id":"initialize-instance-method","name":"initialize","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":3,"url":null},"def":{"name":"initialize","visibility":"Public","body":""}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Debug","path":"PlaceOS/Client/API/Models/Websocket/Response/Debug.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Debug","name":"Debug","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"id:String|Int32|Int64-instance-method","name":"id","doc":"The identifier included with the original request.","summary":"

The identifier included with the original request.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":17,"url":null},"def":{"name":"id","return_type":"String | Int32 | Int64","visibility":"Public","body":"@id"}},{"html_id":"klass:String-instance-method","name":"klass","doc":"Class of the originating message source.","summary":"

Class of the originating message source.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":23,"url":null},"def":{"name":"klass","return_type":"String","visibility":"Public","body":"@klass"}},{"html_id":"level:Level-instance-method","name":"level","doc":"Message verbosity level.","summary":"

Message verbosity level.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":26,"url":null},"def":{"name":"level","return_type":"Level","visibility":"Public","body":"@level"}},{"html_id":"mod:String-instance-method","name":"mod","doc":"ID of the module the event originated from.","summary":"

ID of the module the event originated from.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":20,"url":null},"def":{"name":"mod","return_type":"String","visibility":"Public","body":"@mod"}},{"html_id":"msg:String-instance-method","name":"msg","doc":"Log message.","summary":"

Log message.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":29,"url":null},"def":{"name":"msg","return_type":"String","visibility":"Public","body":"@msg"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Debug/Level","path":"PlaceOS/Client/API/Models/Websocket/Response/Debug/Level.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Debug::Level","name":"Level","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":7,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"Unknown","name":"Unknown","value":"0"},{"id":"Fatal","name":"Fatal","value":"1"},{"id":"Error","name":"Error","value":"2"},{"id":"Warn","name":"Warn","value":"3"},{"id":"Info","name":"Info","value":"4"},{"id":"Debug","name":"Debug","value":"5"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Debug","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Debug","name":"Debug"},"instance_methods":[{"html_id":"debug?-instance-method","name":"debug?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":13,"url":null},"def":{"name":"debug?","visibility":"Public","body":"self == Debug"}},{"html_id":"error?-instance-method","name":"error?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":10,"url":null},"def":{"name":"error?","visibility":"Public","body":"self == Error"}},{"html_id":"fatal?-instance-method","name":"fatal?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":9,"url":null},"def":{"name":"fatal?","visibility":"Public","body":"self == Fatal"}},{"html_id":"info?-instance-method","name":"info?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":12,"url":null},"def":{"name":"info?","visibility":"Public","body":"self == Info"}},{"html_id":"unknown?-instance-method","name":"unknown?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":8,"url":null},"def":{"name":"unknown?","visibility":"Public","body":"self == Unknown"}},{"html_id":"warn?-instance-method","name":"warn?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/debug.cr","line_number":11,"url":null},"def":{"name":"warn?","visibility":"Public","body":"self == Warn"}}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Error","path":"PlaceOS/Client/API/Models/Websocket/Response/Error.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Error","name":"Error","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"code:Code-instance-method","name":"code","doc":"Error type.","summary":"

Error type.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":21,"url":null},"def":{"name":"code","return_type":"Code","visibility":"Public","body":"@code"}},{"html_id":"id:String|Int32|Int64-instance-method","name":"id","doc":"The identifier included with the original request.","summary":"

The identifier included with the original request.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":18,"url":null},"def":{"name":"id","return_type":"String | Int32 | Int64","visibility":"Public","body":"@id"}},{"html_id":"msg:String-instance-method","name":"msg","doc":"Additional error info.","summary":"

Additional error info.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":24,"url":null},"def":{"name":"msg","return_type":"String","visibility":"Public","body":"@msg"}}],"types":[{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Error/Code","path":"PlaceOS/Client/API/Models/Websocket/Response/Error/Code.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Error::Code","name":"Code","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":6,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"ParseError","name":"ParseError","value":"0"},{"id":"BadRequest","name":"BadRequest","value":"1"},{"id":"AccessDenied","name":"AccessDenied","value":"2"},{"id":"RequestFailed","name":"RequestFailed","value":"3"},{"id":"UnknownCommand","name":"UnknownCommand","value":"4"},{"id":"SystemNotFound","name":"SystemNotFound","value":"5"},{"id":"ModuleNotFound","name":"ModuleNotFound","value":"6"},{"id":"UnexpectedFailure","name":"UnexpectedFailure","value":"7"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Error","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Error","name":"Error"},"instance_methods":[{"html_id":"access_denied?-instance-method","name":"access_denied?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":9,"url":null},"def":{"name":"access_denied?","visibility":"Public","body":"self == AccessDenied"}},{"html_id":"bad_request?-instance-method","name":"bad_request?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":8,"url":null},"def":{"name":"bad_request?","visibility":"Public","body":"self == BadRequest"}},{"html_id":"module_not_found?-instance-method","name":"module_not_found?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":13,"url":null},"def":{"name":"module_not_found?","visibility":"Public","body":"self == ModuleNotFound"}},{"html_id":"parse_error?-instance-method","name":"parse_error?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":7,"url":null},"def":{"name":"parse_error?","visibility":"Public","body":"self == ParseError"}},{"html_id":"request_failed?-instance-method","name":"request_failed?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":10,"url":null},"def":{"name":"request_failed?","visibility":"Public","body":"self == RequestFailed"}},{"html_id":"system_not_found?-instance-method","name":"system_not_found?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":12,"url":null},"def":{"name":"system_not_found?","visibility":"Public","body":"self == SystemNotFound"}},{"html_id":"unexpected_failure?-instance-method","name":"unexpected_failure?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":14,"url":null},"def":{"name":"unexpected_failure?","visibility":"Public","body":"self == UnexpectedFailure"}},{"html_id":"unknown_command?-instance-method","name":"unknown_command?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/error.cr","line_number":11,"url":null},"def":{"name":"unknown_command?","visibility":"Public","body":"self == UnknownCommand"}}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Meta","path":"PlaceOS/Client/API/Models/Websocket/Response/Meta.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Meta","name":"Meta","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/meta.cr","line_number":3,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/websocket/response/meta.cr","line_number":4,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"index:Int32-instance-method","name":"index","doc":"Module index.","summary":"

Module index.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/meta.cr","line_number":13,"url":null},"def":{"name":"index","return_type":"Int32","visibility":"Public","body":"@index"}},{"html_id":"mod:String-instance-method","name":"mod","doc":"Module name.","summary":"

Module name.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/meta.cr","line_number":10,"url":null},"def":{"name":"mod","return_type":"String","visibility":"Public","body":"@mod"}},{"html_id":"name:String|Nil-instance-method","name":"name","doc":"Name of the method or status key.","summary":"

Name of the method or status key.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/meta.cr","line_number":16,"url":null},"def":{"name":"name","return_type":"String | ::Nil","visibility":"Public","body":"@name"}},{"html_id":"sys:String-instance-method","name":"sys","doc":"The system ID.","summary":"

The system ID.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/meta.cr","line_number":7,"url":null},"def":{"name":"sys","return_type":"String","visibility":"Public","body":"@sys"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Notify","path":"PlaceOS/Client/API/Models/Websocket/Response/Notify.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Notify","name":"Notify","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/notify.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response"},"doc":"Asyncronous state update from an active binding.","summary":"

Asyncronous state update from an active binding.

","constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/websocket/response/notify.cr","line_number":6,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"id:String|Int32|Int64-instance-method","name":"id","doc":"The identifier included with the original request.","summary":"

The identifier included with the original request.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/notify.cr","line_number":9,"url":null},"def":{"name":"id","return_type":"String | Int32 | Int64","visibility":"Public","body":"@id"}},{"html_id":"meta:Meta|Nil-instance-method","name":"meta","doc":"Associated metadata.","summary":"

Associated metadata.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/notify.cr","line_number":15,"url":null},"def":{"name":"meta","return_type":"Meta | ::Nil","visibility":"Public","body":"@meta"}},{"html_id":"value:JSON::Any-instance-method","name":"value","doc":"New status value","summary":"

New status value

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/notify.cr","line_number":12,"url":null},"def":{"name":"value","return_type":"::JSON::Any","visibility":"Public","body":"@value"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Success","path":"PlaceOS/Client/API/Models/Websocket/Response/Success.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Success","name":"Success","abstract":false,"superclass":{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response/success.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/websocket/response/success.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"id:String|Int32|Int64-instance-method","name":"id","doc":"The identifier included with the original request.","summary":"

The identifier included with the original request.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/success.cr","line_number":8,"url":null},"def":{"name":"id","return_type":"String | Int32 | Int64","visibility":"Public","body":"@id"}},{"html_id":"meta:Meta|Nil-instance-method","name":"meta","doc":"Associated metadata.","summary":"

Associated metadata.

","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response/success.cr","line_number":11,"url":null},"def":{"name":"meta","return_type":"Meta | ::Nil","visibility":"Public","body":"@meta"}}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response/Type","path":"PlaceOS/Client/API/Models/Websocket/Response/Type.html","kind":"enum","full_name":"PlaceOS::Client::API::Models::Websocket::Response::Type","name":"Type","abstract":false,"ancestors":[{"html_id":"placeos/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"placeos/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/websocket/response.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"Success","name":"Success","value":"0"},{"id":"Error","name":"Error","value":"1"},{"id":"Notify","name":"Notify","value":"2"},{"id":"Debug","name":"Debug","value":"3"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models/Websocket/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Websocket::Response","name":"Response"},"instance_methods":[{"html_id":"debug?-instance-method","name":"debug?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":8,"url":null},"def":{"name":"debug?","visibility":"Public","body":"self == Debug"}},{"html_id":"error?-instance-method","name":"error?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":6,"url":null},"def":{"name":"error?","visibility":"Public","body":"self == Error"}},{"html_id":"model-instance-method","name":"model","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":10,"url":null},"def":{"name":"model","visibility":"Public","body":"{% if true %}\n case self\n {% for type in @type.constants %}\n when {{ type }} then Response::{{ type }}\n {% end %}\n else\n # Will never happen, but required to stop nil for sneaking into the\n # returned type union.\n raise \"\"\n end\n {% end %}"}},{"html_id":"notify?-instance-method","name":"notify?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":7,"url":null},"def":{"name":"notify?","visibility":"Public","body":"self == Notify"}},{"html_id":"success?-instance-method","name":"success?","abstract":false,"location":{"filename":"src/placeos/api/models/websocket/response.cr","line_number":5,"url":null},"def":{"name":"success?","visibility":"Public","body":"self == Success"}}]}]}]},{"html_id":"placeos/PlaceOS/Client/API/Models/Zone","path":"PlaceOS/Client/API/Models/Zone.html","kind":"struct","full_name":"PlaceOS::Client::API::Models::Zone","name":"Zone","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response","kind":"struct","full_name":"PlaceOS::Client::API::Models::Response","name":"Response"},{"html_id":"placeos/PlaceOS/Client/API/Models/Response/Init","kind":"module","full_name":"PlaceOS::Client::API::Models::Response::Init","name":"Init"},{"html_id":"placeos/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"placeos/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"placeos/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api/models/zone.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models/Timestamps","kind":"module","full_name":"PlaceOS::Client::API::Models::Timestamps","name":"Timestamps"}],"namespace":{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},"constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/placeos/api/models/zone.cr","line_number":5,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"}}],"instance_methods":[{"html_id":"capacity:Int32-instance-method","name":"capacity","doc":"Could be used as people capacity","summary":"

Could be used as people capacity

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":33,"url":null},"def":{"name":"capacity","return_type":"Int32","visibility":"Public","body":"@capacity"}},{"html_id":"code:String|Nil-instance-method","name":"code","doc":"Could be used as floor code or building code etc","summary":"

Could be used as floor code or building code etc

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":24,"url":null},"def":{"name":"code","return_type":"String | ::Nil","visibility":"Public","body":"@code"}},{"html_id":"count:Int32-instance-method","name":"count","doc":"Could be used as desk count for a level","summary":"

Could be used as desk count for a level

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":30,"url":null},"def":{"name":"count","return_type":"Int32","visibility":"Public","body":"@count"}},{"html_id":"description:String|Nil-instance-method","name":"description","doc":"Markdown formatted text that describes the zone.","summary":"

Markdown formatted text that describes the zone.

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":21,"url":null},"def":{"name":"description","return_type":"String | ::Nil","visibility":"Public","body":"@description"}},{"html_id":"display_name:String|Nil-instance-method","name":"display_name","doc":"A human readable identifier for displaying on interfaces","summary":"

A human readable identifier for displaying on interfaces

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":15,"url":null},"def":{"name":"display_name","return_type":"String | ::Nil","visibility":"Public","body":"@display_name"}},{"html_id":"id:String-instance-method","name":"id","doc":"A universally unique identifier for the zone.","summary":"

A universally unique identifier for the zone.

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":9,"url":null},"def":{"name":"id","return_type":"String","visibility":"Public","body":"@id"}},{"html_id":"location:String|Nil-instance-method","name":"location","doc":"Geo-location string (lat,long) or any other location","summary":"

Geo-location string (lat,long) or any other location

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":18,"url":null},"def":{"name":"location","return_type":"String | ::Nil","visibility":"Public","body":"@location"}},{"html_id":"map_id:String|Nil-instance-method","name":"map_id","doc":"Map identifier, could be a URL or id","summary":"

Map identifier, could be a URL or id

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":36,"url":null},"def":{"name":"map_id","return_type":"String | ::Nil","visibility":"Public","body":"@map_id"}},{"html_id":"name:String-instance-method","name":"name","doc":"A human readable identifier.","summary":"

A human readable identifier.

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":12,"url":null},"def":{"name":"name","return_type":"String","visibility":"Public","body":"@name"}},{"html_id":"parent_id:String|Nil-instance-method","name":"parent_id","doc":"Parent id","summary":"

Parent id

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":45,"url":null},"def":{"name":"parent_id","return_type":"String | ::Nil","visibility":"Public","body":"@parent_id"}},{"html_id":"tags:Array(String)-instance-method","name":"tags","doc":"Space seperated list of tags for categorizing the zone.","summary":"

Space seperated list of tags for categorizing the zone.

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":39,"url":null},"def":{"name":"tags","return_type":"Array(String)","visibility":"Public","body":"@tags"}},{"html_id":"timezone:Time::Location|Nil-instance-method","name":"timezone","doc":"Timezone location of the zone","summary":"

Timezone location of the zone

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":52,"url":null},"def":{"name":"timezone","return_type":"Time::Location | ::Nil","visibility":"Public","body":"@timezone"}},{"html_id":"trigger_data:Array(Trigger)|Nil-instance-method","name":"trigger_data","doc":"Trigger data returned when param `complete` is `true`","summary":"

Trigger data returned when param complete is true

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":48,"url":null},"def":{"name":"trigger_data","return_type":"Array(Trigger) | ::Nil","visibility":"Public","body":"@trigger_data"}},{"html_id":"triggers:Array(String)-instance-method","name":"triggers","doc":"List of trigger ID's to be applied to all systems that associate with this zone.","summary":"

List of trigger ID's to be applied to all systems that associate with this zone.

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":42,"url":null},"def":{"name":"triggers","return_type":"Array(String)","visibility":"Public","body":"@triggers"}},{"html_id":"type:String|Nil-instance-method","name":"type","doc":"Could be used as floor type or building type etc","summary":"

Could be used as floor type or building type etc

","abstract":false,"location":{"filename":"src/placeos/api/models/zone.cr","line_number":27,"url":null},"def":{"name":"type","return_type":"String | ::Nil","visibility":"Public","body":"@type"}}]}]}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper","path":"PlaceOS/Client/APIWrapper.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper","abstract":false,"superclass":{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper.cr","line_number":18,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/API/Models","kind":"module","full_name":"PlaceOS::Client::API::Models","name":"Models"}],"namespace":{"html_id":"placeos/PlaceOS/Client","kind":"class","full_name":"PlaceOS::Client","name":"Client"},"constructors":[{"html_id":"new(uri:URI|String,host_header:String|Nil=nil,insecure:Bool=false,&authenticate:HTTP::Client->)-class-method","name":"new","abstract":false,"args":[{"name":"uri","external_name":"uri","restriction":"URI | String"},{"name":"host_header","default_value":"nil","external_name":"host_header","restriction":"String | ::Nil"},{"name":"insecure","default_value":"false","external_name":"insecure","restriction":"::Bool"}],"args_string":"(uri : URI | String, host_header : String | Nil = nil, insecure : Bool = false, &authenticate : HTTP::Client -> )","args_html":"(uri : URI | String, host_header : String | Nil = nil, insecure : Bool = false, &authenticate : HTTP::Client -> )","location":{"filename":"src/placeos/api_wrapper.cr","line_number":31,"url":null},"def":{"name":"new","args":[{"name":"uri","external_name":"uri","restriction":"URI | String"},{"name":"host_header","default_value":"nil","external_name":"host_header","restriction":"String | ::Nil"},{"name":"insecure","default_value":"false","external_name":"insecure","restriction":"::Bool"}],"yields":1,"block_arity":1,"block_arg":{"name":"authenticate","external_name":"authenticate","restriction":"(HTTP::Client ->)"},"visibility":"Public","body":"_ = allocate\n_.initialize(uri, host_header, insecure, &authenticate) do |_arg0|\n yield _arg0\nend\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}},{"html_id":"new(uri:URI|String,host_header:String|Nil=nil,insecure:Bool=false)-class-method","name":"new","abstract":false,"args":[{"name":"uri","external_name":"uri","restriction":"URI | String"},{"name":"host_header","default_value":"nil","external_name":"host_header","restriction":"String | ::Nil"},{"name":"insecure","default_value":"false","external_name":"insecure","restriction":"::Bool"}],"args_string":"(uri : URI | String, host_header : String | Nil = nil, insecure : Bool = false)","args_html":"(uri : URI | String, host_header : String | Nil = nil, insecure : Bool = false)","location":{"filename":"src/placeos/api_wrapper.cr","line_number":36,"url":null},"def":{"name":"new","args":[{"name":"uri","external_name":"uri","restriction":"URI | String"},{"name":"host_header","default_value":"nil","external_name":"host_header","restriction":"String | ::Nil"},{"name":"insecure","default_value":"false","external_name":"insecure","restriction":"::Bool"}],"visibility":"Public","body":"_ = allocate\n_.initialize(uri, host_header, insecure)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"connection(&)-instance-method","name":"connection","abstract":false,"location":{"filename":"src/placeos/api_wrapper.cr","line_number":40,"url":null},"def":{"name":"connection","yields":1,"block_arity":1,"visibility":"Public","body":"HTTP::Client.new(uri) do |client|\n if insecure\n client.tls?.try(&.verify_mode = :NONE)\n end\n authenticate.call(client)\n yield client\nend"}}],"types":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/APIKeys","path":"PlaceOS/Client/APIWrapper/APIKeys.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::APIKeys","name":"APIKeys","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":74,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":9,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,user_id:String,description:String|Nil=nil,scopes:Array(String)|Nil=nil,permissions:PlaceOS::Model::UserJWT::Permissions|Nil=nil)-instance-method","name":"create","doc":"Creates a new zone.","summary":"

Creates a new zone.

","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"user_id","external_name":"user_id","restriction":"String"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"Array(String) | ::Nil"},{"name":"permissions","default_value":"nil","external_name":"permissions","restriction":"::PlaceOS::Model::UserJWT::Permissions | ::Nil"}],"args_string":"(name : String, user_id : String, description : String | Nil = nil, scopes : Array(String) | Nil = nil, permissions : PlaceOS::Model::UserJWT::Permissions | Nil = nil)","args_html":"(name : String, user_id : String, description : String | Nil = nil, scopes : Array(String) | Nil = nil, permissions : PlaceOS::Model::UserJWT::Permissions | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":15,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"user_id","external_name":"user_id","restriction":"String"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"Array(String) | ::Nil"},{"name":"permissions","default_value":"nil","external_name":"permissions","restriction":"::PlaceOS::Model::UserJWT::Permissions | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: API::Models::APIKey)"}},{"html_id":"inspect_jwt-instance-method","name":"inspect_jwt","doc":"Get a clear text version of the JWT token","summary":"

Get a clear text version of the JWT token

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":38,"url":null},"def":{"name":"inspect_jwt","visibility":"Public","body":"get(\"#{base}/inspect\", as: ::PlaceOS::Model::UserJWT)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,authority_id:String|Nil=nil)-instance-method","name":"search","doc":"List or search for zones.\n\nResults maybe filtered by specifying a query - *q* - to search across zone\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* zones will be returned, with a paging based on *offset*.\n\nResults my also also be limited to those associated with specific *tags*.","summary":"

List or search for zones.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":63,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::APIKey))"}},{"html_id":"update(id:String,name:String|Nil=nil,user_id:String|Nil=nil,description:String|Nil=nil,scopes:Array(String)|Nil=nil,permissions:PlaceOS::Model::UserJWT::Permissions|Nil=nil)-instance-method","name":"update","doc":"Updates zone attributes or configuration.","summary":"

Updates zone attributes or configuration.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"user_id","default_value":"nil","external_name":"user_id","restriction":"String | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"Array(String) | ::Nil"},{"name":"permissions","default_value":"nil","external_name":"permissions","restriction":"::PlaceOS::Model::UserJWT::Permissions | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, user_id : String | Nil = nil, description : String | Nil = nil, scopes : Array(String) | Nil = nil, permissions : PlaceOS::Model::UserJWT::Permissions | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, user_id : String | Nil = nil, description : String | Nil = nil, scopes : Array(String) | Nil = nil, permissions : PlaceOS::Model::UserJWT::Permissions | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/api_keys.cr","line_number":26,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"user_id","default_value":"nil","external_name":"user_id","restriction":"String | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"Array(String) | ::Nil"},{"name":"permissions","default_value":"nil","external_name":"permissions","restriction":"::PlaceOS::Model::UserJWT::Permissions | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: API::Models::APIKey)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/AssetInstances","path":"PlaceOS/Client/APIWrapper/AssetInstances.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AssetInstances","name":"AssetInstances","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/asset_instances.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/asset_instances.cr","line_number":9,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,usage_start:Time,usage_end:Time)-instance-method","name":"create","doc":"Creates a new asset instance.","summary":"

Creates a new asset instance.

","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"usage_start","external_name":"usage_start","restriction":"Time"},{"name":"usage_end","external_name":"usage_end","restriction":"Time"}],"args_string":"(name : String, usage_start : Time, usage_end : Time)","args_html":"(name : String, usage_start : Time, usage_end : Time)","location":{"filename":"src/placeos/api_wrapper/asset_instances.cr","line_number":15,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"usage_start","external_name":"usage_start","restriction":"Time"},{"name":"usage_end","external_name":"usage_end","restriction":"Time"}],"visibility":"Public","body":"post(base, body: from_args, as: API::Models::AssetInstance)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0)-instance-method","name":"search","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0)","location":{"filename":"src/placeos/api_wrapper/asset_instances.cr","line_number":55,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::AssetInstance))"}},{"html_id":"update(id:String,name:String|Nil=nil,purchase_date:Time|Nil=nil,identifier:String|Nil=nil,purchase_price:Int32|Nil=nil)-instance-method","name":"update","doc":"Updates asset instance attributes or configuration.","summary":"

Updates asset instance attributes or configuration.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"purchase_date","default_value":"nil","external_name":"purchase_date","restriction":"Time | ::Nil"},{"name":"identifier","default_value":"nil","external_name":"identifier","restriction":"String | ::Nil"},{"name":"purchase_price","default_value":"nil","external_name":"purchase_price","restriction":"Int32 | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, purchase_date : Time | Nil = nil, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, purchase_date : Time | Nil = nil, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/asset_instances.cr","line_number":24,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"purchase_date","default_value":"nil","external_name":"purchase_date","restriction":"Time | ::Nil"},{"name":"identifier","default_value":"nil","external_name":"identifier","restriction":"String | ::Nil"},{"name":"purchase_price","default_value":"nil","external_name":"purchase_price","restriction":"Int32 | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: API::Models::AssetInstance)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Assets","path":"PlaceOS/Client/APIWrapper/Assets.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Assets","name":"Assets","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/assets.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"asset_instances(id:String)-instance-method","name":"asset_instances","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/assets.cr","line_number":35,"url":null},"def":{"name":"asset_instances","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"get(\"#{base}/#{id}/asset_instances\", as: Array(API::Models::AssetInstance))"}},{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/assets.cr","line_number":9,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,purchase_date:Time,identifier:String|Nil=nil,purchase_price:Int32|Nil=nil)-instance-method","name":"create","doc":"Creates a new asset.","summary":"

Creates a new asset.

","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"purchase_date","external_name":"purchase_date","restriction":"Time"},{"name":"identifier","default_value":"nil","external_name":"identifier","restriction":"String | ::Nil"},{"name":"purchase_price","default_value":"nil","external_name":"purchase_price","restriction":"Int32 | ::Nil"}],"args_string":"(name : String, purchase_date : Time, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil)","args_html":"(name : String, purchase_date : Time, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/assets.cr","line_number":15,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"purchase_date","external_name":"purchase_date","restriction":"Time"},{"name":"identifier","default_value":"nil","external_name":"identifier","restriction":"String | ::Nil"},{"name":"purchase_price","default_value":"nil","external_name":"purchase_price","restriction":"Int32 | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: API::Models::Asset)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,parent:String|Nil=nil)-instance-method","name":"search","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"parent","default_value":"nil","external_name":"parent","restriction":"String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, parent : String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, parent : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/assets.cr","line_number":60,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"parent","default_value":"nil","external_name":"parent","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::Asset))"}},{"html_id":"update(id:String,name:String|Nil=nil,purchase_date:Time|Nil=nil,identifier:String|Nil=nil,purchase_price:Int32|Nil=nil)-instance-method","name":"update","doc":"Updates asset attributes or configuration.","summary":"

Updates asset attributes or configuration.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"purchase_date","default_value":"nil","external_name":"purchase_date","restriction":"Time | ::Nil"},{"name":"identifier","default_value":"nil","external_name":"identifier","restriction":"String | ::Nil"},{"name":"purchase_price","default_value":"nil","external_name":"purchase_price","restriction":"Int32 | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, purchase_date : Time | Nil = nil, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, purchase_date : Time | Nil = nil, identifier : String | Nil = nil, purchase_price : Int32 | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/assets.cr","line_number":25,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"purchase_date","default_value":"nil","external_name":"purchase_date","restriction":"Time | ::Nil"},{"name":"identifier","default_value":"nil","external_name":"identifier","restriction":"String | ::Nil"},{"name":"purchase_price","default_value":"nil","external_name":"purchase_price","restriction":"Int32 | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: API::Models::Asset)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","path":"PlaceOS/Client/APIWrapper/AuthBase.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase(Model)","name":"AuthBase","abstract":true,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/auths/base.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"subclasses":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Ldap","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Ldap","name":"Ldap"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/OAuth","kind":"class","full_name":"PlaceOS::Client::APIWrapper::OAuth","name":"OAuth"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Saml","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Saml","name":"Saml"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/endpoint.cr","line_number":11,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = AuthBase(Model).allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"create(**args):Model-instance-method","name":"create","abstract":false,"location":{"filename":"src/placeos/api_wrapper/auths/base.cr","line_number":38,"url":null},"def":{"name":"create","double_splat":{"name":"args","external_name":"args","restriction":""},"return_type":"Model","visibility":"Public","body":"post(base, body: from_args, as: Model)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,authority_id:String|Nil=nil)-instance-method","name":"search","doc":"List or search.\n\nResults maybe filtered by specifying a query - *q* - to search across\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* documents will be returned, with a paging based on *offset*.","summary":"

List or search.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/base.cr","line_number":25,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(Model))"}},{"html_id":"update(**args)-instance-method","name":"update","abstract":false,"location":{"filename":"src/placeos/api_wrapper/auths/base.cr","line_number":34,"url":null},"def":{"name":"update","double_splat":{"name":"args","external_name":"args","restriction":""},"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: Model)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Authority","path":"PlaceOS/Client/APIWrapper/Authority.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Authority","name":"Authority","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/authority.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/authority.cr","line_number":5,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"fetch-instance-method","name":"fetch","doc":"Gets the authority metadata for the attached instance.","summary":"

Gets the authority metadata for the attached instance.

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/authority.cr","line_number":8,"url":null},"def":{"name":"fetch","visibility":"Public","body":"get(base, as: API::Models::Authority)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Cluster","path":"PlaceOS/Client/APIWrapper/Cluster.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Cluster","name":"Cluster","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/cluster.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/cluster.cr","line_number":5,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Domains","path":"PlaceOS/Client/APIWrapper/Domains.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Domains","name":"Domains","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/domains.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/domains.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Drivers","path":"PlaceOS/Client/APIWrapper/Drivers.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Drivers","name":"Drivers","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/drivers.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/drivers.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,role:Role,commit:String,file_name:String,module_name:String,repository_id:String,default_uri:String|Nil=nil,default_port:Int32|Nil=nil,description:String|Nil=nil,ignore_connected:Bool|Nil=nil)-instance-method","name":"create","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"role","external_name":"role","restriction":"Role"},{"name":"commit","external_name":"commit","restriction":"String"},{"name":"file_name","external_name":"file_name","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"repository_id","external_name":"repository_id","restriction":"String"},{"name":"default_uri","default_value":"nil","external_name":"default_uri","restriction":"String | ::Nil"},{"name":"default_port","default_value":"nil","external_name":"default_port","restriction":"Int32 | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"}],"args_string":"(name : String, role : Role, commit : String, file_name : String, module_name : String, repository_id : String, default_uri : String | Nil = nil, default_port : Int32 | Nil = nil, description : String | Nil = nil, ignore_connected : Bool | Nil = nil)","args_html":"(name : String, role : Role, commit : String, file_name : String, module_name : String, repository_id : String, default_uri : String | Nil = nil, default_port : Int32 | Nil = nil, description : String | Nil = nil, ignore_connected : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/drivers.cr","line_number":30,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"role","external_name":"role","restriction":"Role"},{"name":"commit","external_name":"commit","restriction":"String"},{"name":"file_name","external_name":"file_name","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"repository_id","external_name":"repository_id","restriction":"String"},{"name":"default_uri","default_value":"nil","external_name":"default_uri","restriction":"String | ::Nil"},{"name":"default_port","default_value":"nil","external_name":"default_port","restriction":"Int32 | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: Driver)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0)-instance-method","name":"search","doc":"List or search for drivers.\n\nResults maybe filtered by specifying a query - *q* - to search across driver\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* drivers will be returned, with a paging based on *offset*.","summary":"

List or search for drivers.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0)","location":{"filename":"src/placeos/api_wrapper/drivers.cr","line_number":26,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(Driver))"}},{"html_id":"update(id:String,name:String|Nil=nil,role:Role|Nil=nil,commit:String|Nil=nil,file_name:String|Nil=nil,module_name:String|Nil=nil,default_uri:String|Nil=nil,default_port:Int32|Nil=nil,description:String|Nil=nil,ignore_connected:Bool|Nil=nil)-instance-method","name":"update","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"role","default_value":"nil","external_name":"role","restriction":"Role | ::Nil"},{"name":"commit","default_value":"nil","external_name":"commit","restriction":"String | ::Nil"},{"name":"file_name","default_value":"nil","external_name":"file_name","restriction":"String | ::Nil"},{"name":"module_name","default_value":"nil","external_name":"module_name","restriction":"String | ::Nil"},{"name":"default_uri","default_value":"nil","external_name":"default_uri","restriction":"String | ::Nil"},{"name":"default_port","default_value":"nil","external_name":"default_port","restriction":"Int32 | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, role : Role | Nil = nil, commit : String | Nil = nil, file_name : String | Nil = nil, module_name : String | Nil = nil, default_uri : String | Nil = nil, default_port : Int32 | Nil = nil, description : String | Nil = nil, ignore_connected : Bool | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, role : Role | Nil = nil, commit : String | Nil = nil, file_name : String | Nil = nil, module_name : String | Nil = nil, default_uri : String | Nil = nil, default_port : Int32 | Nil = nil, description : String | Nil = nil, ignore_connected : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/drivers.cr","line_number":45,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"role","default_value":"nil","external_name":"role","restriction":"Role | ::Nil"},{"name":"commit","default_value":"nil","external_name":"commit","restriction":"String | ::Nil"},{"name":"file_name","default_value":"nil","external_name":"file_name","restriction":"String | ::Nil"},{"name":"module_name","default_value":"nil","external_name":"module_name","restriction":"String | ::Nil"},{"name":"default_uri","default_value":"nil","external_name":"default_uri","restriction":"String | ::Nil"},{"name":"default_port","default_value":"nil","external_name":"default_port","restriction":"Int32 | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: Driver)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Ldap","path":"PlaceOS/Client/APIWrapper/Ldap.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Ldap","name":"Ldap","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase","name":"AuthBase"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase","name":"AuthBase"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/auths/ldap.cr","line_number":7,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/endpoint.cr","line_number":11,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/auths/ldap.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,authority_id:String,host:String,base:String,port:Int32|Nil=nil,auth_method:String|Nil=nil,uid:String|Nil=nil,bind_dn:String|Nil=nil,password:String|Nil=nil,filter:String|Nil=nil)-instance-method","name":"create","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"authority_id","external_name":"authority_id","restriction":"String"},{"name":"host","external_name":"host","restriction":"String"},{"name":"base","external_name":"base","restriction":"String"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int32 | ::Nil"},{"name":"auth_method","default_value":"nil","external_name":"auth_method","restriction":"String | ::Nil"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"bind_dn","default_value":"nil","external_name":"bind_dn","restriction":"String | ::Nil"},{"name":"password","default_value":"nil","external_name":"password","restriction":"String | ::Nil"},{"name":"filter","default_value":"nil","external_name":"filter","restriction":"String | ::Nil"}],"args_string":"(name : String, authority_id : String, host : String, base : String, port : Int32 | Nil = nil, auth_method : String | Nil = nil, uid : String | Nil = nil, bind_dn : String | Nil = nil, password : String | Nil = nil, filter : String | Nil = nil)","args_html":"(name : String, authority_id : String, host : String, base : String, port : Int32 | Nil = nil, auth_method : String | Nil = nil, uid : String | Nil = nil, bind_dn : String | Nil = nil, password : String | Nil = nil, filter : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/ldap.cr","line_number":10,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"authority_id","external_name":"authority_id","restriction":"String"},{"name":"host","external_name":"host","restriction":"String"},{"name":"base","external_name":"base","restriction":"String"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int32 | ::Nil"},{"name":"auth_method","default_value":"nil","external_name":"auth_method","restriction":"String | ::Nil"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"bind_dn","default_value":"nil","external_name":"bind_dn","restriction":"String | ::Nil"},{"name":"password","default_value":"nil","external_name":"password","restriction":"String | ::Nil"},{"name":"filter","default_value":"nil","external_name":"filter","restriction":"String | ::Nil"}],"visibility":"Public","body":"super(**args)"}},{"html_id":"update(id:String,name:String|Nil=nil,authority_id:String|Nil=nil,port:Int32|Nil=nil,auth_method:String|Nil=nil,uid:String|Nil=nil,host:String|Nil=nil,base:String|Nil=nil,bind_dn:String|Nil=nil,password:String|Nil=nil,filter:String|Nil=nil)-instance-method","name":"update","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int32 | ::Nil"},{"name":"auth_method","default_value":"nil","external_name":"auth_method","restriction":"String | ::Nil"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"host","default_value":"nil","external_name":"host","restriction":"String | ::Nil"},{"name":"base","default_value":"nil","external_name":"base","restriction":"String | ::Nil"},{"name":"bind_dn","default_value":"nil","external_name":"bind_dn","restriction":"String | ::Nil"},{"name":"password","default_value":"nil","external_name":"password","restriction":"String | ::Nil"},{"name":"filter","default_value":"nil","external_name":"filter","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, port : Int32 | Nil = nil, auth_method : String | Nil = nil, uid : String | Nil = nil, host : String | Nil = nil, base : String | Nil = nil, bind_dn : String | Nil = nil, password : String | Nil = nil, filter : String | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, port : Int32 | Nil = nil, auth_method : String | Nil = nil, uid : String | Nil = nil, host : String | Nil = nil, base : String | Nil = nil, bind_dn : String | Nil = nil, password : String | Nil = nil, filter : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/ldap.cr","line_number":25,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int32 | ::Nil"},{"name":"auth_method","default_value":"nil","external_name":"auth_method","restriction":"String | ::Nil"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"host","default_value":"nil","external_name":"host","restriction":"String | ::Nil"},{"name":"base","default_value":"nil","external_name":"base","restriction":"String | ::Nil"},{"name":"bind_dn","default_value":"nil","external_name":"bind_dn","restriction":"String | ::Nil"},{"name":"password","default_value":"nil","external_name":"password","restriction":"String | ::Nil"},{"name":"filter","default_value":"nil","external_name":"filter","restriction":"String | ::Nil"}],"visibility":"Public","body":"super(**args)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Metadata","path":"PlaceOS/Client/APIWrapper/Metadata.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Metadata","name":"Metadata","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":6,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"children(id:String,name:String|Nil=nil)-instance-method","name":"children","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil)","args_html":"(id : String, name : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":12,"url":null},"def":{"name":"children","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(\"#{base}/#{id}/children\", params: from_args, as: Array(NamedTuple(zone: API::Models::Zone, metadata: Hash(String, API::Models::Metadata))))"}},{"html_id":"destroy(id:String,name:String)-instance-method","name":"destroy","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","external_name":"name","restriction":"String"}],"args_string":"(id : String, name : String)","args_html":"(id : String, name : String)","location":{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":38,"url":null},"def":{"name":"destroy","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","external_name":"name","restriction":"String"}],"visibility":"Public","body":"delete(\"#{base}/#{id}\", params: from_args)\nnil\n"}},{"html_id":"fetch(id:String,name:String|Nil=nil)-instance-method","name":"fetch","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil)","args_html":"(id : String, name : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":8,"url":null},"def":{"name":"fetch","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(\"#{base}/#{id}\", params: from_args, as: Hash(String, API::Models::Metadata))"}},{"html_id":"merge(id:String,name:String,details:JSON::Any|Hash|NamedTuple|Array,description:String|Nil=nil)-instance-method","name":"merge","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","external_name":"name","restriction":"String"},{"name":"details","external_name":"details","restriction":"JSON::Any | Hash | NamedTuple | Array"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String, details : JSON::Any | Hash | NamedTuple | Array, description : String | Nil = nil)","args_html":"(id : String, name : String, details : JSON::Any | Hash | NamedTuple | Array, description : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":27,"url":null},"def":{"name":"merge","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","external_name":"name","restriction":"String"},{"name":"details","external_name":"details","restriction":"JSON::Any | Hash | NamedTuple | Array"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"}],"visibility":"Public","body":"params = HTTP::Params {\"name\" => name}\nbody = {name: name, description: description, details: details, parent_id: id}\npatch(\"#{base}/#{id}?#{params}\", body: body, as: API::Models::Metadata)\n"}},{"html_id":"update(id:String,name:String,details:JSON::Any|Hash|NamedTuple|Array,description:String|Nil=nil)-instance-method","name":"update","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","external_name":"name","restriction":"String"},{"name":"details","external_name":"details","restriction":"JSON::Any | Hash | NamedTuple | Array"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String, details : JSON::Any | Hash | NamedTuple | Array, description : String | Nil = nil)","args_html":"(id : String, name : String, details : JSON::Any | Hash | NamedTuple | Array, description : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/metadata.cr","line_number":16,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","external_name":"name","restriction":"String"},{"name":"details","external_name":"details","restriction":"JSON::Any | Hash | NamedTuple | Array"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"}],"visibility":"Public","body":"params = HTTP::Params {\"name\" => name}\nbody = {name: name, description: description, details: details, parent_id: id}\nput(\"#{base}/#{id}?#{params}\", body: body, as: API::Models::Metadata)\n"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Modules","path":"PlaceOS/Client/APIWrapper/Modules.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Modules","name":"Modules","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/modules.cr","line_number":7,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":11,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(driver_id:String,control_system_id:String|Nil=nil,ip:String|Nil=nil,udp:Bool|Nil=nil,port:Int|Nil=nil,makebreak:Bool|Nil=nil,uri:String|Nil=nil,custom_name:String|Nil=nil,settings:Settings|Nil=nil,notes:String|Nil=nil,ignore_connected:Bool|Nil=nil,ignore_startstop:Bool|Nil=nil)-instance-method","name":"create","doc":"Creates a new module.","summary":"

Creates a new module.

","abstract":false,"args":[{"name":"driver_id","external_name":"driver_id","restriction":"String"},{"name":"control_system_id","default_value":"nil","external_name":"control_system_id","restriction":"String | ::Nil"},{"name":"ip","default_value":"nil","external_name":"ip","restriction":"String | ::Nil"},{"name":"udp","default_value":"nil","external_name":"udp","restriction":"Bool | ::Nil"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int | ::Nil"},{"name":"makebreak","default_value":"nil","external_name":"makebreak","restriction":"Bool | ::Nil"},{"name":"uri","default_value":"nil","external_name":"uri","restriction":"String | ::Nil"},{"name":"custom_name","default_value":"nil","external_name":"custom_name","restriction":"String | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"notes","default_value":"nil","external_name":"notes","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"},{"name":"ignore_startstop","default_value":"nil","external_name":"ignore_startstop","restriction":"Bool | ::Nil"}],"args_string":"(driver_id : String, control_system_id : String | Nil = nil, ip : String | Nil = nil, udp : Bool | Nil = nil, port : Int | Nil = nil, makebreak : Bool | Nil = nil, uri : String | Nil = nil, custom_name : String | Nil = nil, settings : Settings | Nil = nil, notes : String | Nil = nil, ignore_connected : Bool | Nil = nil, ignore_startstop : Bool | Nil = nil)","args_html":"(driver_id : String, control_system_id : String | Nil = nil, ip : String | Nil = nil, udp : Bool | Nil = nil, port : Int | Nil = nil, makebreak : Bool | Nil = nil, uri : String | Nil = nil, custom_name : String | Nil = nil, settings : Settings | Nil = nil, notes : String | Nil = nil, ignore_connected : Bool | Nil = nil, ignore_startstop : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":78,"url":null},"def":{"name":"create","args":[{"name":"driver_id","external_name":"driver_id","restriction":"String"},{"name":"control_system_id","default_value":"nil","external_name":"control_system_id","restriction":"String | ::Nil"},{"name":"ip","default_value":"nil","external_name":"ip","restriction":"String | ::Nil"},{"name":"udp","default_value":"nil","external_name":"udp","restriction":"Bool | ::Nil"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int | ::Nil"},{"name":"makebreak","default_value":"nil","external_name":"makebreak","restriction":"Bool | ::Nil"},{"name":"uri","default_value":"nil","external_name":"uri","restriction":"String | ::Nil"},{"name":"custom_name","default_value":"nil","external_name":"custom_name","restriction":"String | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"notes","default_value":"nil","external_name":"notes","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"},{"name":"ignore_startstop","default_value":"nil","external_name":"ignore_startstop","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: API::Models::Module)"}},{"html_id":"ping(id:String)-instance-method","name":"ping","doc":"Performs a connectivity check with the associated device or service.","summary":"

Performs a connectivity check with the associated device or service.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":29,"url":null},"def":{"name":"ping","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"post(\"#{base}/#{id}/ping\", as: API::Models::Ping)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,control_system_id:String|Nil=nil,driver_id:String|Nil=nil)-instance-method","name":"search","doc":"List or search for modules.\n\nResults maybe filtered by specifying a query - *q* - to search across module\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* systems will be returned, with a paging based on *offset*.\n\nResults my also also be limited to those associated with a specific\n*system_id*, that are instances of a *driver_id*, or any combination of\nthese.","summary":"

List or search for modules.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"control_system_id","default_value":"nil","external_name":"control_system_id","restriction":"String | ::Nil"},{"name":"driver_id","default_value":"nil","external_name":"driver_id","restriction":"String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, control_system_id : String | Nil = nil, driver_id : String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, control_system_id : String | Nil = nil, driver_id : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":64,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"control_system_id","default_value":"nil","external_name":"control_system_id","restriction":"String | ::Nil"},{"name":"driver_id","default_value":"nil","external_name":"driver_id","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::Module))"}},{"html_id":"start(id:String)-instance-method","name":"start","doc":"Starts a module.","summary":"

Starts a module.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":17,"url":null},"def":{"name":"start","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"post(\"#{base}/#{id}/start\")\nnil\n"}},{"html_id":"state(id:String,lookup:String|Nil=nil)-instance-method","name":"state","doc":"Queries the state exposed by a module.","summary":"

Queries the state exposed by a module.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"lookup","default_value":"nil","external_name":"lookup","restriction":"String | ::Nil"}],"args_string":"(id : String, lookup : String | Nil = nil)","args_html":"(id : String, lookup : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":34,"url":null},"def":{"name":"state","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"lookup","default_value":"nil","external_name":"lookup","restriction":"String | ::Nil"}],"visibility":"Public","body":"path = \"#{base}/#{id}/state\"\nif lookup\n path = path + \"/#{lookup}\"\nend\nget(path)\n"}},{"html_id":"stop(id:String)-instance-method","name":"stop","doc":"Stops a module.","summary":"

Stops a module.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":23,"url":null},"def":{"name":"stop","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"post(\"#{base}/#{id}/stop\")\nnil\n"}},{"html_id":"update(id:String,control_system_id:String|Nil=nil,ip:String|Nil=nil,udp:Bool|Nil=nil,port:Int|Nil=nil,makebreak:Bool|Nil=nil,uri:String|Nil=nil,custom_name:String|Nil=nil,settings:Settings|Nil=nil,notes:String|Nil=nil,ignore_connected:Bool|Nil=nil,ignore_startstop:Bool|Nil=nil)-instance-method","name":"update","doc":"Updates module attributes or configuration.","summary":"

Updates module attributes or configuration.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"control_system_id","default_value":"nil","external_name":"control_system_id","restriction":"String | ::Nil"},{"name":"ip","default_value":"nil","external_name":"ip","restriction":"String | ::Nil"},{"name":"udp","default_value":"nil","external_name":"udp","restriction":"Bool | ::Nil"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int | ::Nil"},{"name":"makebreak","default_value":"nil","external_name":"makebreak","restriction":"Bool | ::Nil"},{"name":"uri","default_value":"nil","external_name":"uri","restriction":"String | ::Nil"},{"name":"custom_name","default_value":"nil","external_name":"custom_name","restriction":"String | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"notes","default_value":"nil","external_name":"notes","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"},{"name":"ignore_startstop","default_value":"nil","external_name":"ignore_startstop","restriction":"Bool | ::Nil"}],"args_string":"(id : String, control_system_id : String | Nil = nil, ip : String | Nil = nil, udp : Bool | Nil = nil, port : Int | Nil = nil, makebreak : Bool | Nil = nil, uri : String | Nil = nil, custom_name : String | Nil = nil, settings : Settings | Nil = nil, notes : String | Nil = nil, ignore_connected : Bool | Nil = nil, ignore_startstop : Bool | Nil = nil)","args_html":"(id : String, control_system_id : String | Nil = nil, ip : String | Nil = nil, udp : Bool | Nil = nil, port : Int | Nil = nil, makebreak : Bool | Nil = nil, uri : String | Nil = nil, custom_name : String | Nil = nil, settings : Settings | Nil = nil, notes : String | Nil = nil, ignore_connected : Bool | Nil = nil, ignore_startstop : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/modules.cr","line_number":96,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"control_system_id","default_value":"nil","external_name":"control_system_id","restriction":"String | ::Nil"},{"name":"ip","default_value":"nil","external_name":"ip","restriction":"String | ::Nil"},{"name":"udp","default_value":"nil","external_name":"udp","restriction":"Bool | ::Nil"},{"name":"port","default_value":"nil","external_name":"port","restriction":"Int | ::Nil"},{"name":"makebreak","default_value":"nil","external_name":"makebreak","restriction":"Bool | ::Nil"},{"name":"uri","default_value":"nil","external_name":"uri","restriction":"String | ::Nil"},{"name":"custom_name","default_value":"nil","external_name":"custom_name","restriction":"String | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"notes","default_value":"nil","external_name":"notes","restriction":"String | ::Nil"},{"name":"ignore_connected","default_value":"nil","external_name":"ignore_connected","restriction":"Bool | ::Nil"},{"name":"ignore_startstop","default_value":"nil","external_name":"ignore_startstop","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: API::Models::Module)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/OAuth","path":"PlaceOS/Client/APIWrapper/OAuth.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::OAuth","name":"OAuth","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase","name":"AuthBase"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase","name":"AuthBase"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/auths/oauth.cr","line_number":7,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/endpoint.cr","line_number":11,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/auths/oauth.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,authority_id:String,client_id:String|Nil=nil,client_secret:String|Nil=nil,info_mappings:Hash(String,String)|Nil=nil,site:String|Nil=nil,authorize_url:String|Nil=nil,token_method:String|Nil=nil,auth_scheme:String|Nil=nil,token_url:String|Nil=nil,scope:String|Nil=nil,raw_info_url:String|Nil=nil)-instance-method","name":"create","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"authority_id","external_name":"authority_id","restriction":"String"},{"name":"client_id","default_value":"nil","external_name":"client_id","restriction":"String | ::Nil"},{"name":"client_secret","default_value":"nil","external_name":"client_secret","restriction":"String | ::Nil"},{"name":"info_mappings","default_value":"nil","external_name":"info_mappings","restriction":"Hash(String, String) | ::Nil"},{"name":"site","default_value":"nil","external_name":"site","restriction":"String | ::Nil"},{"name":"authorize_url","default_value":"nil","external_name":"authorize_url","restriction":"String | ::Nil"},{"name":"token_method","default_value":"nil","external_name":"token_method","restriction":"String | ::Nil"},{"name":"auth_scheme","default_value":"nil","external_name":"auth_scheme","restriction":"String | ::Nil"},{"name":"token_url","default_value":"nil","external_name":"token_url","restriction":"String | ::Nil"},{"name":"scope","default_value":"nil","external_name":"scope","restriction":"String | ::Nil"},{"name":"raw_info_url","default_value":"nil","external_name":"raw_info_url","restriction":"String | ::Nil"}],"args_string":"(name : String, authority_id : String, client_id : String | Nil = nil, client_secret : String | Nil = nil, info_mappings : Hash(String, String) | Nil = nil, site : String | Nil = nil, authorize_url : String | Nil = nil, token_method : String | Nil = nil, auth_scheme : String | Nil = nil, token_url : String | Nil = nil, scope : String | Nil = nil, raw_info_url : String | Nil = nil)","args_html":"(name : String, authority_id : String, client_id : String | Nil = nil, client_secret : String | Nil = nil, info_mappings : Hash(String, String) | Nil = nil, site : String | Nil = nil, authorize_url : String | Nil = nil, token_method : String | Nil = nil, auth_scheme : String | Nil = nil, token_url : String | Nil = nil, scope : String | Nil = nil, raw_info_url : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/oauth.cr","line_number":10,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"authority_id","external_name":"authority_id","restriction":"String"},{"name":"client_id","default_value":"nil","external_name":"client_id","restriction":"String | ::Nil"},{"name":"client_secret","default_value":"nil","external_name":"client_secret","restriction":"String | ::Nil"},{"name":"info_mappings","default_value":"nil","external_name":"info_mappings","restriction":"Hash(String, String) | ::Nil"},{"name":"site","default_value":"nil","external_name":"site","restriction":"String | ::Nil"},{"name":"authorize_url","default_value":"nil","external_name":"authorize_url","restriction":"String | ::Nil"},{"name":"token_method","default_value":"nil","external_name":"token_method","restriction":"String | ::Nil"},{"name":"auth_scheme","default_value":"nil","external_name":"auth_scheme","restriction":"String | ::Nil"},{"name":"token_url","default_value":"nil","external_name":"token_url","restriction":"String | ::Nil"},{"name":"scope","default_value":"nil","external_name":"scope","restriction":"String | ::Nil"},{"name":"raw_info_url","default_value":"nil","external_name":"raw_info_url","restriction":"String | ::Nil"}],"visibility":"Public","body":"super(**args)"}},{"html_id":"update(id:String,name:String|Nil=nil,authority_id:String|Nil=nil,client_id:String|Nil=nil,client_secret:String|Nil=nil,info_mappings:Hash(String,String)|Nil=nil,site:String|Nil=nil,authorize_url:String|Nil=nil,token_method:String|Nil=nil,auth_scheme:String|Nil=nil,token_url:String|Nil=nil,scope:String|Nil=nil,raw_info_url:String|Nil=nil)-instance-method","name":"update","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"client_id","default_value":"nil","external_name":"client_id","restriction":"String | ::Nil"},{"name":"client_secret","default_value":"nil","external_name":"client_secret","restriction":"String | ::Nil"},{"name":"info_mappings","default_value":"nil","external_name":"info_mappings","restriction":"Hash(String, String) | ::Nil"},{"name":"site","default_value":"nil","external_name":"site","restriction":"String | ::Nil"},{"name":"authorize_url","default_value":"nil","external_name":"authorize_url","restriction":"String | ::Nil"},{"name":"token_method","default_value":"nil","external_name":"token_method","restriction":"String | ::Nil"},{"name":"auth_scheme","default_value":"nil","external_name":"auth_scheme","restriction":"String | ::Nil"},{"name":"token_url","default_value":"nil","external_name":"token_url","restriction":"String | ::Nil"},{"name":"scope","default_value":"nil","external_name":"scope","restriction":"String | ::Nil"},{"name":"raw_info_url","default_value":"nil","external_name":"raw_info_url","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, client_id : String | Nil = nil, client_secret : String | Nil = nil, info_mappings : Hash(String, String) | Nil = nil, site : String | Nil = nil, authorize_url : String | Nil = nil, token_method : String | Nil = nil, auth_scheme : String | Nil = nil, token_url : String | Nil = nil, scope : String | Nil = nil, raw_info_url : String | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, client_id : String | Nil = nil, client_secret : String | Nil = nil, info_mappings : Hash(String, String) | Nil = nil, site : String | Nil = nil, authorize_url : String | Nil = nil, token_method : String | Nil = nil, auth_scheme : String | Nil = nil, token_url : String | Nil = nil, scope : String | Nil = nil, raw_info_url : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/oauth.cr","line_number":27,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"client_id","default_value":"nil","external_name":"client_id","restriction":"String | ::Nil"},{"name":"client_secret","default_value":"nil","external_name":"client_secret","restriction":"String | ::Nil"},{"name":"info_mappings","default_value":"nil","external_name":"info_mappings","restriction":"Hash(String, String) | ::Nil"},{"name":"site","default_value":"nil","external_name":"site","restriction":"String | ::Nil"},{"name":"authorize_url","default_value":"nil","external_name":"authorize_url","restriction":"String | ::Nil"},{"name":"token_method","default_value":"nil","external_name":"token_method","restriction":"String | ::Nil"},{"name":"auth_scheme","default_value":"nil","external_name":"auth_scheme","restriction":"String | ::Nil"},{"name":"token_url","default_value":"nil","external_name":"token_url","restriction":"String | ::Nil"},{"name":"scope","default_value":"nil","external_name":"scope","restriction":"String | ::Nil"},{"name":"raw_info_url","default_value":"nil","external_name":"raw_info_url","restriction":"String | ::Nil"}],"visibility":"Public","body":"super(**args)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/OAuthApplications","path":"PlaceOS/Client/APIWrapper/OAuthApplications.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::OAuthApplications","name":"OAuthApplications","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/oauth_applications.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/oauth_applications.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,uid:String|Nil=nil,secret:String|Nil=nil,scopes:String|Nil=nil,owner_id:String|Nil=nil,redirect_uri:String|Nil=nil,skip_authorization:Bool|Nil=nil,confidential:Bool|Nil=nil,revoked_at:Time|Nil=nil)-instance-method","name":"create","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"secret","default_value":"nil","external_name":"secret","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"String | ::Nil"},{"name":"owner_id","default_value":"nil","external_name":"owner_id","restriction":"String | ::Nil"},{"name":"redirect_uri","default_value":"nil","external_name":"redirect_uri","restriction":"String | ::Nil"},{"name":"skip_authorization","default_value":"nil","external_name":"skip_authorization","restriction":"Bool | ::Nil"},{"name":"confidential","default_value":"nil","external_name":"confidential","restriction":"Bool | ::Nil"},{"name":"revoked_at","default_value":"nil","external_name":"revoked_at","restriction":"Time | ::Nil"}],"args_string":"(name : String, uid : String | Nil = nil, secret : String | Nil = nil, scopes : String | Nil = nil, owner_id : String | Nil = nil, redirect_uri : String | Nil = nil, skip_authorization : Bool | Nil = nil, confidential : Bool | Nil = nil, revoked_at : Time | Nil = nil)","args_html":"(name : String, uid : String | Nil = nil, secret : String | Nil = nil, scopes : String | Nil = nil, owner_id : String | Nil = nil, redirect_uri : String | Nil = nil, skip_authorization : Bool | Nil = nil, confidential : Bool | Nil = nil, revoked_at : Time | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/oauth_applications.cr","line_number":50,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"secret","default_value":"nil","external_name":"secret","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"String | ::Nil"},{"name":"owner_id","default_value":"nil","external_name":"owner_id","restriction":"String | ::Nil"},{"name":"redirect_uri","default_value":"nil","external_name":"redirect_uri","restriction":"String | ::Nil"},{"name":"skip_authorization","default_value":"nil","external_name":"skip_authorization","restriction":"Bool | ::Nil"},{"name":"confidential","default_value":"nil","external_name":"confidential","restriction":"Bool | ::Nil"},{"name":"revoked_at","default_value":"nil","external_name":"revoked_at","restriction":"Time | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: OAuthApplication)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,authority:String|Nil=nil)-instance-method","name":"search","doc":"List or search for applications.\n\nResults maybe filtered by specifying a query - *q* - to search across application\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* application will be returned, with a paging based on *offset*.","summary":"

List or search for applications.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority","default_value":"nil","external_name":"authority","restriction":"String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority : String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/oauth_applications.cr","line_number":26,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority","default_value":"nil","external_name":"authority","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(OAuthApplication))"}},{"html_id":"update(id:String,name:String|Nil=nil,uid:String|Nil=nil,secret:String|Nil=nil,scopes:String|Nil=nil,owner_id:String|Nil=nil,redirect_uri:String|Nil=nil,skip_authorization:Bool|Nil=nil,confidential:Bool|Nil=nil,revoked_at:Time|Nil=nil)-instance-method","name":"update","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"secret","default_value":"nil","external_name":"secret","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"String | ::Nil"},{"name":"owner_id","default_value":"nil","external_name":"owner_id","restriction":"String | ::Nil"},{"name":"redirect_uri","default_value":"nil","external_name":"redirect_uri","restriction":"String | ::Nil"},{"name":"skip_authorization","default_value":"nil","external_name":"skip_authorization","restriction":"Bool | ::Nil"},{"name":"confidential","default_value":"nil","external_name":"confidential","restriction":"Bool | ::Nil"},{"name":"revoked_at","default_value":"nil","external_name":"revoked_at","restriction":"Time | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, uid : String | Nil = nil, secret : String | Nil = nil, scopes : String | Nil = nil, owner_id : String | Nil = nil, redirect_uri : String | Nil = nil, skip_authorization : Bool | Nil = nil, confidential : Bool | Nil = nil, revoked_at : Time | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, uid : String | Nil = nil, secret : String | Nil = nil, scopes : String | Nil = nil, owner_id : String | Nil = nil, redirect_uri : String | Nil = nil, skip_authorization : Bool | Nil = nil, confidential : Bool | Nil = nil, revoked_at : Time | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/oauth_applications.cr","line_number":35,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"uid","default_value":"nil","external_name":"uid","restriction":"String | ::Nil"},{"name":"secret","default_value":"nil","external_name":"secret","restriction":"String | ::Nil"},{"name":"scopes","default_value":"nil","external_name":"scopes","restriction":"String | ::Nil"},{"name":"owner_id","default_value":"nil","external_name":"owner_id","restriction":"String | ::Nil"},{"name":"redirect_uri","default_value":"nil","external_name":"redirect_uri","restriction":"String | ::Nil"},{"name":"skip_authorization","default_value":"nil","external_name":"skip_authorization","restriction":"Bool | ::Nil"},{"name":"confidential","default_value":"nil","external_name":"confidential","restriction":"Bool | ::Nil"},{"name":"revoked_at","default_value":"nil","external_name":"revoked_at","restriction":"Time | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: OAuthApplication)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Repositories","path":"PlaceOS/Client/APIWrapper/Repositories.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Repositories","name":"Repositories","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/repositories.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/repositories.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Root","path":"PlaceOS/Client/APIWrapper/Root.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Root","name":"Root","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/root.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/root.cr","line_number":5,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"signal(channel:String,payload)-instance-method","name":"signal","doc":"send data to listening drivers","summary":"

send data to listening drivers

","abstract":false,"args":[{"name":"channel","external_name":"channel","restriction":"String"},{"name":"payload","external_name":"payload","restriction":""}],"args_string":"(channel : String, payload)","args_html":"(channel : String, payload)","location":{"filename":"src/placeos/api_wrapper/root.cr","line_number":8,"url":null},"def":{"name":"signal","args":[{"name":"channel","external_name":"channel","restriction":"String"},{"name":"payload","external_name":"payload","restriction":""}],"visibility":"Public","body":"post(\"#{base}/signal?channel=#{channel}\", body: payload)"}},{"html_id":"version-instance-method","name":"version","abstract":false,"location":{"filename":"src/placeos/api_wrapper/root.cr","line_number":15,"url":null},"def":{"name":"version","visibility":"Public","body":"get(\"#{base}/version\", as: API::Models::Version)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Saml","path":"PlaceOS/Client/APIWrapper/Saml.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Saml","name":"Saml","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase","name":"AuthBase"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/AuthBase","kind":"class","full_name":"PlaceOS::Client::APIWrapper::AuthBase","name":"AuthBase"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/auths/saml.cr","line_number":7,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/endpoint.cr","line_number":11,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/auths/saml.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,authority_id:String,issuer:String,idp_sso_target_url:String,name_identifier_format:String,assertion_consumer_service_url:String,request_attributes:Array(NamedTuple(name:String,name_format:String,friendly_name:String)),idp_sso_target_url_runtime_params:Hash(String,String)|Nil=nil,uid_getter:String|Nil=nil,idp_cert:String|Nil=nil,idp_cert_fingerprint:String|Nil=nil,getter_service_name:String|Nil=nil,getter_statements:Hash(String,Array(String))|Nil=nil,idp_slo_target_url:String|Nil=nil,slo_default_relay_state:String|Nil=nil)-instance-method","name":"create","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"authority_id","external_name":"authority_id","restriction":"String"},{"name":"issuer","external_name":"issuer","restriction":"String"},{"name":"idp_sso_target_url","external_name":"idp_sso_target_url","restriction":"String"},{"name":"name_identifier_format","external_name":"name_identifier_format","restriction":"String"},{"name":"assertion_consumer_service_url","external_name":"assertion_consumer_service_url","restriction":"String"},{"name":"request_attributes","external_name":"request_attributes","restriction":"Array(NamedTuple(name: String, name_format: String, friendly_name: String))"},{"name":"idp_sso_target_url_runtime_params","default_value":"nil","external_name":"idp_sso_target_url_runtime_params","restriction":"Hash(String, String) | ::Nil"},{"name":"uid_getter","default_value":"nil","external_name":"uid_getter","restriction":"String | ::Nil"},{"name":"idp_cert","default_value":"nil","external_name":"idp_cert","restriction":"String | ::Nil"},{"name":"idp_cert_fingerprint","default_value":"nil","external_name":"idp_cert_fingerprint","restriction":"String | ::Nil"},{"name":"getter_service_name","default_value":"nil","external_name":"getter_service_name","restriction":"String | ::Nil"},{"name":"getter_statements","default_value":"nil","external_name":"getter_statements","restriction":"Hash(String, Array(String)) | ::Nil"},{"name":"idp_slo_target_url","default_value":"nil","external_name":"idp_slo_target_url","restriction":"String | ::Nil"},{"name":"slo_default_relay_state","default_value":"nil","external_name":"slo_default_relay_state","restriction":"String | ::Nil"}],"args_string":"(name : String, authority_id : String, issuer : String, idp_sso_target_url : String, name_identifier_format : String, assertion_consumer_service_url : String, request_attributes : Array(NamedTuple(name: String, name_format: String, friendly_name: String)), idp_sso_target_url_runtime_params : Hash(String, String) | Nil = nil, uid_getter : String | Nil = nil, idp_cert : String | Nil = nil, idp_cert_fingerprint : String | Nil = nil, getter_service_name : String | Nil = nil, getter_statements : Hash(String, Array(String)) | Nil = nil, idp_slo_target_url : String | Nil = nil, slo_default_relay_state : String | Nil = nil)","args_html":"(name : String, authority_id : String, issuer : String, idp_sso_target_url : String, name_identifier_format : String, assertion_consumer_service_url : String, request_attributes : Array(NamedTuple(name: String, name_format: String, friendly_name: String)), idp_sso_target_url_runtime_params : Hash(String, String) | Nil = nil, uid_getter : String | Nil = nil, idp_cert : String | Nil = nil, idp_cert_fingerprint : String | Nil = nil, getter_service_name : String | Nil = nil, getter_statements : Hash(String, Array(String)) | Nil = nil, idp_slo_target_url : String | Nil = nil, slo_default_relay_state : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/saml.cr","line_number":10,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"authority_id","external_name":"authority_id","restriction":"String"},{"name":"issuer","external_name":"issuer","restriction":"String"},{"name":"idp_sso_target_url","external_name":"idp_sso_target_url","restriction":"String"},{"name":"name_identifier_format","external_name":"name_identifier_format","restriction":"String"},{"name":"assertion_consumer_service_url","external_name":"assertion_consumer_service_url","restriction":"String"},{"name":"request_attributes","external_name":"request_attributes","restriction":"Array(NamedTuple(name: String, name_format: String, friendly_name: String))"},{"name":"idp_sso_target_url_runtime_params","default_value":"nil","external_name":"idp_sso_target_url_runtime_params","restriction":"Hash(String, String) | ::Nil"},{"name":"uid_getter","default_value":"nil","external_name":"uid_getter","restriction":"String | ::Nil"},{"name":"idp_cert","default_value":"nil","external_name":"idp_cert","restriction":"String | ::Nil"},{"name":"idp_cert_fingerprint","default_value":"nil","external_name":"idp_cert_fingerprint","restriction":"String | ::Nil"},{"name":"getter_service_name","default_value":"nil","external_name":"getter_service_name","restriction":"String | ::Nil"},{"name":"getter_statements","default_value":"nil","external_name":"getter_statements","restriction":"Hash(String, Array(String)) | ::Nil"},{"name":"idp_slo_target_url","default_value":"nil","external_name":"idp_slo_target_url","restriction":"String | ::Nil"},{"name":"slo_default_relay_state","default_value":"nil","external_name":"slo_default_relay_state","restriction":"String | ::Nil"}],"visibility":"Public","body":"super(**args)"}},{"html_id":"update(id:String,name:String|Nil=nil,authority_id:String|Nil=nil,issuer:String|Nil=nil,idp_sso_target_url:String|Nil=nil,name_identifier_format:String|Nil=nil,assertion_consumer_service_url:String|Nil=nil,request_attributes:Array(NamedTuple(name:String,name_format:String,friendly_name:String))|Nil=nil,idp_sso_target_url_runtime_params:Hash(String,String)|Nil=nil,uid_getter:String|Nil=nil,idp_cert:String|Nil=nil,idp_cert_fingerprint:String|Nil=nil,getter_service_name:String|Nil=nil,getter_statements:Hash(String,Array(String))|Nil=nil,idp_slo_target_url:String|Nil=nil,slo_default_relay_state:String|Nil=nil)-instance-method","name":"update","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"issuer","default_value":"nil","external_name":"issuer","restriction":"String | ::Nil"},{"name":"idp_sso_target_url","default_value":"nil","external_name":"idp_sso_target_url","restriction":"String | ::Nil"},{"name":"name_identifier_format","default_value":"nil","external_name":"name_identifier_format","restriction":"String | ::Nil"},{"name":"assertion_consumer_service_url","default_value":"nil","external_name":"assertion_consumer_service_url","restriction":"String | ::Nil"},{"name":"request_attributes","default_value":"nil","external_name":"request_attributes","restriction":"Array(NamedTuple(name: String, name_format: String, friendly_name: String)) | ::Nil"},{"name":"idp_sso_target_url_runtime_params","default_value":"nil","external_name":"idp_sso_target_url_runtime_params","restriction":"Hash(String, String) | ::Nil"},{"name":"uid_getter","default_value":"nil","external_name":"uid_getter","restriction":"String | ::Nil"},{"name":"idp_cert","default_value":"nil","external_name":"idp_cert","restriction":"String | ::Nil"},{"name":"idp_cert_fingerprint","default_value":"nil","external_name":"idp_cert_fingerprint","restriction":"String | ::Nil"},{"name":"getter_service_name","default_value":"nil","external_name":"getter_service_name","restriction":"String | ::Nil"},{"name":"getter_statements","default_value":"nil","external_name":"getter_statements","restriction":"Hash(String, Array(String)) | ::Nil"},{"name":"idp_slo_target_url","default_value":"nil","external_name":"idp_slo_target_url","restriction":"String | ::Nil"},{"name":"slo_default_relay_state","default_value":"nil","external_name":"slo_default_relay_state","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, issuer : String | Nil = nil, idp_sso_target_url : String | Nil = nil, name_identifier_format : String | Nil = nil, assertion_consumer_service_url : String | Nil = nil, request_attributes : Array(NamedTuple(name: String, name_format: String, friendly_name: String)) | Nil = nil, idp_sso_target_url_runtime_params : Hash(String, String) | Nil = nil, uid_getter : String | Nil = nil, idp_cert : String | Nil = nil, idp_cert_fingerprint : String | Nil = nil, getter_service_name : String | Nil = nil, getter_statements : Hash(String, Array(String)) | Nil = nil, idp_slo_target_url : String | Nil = nil, slo_default_relay_state : String | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, authority_id : String | Nil = nil, issuer : String | Nil = nil, idp_sso_target_url : String | Nil = nil, name_identifier_format : String | Nil = nil, assertion_consumer_service_url : String | Nil = nil, request_attributes : Array(NamedTuple(name: String, name_format: String, friendly_name: String)) | Nil = nil, idp_sso_target_url_runtime_params : Hash(String, String) | Nil = nil, uid_getter : String | Nil = nil, idp_cert : String | Nil = nil, idp_cert_fingerprint : String | Nil = nil, getter_service_name : String | Nil = nil, getter_statements : Hash(String, Array(String)) | Nil = nil, idp_slo_target_url : String | Nil = nil, slo_default_relay_state : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/auths/saml.cr","line_number":30,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"issuer","default_value":"nil","external_name":"issuer","restriction":"String | ::Nil"},{"name":"idp_sso_target_url","default_value":"nil","external_name":"idp_sso_target_url","restriction":"String | ::Nil"},{"name":"name_identifier_format","default_value":"nil","external_name":"name_identifier_format","restriction":"String | ::Nil"},{"name":"assertion_consumer_service_url","default_value":"nil","external_name":"assertion_consumer_service_url","restriction":"String | ::Nil"},{"name":"request_attributes","default_value":"nil","external_name":"request_attributes","restriction":"Array(NamedTuple(name: String, name_format: String, friendly_name: String)) | ::Nil"},{"name":"idp_sso_target_url_runtime_params","default_value":"nil","external_name":"idp_sso_target_url_runtime_params","restriction":"Hash(String, String) | ::Nil"},{"name":"uid_getter","default_value":"nil","external_name":"uid_getter","restriction":"String | ::Nil"},{"name":"idp_cert","default_value":"nil","external_name":"idp_cert","restriction":"String | ::Nil"},{"name":"idp_cert_fingerprint","default_value":"nil","external_name":"idp_cert_fingerprint","restriction":"String | ::Nil"},{"name":"getter_service_name","default_value":"nil","external_name":"getter_service_name","restriction":"String | ::Nil"},{"name":"getter_statements","default_value":"nil","external_name":"getter_statements","restriction":"Hash(String, Array(String)) | ::Nil"},{"name":"idp_slo_target_url","default_value":"nil","external_name":"idp_slo_target_url","restriction":"String | ::Nil"},{"name":"slo_default_relay_state","default_value":"nil","external_name":"slo_default_relay_state","restriction":"String | ::Nil"}],"visibility":"Public","body":"super(**args)"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Settings","path":"PlaceOS/Client/APIWrapper/Settings.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Settings","name":"Settings","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/settings.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/settings.cr","line_number":56,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(parent_id:String,settings_string:String,encryption_level:Encryption::Level=Encryption::Level::Support)-instance-method","name":"create","doc":"Create new settings.","summary":"

Create new settings.

","abstract":false,"args":[{"name":"parent_id","external_name":"parent_id","restriction":"String"},{"name":"settings_string","external_name":"settings_string","restriction":"String"},{"name":"encryption_level","default_value":"Encryption::Level::Support","external_name":"encryption_level","restriction":"Encryption::Level"}],"args_string":"(parent_id : String, settings_string : String, encryption_level : Encryption::Level = Encryption::Level::Support)","args_html":"(parent_id : String, settings_string : String, encryption_level : Encryption::Level = Encryption::Level::Support)","location":{"filename":"src/placeos/api_wrapper/settings.cr","line_number":13,"url":null},"def":{"name":"create","args":[{"name":"parent_id","external_name":"parent_id","restriction":"String"},{"name":"settings_string","external_name":"settings_string","restriction":"String"},{"name":"encryption_level","default_value":"Encryption::Level::Support","external_name":"encryption_level","restriction":"Encryption::Level"}],"visibility":"Public","body":"YAML.parse(settings_string)\ncreate_actual(parent_id, settings_string, encryption_level.to_i)\n"}},{"html_id":"search(parent_ids:Array(String))-instance-method","name":"search","abstract":false,"args":[{"name":"parent_ids","external_name":"parent_ids","restriction":"Array(String)"}],"args_string":"(parent_ids : Array(String))","args_html":"(parent_ids : Array(String))","location":{"filename":"src/placeos/api_wrapper/settings.cr","line_number":42,"url":null},"def":{"name":"search","args":[{"name":"parent_ids","external_name":"parent_ids","restriction":"Array(String)"}],"visibility":"Public","body":"search(parent_id: parent_ids.join(\",\"))"}},{"html_id":"search(q:String|Nil=nil,limit:Int=1000,offset:Int=0,parent_id:String|Nil=nil)-instance-method","name":"search","doc":"List or search for systems.","summary":"

List or search for systems.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"1000","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 1000, offset : Int = 0, parent_id : String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 1000, offset : Int = 0, parent_id : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/settings.cr","line_number":47,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"1000","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::Settings))"}},{"html_id":"update(id:String,settings_string:String)-instance-method","name":"update","doc":"Update settings.","summary":"

Update settings.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"settings_string","external_name":"settings_string","restriction":"String"}],"args_string":"(id : String, settings_string : String)","args_html":"(id : String, settings_string : String)","location":{"filename":"src/placeos/api_wrapper/settings.cr","line_number":31,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"settings_string","external_name":"settings_string","restriction":"String"}],"visibility":"Public","body":"YAML.parse(settings_string)\nput(\"#{base}/#{id}\", body: from_args, as: API::Models::Settings)\n"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Systems","path":"PlaceOS/Client/APIWrapper/Systems.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Systems","name":"Systems","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/systems.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":163,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":7,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"count(id:String,module_name:String):Int32|Nil-instance-method","name":"count","doc":"Gets the number of *module_name* instances available in system *id*.","summary":"

Gets the number of module_name instances available in system id.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"}],"args_string":"(id : String, module_name : String) : Int32 | Nil","args_html":"(id : String, module_name : String) : Int32 | Nil","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":48,"url":null},"def":{"name":"count","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"}],"return_type":"Int32 | ::Nil","visibility":"Public","body":"(types(id))[module_name]?"}},{"html_id":"create(name:String,zones:Array(String),description:String|Nil=nil,email:String|Nil=nil,capacity:Int|Nil=nil,bookable:Bool|Nil=nil,installed_ui_devices:Int|Nil=nil,modules:Array(String)|Nil=nil,support_url:String|Nil=nil,display_name:String|Nil=nil,timezone:String|Nil=nil,code:String|Nil=nil,type:String|Nil=nil,map_id:String|Nil=nil,images:Array(String)|Nil=nil,features:Array(String)|Nil=nil,public:Bool|Nil=nil)-instance-method","name":"create","doc":"Creates a new system.\n\nSystems must be given a unique *name* within the PlaceOS instance they are\nrunning from. Additionally, a system must be a member of at least one\n*zone*. All other attributes are optional at the time of creation.","summary":"

Creates a new system.

","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"zones","external_name":"zones","restriction":"Array(String)"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"email","default_value":"nil","external_name":"email","restriction":"String | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int | ::Nil"},{"name":"bookable","default_value":"nil","external_name":"bookable","restriction":"Bool | ::Nil"},{"name":"installed_ui_devices","default_value":"nil","external_name":"installed_ui_devices","restriction":"Int | ::Nil"},{"name":"modules","default_value":"nil","external_name":"modules","restriction":"Array(String) | ::Nil"},{"name":"support_url","default_value":"nil","external_name":"support_url","restriction":"String | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"timezone","default_value":"nil","external_name":"timezone","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"images","default_value":"nil","external_name":"images","restriction":"Array(String) | ::Nil"},{"name":"features","default_value":"nil","external_name":"features","restriction":"Array(String) | ::Nil"},{"name":"public","default_value":"nil","external_name":"public","restriction":"Bool | ::Nil"}],"args_string":"(name : String, zones : Array(String), description : String | Nil = nil, email : String | Nil = nil, capacity : Int | Nil = nil, bookable : Bool | Nil = nil, installed_ui_devices : Int | Nil = nil, modules : Array(String) | Nil = nil, support_url : String | Nil = nil, display_name : String | Nil = nil, timezone : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, map_id : String | Nil = nil, images : Array(String) | Nil = nil, features : Array(String) | Nil = nil, public : Bool | Nil = nil)","args_html":"(name : String, zones : Array(String), description : String | Nil = nil, email : String | Nil = nil, capacity : Int | Nil = nil, bookable : Bool | Nil = nil, installed_ui_devices : Int | Nil = nil, modules : Array(String) | Nil = nil, support_url : String | Nil = nil, display_name : String | Nil = nil, timezone : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, map_id : String | Nil = nil, images : Array(String) | Nil = nil, features : Array(String) | Nil = nil, public : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":69,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"zones","external_name":"zones","restriction":"Array(String)"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"email","default_value":"nil","external_name":"email","restriction":"String | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int | ::Nil"},{"name":"bookable","default_value":"nil","external_name":"bookable","restriction":"Bool | ::Nil"},{"name":"installed_ui_devices","default_value":"nil","external_name":"installed_ui_devices","restriction":"Int | ::Nil"},{"name":"modules","default_value":"nil","external_name":"modules","restriction":"Array(String) | ::Nil"},{"name":"support_url","default_value":"nil","external_name":"support_url","restriction":"String | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"timezone","default_value":"nil","external_name":"timezone","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"images","default_value":"nil","external_name":"images","restriction":"Array(String) | ::Nil"},{"name":"features","default_value":"nil","external_name":"features","restriction":"Array(String) | ::Nil"},{"name":"public","default_value":"nil","external_name":"public","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: System)"}},{"html_id":"execute(id:String,module_name:String,method:String,index:Int32=1,*args:Array(JSON::Any::Type))-instance-method","name":"execute","doc":"Executes a behaviour exposed by a module within the passed system *id*.","summary":"

Executes a behaviour exposed by a module within the passed system id.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"method","external_name":"method","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int32"},{"name":"args","external_name":"args","restriction":"Array(JSON::Any::Type)"}],"args_string":"(id : String, module_name : String, method : String, index : Int32 = 1, *args : Array(JSON::Any::Type))","args_html":"(id : String, module_name : String, method : String, index : Int32 = 1, *args : Array(JSON::Any::Type))","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":25,"url":null},"def":{"name":"execute","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"method","external_name":"method","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int32"},{"name":"args","external_name":"args","restriction":"Array(JSON::Any::Type)"}],"splat_index":4,"visibility":"Public","body":"post(\"#{base}/#{id}/#{module_name}_#{index}/#{method}\", body: args)"}},{"html_id":"functions(id:String,module_name:String,index:Int=1)-instance-method","name":"functions","doc":"Queries the behaviour exposed by a module within system *id*.","summary":"

Queries the behaviour exposed by a module within system id.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int"}],"args_string":"(id : String, module_name : String, index : Int = 1)","args_html":"(id : String, module_name : String, index : Int = 1)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":43,"url":null},"def":{"name":"functions","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int"}],"visibility":"Public","body":"get(\"#{base}/#{id}/functions/#{module_name}_#{index}\", as: Hash(String, Function))"}},{"html_id":"search(q:String|Nil=nil,limit:Int=1000,offset:Int=0,zone_id:String|Nil=nil,module_id:String|Nil=nil,features:String|Nil=nil,capacity:Int32|Nil=nil,bookable:Bool|Nil=nil)-instance-method","name":"search","doc":"List or search for systems.\n\nResults maybe filtered by specifying a query - *q* - to search across system\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* systems will be returned, with a paging based on *offset*.","summary":"

List or search for systems.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"1000","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"zone_id","default_value":"nil","external_name":"zone_id","restriction":"String | ::Nil"},{"name":"module_id","default_value":"nil","external_name":"module_id","restriction":"String | ::Nil"},{"name":"features","default_value":"nil","external_name":"features","restriction":"String | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int32 | ::Nil"},{"name":"bookable","default_value":"nil","external_name":"bookable","restriction":"Bool | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 1000, offset : Int = 0, zone_id : String | Nil = nil, module_id : String | Nil = nil, features : String | Nil = nil, capacity : Int32 | Nil = nil, bookable : Bool | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 1000, offset : Int = 0, zone_id : String | Nil = nil, module_id : String | Nil = nil, features : String | Nil = nil, capacity : Int32 | Nil = nil, bookable : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":140,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"1000","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"zone_id","default_value":"nil","external_name":"zone_id","restriction":"String | ::Nil"},{"name":"module_id","default_value":"nil","external_name":"module_id","restriction":"String | ::Nil"},{"name":"features","default_value":"nil","external_name":"features","restriction":"String | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int32 | ::Nil"},{"name":"bookable","default_value":"nil","external_name":"bookable","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(System))"}},{"html_id":"settings(id:String)-instance-method","name":"settings","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":57,"url":null},"def":{"name":"settings","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"get(\"#{base}/#{id}/settings\", as: Array(Settings))"}},{"html_id":"start(id:String)-instance-method","name":"start","doc":"Start all modules within a system.","summary":"

Start all modules within a system.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":13,"url":null},"def":{"name":"start","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"post(\"#{base}/#{id}/start\")\nnil\n"}},{"html_id":"state(id:String,module_name:String,index:Int=1,lookup:String|Nil=nil)-instance-method","name":"state","doc":"Queries the state exposed by a module within the passed system *id*.","summary":"

Queries the state exposed by a module within the passed system id.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int"},{"name":"lookup","default_value":"nil","external_name":"lookup","restriction":"String | ::Nil"}],"args_string":"(id : String, module_name : String, index : Int = 1, lookup : String | Nil = nil)","args_html":"(id : String, module_name : String, index : Int = 1, lookup : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":36,"url":null},"def":{"name":"state","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int"},{"name":"lookup","default_value":"nil","external_name":"lookup","restriction":"String | ::Nil"}],"visibility":"Public","body":"path = \"#{base}/#{id}/#{module_name}_#{index}\"\nif lookup.nil?\nelse\n path = path + \"/#{lookup}\"\nend\nget(path)\n"}},{"html_id":"stop(id:String)-instance-method","name":"stop","doc":"Stops all modules within a system.","summary":"

Stops all modules within a system.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":19,"url":null},"def":{"name":"stop","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"post(\"#{base}/#{id}/stop\")\nnil\n"}},{"html_id":"types(id:String)-instance-method","name":"types","doc":"Queries the types of modules available in system *id*.","summary":"

Queries the types of modules available in system id.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"}],"args_string":"(id : String)","args_html":"(id : String)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":53,"url":null},"def":{"name":"types","args":[{"name":"id","external_name":"id","restriction":"String"}],"visibility":"Public","body":"get(\"#{base}/#{id}/types\", as: Hash(String, Int32))"}},{"html_id":"update(id:String,version:Int,name:String|Nil=nil,zones:Array(String)|Nil=nil,description:String|Nil=nil,email:String|Nil=nil,capacity:Int|Nil=nil,bookable:Bool|Nil=nil,installed_ui_devices:Int|Nil=nil,modules:Array(String)|Nil=nil,support_url:String|Nil=nil,display_name:String|Nil=nil,timezone:String|Nil=nil,code:String|Nil=nil,type:String|Nil=nil,map_id:String|Nil=nil,images:Array(String)|Nil=nil,features:Array(String)|Nil=nil,public:Bool|Nil=nil)-instance-method","name":"update","doc":"Requests a change to an existing system.\n\nIn addition to specifying the ID of the system to update, you must reference\nthe the current system metadata *version* for the update to be allowed. This\nmust match the current version attribute of the system and will be\nincrememented following a successful update.","summary":"

Requests a change to an existing system.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"version","external_name":"version","restriction":"Int"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"zones","default_value":"nil","external_name":"zones","restriction":"Array(String) | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"email","default_value":"nil","external_name":"email","restriction":"String | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int | ::Nil"},{"name":"bookable","default_value":"nil","external_name":"bookable","restriction":"Bool | ::Nil"},{"name":"installed_ui_devices","default_value":"nil","external_name":"installed_ui_devices","restriction":"Int | ::Nil"},{"name":"modules","default_value":"nil","external_name":"modules","restriction":"Array(String) | ::Nil"},{"name":"support_url","default_value":"nil","external_name":"support_url","restriction":"String | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"timezone","default_value":"nil","external_name":"timezone","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"images","default_value":"nil","external_name":"images","restriction":"Array(String) | ::Nil"},{"name":"features","default_value":"nil","external_name":"features","restriction":"Array(String) | ::Nil"},{"name":"public","default_value":"nil","external_name":"public","restriction":"Bool | ::Nil"}],"args_string":"(id : String, version : Int, name : String | Nil = nil, zones : Array(String) | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, capacity : Int | Nil = nil, bookable : Bool | Nil = nil, installed_ui_devices : Int | Nil = nil, modules : Array(String) | Nil = nil, support_url : String | Nil = nil, display_name : String | Nil = nil, timezone : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, map_id : String | Nil = nil, images : Array(String) | Nil = nil, features : Array(String) | Nil = nil, public : Bool | Nil = nil)","args_html":"(id : String, version : Int, name : String | Nil = nil, zones : Array(String) | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, capacity : Int | Nil = nil, bookable : Bool | Nil = nil, installed_ui_devices : Int | Nil = nil, modules : Array(String) | Nil = nil, support_url : String | Nil = nil, display_name : String | Nil = nil, timezone : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, map_id : String | Nil = nil, images : Array(String) | Nil = nil, features : Array(String) | Nil = nil, public : Bool | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":97,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"version","external_name":"version","restriction":"Int"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"zones","default_value":"nil","external_name":"zones","restriction":"Array(String) | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"email","default_value":"nil","external_name":"email","restriction":"String | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int | ::Nil"},{"name":"bookable","default_value":"nil","external_name":"bookable","restriction":"Bool | ::Nil"},{"name":"installed_ui_devices","default_value":"nil","external_name":"installed_ui_devices","restriction":"Int | ::Nil"},{"name":"modules","default_value":"nil","external_name":"modules","restriction":"Array(String) | ::Nil"},{"name":"support_url","default_value":"nil","external_name":"support_url","restriction":"String | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"timezone","default_value":"nil","external_name":"timezone","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"images","default_value":"nil","external_name":"images","restriction":"Array(String) | ::Nil"},{"name":"features","default_value":"nil","external_name":"features","restriction":"Array(String) | ::Nil"},{"name":"public","default_value":"nil","external_name":"public","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", params: \"version=#{version}\", body: from_args, as: System)"}},{"html_id":"with_emails(list:Array(String)|String)-instance-method","name":"with_emails","doc":"Returns systems with a specified email address(es)\n","summary":"

Returns systems with a specified email address(es)

","abstract":false,"args":[{"name":"list","external_name":"list","restriction":"Array(String) | String"}],"args_string":"(list : Array(String) | String)","args_html":"(list : Array(String) | String)","location":{"filename":"src/placeos/api_wrapper/systems.cr","line_number":155,"url":null},"def":{"name":"with_emails","args":[{"name":"list","external_name":"list","restriction":"Array(String) | String"}],"visibility":"Public","body":"query = list.is_a?(Array) ? list.join(',') : list\nget(\"#{base}/with_emails\", params: HTTP::Params {\"in\" => query}, as: Array(System))\n"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/SystemTriggers","path":"PlaceOS/Client/APIWrapper/SystemTriggers.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::SystemTriggers","name":"SystemTriggers","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/system_triggers.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"SystemTriggers are embedded beneath a systems route","summary":"

SystemTriggers are embedded beneath a systems route

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/system_triggers.cr","line_number":6,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Triggers","path":"PlaceOS/Client/APIWrapper/Triggers.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Triggers","name":"Triggers","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/triggers.cr","line_number":4,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/triggers.cr","line_number":8,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Users","path":"PlaceOS/Client/APIWrapper/Users.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Users","name":"Users","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/users.cr","line_number":7,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"doc":"TODO:\n- create\n- update","summary":"

TODO - create - update

","instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/users.cr","line_number":11,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"current-instance-method","name":"current","abstract":false,"location":{"filename":"src/placeos/api_wrapper/users.cr","line_number":13,"url":null},"def":{"name":"current","visibility":"Public","body":"get(\"#{base}/current\", as: User)"}},{"html_id":"resource_token-instance-method","name":"resource_token","abstract":false,"location":{"filename":"src/placeos/api_wrapper/users.cr","line_number":17,"url":null},"def":{"name":"resource_token","visibility":"Public","body":"post(\"#{base}/resource_token\", as: ResourceToken)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,authority_id:String|Nil=nil,include_deleted:Bool=false,include_metadata:Bool=false)-instance-method","name":"search","doc":"List or search for users.\n\nResults maybe filtered by specifying a query - *q* - to search across zone\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* zones will be returned, with a paging based on *offset*.\n\nResults my also also be limited to those associated with specific *tags*.","summary":"

List or search for users.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"include_deleted","default_value":"false","external_name":"include_deleted","restriction":"Bool"},{"name":"include_metadata","default_value":"false","external_name":"include_metadata","restriction":"Bool"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil, include_deleted : Bool = false, include_metadata : Bool = false)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil, include_deleted : Bool = false, include_metadata : Bool = false)","location":{"filename":"src/placeos/api_wrapper/users.cr","line_number":39,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"authority_id","default_value":"nil","external_name":"authority_id","restriction":"String | ::Nil"},{"name":"include_deleted","default_value":"false","external_name":"include_deleted","restriction":"Bool"},{"name":"include_metadata","default_value":"false","external_name":"include_metadata","restriction":"Bool"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::User))"}}]},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Zones","path":"PlaceOS/Client/APIWrapper/Zones.html","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Zones","name":"Zones","abstract":false,"superclass":{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},"ancestors":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint","kind":"class","full_name":"PlaceOS::Client::APIWrapper::Endpoint","name":"Endpoint"},{"html_id":"placeos/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"placeos/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/placeos/api_wrapper/zones.cr","line_number":5,"url":null}],"repository_name":"placeos","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Destroy","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Destroy","name":"Destroy"},{"html_id":"placeos/PlaceOS/Client/APIWrapper/Endpoint/Fetch","kind":"module","full_name":"PlaceOS::Client::APIWrapper::Endpoint::Fetch","name":"Fetch"}],"namespace":{"html_id":"placeos/PlaceOS/Client/APIWrapper","kind":"class","full_name":"PlaceOS::Client::APIWrapper","name":"APIWrapper"},"constructors":[{"html_id":"new(client:APIWrapper)-class-method","name":"new","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"args_string":"(client : APIWrapper)","args_html":"(client : APIWrapper)","location":{"filename":"src/placeos/api_wrapper/zones.cr","line_number":99,"url":null},"def":{"name":"new","args":[{"name":"client","external_name":"client","restriction":"APIWrapper"}],"visibility":"Public","body":"_ = allocate\n_.initialize(client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"base:String-instance-method","name":"base","doc":"The base route for the endpoint","summary":"

The base route for the endpoint

","abstract":false,"location":{"filename":"src/placeos/api_wrapper/zones.cr","line_number":9,"url":null},"def":{"name":"base","return_type":"String","visibility":"Public","body":"@base"}},{"html_id":"create(name:String,description:String|Nil=nil,tags:Array(String)|Nil=nil,settings:Settings|Nil=nil,triggers:Array(String)|Nil=nil,display_name:String|Nil=nil,location:String|Nil=nil,code:String|Nil=nil,type:String|Nil=nil,count:Int32|Nil=nil,capacity:Int32|Nil=nil,map_id:String|Nil=nil,parent_id:String|Nil=nil)-instance-method","name":"create","doc":"Creates a new zone.","summary":"

Creates a new zone.

","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"tags","default_value":"nil","external_name":"tags","restriction":"Array(String) | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"triggers","default_value":"nil","external_name":"triggers","restriction":"Array(String) | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"location","default_value":"nil","external_name":"location","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"count","default_value":"nil","external_name":"count","restriction":"Int32 | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int32 | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"}],"args_string":"(name : String, description : String | Nil = nil, tags : Array(String) | Nil = nil, settings : Settings | Nil = nil, triggers : Array(String) | Nil = nil, display_name : String | Nil = nil, location : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, count : Int32 | Nil = nil, capacity : Int32 | Nil = nil, map_id : String | Nil = nil, parent_id : String | Nil = nil)","args_html":"(name : String, description : String | Nil = nil, tags : Array(String) | Nil = nil, settings : Settings | Nil = nil, triggers : Array(String) | Nil = nil, display_name : String | Nil = nil, location : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, count : Int32 | Nil = nil, capacity : Int32 | Nil = nil, map_id : String | Nil = nil, parent_id : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/zones.cr","line_number":28,"url":null},"def":{"name":"create","args":[{"name":"name","external_name":"name","restriction":"String"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"tags","default_value":"nil","external_name":"tags","restriction":"Array(String) | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"triggers","default_value":"nil","external_name":"triggers","restriction":"Array(String) | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"location","default_value":"nil","external_name":"location","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"count","default_value":"nil","external_name":"count","restriction":"Int32 | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int32 | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"}],"visibility":"Public","body":"post(base, body: from_args, as: API::Models::Zone)"}},{"html_id":"execute(id:String,method:String,module_name:String,index:Int32=1,args=nil)-instance-method","name":"execute","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"method","external_name":"method","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int32"},{"name":"args","default_value":"nil","external_name":"args","restriction":""}],"args_string":"(id : String, method : String, module_name : String, index : Int32 = 1, args = nil)","args_html":"(id : String, method : String, module_name : String, index : Int32 = 1, args = nil)","location":{"filename":"src/placeos/api_wrapper/zones.cr","line_number":14,"url":null},"def":{"name":"execute","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"method","external_name":"method","restriction":"String"},{"name":"module_name","external_name":"module_name","restriction":"String"},{"name":"index","default_value":"1","external_name":"index","restriction":"Int32"},{"name":"args","default_value":"nil","external_name":"args","restriction":""}],"visibility":"Public","body":"post(\"#{base}/#{id}/#{module_name}_#{index}/#{method}\", body: args)"}},{"html_id":"search(q:String|Nil=nil,limit:Int=20,offset:Int=0,parent_id:String|Nil=nil,tags:Array(String)|String|Nil=nil)-instance-method","name":"search","doc":"List or search for zones.\n\nResults maybe filtered by specifying a query - *q* - to search across zone\nattributes. A small query language is supported within this:\n\nOperator | Action\n-------- | ------\n`+` | Matches both terms\n`|` | Matches either terms\n`-` | Negates a single token\n`\"` | Wraps tokens to form a phrase\n`(` `)` | Provides precedence\n`~N` | Specifies edit distance (fuzziness) after a word\n`~N` | Specifies slop amount (deviation) after a phrase\n\nUp to *limit* zones will be returned, with a paging based on *offset*.\n\nResults my also also be limited to those associated with specific *tags*.","summary":"

List or search for zones.

","abstract":false,"args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"},{"name":"tags","default_value":"nil","external_name":"tags","restriction":"Array(String) | String | ::Nil"}],"args_string":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, parent_id : String | Nil = nil, tags : Array(String) | String | Nil = nil)","args_html":"(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, parent_id : String | Nil = nil, tags : Array(String) | String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/zones.cr","line_number":87,"url":null},"def":{"name":"search","args":[{"name":"q","default_value":"nil","external_name":"q","restriction":"String | ::Nil"},{"name":"limit","default_value":"20","external_name":"limit","restriction":"Int"},{"name":"offset","default_value":"0","external_name":"offset","restriction":"Int"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"},{"name":"tags","default_value":"nil","external_name":"tags","restriction":"Array(String) | String | ::Nil"}],"visibility":"Public","body":"get(base, params: from_args, as: Array(API::Models::Zone))"}},{"html_id":"update(id:String,name:String|Nil=nil,description:String|Nil=nil,tags:Array(String)|Nil=nil,settings:Settings|Nil=nil,triggers:Array(String)|Nil=nil,display_name:String|Nil=nil,location:String|Nil=nil,code:String|Nil=nil,type:String|Nil=nil,count:Int32|Nil=nil,capacity:Int32|Nil=nil,map_id:String|Nil=nil,parent_id:String|Nil=nil)-instance-method","name":"update","doc":"Updates zone attributes or configuration.","summary":"

Updates zone attributes or configuration.

","abstract":false,"args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"tags","default_value":"nil","external_name":"tags","restriction":"Array(String) | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"triggers","default_value":"nil","external_name":"triggers","restriction":"Array(String) | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"location","default_value":"nil","external_name":"location","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"count","default_value":"nil","external_name":"count","restriction":"Int32 | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int32 | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"}],"args_string":"(id : String, name : String | Nil = nil, description : String | Nil = nil, tags : Array(String) | Nil = nil, settings : Settings | Nil = nil, triggers : Array(String) | Nil = nil, display_name : String | Nil = nil, location : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, count : Int32 | Nil = nil, capacity : Int32 | Nil = nil, map_id : String | Nil = nil, parent_id : String | Nil = nil)","args_html":"(id : String, name : String | Nil = nil, description : String | Nil = nil, tags : Array(String) | Nil = nil, settings : Settings | Nil = nil, triggers : Array(String) | Nil = nil, display_name : String | Nil = nil, location : String | Nil = nil, code : String | Nil = nil, type : String | Nil = nil, count : Int32 | Nil = nil, capacity : Int32 | Nil = nil, map_id : String | Nil = nil, parent_id : String | Nil = nil)","location":{"filename":"src/placeos/api_wrapper/zones.cr","line_number":47,"url":null},"def":{"name":"update","args":[{"name":"id","external_name":"id","restriction":"String"},{"name":"name","default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"description","default_value":"nil","external_name":"description","restriction":"String | ::Nil"},{"name":"tags","default_value":"nil","external_name":"tags","restriction":"Array(String) | ::Nil"},{"name":"settings","default_value":"nil","external_name":"settings","restriction":"Settings | ::Nil"},{"name":"triggers","default_value":"nil","external_name":"triggers","restriction":"Array(String) | ::Nil"},{"name":"display_name","default_value":"nil","external_name":"display_name","restriction":"String | ::Nil"},{"name":"location","default_value":"nil","external_name":"location","restriction":"String | ::Nil"},{"name":"code","default_value":"nil","external_name":"code","restriction":"String | ::Nil"},{"name":"type","default_value":"nil","external_name":"type","restriction":"String | ::Nil"},{"name":"count","default_value":"nil","external_name":"count","restriction":"Int32 | ::Nil"},{"name":"capacity","default_value":"nil","external_name":"capacity","restriction":"Int32 | ::Nil"},{"name":"map_id","default_value":"nil","external_name":"map_id","restriction":"String | ::Nil"},{"name":"parent_id","default_value":"nil","external_name":"parent_id","restriction":"String | ::Nil"}],"visibility":"Public","body":"put(\"#{base}/#{id}\", body: from_args, as: API::Models::Zone)"}}]}]}]}]}]}}) \ No newline at end of file