lockally 0.2.0 → 0.3.0

data/docs/AdminApi.md

@@ -4,14 +4,14 @@ 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 |
+| [**admin_login**](AdminApi.md#admin_login) | **POST** /v1/admin/login | Tenant-admin email+password login |
+| [**admin_logout**](AdminApi.md#admin_logout) | **POST** /v1/admin/logout | Invalidate the current admin session |
+| [**get_current_admin**](AdminApi.md#get_current_admin) | **GET** /v1/admin/me | Get the current admin + tenant |
 
 
-## v1_admin_login_post
+## admin_login
 
-> <V1AdminLoginPost200Response> v1_admin_login_post(v1_admin_login_post_request)
+> <AdminLogin200Response> admin_login(admin_login_request)
 
 Tenant-admin email+password login
 
@@ -24,32 +24,32 @@ require 'time'
 require 'lockally'
 
 api_instance = Lockally::AdminApi.new
-v1_admin_login_post_request = Lockally::V1AdminLoginPostRequest.new({email: 'email_example', password: 'password_example'}) # V1AdminLoginPostRequest | 
+admin_login_request = Lockally::AdminLoginRequest.new({email: 'email_example', password: 'password_example'}) # AdminLoginRequest | 
 
 begin
   # Tenant-admin email+password login
-  result = api_instance.v1_admin_login_post(v1_admin_login_post_request)
+  result = api_instance.admin_login(admin_login_request)
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminApi->v1_admin_login_post: #{e}"
+  puts "Error when calling AdminApi->admin_login: #{e}"
 end
 ```
 
-#### Using the v1_admin_login_post_with_http_info variant
+#### Using the admin_login_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)
+> <Array(<AdminLogin200Response>, Integer, Hash)> admin_login_with_http_info(admin_login_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)
+  data, status_code, headers = api_instance.admin_login_with_http_info(admin_login_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1AdminLoginPost200Response>
+  p data # => <AdminLogin200Response>
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminApi->v1_admin_login_post_with_http_info: #{e}"
+  puts "Error when calling AdminApi->admin_login_with_http_info: #{e}"
 end
 ```
 
@@ -57,11 +57,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **v1_admin_login_post_request** | [**V1AdminLoginPostRequest**](V1AdminLoginPostRequest.md) |  |  |
+| **admin_login_request** | [**AdminLoginRequest**](AdminLoginRequest.md) |  |  |
 
 ### Return type
 
-[**V1AdminLoginPost200Response**](V1AdminLoginPost200Response.md)
+[**AdminLogin200Response**](AdminLogin200Response.md)
 
 ### Authorization
 
@@ -73,9 +73,9 @@ No authorization required
 - **Accept**: application/json, application/problem+json
 
 
-## v1_admin_logout_post
+## admin_logout
 
-> v1_admin_logout_post
+> admin_logout
 
 Invalidate the current admin session
 
@@ -96,27 +96,27 @@ api_instance = Lockally::AdminApi.new
 
 begin
   # Invalidate the current admin session
-  api_instance.v1_admin_logout_post
+  api_instance.admin_logout
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminApi->v1_admin_logout_post: #{e}"
+  puts "Error when calling AdminApi->admin_logout: #{e}"
 end
 ```
 
-#### Using the v1_admin_logout_post_with_http_info variant
+#### Using the admin_logout_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
+> <Array(nil, Integer, Hash)> admin_logout_with_http_info
 
 ```ruby
 begin
   # Invalidate the current admin session
-  data, status_code, headers = api_instance.v1_admin_logout_post_with_http_info
+  data, status_code, headers = api_instance.admin_logout_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}"
+  puts "Error when calling AdminApi->admin_logout_with_http_info: #{e}"
 end
 ```
 
@@ -138,9 +138,9 @@ nil (empty response body)
 - **Accept**: application/problem+json
 
 
-## v1_admin_me_get
+## get_current_admin
 
-> <V1AdminMeGet200Response> v1_admin_me_get
+> <GetCurrentAdmin200Response> get_current_admin
 
 Get the current admin + tenant
 
@@ -161,28 +161,28 @@ api_instance = Lockally::AdminApi.new
 
 begin
   # Get the current admin + tenant
-  result = api_instance.v1_admin_me_get
+  result = api_instance.get_current_admin
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminApi->v1_admin_me_get: #{e}"
+  puts "Error when calling AdminApi->get_current_admin: #{e}"
 end
 ```
 
-#### Using the v1_admin_me_get_with_http_info variant
+#### Using the get_current_admin_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
+> <Array(<GetCurrentAdmin200Response>, Integer, Hash)> get_current_admin_with_http_info
 
 ```ruby
 begin
   # Get the current admin + tenant
-  data, status_code, headers = api_instance.v1_admin_me_get_with_http_info
+  data, status_code, headers = api_instance.get_current_admin_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1AdminMeGet200Response>
+  p data # => <GetCurrentAdmin200Response>
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminApi->v1_admin_me_get_with_http_info: #{e}"
+  puts "Error when calling AdminApi->get_current_admin_with_http_info: #{e}"
 end
 ```
 
@@ -192,7 +192,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**V1AdminMeGet200Response**](V1AdminMeGet200Response.md)
+[**GetCurrentAdmin200Response**](GetCurrentAdmin200Response.md)
 
 ### Authorization
 

data/docs/{V1AdminLoginPost200Response.md → AdminLogin200Response.md}

@@ -1,4 +1,4 @@
-# Lockally::V1AdminLoginPost200Response
+# Lockally::AdminLogin200Response
 
 ## Properties
 
@@ -14,7 +14,7 @@
 ```ruby
 require 'lockally'
 
-instance = Lockally::V1AdminLoginPost200Response.new(
+instance = Lockally::AdminLogin200Response.new(
   token: adm_sess_...,
   expires_at: null,
   admin: null,

data/docs/{V1AdminLoginPostRequest.md → AdminLoginRequest.md}

@@ -1,4 +1,4 @@
-# Lockally::V1AdminLoginPostRequest
+# Lockally::AdminLoginRequest
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'lockally'
 
-instance = Lockally::V1AdminLoginPostRequest.new(
+instance = Lockally::AdminLoginRequest.new(
   email: null,
   password: null
 )

data/docs/AdminsApi.md

@@ -4,17 +4,19 @@ All URIs are relative to *https://api.lockally.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**v1_admins_get**](AdminsApi.md#v1_admins_get) | **GET** /v1/admins | List tenant admins |
-| [**v1_admins_id_delete**](AdminsApi.md#v1_admins_id_delete) | **DELETE** /v1/admins/{id} | Delete an admin |
-| [**v1_admins_id_patch**](AdminsApi.md#v1_admins_id_patch) | **PATCH** /v1/admins/{id} | Update an admin |
-| [**v1_admins_post**](AdminsApi.md#v1_admins_post) | **POST** /v1/admins | Invite a new admin |
+| [**delete_admin**](AdminsApi.md#delete_admin) | **DELETE** /v1/admins/{id} | Delete an admin |
+| [**invite_admin**](AdminsApi.md#invite_admin) | **POST** /v1/admins | Invite a new admin |
+| [**list_admins**](AdminsApi.md#list_admins) | **GET** /v1/admins | List tenant admins |
+| [**update_admin**](AdminsApi.md#update_admin) | **PATCH** /v1/admins/{id} | Update an admin |
 
 
-## v1_admins_get
+## delete_admin
 
-> <V1AdminsGet200Response> v1_admins_get
+> delete_admin(id)
 
-List tenant admins
+Delete an admin
+
+Hard-delete. Cascade-drops the admin's sessions (immediate revocation). Same safety rails as PATCH disabled=true. 
 
 ### Examples
 
@@ -28,41 +30,43 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::AdminsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
 
 begin
-  # List tenant admins
-  result = api_instance.v1_admins_get
-  p result
+  # Delete an admin
+  api_instance.delete_admin(id)
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminsApi->v1_admins_get: #{e}"
+  puts "Error when calling AdminsApi->delete_admin: #{e}"
 end
 ```
 
-#### Using the v1_admins_get_with_http_info variant
+#### Using the delete_admin_with_http_info variant
 
-This returns an Array which contains the response data, status code and headers.
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(<V1AdminsGet200Response>, Integer, Hash)> v1_admins_get_with_http_info
+> <Array(nil, Integer, Hash)> delete_admin_with_http_info(id)
 
 ```ruby
 begin
-  # List tenant admins
-  data, status_code, headers = api_instance.v1_admins_get_with_http_info
+  # Delete an admin
+  data, status_code, headers = api_instance.delete_admin_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1AdminsGet200Response>
+  p data # => nil
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminsApi->v1_admins_get_with_http_info: #{e}"
+  puts "Error when calling AdminsApi->delete_admin_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-This endpoint does not need any parameter.
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
 
 ### Return type
 
-[**V1AdminsGet200Response**](V1AdminsGet200Response.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -71,16 +75,16 @@ This endpoint does not need any parameter.
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json, application/problem+json
+- **Accept**: application/problem+json
 
 
-## v1_admins_id_delete
+## invite_admin
 
-> v1_admins_id_delete(id)
+> <AdminFull> invite_admin(invite_admin_request)
 
-Delete an admin
+Invite a new admin
 
-Hard-delete. Cascade-drops the admin's sessions (immediate revocation). Same safety rails as PATCH disabled=true. 
+Creates a new tenant admin. If `password` is omitted, lockally generates a 16-char password and returns it ONCE in the response. Email is case-insensitive and unique per tenant. 
 
 ### Examples
 
@@ -94,31 +98,32 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::AdminsApi.new
-id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+invite_admin_request = Lockally::InviteAdminRequest.new({email: 'email_example'}) # InviteAdminRequest | 
 
 begin
-  # Delete an admin
-  api_instance.v1_admins_id_delete(id)
+  # Invite a new admin
+  result = api_instance.invite_admin(invite_admin_request)
+  p result
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminsApi->v1_admins_id_delete: #{e}"
+  puts "Error when calling AdminsApi->invite_admin: #{e}"
 end
 ```
 
-#### Using the v1_admins_id_delete_with_http_info variant
+#### Using the invite_admin_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> v1_admins_id_delete_with_http_info(id)
+> <Array(<AdminFull>, Integer, Hash)> invite_admin_with_http_info(invite_admin_request)
 
 ```ruby
 begin
-  # Delete an admin
-  data, status_code, headers = api_instance.v1_admins_id_delete_with_http_info(id)
+  # Invite a new admin
+  data, status_code, headers = api_instance.invite_admin_with_http_info(invite_admin_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <AdminFull>
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminsApi->v1_admins_id_delete_with_http_info: #{e}"
+  puts "Error when calling AdminsApi->invite_admin_with_http_info: #{e}"
 end
 ```
 
@@ -126,11 +131,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
+| **invite_admin_request** | [**InviteAdminRequest**](InviteAdminRequest.md) |  |  |
 
 ### Return type
 
-nil (empty response body)
+[**AdminFull**](AdminFull.md)
 
 ### Authorization
 
@@ -138,17 +143,15 @@ nil (empty response body)
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/problem+json
-
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
 
-## v1_admins_id_patch
 
-> <AdminFull> v1_admins_id_patch(id, v1_admins_id_patch_request)
+## list_admins
 
-Update an admin
+> <ListAdmins200Response> list_admins
 
-Supply at least one of `password`, `display_name`, `role`, `disabled`.  **Safety rails.** A session bearer (adm_sess_*) cannot disable itself — use another admin or an API key (which bypasses the self-rail). Disabling the last active admin returns 409 to prevent orphaning the tenant from its console. 
+List tenant admins
 
 ### Examples
 
@@ -162,46 +165,41 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::AdminsApi.new
-id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
-v1_admins_id_patch_request = Lockally::V1AdminsIdPatchRequest.new # V1AdminsIdPatchRequest | 
 
 begin
-  # Update an admin
-  result = api_instance.v1_admins_id_patch(id, v1_admins_id_patch_request)
+  # List tenant admins
+  result = api_instance.list_admins
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminsApi->v1_admins_id_patch: #{e}"
+  puts "Error when calling AdminsApi->list_admins: #{e}"
 end
 ```
 
-#### Using the v1_admins_id_patch_with_http_info variant
+#### Using the list_admins_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<AdminFull>, Integer, Hash)> v1_admins_id_patch_with_http_info(id, v1_admins_id_patch_request)
+> <Array(<ListAdmins200Response>, Integer, Hash)> list_admins_with_http_info
 
 ```ruby
 begin
-  # Update an admin
-  data, status_code, headers = api_instance.v1_admins_id_patch_with_http_info(id, v1_admins_id_patch_request)
+  # List tenant admins
+  data, status_code, headers = api_instance.list_admins_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <AdminFull>
+  p data # => <ListAdmins200Response>
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminsApi->v1_admins_id_patch_with_http_info: #{e}"
+  puts "Error when calling AdminsApi->list_admins_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **v1_admins_id_patch_request** | [**V1AdminsIdPatchRequest**](V1AdminsIdPatchRequest.md) |  |  |
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**AdminFull**](AdminFull.md)
+[**ListAdmins200Response**](ListAdmins200Response.md)
 
 ### Authorization
 
