lockally 0.1.0 → 0.3.0

data/docs/DomainsApi.md

@@ -4,16 +4,89 @@ All URIs are relative to *https://api.lockally.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**v1_domains_domain_delete**](DomainsApi.md#v1_domains_domain_delete) | **DELETE** /v1/domains/{domain} | Delete a domain |
-| [**v1_domains_domain_get**](DomainsApi.md#v1_domains_domain_get) | **GET** /v1/domains/{domain} | Get a domain |
-| [**v1_domains_domain_verify_post**](DomainsApi.md#v1_domains_domain_verify_post) | **POST** /v1/domains/{domain}/verify | Force-poll DNS verification |
-| [**v1_domains_get**](DomainsApi.md#v1_domains_get) | **GET** /v1/domains | List domains |
-| [**v1_domains_post**](DomainsApi.md#v1_domains_post) | **POST** /v1/domains | Register a domain |
+| [**create_domain**](DomainsApi.md#create_domain) | **POST** /v1/domains | Register a domain |
+| [**delete_domain**](DomainsApi.md#delete_domain) | **DELETE** /v1/domains/{domain} | Delete a domain |
+| [**disable_return_path**](DomainsApi.md#disable_return_path) | **DELETE** /v1/domains/{domain}/return-path | Turn off the custom Return-Path |
+| [**enable_return_path**](DomainsApi.md#enable_return_path) | **POST** /v1/domains/{domain}/return-path | Turn on the custom Return-Path |
+| [**get_domain**](DomainsApi.md#get_domain) | **GET** /v1/domains/{domain} | Get a domain |
+| [**get_return_path**](DomainsApi.md#get_return_path) | **GET** /v1/domains/{domain}/return-path | Get the custom Return-Path |
+| [**list_domains**](DomainsApi.md#list_domains) | **GET** /v1/domains | List domains |
+| [**verify_domain**](DomainsApi.md#verify_domain) | **POST** /v1/domains/{domain}/verify | Force-poll DNS verification |
+| [**verify_return_path**](DomainsApi.md#verify_return_path) | **POST** /v1/domains/{domain}/return-path/verify | Check the custom Return-Path records |
 
 
-## v1_domains_domain_delete
+## create_domain
 
-> v1_domains_domain_delete(domain)
+> <Domain> create_domain(create_domain_request)
+
+Register a domain
+
+Registers a new domain for the calling tenant. Generates a DKIM keypair and verification token. Returns DNS instructions the tenant must publish under their own DNS (verification TXT, SPF include, DKIM TXT, MX records to `mx1`/`mx2.lockally.com`, DMARC seed).  **Idempotent** — re-posting the same domain returns the existing record with the same DKIM keys and token (regenerating would break the tenant's published DNS). Returns 200 on idempotent hit, 201 on first create.  Returns 409 if the domain is already claimed by a different tenant. 
+
+### 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::DomainsApi.new
+create_domain_request = Lockally::CreateDomainRequest.new({domain: 'acme.com'}) # CreateDomainRequest | 
+
+begin
+  # Register a domain
+  result = api_instance.create_domain(create_domain_request)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->create_domain: #{e}"
+end
+```
+
+#### Using the create_domain_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Domain>, Integer, Hash)> create_domain_with_http_info(create_domain_request)
+
+```ruby
+begin
+  # Register a domain
+  data, status_code, headers = api_instance.create_domain_with_http_info(create_domain_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Domain>
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->create_domain_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_domain_request** | [**CreateDomainRequest**](CreateDomainRequest.md) |  |  |
+
+### Return type
+
+[**Domain**](Domain.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## delete_domain
+
+> delete_domain(domain)
 
 Delete a domain
 
@@ -35,27 +108,95 @@ domain = 'domain_example' # String |
 
 begin
   # Delete a domain
-  api_instance.v1_domains_domain_delete(domain)
+  api_instance.delete_domain(domain)
 rescue Lockally::ApiError => e
-  puts "Error when calling DomainsApi->v1_domains_domain_delete: #{e}"
+  puts "Error when calling DomainsApi->delete_domain: #{e}"
 end
 ```
 
-#### Using the v1_domains_domain_delete_with_http_info variant
+#### Using the delete_domain_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_domains_domain_delete_with_http_info(domain)
+> <Array(nil, Integer, Hash)> delete_domain_with_http_info(domain)
 
 ```ruby
 begin
   # Delete a domain
-  data, status_code, headers = api_instance.v1_domains_domain_delete_with_http_info(domain)
+  data, status_code, headers = api_instance.delete_domain_with_http_info(domain)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->delete_domain_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## disable_return_path
+
+> disable_return_path(domain)
+
+Turn off the custom Return-Path
+
+API mail uses the sender's own address as the envelope sender again, from the next message. 
+
+### 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::DomainsApi.new
+domain = 'domain_example' # String | 
+
+begin
+  # Turn off the custom Return-Path
+  api_instance.disable_return_path(domain)
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->disable_return_path: #{e}"
+end
+```
+
+#### Using the disable_return_path_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)> disable_return_path_with_http_info(domain)
+
+```ruby
+begin
+  # Turn off the custom Return-Path
+  data, status_code, headers = api_instance.disable_return_path_with_http_info(domain)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
 rescue Lockally::ApiError => e
-  puts "Error when calling DomainsApi->v1_domains_domain_delete_with_http_info: #{e}"
+  puts "Error when calling DomainsApi->disable_return_path_with_http_info: #{e}"
 end
 ```
 
@@ -79,9 +220,78 @@ nil (empty response body)
 - **Accept**: application/problem+json
 
 
-## v1_domains_domain_get
+## enable_return_path
 
-> <Domain> v1_domains_domain_get(domain)
+> <ReturnPath> enable_return_path(domain)
+
+Turn on the custom Return-Path
+
+Moves it to `pending` and returns the two records to publish on `bounces.<domain>`. Nothing changes for mail until they are confirmed with the verify call. The domain must be verified. Available on every plan except Free. 
+
+### 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::DomainsApi.new
+domain = 'domain_example' # String | 
+
+begin
+  # Turn on the custom Return-Path
+  result = api_instance.enable_return_path(domain)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->enable_return_path: #{e}"
+end
+```
+
+#### Using the enable_return_path_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ReturnPath>, Integer, Hash)> enable_return_path_with_http_info(domain)
+
+```ruby
+begin
+  # Turn on the custom Return-Path
+  data, status_code, headers = api_instance.enable_return_path_with_http_info(domain)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ReturnPath>
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->enable_return_path_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** |  |  |
+
+### Return type
+
+[**ReturnPath**](ReturnPath.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_domain
+
+> <Domain> get_domain(domain)
 
 Get a domain
 
@@ -101,28 +311,28 @@ domain = 'domain_example' # String |
 
 begin
   # Get a domain
-  result = api_instance.v1_domains_domain_get(domain)
+  result = api_instance.get_domain(domain)
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling DomainsApi->v1_domains_domain_get: #{e}"
+  puts "Error when calling DomainsApi->get_domain: #{e}"
 end
 ```
 
-#### Using the v1_domains_domain_get_with_http_info variant
+#### Using the get_domain_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Domain>, Integer, Hash)> v1_domains_domain_get_with_http_info(domain)
+> <Array(<Domain>, Integer, Hash)> get_domain_with_http_info(domain)
 
 ```ruby
 begin
   # Get a domain
-  data, status_code, headers = api_instance.v1_domains_domain_get_with_http_info(domain)
+  data, status_code, headers = api_instance.get_domain_with_http_info(domain)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Domain>
 rescue Lockally::ApiError => e
-  puts "Error when calling DomainsApi->v1_domains_domain_get_with_http_info: #{e}"
+  puts "Error when calling DomainsApi->get_domain_with_http_info: #{e}"
 end
 ```
 
@@ -146,13 +356,13 @@ end
 - **Accept**: application/json, application/problem+json
 
 
-## v1_domains_domain_verify_post
+## get_return_path
 
-> <Domain> v1_domains_domain_verify_post(domain)
+> <ReturnPath> get_return_path(domain)
 
-Force-poll DNS verification
+Get the custom Return-Path
 
-Synchronously checks the `_lockally-verify.<domain>` TXT record against the stored verification token. Returns 200 either way: the returned `verified` boolean tells you whether DNS now confirms. Caller polls until `verified: true`. In v2 a background worker auto-polls and fires a `domain.verified` webhook. 
+A custom Return-Path moves the envelope sender of mail sent through the API from this domain onto `bounces.<domain>`. Bounce reports then come back to Lockally instead of the sending mailbox, and a bounce that arrives after delivery marks the message bounced, suppresses the address and fires `delivery.bounced`. Mail sent from webmail or mail apps is not affected. DKIM stays signed by the domain itself. `status` is `off`, `pending` (records not confirmed yet) or `active`. 
 
 ### Examples
 
@@ -169,29 +379,29 @@ api_instance = Lockally::DomainsApi.new
 domain = 'domain_example' # String | 
 
 begin
-  # Force-poll DNS verification
-  result = api_instance.v1_domains_domain_verify_post(domain)
+  # Get the custom Return-Path
+  result = api_instance.get_return_path(domain)
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling DomainsApi->v1_domains_domain_verify_post: #{e}"
+  puts "Error when calling DomainsApi->get_return_path: #{e}"
 end
 ```
 
-#### Using the v1_domains_domain_verify_post_with_http_info variant
+#### Using the get_return_path_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Domain>, Integer, Hash)> v1_domains_domain_verify_post_with_http_info(domain)
+> <Array(<ReturnPath>, Integer, Hash)> get_return_path_with_http_info(domain)
 
 ```ruby
 begin
-  # Force-poll DNS verification
-  data, status_code, headers = api_instance.v1_domains_domain_verify_post_with_http_info(domain)
+  # Get the custom Return-Path
+  data, status_code, headers = api_instance.get_return_path_with_http_info(domain)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Domain>
+  p data # => <ReturnPath>
 rescue Lockally::ApiError => e
-  puts "Error when calling DomainsApi->v1_domains_domain_verify_post_with_http_info: #{e}"
+  puts "Error when calling DomainsApi->get_return_path_with_http_info: #{e}"
 end
 ```
 
@@ -203,7 +413,7 @@ end
 
 ### Return type
 
-[**Domain**](Domain.md)
+[**ReturnPath**](ReturnPath.md)
 
 ### Authorization
 
@@ -215,9 +425,9 @@ end
 - **Accept**: application/json, application/problem+json
 
 
-## v1_domains_get
+## list_domains
 
-> <V1DomainsGet200Response> v1_domains_get
+> <ListDomains200Response> list_domains
 
 List domains
 
@@ -238,28 +448,28 @@ api_instance = Lockally::DomainsApi.new
 
 begin
   # List domains
-  result = api_instance.v1_domains_get
+  result = api_instance.list_domains
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling DomainsApi->v1_domains_get: #{e}"
+  puts "Error when calling DomainsApi->list_domains: #{e}"
 end
 ```
 
-#### Using the v1_domains_get_with_http_info variant
+#### Using the list_domains_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<V1DomainsGet200Response>, Integer, Hash)> v1_domains_get_with_http_info
+> <Array(<ListDomains200Response>, Integer, Hash)> list_domains_with_http_info
 
 ```ruby
 begin
   # List domains
-  data, status_code, headers = api_instance.v1_domains_get_with_http_info
+  data, status_code, headers = api_instance.list_domains_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1DomainsGet200Response>
+  p data # => <ListDomains200Response>
 rescue Lockally::ApiError => e
-  puts "Error when calling DomainsApi->v1_domains_get_with_http_info: #{e}"
+  puts "Error when calling DomainsApi->list_domains_with_http_info: #{e}"
 end
 ```
 
@@ -269,7 +479,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**V1DomainsGet200Response**](V1DomainsGet200Response.md)
+[**ListDomains200Response**](ListDomains200Response.md)
 
 ### Authorization
 
@@ -281,13 +491,13 @@ This endpoint does not need any parameter.
 - **Accept**: application/json, application/problem+json
 
 
-## v1_domains_post
+## verify_domain
 
-> <Domain> v1_domains_post(v1_domains_post_request)
+> <Domain> verify_domain(domain)
 
-Register a domain
+Force-poll DNS verification
 
-Registers a new domain for the calling tenant. Generates a DKIM keypair and verification token. Returns DNS instructions the tenant must publish under their own DNS (verification TXT, SPF include, DKIM TXT, MX records to `mx1`/`mx2.lockally.com`, DMARC seed).  **Idempotent** — re-posting the same domain returns the existing record with the same DKIM keys and token (regenerating would break the tenant's published DNS). Returns 200 on idempotent hit, 201 on first create.  Returns 409 if the domain is already claimed by a different tenant. 
+Synchronously checks the `_lockally-verify.<domain>` TXT record against the stored verification token. Returns 200 either way: the returned `verified` boolean tells you whether DNS now confirms. Caller polls until `verified: true`. In v2 a background worker auto-polls and fires a `domain.verified` webhook. 
 
 ### Examples
 
@@ -301,32 +511,32 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::DomainsApi.new
-v1_domains_post_request = Lockally::V1DomainsPostRequest.new({domain: 'acme.com'}) # V1DomainsPostRequest | 
+domain = 'domain_example' # String | 
 
 begin
-  # Register a domain
-  result = api_instance.v1_domains_post(v1_domains_post_request)
+  # Force-poll DNS verification
+  result = api_instance.verify_domain(domain)
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling DomainsApi->v1_domains_post: #{e}"
+  puts "Error when calling DomainsApi->verify_domain: #{e}"
 end
 ```
 
-#### Using the v1_domains_post_with_http_info variant
+#### Using the verify_domain_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Domain>, Integer, Hash)> v1_domains_post_with_http_info(v1_domains_post_request)
+> <Array(<Domain>, Integer, Hash)> verify_domain_with_http_info(domain)
 
 ```ruby
 begin
-  # Register a domain
-  data, status_code, headers = api_instance.v1_domains_post_with_http_info(v1_domains_post_request)
+  # Force-poll DNS verification
+  data, status_code, headers = api_instance.verify_domain_with_http_info(domain)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Domain>
 rescue Lockally::ApiError => e
-  puts "Error when calling DomainsApi->v1_domains_post_with_http_info: #{e}"
+  puts "Error when calling DomainsApi->verify_domain_with_http_info: #{e}"
 end
 ```
 
@@ -334,7 +544,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **v1_domains_post_request** | [**V1DomainsPostRequest**](V1DomainsPostRequest.md) |  |  |
+| **domain** | **String** |  |  |
 
 ### Return type
 
@@ -346,6 +556,75 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## verify_return_path
+
+> <ReturnPath> verify_return_path(domain)
+
+Check the custom Return-Path records
+
+Looks up the MX and SPF records on `bounces.<domain>`. Returns 200 either way: while a record is missing the status stays `pending` and `check` says which one. Once both are found the Return-Path becomes `active` and the send path starts using it. 
+
+### 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::DomainsApi.new
+domain = 'domain_example' # String | 
+
+begin
+  # Check the custom Return-Path records
+  result = api_instance.verify_return_path(domain)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->verify_return_path: #{e}"
+end
+```
+
+#### Using the verify_return_path_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ReturnPath>, Integer, Hash)> verify_return_path_with_http_info(domain)
+
+```ruby
+begin
+  # Check the custom Return-Path records
+  data, status_code, headers = api_instance.verify_return_path_with_http_info(domain)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ReturnPath>
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->verify_return_path_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** |  |  |
+
+### Return type
+
+[**ReturnPath**](ReturnPath.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json
 

data/docs/Draft.md

@@ -0,0 +1,44 @@
+# Lockally::Draft
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **mailbox_id** | **String** |  |  |
+| **mailbox** | **String** |  | [optional] |
+| **thread_id** | **String** |  | [optional] |
+| **to** | **Array<String>** |  |  |
+| **cc** | **Array<String>** |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **body_text** | **String** |  | [optional] |
+| **status** | **String** |  |  |
+| **policy_flags** | **Hash<String, Object>** |  |  |
+| **reviewed_at** | **Time** |  | [optional] |
+| **sent_message_id** | **String** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::Draft.new(
+  id: null,
+  mailbox_id: null,
+  mailbox: null,
+  thread_id: null,
+  to: null,
+  cc: null,
+  subject: null,
+  body_text: null,
+  status: null,
+  policy_flags: null,
+  reviewed_at: null,
+  sent_message_id: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/DraftList.md

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

data/docs/DraftResult.md

@@ -0,0 +1,26 @@
+# Lockally::DraftResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **draft_id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **policy_flags** | **Hash<String, Object>** |  |  |
+| **thread_id** | **String** |  | [optional] |
+| **sent** | [**AgentSendResult**](AgentSendResult.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::DraftResult.new(
+  draft_id: null,
+  status: null,
+  policy_flags: null,
+  thread_id: null,
+  sent: null
+)
+```
+