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.
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)
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)
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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/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[](https://github.com/placeos/crystal-client/releases)\n[](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":"
","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":"
","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":"
","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":"
","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":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":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":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":"
","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/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":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":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":"
","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":"
","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":"
","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":"
","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/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":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":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":"
","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":"
","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":"
","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":"
","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,"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":"
","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":"
","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":"
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":"
","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":"
","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":"
","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":"
","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":"
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":"
","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":"
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":"
","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":"
","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":"
'
+ );
+
+ 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[](https://github.com/placeos/crystal-client/releases)\n[](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":"
","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":"
","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":"
","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":"
","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":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":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":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":"
","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/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":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":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":"
","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":"
","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":"
","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":"
","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/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":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":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":"
","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":"
","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":"
","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":"
","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,"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":"
","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":"
","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":"
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":"
","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":"
","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":"
","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":"
","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":"
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":"
","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":"
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":"
","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":"
","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":"
+