@@ -209,17 +207,17 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json
 
 
-## v1_admins_post
+## update_admin
 
-> <AdminFull> v1_admins_post(v1_admins_post_request)
+> <AdminFull> update_admin(id, update_admin_request)
 
-Invite a new admin
+Update an admin
 
-Creates a new tenant admin. If `password` is omitted, lockally generates a 16-char password and returns it ONCE in the response. Email is case-insensitive and unique per tenant. 
+Supply at least one of `password`, `display_name`, `role`, `disabled`.  **Safety rails.** A session bearer (adm_sess_*) cannot disable itself — use another admin or an API key (which bypasses the self-rail). Disabling the last active admin returns 409 to prevent orphaning the tenant from its console. 
 
 ### Examples
 
@@ -233,32 +231,33 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::AdminsApi.new
-v1_admins_post_request = Lockally::V1AdminsPostRequest.new({email: 'email_example'}) # V1AdminsPostRequest | 
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+update_admin_request = Lockally::UpdateAdminRequest.new # UpdateAdminRequest | 
 
 begin
-  # Invite a new admin
-  result = api_instance.v1_admins_post(v1_admins_post_request)
+  # Update an admin
+  result = api_instance.update_admin(id, update_admin_request)
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminsApi->v1_admins_post: #{e}"
+  puts "Error when calling AdminsApi->update_admin: #{e}"
 end
 ```
 
-#### Using the v1_admins_post_with_http_info variant
+#### Using the update_admin_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<AdminFull>, Integer, Hash)> v1_admins_post_with_http_info(v1_admins_post_request)
+> <Array(<AdminFull>, Integer, Hash)> update_admin_with_http_info(id, update_admin_request)
 
 ```ruby
 begin
-  # Invite a new admin
-  data, status_code, headers = api_instance.v1_admins_post_with_http_info(v1_admins_post_request)
+  # Update an admin
+  data, status_code, headers = api_instance.update_admin_with_http_info(id, update_admin_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <AdminFull>
 rescue Lockally::ApiError => e
-  puts "Error when calling AdminsApi->v1_admins_post_with_http_info: #{e}"
+  puts "Error when calling AdminsApi->update_admin_with_http_info: #{e}"
 end
 ```
 
@@ -266,7 +265,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **v1_admins_post_request** | [**V1AdminsPostRequest**](V1AdminsPostRequest.md) |  |  |
+| **id** | **String** |  |  |
+| **update_admin_request** | [**UpdateAdminRequest**](UpdateAdminRequest.md) |  |  |
 
 ### Return type
 

data/docs/AgentSendResult.md

@@ -0,0 +1,22 @@
+# Lockally::AgentSendResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The Lockally message id. | [optional] |
+| **status** | **String** |  | [optional] |
+| **thread_id** | **String** | The conversation the message joined. |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::AgentSendResult.new(
+  id: null,
+  status: null,
+  thread_id: null
+)
+```
+