lockally 0.1.0

data/docs/UsersApi.md

@@ -0,0 +1,352 @@
+# Lockally::UsersApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_user**](UsersApi.md#create_user) | **POST** /v1/users | Create a user |
+| [**delete_user**](UsersApi.md#delete_user) | **DELETE** /v1/users/{id} | Delete a user |
+| [**get_user**](UsersApi.md#get_user) | **GET** /v1/users/{id} | Get a user |
+| [**list_users**](UsersApi.md#list_users) | **GET** /v1/users | List users |
+| [**update_user**](UsersApi.md#update_user) | **PATCH** /v1/users/{id} | Update a user |
+
+
+## create_user
+
+> <User> create_user(create_user_request)
+
+Create a user
+
+### 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::UsersApi.new
+create_user_request = Lockally::CreateUserRequest.new({email: 'email_example', first_name: 'first_name_example', last_name: 'last_name_example'}) # CreateUserRequest | 
+
+begin
+  # Create a user
+  result = api_instance.create_user(create_user_request)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling UsersApi->create_user: #{e}"
+end
+```
+
+#### Using the create_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<User>, Integer, Hash)> create_user_with_http_info(create_user_request)
+
+```ruby
+begin
+  # Create a user
+  data, status_code, headers = api_instance.create_user_with_http_info(create_user_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <User>
+rescue Lockally::ApiError => e
+  puts "Error when calling UsersApi->create_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_user_request** | [**CreateUserRequest**](CreateUserRequest.md) |  |  |
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## delete_user
+
+> delete_user(id)
+
+Delete a user
+
+Soft-deletes the user by setting status to deprovisioned.
+
+### 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::UsersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Delete a user
+  api_instance.delete_user(id)
+rescue Lockally::ApiError => e
+  puts "Error when calling UsersApi->delete_user: #{e}"
+end
+```
+
+#### Using the delete_user_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)> delete_user_with_http_info(id)
+
+```ruby
+begin
+  # Delete a user
+  data, status_code, headers = api_instance.delete_user_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lockally::ApiError => e
+  puts "Error when calling UsersApi->delete_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## get_user
+
+> <User> get_user(id)
+
+Get a user
+
+### 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::UsersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get a user
+  result = api_instance.get_user(id)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling UsersApi->get_user: #{e}"
+end
+```
+
+#### Using the get_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<User>, Integer, Hash)> get_user_with_http_info(id)
+
+```ruby
+begin
+  # Get a user
+  data, status_code, headers = api_instance.get_user_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <User>
+rescue Lockally::ApiError => e
+  puts "Error when calling UsersApi->get_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## list_users
+
+> <ListUsers200Response> list_users(opts)
+
+List users
+
+### 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::UsersApi.new
+opts = {
+  limit: 56 # Integer | 
+}
+
+begin
+  # List users
+  result = api_instance.list_users(opts)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling UsersApi->list_users: #{e}"
+end
+```
+
+#### Using the list_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListUsers200Response>, Integer, Hash)> list_users_with_http_info(opts)
+
+```ruby
+begin
+  # List users
+  data, status_code, headers = api_instance.list_users_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListUsers200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling UsersApi->list_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional][default to 100] |
+
+### Return type
+
+[**ListUsers200Response**](ListUsers200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## update_user
+
+> <User> update_user(id, update_user_request)
+
+Update a user
+
+### 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::UsersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+update_user_request = Lockally::UpdateUserRequest.new # UpdateUserRequest | 
+
+begin
+  # Update a user
+  result = api_instance.update_user(id, update_user_request)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling UsersApi->update_user: #{e}"
+end
+```
+
+#### Using the update_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<User>, Integer, Hash)> update_user_with_http_info(id, update_user_request)
+
+```ruby
+begin
+  # Update a user
+  data, status_code, headers = api_instance.update_user_with_http_info(id, update_user_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <User>
+rescue Lockally::ApiError => e
+  puts "Error when calling UsersApi->update_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **update_user_request** | [**UpdateUserRequest**](UpdateUserRequest.md) |  |  |
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+

data/docs/V1AdminLoginPost200Response.md

@@ -0,0 +1,24 @@
+# Lockally::V1AdminLoginPost200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** |  |  |
+| **expires_at** | **Time** |  |  |
+| **admin** | [**Admin**](Admin.md) |  |  |
+| **tenant** | [**Tenant**](Tenant.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1AdminLoginPost200Response.new(
+  token: adm_sess_...,
+  expires_at: null,
+  admin: null,
+  tenant: null
+)
+```
+

data/docs/V1AdminLoginPostRequest.md

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

data/docs/V1AdminMeGet200Response.md

@@ -0,0 +1,20 @@
+# Lockally::V1AdminMeGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **admin** | [**Admin**](Admin.md) |  |  |
+| **tenant** | [**Tenant**](Tenant.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1AdminMeGet200Response.new(
+  admin: null,
+  tenant: null
+)
+```
+

data/docs/V1AdminsGet200Response.md

@@ -0,0 +1,18 @@
+# Lockally::V1AdminsGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<AdminFull>**](AdminFull.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1AdminsGet200Response.new(
+  data: null
+)
+```
+

data/docs/V1AdminsIdPatchRequest.md

@@ -0,0 +1,24 @@
+# Lockally::V1AdminsIdPatchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **password** | **String** |  | [optional] |
+| **display_name** | **String** |  | [optional] |
+| **role** | **String** |  | [optional] |
+| **disabled** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1AdminsIdPatchRequest.new(
+  password: null,
+  display_name: null,
+  role: null,
+  disabled: null
+)
+```
+

data/docs/V1AdminsPostRequest.md

@@ -0,0 +1,24 @@
+# Lockally::V1AdminsPostRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **password** | **String** |  | [optional] |
+| **display_name** | **String** |  | [optional] |
+| **role** | **String** |  | [optional][default to 'admin'] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1AdminsPostRequest.new(
+  email: null,
+  password: null,
+  display_name: null,
+  role: null
+)
+```
+

data/docs/V1AliasesGet200Response.md

@@ -0,0 +1,18 @@
+# Lockally::V1AliasesGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<ModelAlias>**](ModelAlias.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1AliasesGet200Response.new(
+  data: null
+)
+```
+

data/docs/V1AliasesPostRequest.md

@@ -0,0 +1,20 @@
+# Lockally::V1AliasesPostRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **alias_address** | **String** |  |  |
+| **alias_target** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1AliasesPostRequest.new(
+  alias_address: support@acme.com,
+  alias_target: alice@acme.com
+)
+```
+

data/docs/V1ApiKeysGet200Response.md

@@ -0,0 +1,18 @@
+# Lockally::V1ApiKeysGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<APIKey>**](APIKey.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1ApiKeysGet200Response.new(
+  data: null
+)
+```
+

data/docs/V1ApiKeysPost201Response.md

@@ -0,0 +1,34 @@
+# Lockally::V1ApiKeysPost201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **tenant_id** | **String** |  |  |
+| **prefix** | **String** | 8-char public prefix; safe to store and display. |  |
+| **scopes** | **Array<String>** |  |  |
+| **label** | **String** |  |  |
+| **last_used_at** | **Time** |  | [optional] |
+| **revoked_at** | **Time** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **secret** | **String** | The full `lk_live_<prefix>_<secret>` token. Shown ONCE. |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1ApiKeysPost201Response.new(
+  id: null,
+  tenant_id: null,
+  prefix: fbl73bhj,
+  scopes: null,
+  label: ci-pipeline,
+  last_used_at: null,
+  revoked_at: null,
+  created_at: null,
+  secret: lk_live_fbl73bhj_sfvqy7y757cnvu33bgqdpyrrhq3tyyf3
+)
+```
+

data/docs/V1ApiKeysPostRequest.md

@@ -0,0 +1,20 @@
+# Lockally::V1ApiKeysPostRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | Free-text identifier shown in the dashboard. |  |
+| **scopes** | **Array<String>** | Allowed scopes on this key. |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1ApiKeysPostRequest.new(
+  label: ci-pipeline,
+  scopes: null
+)
+```
+

data/docs/V1DomainsGet200Response.md

@@ -0,0 +1,18 @@
+# Lockally::V1DomainsGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Domain>**](Domain.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1DomainsGet200Response.new(
+  data: null
+)
+```
+

data/docs/V1DomainsPostRequest.md

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

data/docs/V1InboxesMailboxMessagesPostRequest.md

@@ -0,0 +1,26 @@
+# Lockally::V1InboxesMailboxMessagesPostRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **to** | **Array<String>** |  |  |
+| **cc** | **Array<String>** |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **text** | **String** |  |  |
+| **html** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1InboxesMailboxMessagesPostRequest.new(
+  to: null,
+  cc: null,
+  subject: null,
+  text: null,
+  html: null
+)
+```
+

data/docs/V1MailboxesEmailExportPost201Response.md

@@ -0,0 +1,22 @@
+# Lockally::V1MailboxesEmailExportPost201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Relative download URL. Caller appends to the API host. |  |
+| **expires_at** | **Time** |  |  |
+| **format** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1MailboxesEmailExportPost201Response.new(
+  url: null,
+  expires_at: null,
+  format: null
+)
+```
+