lockally 0.1.0

data/docs/TenantApi.md

@@ -0,0 +1,141 @@
+# Lockally::TenantApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_tenant_get**](TenantApi.md#v1_tenant_get) | **GET** /v1/tenant | Get the calling tenant |
+| [**v1_usage_get**](TenantApi.md#v1_usage_get) | **GET** /v1/usage | Usage snapshot |
+
+
+## v1_tenant_get
+
+> <Tenant> v1_tenant_get
+
+Get the calling tenant
+
+Returns the tenant the presented API key belongs to.
+
+### 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::TenantApi.new
+
+begin
+  # Get the calling tenant
+  result = api_instance.v1_tenant_get
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling TenantApi->v1_tenant_get: #{e}"
+end
+```
+
+#### Using the v1_tenant_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Tenant>, Integer, Hash)> v1_tenant_get_with_http_info
+
+```ruby
+begin
+  # Get the calling tenant
+  data, status_code, headers = api_instance.v1_tenant_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Tenant>
+rescue Lockally::ApiError => e
+  puts "Error when calling TenantApi->v1_tenant_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Tenant**](Tenant.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v1_usage_get
+
+> <V1UsageGet200Response> v1_usage_get
+
+Usage snapshot
+
+Returns the tenant's current usage + cap consumption. Designed for poll-based alerting on the integrator side (e.g. \"warn when daily quota is 80% used\"). Refreshed live from Postgres — there is no cache, so callers should poll at most once per minute. 
+
+### 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::TenantApi.new
+
+begin
+  # Usage snapshot
+  result = api_instance.v1_usage_get
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling TenantApi->v1_usage_get: #{e}"
+end
+```
+
+#### Using the v1_usage_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1UsageGet200Response>, Integer, Hash)> v1_usage_get_with_http_info
+
+```ruby
+begin
+  # Usage snapshot
+  data, status_code, headers = api_instance.v1_usage_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1UsageGet200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling TenantApi->v1_usage_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1UsageGet200Response**](V1UsageGet200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+

data/docs/TestApi.md

@@ -0,0 +1,74 @@
+# Lockally::TestApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_test_inbound_post**](TestApi.md#v1_test_inbound_post) | **POST** /v1/test/inbound | Simulate an inbound email (test keys only) |
+
+
+## v1_test_inbound_post
+
+> Object v1_test_inbound_post
+
+Simulate an inbound email (test keys only)
+
+Runs a synthetic message through the REAL indexing pipeline — thread adoption, deterministic extraction (incl. injection_risk), and the message.received webhook — so the whole agent loop is testable without a real domain or MTA. Requires an lk_test_* key (create with {\"test\": true} on POST /v1/api-keys). Body: {mailbox, from, subject, text, in_reply_to?, references?}.
+
+### 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::TestApi.new
+
+begin
+  # Simulate an inbound email (test keys only)
+  result = api_instance.v1_test_inbound_post
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling TestApi->v1_test_inbound_post: #{e}"
+end
+```
+
+#### Using the v1_test_inbound_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> v1_test_inbound_post_with_http_info
+
+```ruby
+begin
+  # Simulate an inbound email (test keys only)
+  data, status_code, headers = api_instance.v1_test_inbound_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lockally::ApiError => e
+  puts "Error when calling TestApi->v1_test_inbound_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/UnitBundle.md

@@ -0,0 +1,26 @@
+# Lockally::UnitBundle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  |  |
+| **units** | **Integer** |  |  |
+| **display_name** | **String** |  |  |
+| **price_naira** | **Integer** |  |  |
+| **display_price** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UnitBundle.new(
+  key: null,
+  units: null,
+  display_name: null,
+  price_naira: null,
+  display_price: null
+)
+```
+

data/docs/UpdateCalendarEventRequest.md

@@ -0,0 +1,28 @@
+# Lockally::UpdateCalendarEventRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **location** | **String** |  | [optional] |
+| **starts_at** | **Time** |  | [optional] |
+| **ends_at** | **Time** |  | [optional] |
+| **all_day** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UpdateCalendarEventRequest.new(
+  title: null,
+  description: null,
+  location: null,
+  starts_at: null,
+  ends_at: null,
+  all_day: null
+)
+```
+

data/docs/UpdateCalendarIntegrationRequest.md

@@ -0,0 +1,22 @@
+# Lockally::UpdateCalendarIntegrationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UpdateCalendarIntegrationRequest.new(
+  label: null,
+  status: null,
+  error_message: null
+)
+```
+

data/docs/UpdateCalendarMemberRequest.md

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

data/docs/UpdateCalendarPoliciesRequest.md

@@ -0,0 +1,34 @@
+# Lockally::UpdateCalendarPoliciesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **max_meeting_duration_mins** | **Integer** |  | [optional] |
+| **working_hours_start** | **String** |  | [optional] |
+| **working_hours_end** | **String** |  | [optional] |
+| **booking_window_days** | **Integer** |  | [optional] |
+| **recurring_meeting_limit** | **Integer** |  | [optional] |
+| **resource_approval_mode** | **String** |  | [optional] |
+| **external_invites_allowed** | **Boolean** |  | [optional] |
+| **external_sharing_allowed** | **Boolean** |  | [optional] |
+| **public_links_enabled** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UpdateCalendarPoliciesRequest.new(
+  max_meeting_duration_mins: null,
+  working_hours_start: null,
+  working_hours_end: null,
+  booking_window_days: null,
+  recurring_meeting_limit: null,
+  resource_approval_mode: null,
+  external_invites_allowed: null,
+  external_sharing_allowed: null,
+  public_links_enabled: null
+)
+```
+

data/docs/UpdateCalendarRequest.md

@@ -0,0 +1,26 @@
+# Lockally::UpdateCalendarRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **color** | **String** |  | [optional] |
+| **owner_email** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **visibility** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UpdateCalendarRequest.new(
+  name: null,
+  color: null,
+  owner_email: null,
+  description: null,
+  visibility: null
+)
+```
+

data/docs/UpdateContactListRequest.md

@@ -0,0 +1,22 @@
+# Lockally::UpdateContactListRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **visibility** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UpdateContactListRequest.new(
+  name: null,
+  description: null,
+  visibility: null
+)
+```
+

data/docs/UpdateContactRequest.md

@@ -0,0 +1,34 @@
+# Lockally::UpdateContactRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **company** | **String** |  | [optional] |
+| **notes** | **String** |  | [optional] |
+| **contact_type** | **String** |  | [optional] |
+| **department** | **String** |  | [optional] |
+| **role** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UpdateContactRequest.new(
+  name: null,
+  email: null,
+  phone: null,
+  company: null,
+  notes: null,
+  contact_type: null,
+  department: null,
+  role: null,
+  status: null
+)
+```
+

data/docs/UpdateDirectoryPermissionsRequest.md

@@ -0,0 +1,24 @@
+# Lockally::UpdateDirectoryPermissionsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_view_access** | **String** |  | [optional] |
+| **contact_edit_access** | **String** |  | [optional] |
+| **list_manage_access** | **String** |  | [optional] |
+| **external_sharing** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UpdateDirectoryPermissionsRequest.new(
+  contact_view_access: null,
+  contact_edit_access: null,
+  list_manage_access: null,
+  external_sharing: null
+)
+```
+

data/docs/UpdateGALSettingsRequest.md

@@ -0,0 +1,26 @@
+# Lockally::UpdateGALSettingsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gal_enabled** | **Boolean** |  | [optional] |
+| **hide_from_directory** | **Boolean** |  | [optional] |
+| **department_grouping** | **Boolean** |  | [optional] |
+| **search_visibility** | **String** |  | [optional] |
+| **include_external_contacts** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UpdateGALSettingsRequest.new(
+  gal_enabled: null,
+  hide_from_directory: null,
+  department_grouping: null,
+  search_visibility: null,
+  include_external_contacts: null
+)
+```
+

data/docs/UpdateMigrationMailboxRequest.md

@@ -0,0 +1,20 @@
+# Lockally::UpdateMigrationMailboxRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dest_email** | **String** |  | [optional] |
+| **status** | **String** | Can only be set to \"skipped\". | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UpdateMigrationMailboxRequest.new(
+  dest_email: null,
+  status: null
+)
+```
+

data/docs/UpdateMigrationRequest.md

@@ -0,0 +1,20 @@
+# Lockally::UpdateMigrationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **settings** | [**MigrationSettings**](MigrationSettings.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UpdateMigrationRequest.new(
+  name: null,
+  settings: null
+)
+```
+

data/docs/UpdateResourceRequest.md

@@ -0,0 +1,24 @@
+# Lockally::UpdateResourceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **capacity** | **Integer** |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UpdateResourceRequest.new(
+  name: null,
+  type: null,
+  capacity: null,
+  status: null
+)
+```
+

data/docs/UpdateUserRequest.md

@@ -0,0 +1,26 @@
+# Lockally::UpdateUserRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **department** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UpdateUserRequest.new(
+  first_name: null,
+  last_name: null,
+  title: null,
+  department: null,
+  status: null
+)
+```
+

data/docs/User.md

@@ -0,0 +1,38 @@
+# Lockally::User
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **tenant_id** | **String** |  |  |
+| **email** | **String** |  |  |
+| **first_name** | **String** |  |  |
+| **last_name** | **String** |  |  |
+| **title** | **String** |  | [optional] |
+| **department** | **String** |  | [optional] |
+| **status** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+| **mailbox_count** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::User.new(
+  id: null,
+  tenant_id: null,
+  email: null,
+  first_name: null,
+  last_name: null,
+  title: null,
+  department: null,
+  status: null,
+  created_at: null,
+  updated_at: null,
+  mailbox_count: null
+)
+```
+

data/docs/UserEvent.md

@@ -0,0 +1,22 @@
+# Lockally::UserEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+| **event_at** | **Time** |  | [optional] |
+| **days_inactive** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::UserEvent.new(
+  email: null,
+  event_at: null,
+  days_inactive: null
+)
+```
+