lockally 0.1.0 → 0.3.0

data/docs/ApiKeysApi.md

@@ -4,18 +4,18 @@ All URIs are relative to *https://api.lockally.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**v1_api_keys_get**](ApiKeysApi.md#v1_api_keys_get) | **GET** /v1/api-keys | List API keys |
-| [**v1_api_keys_id_delete**](ApiKeysApi.md#v1_api_keys_id_delete) | **DELETE** /v1/api-keys/{id} | Revoke an API key |
-| [**v1_api_keys_post**](ApiKeysApi.md#v1_api_keys_post) | **POST** /v1/api-keys | Create an API key |
+| [**create_api_key**](ApiKeysApi.md#create_api_key) | **POST** /v1/api-keys | Create an API key |
+| [**list_api_keys**](ApiKeysApi.md#list_api_keys) | **GET** /v1/api-keys | List API keys |
+| [**revoke_api_key**](ApiKeysApi.md#revoke_api_key) | **DELETE** /v1/api-keys/{id} | Revoke an API key |
 
 
-## v1_api_keys_get
+## create_api_key
 
-> <V1ApiKeysGet200Response> v1_api_keys_get
+> <CreateApiKey201Response> create_api_key(create_api_key_request)
 
-List API keys
+Create an API key
 
-Returns all API keys (active and revoked) belonging to the calling tenant. The `secret` is **never** returned — only prefix + metadata. 
+Provisions a fresh API key for the calling tenant.  **The full `secret` is included in this response ONLY** — store it immediately. The cleartext secret is not recoverable from the argon2id hash kept server-side; rotate by creating a new key and revoking the old one. 
 
 ### Examples
 
@@ -29,41 +29,44 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::ApiKeysApi.new
+create_api_key_request = Lockally::CreateApiKeyRequest.new({label: 'ci-pipeline', scopes: ['tenant:read']}) # CreateApiKeyRequest | 
 
 begin
-  # List API keys
-  result = api_instance.v1_api_keys_get
+  # Create an API key
+  result = api_instance.create_api_key(create_api_key_request)
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling ApiKeysApi->v1_api_keys_get: #{e}"
+  puts "Error when calling ApiKeysApi->create_api_key: #{e}"
 end
 ```
 
-#### Using the v1_api_keys_get_with_http_info variant
+#### Using the create_api_key_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<V1ApiKeysGet200Response>, Integer, Hash)> v1_api_keys_get_with_http_info
+> <Array(<CreateApiKey201Response>, Integer, Hash)> create_api_key_with_http_info(create_api_key_request)
 
 ```ruby
 begin
-  # List API keys
-  data, status_code, headers = api_instance.v1_api_keys_get_with_http_info
+  # Create an API key
+  data, status_code, headers = api_instance.create_api_key_with_http_info(create_api_key_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1ApiKeysGet200Response>
+  p data # => <CreateApiKey201Response>
 rescue Lockally::ApiError => e
-  puts "Error when calling ApiKeysApi->v1_api_keys_get_with_http_info: #{e}"
+  puts "Error when calling ApiKeysApi->create_api_key_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-This endpoint does not need any parameter.
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_api_key_request** | [**CreateApiKeyRequest**](CreateApiKeyRequest.md) |  |  |
 
 ### Return type
 
-[**V1ApiKeysGet200Response**](V1ApiKeysGet200Response.md)
+[**CreateApiKey201Response**](CreateApiKey201Response.md)
 
 ### Authorization
 
@@ -71,17 +74,17 @@ This endpoint does not need any parameter.
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json, application/problem+json
 
 
-## v1_api_keys_id_delete
+## list_api_keys
 
-> v1_api_keys_id_delete(id)
+> <ListApiKeys200Response> list_api_keys
 
-Revoke an API key
+List API keys
 
-Soft-deletes (sets `revoked_at`) on the named key. The row stays for audit purposes; the key no longer authenticates.  You **cannot revoke the key currently being used** to make this call — that would lock you out. Use a different `tenant:admin` key. 
+Returns all API keys (active and revoked) belonging to the calling tenant. The `secret` is **never** returned — only prefix + metadata. 
 
 ### Examples
 
@@ -95,43 +98,41 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::ApiKeysApi.new
-id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
 
 begin
-  # Revoke an API key
-  api_instance.v1_api_keys_id_delete(id)
+  # List API keys
+  result = api_instance.list_api_keys
+  p result
 rescue Lockally::ApiError => e
-  puts "Error when calling ApiKeysApi->v1_api_keys_id_delete: #{e}"
+  puts "Error when calling ApiKeysApi->list_api_keys: #{e}"
 end
 ```
 
-#### Using the v1_api_keys_id_delete_with_http_info variant
+#### Using the list_api_keys_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_api_keys_id_delete_with_http_info(id)
+> <Array(<ListApiKeys200Response>, Integer, Hash)> list_api_keys_with_http_info
 
 ```ruby
 begin
-  # Revoke an API key
-  data, status_code, headers = api_instance.v1_api_keys_id_delete_with_http_info(id)
+  # List API keys
+  data, status_code, headers = api_instance.list_api_keys_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <ListApiKeys200Response>
 rescue Lockally::ApiError => e
-  puts "Error when calling ApiKeysApi->v1_api_keys_id_delete_with_http_info: #{e}"
+  puts "Error when calling ApiKeysApi->list_api_keys_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
+This endpoint does not need any parameter.
 
 ### Return type
 
-nil (empty response body)
+[**ListApiKeys200Response**](ListApiKeys200Response.md)
 
 ### Authorization
 
@@ -140,16 +141,16 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/problem+json
+- **Accept**: application/json, application/problem+json
 
 
-## v1_api_keys_post
+## revoke_api_key
 
-> <V1ApiKeysPost201Response> v1_api_keys_post(v1_api_keys_post_request)
+> revoke_api_key(id)
 
-Create an API key
+Revoke an API key
 
-Provisions a fresh API key for the calling tenant.  **The full `secret` is included in this response ONLY** — store it immediately. The cleartext secret is not recoverable from the argon2id hash kept server-side; rotate by creating a new key and revoking the old one. 
+Soft-deletes (sets `revoked_at`) on the named key. The row stays for audit purposes; the key no longer authenticates.  You **cannot revoke the key currently being used** to make this call — that would lock you out. Use a different `tenant:admin` key. 
 
 ### Examples
 
@@ -163,32 +164,31 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::ApiKeysApi.new
-v1_api_keys_post_request = Lockally::V1ApiKeysPostRequest.new({label: 'ci-pipeline', scopes: ['tenant:read']}) # V1ApiKeysPostRequest | 
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
 
 begin
-  # Create an API key
-  result = api_instance.v1_api_keys_post(v1_api_keys_post_request)
-  p result
+  # Revoke an API key
+  api_instance.revoke_api_key(id)
 rescue Lockally::ApiError => e
-  puts "Error when calling ApiKeysApi->v1_api_keys_post: #{e}"
+  puts "Error when calling ApiKeysApi->revoke_api_key: #{e}"
 end
 ```
 
-#### Using the v1_api_keys_post_with_http_info variant
+#### Using the revoke_api_key_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(<V1ApiKeysPost201Response>, Integer, Hash)> v1_api_keys_post_with_http_info(v1_api_keys_post_request)
+> <Array(nil, Integer, Hash)> revoke_api_key_with_http_info(id)
 
 ```ruby
 begin
-  # Create an API key
-  data, status_code, headers = api_instance.v1_api_keys_post_with_http_info(v1_api_keys_post_request)
+  # Revoke an API key
+  data, status_code, headers = api_instance.revoke_api_key_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1ApiKeysPost201Response>
+  p data # => nil
 rescue Lockally::ApiError => e
-  puts "Error when calling ApiKeysApi->v1_api_keys_post_with_http_info: #{e}"
+  puts "Error when calling ApiKeysApi->revoke_api_key_with_http_info: #{e}"
 end
 ```
 
@@ -196,11 +196,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **v1_api_keys_post_request** | [**V1ApiKeysPostRequest**](V1ApiKeysPostRequest.md) |  |  |
+| **id** | **String** |  |  |
 
 ### Return type
 
-[**V1ApiKeysPost201Response**](V1ApiKeysPost201Response.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -208,6 +208,6 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: application/json, application/problem+json
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
 

data/docs/BatchResult.md

@@ -7,7 +7,7 @@
 | **index** | **Integer** |  | [optional] |
 | **id** | **String** |  | [optional] |
 | **message_id** | **String** |  | [optional] |
-| **status** | **String** |  | [optional] |
+| **status** | **String** | \"suppressed\" means every recipient of that slot was on your suppression list, and it carries no id or message_id. \"delivered\" only appears on a test key: the send was simulated, not transmitted. | [optional] |
 | **error** | **String** | Present when this message failed; the others are then absent. | [optional] |
 
 ## Example

data/docs/Calendar.md

@@ -10,7 +10,11 @@
 | **color** | **String** |  | [optional] |
 | **owner_email** | **String** |  | [optional] |
 | **description** | **String** |  | [optional] |
+| **calendar_type** | **String** | What the calendar is for. Separate from visibility, which is who may see it: a team calendar can be open to everyone and a department one restricted to named people. \"personal\" is a person's own and is not listed in the console's management table.  | [optional] |
+| **owner_unit** | **String** | The owning department or office. Empty on a personal calendar, which is owned by owner_email. | [optional] |
 | **visibility** | **String** |  |  |
+| **access_department** | **String** | Which department may see it, when visibility is \"department\". Matched against the department recorded on a user, so access follows a person between departments with no membership list to maintain.  | [optional] |
+| **status** | **String** | Archived keeps the calendar, its events and its feed, and stops it taking new events. | [optional] |
 | **feed_url** | **String** |  | [optional] |
 | **event_count** | **Integer** |  | [optional] |
 | **created_at** | **Time** |  |  |
@@ -28,7 +32,11 @@ instance = Lockally::Calendar.new(
   color: null,
   owner_email: null,
   description: null,
+  calendar_type: null,
+  owner_unit: null,
   visibility: null,
+  access_department: null,
+  status: null,
   feed_url: null,
   event_count: null,
   created_at: null,

data/docs/CalendarsApi.md

@@ -12,6 +12,7 @@ All URIs are relative to *https://api.lockally.com*
 | [**delete_calendar_event**](CalendarsApi.md#delete_calendar_event) | **DELETE** /v1/calendars/{id}/events/{eventId} | Delete a calendar event |
 | [**delete_calendar_integration**](CalendarsApi.md#delete_calendar_integration) | **DELETE** /v1/calendar-integrations/{id} | Delete a calendar integration |
 | [**get_calendar**](CalendarsApi.md#get_calendar) | **GET** /v1/calendars/{id} | Get a calendar |
+| [**get_calendar_overview**](CalendarsApi.md#get_calendar_overview) | **GET** /v1/calendar-overview | Administrative overview of the organization's calendar system |
 | [**get_calendar_policies**](CalendarsApi.md#get_calendar_policies) | **GET** /v1/calendar-policies | Get calendar policies |
 | [**get_calendar_security**](CalendarsApi.md#get_calendar_security) | **GET** /v1/calendar-security | Get calendar security overview |
 | [**list_calendar_events**](CalendarsApi.md#list_calendar_events) | **GET** /v1/calendars/{id}/events | List events in a calendar |
@@ -238,6 +239,8 @@ end
 
 Create a calendar integration
 
+Not implemented. Calendar integrations do not sync with any provider yet, so this always answers 501. Listing and deleting still work, for entries created before the feature was withdrawn. 
+
 ### Examples
 
 ```ruby
@@ -566,6 +569,72 @@ end
 - **Accept**: application/json, application/problem+json
 
 
+## get_calendar_overview
+
+> <GetCalendarOverview200Response> get_calendar_overview
+
+Administrative overview of the organization's calendar system
+
+Counts across the whole account, plus the recent calendar entries from the audit trail. Not scoped to the caller's own calendar. 
+
+### 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::CalendarsApi.new
+
+begin
+  # Administrative overview of the organization's calendar system
+  result = api_instance.get_calendar_overview
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling CalendarsApi->get_calendar_overview: #{e}"
+end
+```
+
+#### Using the get_calendar_overview_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCalendarOverview200Response>, Integer, Hash)> get_calendar_overview_with_http_info
+
+```ruby
+begin
+  # Administrative overview of the organization's calendar system
+  data, status_code, headers = api_instance.get_calendar_overview_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCalendarOverview200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling CalendarsApi->get_calendar_overview_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetCalendarOverview200Response**](GetCalendarOverview200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
 ## get_calendar_policies
 
 > <CalendarPolicies> get_calendar_policies
@@ -1036,6 +1105,8 @@ nil (empty response body)
 
 Trigger sync for a calendar integration
 
+Not implemented. Calendar integrations do not sync with any provider yet, so this always answers 501. Listing and deleting still work, for entries created before the feature was withdrawn. 
+
 ### Examples
 
 ```ruby
@@ -1243,6 +1314,8 @@ end
 
 Update a calendar integration
 
+Not implemented. Calendar integrations do not sync with any provider yet, so this always answers 501. Listing and deleting still work, for entries created before the feature was withdrawn. 
+
 ### Examples
 
 ```ruby

data/docs/ContactLookup.md

@@ -0,0 +1,26 @@
+# Lockally::ContactLookup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **known** | **Boolean** |  |  |
+| **internal** | **Boolean** | True when the address is one of the tenant's own mailboxes. |  |
+| **contact** | [**ContactLookupContact**](ContactLookupContact.md) |  | [optional] |
+| **history** | [**ContactLookupHistory**](ContactLookupHistory.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ContactLookup.new(
+  email: null,
+  known: null,
+  internal: null,
+  contact: null,
+  history: null
+)
+```
+

data/docs/ContactLookupContact.md

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

data/docs/ContactLookupHistory.md

@@ -0,0 +1,22 @@
+# Lockally::ContactLookupHistory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **thread_count** | **Integer** |  | [optional] |
+| **first_seen** | **Time** |  | [optional] |
+| **last_seen** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ContactLookupHistory.new(
+  thread_count: null,
+  first_seen: null,
+  last_seen: null
+)
+```
+

data/docs/CreateAiUnitsCheckout200Response.md

@@ -0,0 +1,22 @@
+# Lockally::CreateAiUnitsCheckout200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_url** | **String** |  |  |
+| **reference** | **String** |  |  |
+| **units** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::CreateAiUnitsCheckout200Response.new(
+  authorization_url: null,
+  reference: null,
+  units: null
+)
+```
+

data/docs/{V1AliasesPostRequest.md → CreateAliasRequest.md}

@@ -1,4 +1,4 @@
-# Lockally::V1AliasesPostRequest
+# Lockally::CreateAliasRequest
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'lockally'
 
-instance = Lockally::V1AliasesPostRequest.new(
+instance = Lockally::CreateAliasRequest.new(
   alias_address: support@acme.com,
   alias_target: alice@acme.com
 )

data/docs/{V1ApiKeysPost201Response.md → CreateApiKey201Response.md}

@@ -1,4 +1,4 @@
-# Lockally::V1ApiKeysPost201Response
+# Lockally::CreateApiKey201Response
 
 ## Properties
 
@@ -19,7 +19,7 @@
 ```ruby
 require 'lockally'
 
-instance = Lockally::V1ApiKeysPost201Response.new(
+instance = Lockally::CreateApiKey201Response.new(
   id: null,
   tenant_id: null,
   prefix: fbl73bhj,

data/docs/CreateApiKeyRequest.md

@@ -0,0 +1,22 @@
+# Lockally::CreateApiKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | Free-text identifier shown in the dashboard. |  |
+| **scopes** | **Array<String>** | Allowed scopes on this key. |  |
+| **test** | **Boolean** | Issue a test key (`lk_test_` prefix). A test key accepts sends, records them and fires a simulated delivery webhook without sending mail, and counts against no limit or allowance.  | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::CreateApiKeyRequest.new(
+  label: ci-pipeline,
+  scopes: null,
+  test: null
+)
+```
+

data/docs/{V1DomainsPostRequest.md → CreateDomainRequest.md}

@@ -1,4 +1,4 @@
-# Lockally::V1DomainsPostRequest
+# Lockally::CreateDomainRequest
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'lockally'
 
-instance = Lockally::V1DomainsPostRequest.new(
+instance = Lockally::CreateDomainRequest.new(
   domain: acme.com
 )
 ```

data/docs/{V1MailboxesPostRequest.md → CreateMailboxRequest.md}

@@ -1,4 +1,4 @@
-# Lockally::V1MailboxesPostRequest
+# Lockally::CreateMailboxRequest
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'lockally'
 
-instance = Lockally::V1MailboxesPostRequest.new(
+instance = Lockally::CreateMailboxRequest.new(
   email: alice@acme.com,
   password: null,
   quota_bytes: null

data/docs/{V1SuppressionsPostRequest.md → CreateSuppressionRequest.md}

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

data/docs/{V1WebhooksPostRequest.md → CreateWebhookRequest.md}

@@ -1,4 +1,4 @@
-# Lockally::V1WebhooksPostRequest
+# Lockally::CreateWebhookRequest
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'lockally'
 
-instance = Lockally::V1WebhooksPostRequest.new(
+instance = Lockally::CreateWebhookRequest.new(
   url: https://example.com/webhooks/lockally,
   events: null
 )