lockally 0.1.0

data/docs/AddContactListMemberRequest.md

@@ -0,0 +1,18 @@
+# Lockally::AddContactListMemberRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::AddContactListMemberRequest.new(
+  contact_id: null
+)
+```
+

data/docs/AddOn.md

@@ -0,0 +1,28 @@
+# Lockally::AddOn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **display_name** | **String** |  |  |
+| **description** | **String** |  |  |
+| **price_naira** | **Integer** |  |  |
+| **pricing_model** | **String** |  |  |
+| **active** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::AddOn.new(
+  name: null,
+  display_name: null,
+  description: null,
+  price_naira: null,
+  pricing_model: null,
+  active: null
+)
+```
+

data/docs/AddOnsApi.md

@@ -0,0 +1,275 @@
+# Lockally::AddOnsApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**activate_add_on**](AddOnsApi.md#activate_add_on) | **POST** /v1/add-ons/{name}/activate | Activate an add-on |
+| [**cancel_add_on**](AddOnsApi.md#cancel_add_on) | **POST** /v1/add-ons/{name}/cancel | Cancel an add-on |
+| [**get_add_on_status**](AddOnsApi.md#get_add_on_status) | **GET** /v1/add-ons/{name} | Get add-on status |
+| [**list_add_ons**](AddOnsApi.md#list_add_ons) | **GET** /v1/add-ons | List add-ons |
+
+
+## activate_add_on
+
+> <ActivateAddOn200Response> activate_add_on(name)
+
+Activate an add-on
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AddOnsApi.new
+name = 'name_example' # String | Add-on key
+
+begin
+  # Activate an add-on
+  result = api_instance.activate_add_on(name)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling AddOnsApi->activate_add_on: #{e}"
+end
+```
+
+#### Using the activate_add_on_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ActivateAddOn200Response>, Integer, Hash)> activate_add_on_with_http_info(name)
+
+```ruby
+begin
+  # Activate an add-on
+  data, status_code, headers = api_instance.activate_add_on_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ActivateAddOn200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling AddOnsApi->activate_add_on_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Add-on key |  |
+
+### Return type
+
+[**ActivateAddOn200Response**](ActivateAddOn200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## cancel_add_on
+
+> cancel_add_on(name)
+
+Cancel an add-on
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AddOnsApi.new
+name = 'name_example' # String | Add-on key
+
+begin
+  # Cancel an add-on
+  api_instance.cancel_add_on(name)
+rescue Lockally::ApiError => e
+  puts "Error when calling AddOnsApi->cancel_add_on: #{e}"
+end
+```
+
+#### Using the cancel_add_on_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> cancel_add_on_with_http_info(name)
+
+```ruby
+begin
+  # Cancel an add-on
+  data, status_code, headers = api_instance.cancel_add_on_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lockally::ApiError => e
+  puts "Error when calling AddOnsApi->cancel_add_on_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Add-on key |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## get_add_on_status
+
+> <GetAddOnStatus200Response> get_add_on_status(name)
+
+Get add-on status
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AddOnsApi.new
+name = 'name_example' # String | Add-on key
+
+begin
+  # Get add-on status
+  result = api_instance.get_add_on_status(name)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling AddOnsApi->get_add_on_status: #{e}"
+end
+```
+
+#### Using the get_add_on_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAddOnStatus200Response>, Integer, Hash)> get_add_on_status_with_http_info(name)
+
+```ruby
+begin
+  # Get add-on status
+  data, status_code, headers = api_instance.get_add_on_status_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAddOnStatus200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling AddOnsApi->get_add_on_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Add-on key |  |
+
+### Return type
+
+[**GetAddOnStatus200Response**](GetAddOnStatus200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## list_add_ons
+
+> <ListAddOns200Response> list_add_ons
+
+List add-ons
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AddOnsApi.new
+
+begin
+  # List add-ons
+  result = api_instance.list_add_ons
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling AddOnsApi->list_add_ons: #{e}"
+end
+```
+
+#### Using the list_add_ons_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListAddOns200Response>, Integer, Hash)> list_add_ons_with_http_info
+
+```ruby
+begin
+  # List add-ons
+  data, status_code, headers = api_instance.list_add_ons_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListAddOns200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling AddOnsApi->list_add_ons_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListAddOns200Response**](ListAddOns200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+

data/docs/AddSharedMemberRequest.md

@@ -0,0 +1,20 @@
+# Lockally::AddSharedMemberRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **member_email** | **String** |  |  |
+| **role** | **String** |  | [optional][default to 'member'] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::AddSharedMemberRequest.new(
+  member_email: null,
+  role: null
+)
+```
+

data/docs/Admin.md

@@ -0,0 +1,30 @@
+# Lockally::Admin
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **tenant_id** | **String** |  |  |
+| **email** | **String** |  |  |
+| **display_name** | **String** |  | [optional] |
+| **role** | **String** |  |  |
+| **last_login_at** | **Time** |  | [optional] |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::Admin.new(
+  id: null,
+  tenant_id: null,
+  email: null,
+  display_name: null,
+  role: null,
+  last_login_at: null,
+  created_at: null
+)
+```
+

data/docs/AdminApi.md

@@ -0,0 +1,205 @@
+# Lockally::AdminApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_admin_login_post**](AdminApi.md#v1_admin_login_post) | **POST** /v1/admin/login | Tenant-admin email+password login |
+| [**v1_admin_logout_post**](AdminApi.md#v1_admin_logout_post) | **POST** /v1/admin/logout | Invalidate the current admin session |
+| [**v1_admin_me_get**](AdminApi.md#v1_admin_me_get) | **GET** /v1/admin/me | Get the current admin + tenant |
+
+
+## v1_admin_login_post
+
+> <V1AdminLoginPost200Response> v1_admin_login_post(v1_admin_login_post_request)
+
+Tenant-admin email+password login
+
+Exchanges an admin's email + password for a session token. The web console at `app.lockally.com` posts this on form submission and stores the returned token in an httpOnly cookie.  **No enumeration leak.** Wrong-email and wrong-password both return the same 401 with title \"Invalid credentials\". The argon2id verify runs even on lookup miss (well, structurally — the lookup fails fast but the response shape is constant) so timing leaks are bounded.  Tokens are prefixed `adm_sess_` and valid for 7 days. Use as the `Authorization: Bearer` value on all subsequent calls. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+
+api_instance = Lockally::AdminApi.new
+v1_admin_login_post_request = Lockally::V1AdminLoginPostRequest.new({email: 'email_example', password: 'password_example'}) # V1AdminLoginPostRequest | 
+
+begin
+  # Tenant-admin email+password login
+  result = api_instance.v1_admin_login_post(v1_admin_login_post_request)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling AdminApi->v1_admin_login_post: #{e}"
+end
+```
+
+#### Using the v1_admin_login_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1AdminLoginPost200Response>, Integer, Hash)> v1_admin_login_post_with_http_info(v1_admin_login_post_request)
+
+```ruby
+begin
+  # Tenant-admin email+password login
+  data, status_code, headers = api_instance.v1_admin_login_post_with_http_info(v1_admin_login_post_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1AdminLoginPost200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling AdminApi->v1_admin_login_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **v1_admin_login_post_request** | [**V1AdminLoginPostRequest**](V1AdminLoginPostRequest.md) |  |  |
+
+### Return type
+
+[**V1AdminLoginPost200Response**](V1AdminLoginPost200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## v1_admin_logout_post
+
+> v1_admin_logout_post
+
+Invalidate the current admin session
+
+Deletes the session row from the database. Idempotent — calling logout on an already-invalid token returns 204 anyway. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AdminApi.new
+
+begin
+  # Invalidate the current admin session
+  api_instance.v1_admin_logout_post
+rescue Lockally::ApiError => e
+  puts "Error when calling AdminApi->v1_admin_logout_post: #{e}"
+end
+```
+
+#### Using the v1_admin_logout_post_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> v1_admin_logout_post_with_http_info
+
+```ruby
+begin
+  # Invalidate the current admin session
+  data, status_code, headers = api_instance.v1_admin_logout_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lockally::ApiError => e
+  puts "Error when calling AdminApi->v1_admin_logout_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## v1_admin_me_get
+
+> <V1AdminMeGet200Response> v1_admin_me_get
+
+Get the current admin + tenant
+
+Returns the admin profile + tenant for the session token presented in `Authorization: Bearer`. Used by the web console's layout load function to populate the sidebar.  Returns 403 if called with an API key (lk_live_*) bearer — admin context only exists for session tokens. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AdminApi.new
+
+begin
+  # Get the current admin + tenant
+  result = api_instance.v1_admin_me_get
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling AdminApi->v1_admin_me_get: #{e}"
+end
+```
+
+#### Using the v1_admin_me_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1AdminMeGet200Response>, Integer, Hash)> v1_admin_me_get_with_http_info
+
+```ruby
+begin
+  # Get the current admin + tenant
+  data, status_code, headers = api_instance.v1_admin_me_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1AdminMeGet200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling AdminApi->v1_admin_me_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1AdminMeGet200Response**](V1AdminMeGet200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+

data/docs/AdminFull.md

@@ -0,0 +1,36 @@
+# Lockally::AdminFull
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **tenant_id** | **String** |  |  |
+| **email** | **String** |  |  |
+| **display_name** | **String** |  | [optional] |
+| **role** | **String** |  |  |
+| **last_login_at** | **Time** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **disabled** | **Boolean** |  |  |
+| **disabled_at** | **Time** |  | [optional] |
+| **password** | **String** | Present ONLY on POST response when lockally generated the password. Shown once. | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::AdminFull.new(
+  id: null,
+  tenant_id: null,
+  email: null,
+  display_name: null,
+  role: null,
+  last_login_at: null,
+  created_at: null,
+  disabled: null,
+  disabled_at: null,
+  password: null
+)
+```
+