lockally 0.1.0 → 0.3.0

data/docs/TemplatesApi.md

@@ -4,18 +4,18 @@ All URIs are relative to *https://api.lockally.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**v1_templates_get**](TemplatesApi.md#v1_templates_get) | **GET** /v1/templates | List templates |
-| [**v1_templates_id_delete**](TemplatesApi.md#v1_templates_id_delete) | **DELETE** /v1/templates/{id} | Delete a template |
-| [**v1_templates_id_get**](TemplatesApi.md#v1_templates_id_get) | **GET** /v1/templates/{id} | Get a template |
-| [**v1_templates_id_put**](TemplatesApi.md#v1_templates_id_put) | **PUT** /v1/templates/{id} | Update a template |
-| [**v1_templates_post**](TemplatesApi.md#v1_templates_post) | **POST** /v1/templates | Create a template |
+| [**create_template**](TemplatesApi.md#create_template) | **POST** /v1/templates | Create a template |
+| [**delete_template**](TemplatesApi.md#delete_template) | **DELETE** /v1/templates/{id} | Delete a template |
+| [**get_template**](TemplatesApi.md#get_template) | **GET** /v1/templates/{id} | Get a template |
+| [**list_templates**](TemplatesApi.md#list_templates) | **GET** /v1/templates | List templates |
+| [**update_template**](TemplatesApi.md#update_template) | **PUT** /v1/templates/{id} | Update a template |
 
 
-## v1_templates_get
+## create_template
 
-> <V1TemplatesGet200Response> v1_templates_get
+> <Template> create_template(template_input)
 
-List templates
+Create a template
 
 ### Examples
 
@@ -29,41 +29,44 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::TemplatesApi.new
+template_input = Lockally::TemplateInput.new({name: 'name_example'}) # TemplateInput | 
 
 begin
-  # List templates
-  result = api_instance.v1_templates_get
+  # Create a template
+  result = api_instance.create_template(template_input)
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling TemplatesApi->v1_templates_get: #{e}"
+  puts "Error when calling TemplatesApi->create_template: #{e}"
 end
 ```
 
-#### Using the v1_templates_get_with_http_info variant
+#### Using the create_template_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<V1TemplatesGet200Response>, Integer, Hash)> v1_templates_get_with_http_info
+> <Array(<Template>, Integer, Hash)> create_template_with_http_info(template_input)
 
 ```ruby
 begin
-  # List templates
-  data, status_code, headers = api_instance.v1_templates_get_with_http_info
+  # Create a template
+  data, status_code, headers = api_instance.create_template_with_http_info(template_input)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1TemplatesGet200Response>
+  p data # => <Template>
 rescue Lockally::ApiError => e
-  puts "Error when calling TemplatesApi->v1_templates_get_with_http_info: #{e}"
+  puts "Error when calling TemplatesApi->create_template_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-This endpoint does not need any parameter.
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_input** | [**TemplateInput**](TemplateInput.md) |  |  |
 
 ### Return type
 
-[**V1TemplatesGet200Response**](V1TemplatesGet200Response.md)
+[**Template**](Template.md)
 
 ### Authorization
 
@@ -71,13 +74,13 @@ 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_templates_id_delete
+## delete_template
 
-> v1_templates_id_delete(id)
+> delete_template(id)
 
 Delete a template
 
@@ -97,27 +100,27 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Delete a template
-  api_instance.v1_templates_id_delete(id)
+  api_instance.delete_template(id)
 rescue Lockally::ApiError => e
-  puts "Error when calling TemplatesApi->v1_templates_id_delete: #{e}"
+  puts "Error when calling TemplatesApi->delete_template: #{e}"
 end
 ```
 
-#### Using the v1_templates_id_delete_with_http_info variant
+#### Using the delete_template_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_templates_id_delete_with_http_info(id)
+> <Array(nil, Integer, Hash)> delete_template_with_http_info(id)
 
 ```ruby
 begin
   # Delete a template
-  data, status_code, headers = api_instance.v1_templates_id_delete_with_http_info(id)
+  data, status_code, headers = api_instance.delete_template_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
 rescue Lockally::ApiError => e
-  puts "Error when calling TemplatesApi->v1_templates_id_delete_with_http_info: #{e}"
+  puts "Error when calling TemplatesApi->delete_template_with_http_info: #{e}"
 end
 ```
 
@@ -141,9 +144,9 @@ nil (empty response body)
 - **Accept**: application/problem+json
 
 
-## v1_templates_id_get
+## get_template
 
-> <Template> v1_templates_id_get(id)
+> <Template> get_template(id)
 
 Get a template
 
@@ -163,28 +166,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Get a template
-  result = api_instance.v1_templates_id_get(id)
+  result = api_instance.get_template(id)
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling TemplatesApi->v1_templates_id_get: #{e}"
+  puts "Error when calling TemplatesApi->get_template: #{e}"
 end
 ```
 
-#### Using the v1_templates_id_get_with_http_info variant
+#### Using the get_template_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Template>, Integer, Hash)> v1_templates_id_get_with_http_info(id)
+> <Array(<Template>, Integer, Hash)> get_template_with_http_info(id)
 
 ```ruby
 begin
   # Get a template
-  data, status_code, headers = api_instance.v1_templates_id_get_with_http_info(id)
+  data, status_code, headers = api_instance.get_template_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Template>
 rescue Lockally::ApiError => e
-  puts "Error when calling TemplatesApi->v1_templates_id_get_with_http_info: #{e}"
+  puts "Error when calling TemplatesApi->get_template_with_http_info: #{e}"
 end
 ```
 
@@ -208,11 +211,11 @@ end
 - **Accept**: application/json, application/problem+json
 
 
-## v1_templates_id_put
+## list_templates
 
-> <Template> v1_templates_id_put(id, template_input)
+> <ListTemplates200Response> list_templates
 
-Update a template
+List templates
 
 ### Examples
 
@@ -226,46 +229,41 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::TemplatesApi.new
-id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
-template_input = Lockally::TemplateInput.new({name: 'name_example'}) # TemplateInput | 
 
 begin
-  # Update a template
-  result = api_instance.v1_templates_id_put(id, template_input)
+  # List templates
+  result = api_instance.list_templates
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling TemplatesApi->v1_templates_id_put: #{e}"
+  puts "Error when calling TemplatesApi->list_templates: #{e}"
 end
 ```
 
-#### Using the v1_templates_id_put_with_http_info variant
+#### Using the list_templates_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Template>, Integer, Hash)> v1_templates_id_put_with_http_info(id, template_input)
+> <Array(<ListTemplates200Response>, Integer, Hash)> list_templates_with_http_info
 
 ```ruby
 begin
-  # Update a template
-  data, status_code, headers = api_instance.v1_templates_id_put_with_http_info(id, template_input)
+  # List templates
+  data, status_code, headers = api_instance.list_templates_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Template>
+  p data # => <ListTemplates200Response>
 rescue Lockally::ApiError => e
-  puts "Error when calling TemplatesApi->v1_templates_id_put_with_http_info: #{e}"
+  puts "Error when calling TemplatesApi->list_templates_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **template_input** | [**TemplateInput**](TemplateInput.md) |  |  |
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**Template**](Template.md)
+[**ListTemplates200Response**](ListTemplates200Response.md)
 
 ### Authorization
 
@@ -273,15 +271,15 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json
 
 
-## v1_templates_post
+## update_template
 
-> <Template> v1_templates_post(template_input)
+> <Template> update_template(id, template_input)
 
-Create a template
+Update a template
 
 ### Examples
 
@@ -295,32 +293,33 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::TemplatesApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
 template_input = Lockally::TemplateInput.new({name: 'name_example'}) # TemplateInput | 
 
 begin
-  # Create a template
-  result = api_instance.v1_templates_post(template_input)
+  # Update a template
+  result = api_instance.update_template(id, template_input)
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling TemplatesApi->v1_templates_post: #{e}"
+  puts "Error when calling TemplatesApi->update_template: #{e}"
 end
 ```
 
-#### Using the v1_templates_post_with_http_info variant
+#### Using the update_template_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Template>, Integer, Hash)> v1_templates_post_with_http_info(template_input)
+> <Array(<Template>, Integer, Hash)> update_template_with_http_info(id, template_input)
 
 ```ruby
 begin
-  # Create a template
-  data, status_code, headers = api_instance.v1_templates_post_with_http_info(template_input)
+  # Update a template
+  data, status_code, headers = api_instance.update_template_with_http_info(id, template_input)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Template>
 rescue Lockally::ApiError => e
-  puts "Error when calling TemplatesApi->v1_templates_post_with_http_info: #{e}"
+  puts "Error when calling TemplatesApi->update_template_with_http_info: #{e}"
 end
 ```
 
@@ -328,6 +327,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
 | **template_input** | [**TemplateInput**](TemplateInput.md) |  |  |
 
 ### Return type

data/docs/TenantApi.md

@@ -4,13 +4,13 @@ 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 |
+| [**get_tenant**](TenantApi.md#get_tenant) | **GET** /v1/tenant | Get the calling tenant |
+| [**get_usage**](TenantApi.md#get_usage) | **GET** /v1/usage | Usage snapshot |
 
 
-## v1_tenant_get
+## get_tenant
 
-> <Tenant> v1_tenant_get
+> <Tenant> get_tenant
 
 Get the calling tenant
 
@@ -31,28 +31,28 @@ api_instance = Lockally::TenantApi.new
 
 begin
   # Get the calling tenant
-  result = api_instance.v1_tenant_get
+  result = api_instance.get_tenant
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling TenantApi->v1_tenant_get: #{e}"
+  puts "Error when calling TenantApi->get_tenant: #{e}"
 end
 ```
 
-#### Using the v1_tenant_get_with_http_info variant
+#### Using the get_tenant_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
+> <Array(<Tenant>, Integer, Hash)> get_tenant_with_http_info
 
 ```ruby
 begin
   # Get the calling tenant
-  data, status_code, headers = api_instance.v1_tenant_get_with_http_info
+  data, status_code, headers = api_instance.get_tenant_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}"
+  puts "Error when calling TenantApi->get_tenant_with_http_info: #{e}"
 end
 ```
 
@@ -74,9 +74,9 @@ This endpoint does not need any parameter.
 - **Accept**: application/json, application/problem+json
 
 
-## v1_usage_get
+## get_usage
 
-> <V1UsageGet200Response> v1_usage_get
+> <GetUsage200Response> get_usage
 
 Usage snapshot
 
@@ -97,28 +97,28 @@ api_instance = Lockally::TenantApi.new
 
 begin
   # Usage snapshot
-  result = api_instance.v1_usage_get
+  result = api_instance.get_usage
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling TenantApi->v1_usage_get: #{e}"
+  puts "Error when calling TenantApi->get_usage: #{e}"
 end
 ```
 
-#### Using the v1_usage_get_with_http_info variant
+#### Using the get_usage_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
+> <Array(<GetUsage200Response>, Integer, Hash)> get_usage_with_http_info
 
 ```ruby
 begin
   # Usage snapshot
-  data, status_code, headers = api_instance.v1_usage_get_with_http_info
+  data, status_code, headers = api_instance.get_usage_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1UsageGet200Response>
+  p data # => <GetUsage200Response>
 rescue Lockally::ApiError => e
-  puts "Error when calling TenantApi->v1_usage_get_with_http_info: #{e}"
+  puts "Error when calling TenantApi->get_usage_with_http_info: #{e}"
 end
 ```
 
@@ -128,7 +128,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**V1UsageGet200Response**](V1UsageGet200Response.md)
+[**GetUsage200Response**](GetUsage200Response.md)
 
 ### Authorization
 

data/docs/TestApi.md

@@ -4,12 +4,12 @@ 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) |
+| [**simulate_inbound_email**](TestApi.md#simulate_inbound_email) | **POST** /v1/test/inbound | Simulate an inbound email (test keys only) |
 
 
-## v1_test_inbound_post
+## simulate_inbound_email
 
-> Object v1_test_inbound_post
+> <SimulatedInbound> simulate_inbound_email
 
 Simulate an inbound email (test keys only)
 
@@ -30,28 +30,28 @@ api_instance = Lockally::TestApi.new
 
 begin
   # Simulate an inbound email (test keys only)
-  result = api_instance.v1_test_inbound_post
+  result = api_instance.simulate_inbound_email
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling TestApi->v1_test_inbound_post: #{e}"
+  puts "Error when calling TestApi->simulate_inbound_email: #{e}"
 end
 ```
 
-#### Using the v1_test_inbound_post_with_http_info variant
+#### Using the simulate_inbound_email_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
+> <Array(<SimulatedInbound>, Integer, Hash)> simulate_inbound_email_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
+  data, status_code, headers = api_instance.simulate_inbound_email_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <SimulatedInbound>
 rescue Lockally::ApiError => e
-  puts "Error when calling TestApi->v1_test_inbound_post_with_http_info: #{e}"
+  puts "Error when calling TestApi->simulate_inbound_email_with_http_info: #{e}"
 end
 ```
 
@@ -61,7 +61,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-**Object**
+[**SimulatedInbound**](SimulatedInbound.md)
 
 ### Authorization
 

data/docs/Thread.md

@@ -0,0 +1,22 @@
+# Lockally::Thread
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **thread** | [**ThreadSummary**](ThreadSummary.md) |  |  |
+| **mailbox** | **String** |  |  |
+| **messages** | [**Array<ThreadMessage>**](ThreadMessage.md) | Chronological. Reading never marks a message read. |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::Thread.new(
+  thread: null,
+  mailbox: null,
+  messages: null
+)
+```
+

data/docs/ThreadClassification.md

@@ -0,0 +1,22 @@
+# Lockally::ThreadClassification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **thread_id** | **String** |  |  |
+| **cached** | **Boolean** | True when a previous classification was reused. | [optional] |
+| **classification** | **Hash<String, Object>** | Intent | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ThreadClassification.new(
+  thread_id: null,
+  cached: null,
+  classification: null
+)
+```
+

data/docs/ThreadList.md

@@ -0,0 +1,20 @@
+# Lockally::ThreadList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mailbox** | **String** |  |  |
+| **threads** | [**Array<ThreadSummary>**](ThreadSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ThreadList.new(
+  mailbox: null,
+  threads: null
+)
+```
+

data/docs/ThreadMessage.md

@@ -0,0 +1,40 @@
+# Lockally::ThreadMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **direction** | **String** |  |  |
+| **rfc_message_id** | **String** | The Internet Message-ID |  |
+| **in_reply_to** | **String** |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **from** | **String** |  |  |
+| **to** | **Array<String>** |  |  |
+| **snippet** | **String** |  | [optional] |
+| **has_attachments** | **Boolean** |  |  |
+| **attachments** | **Array<Hash<String, Object>>** |  | [optional] |
+| **annotations** | **Hash<String, Object>** | Signals computed at ingest | [optional] |
+| **received_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ThreadMessage.new(
+  id: null,
+  direction: null,
+  rfc_message_id: null,
+  in_reply_to: null,
+  subject: null,
+  from: null,
+  to: null,
+  snippet: null,
+  has_attachments: null,
+  attachments: null,
+  annotations: null,
+  received_at: null
+)
+```
+

data/docs/ThreadMessageBody.md

@@ -0,0 +1,42 @@
+# Lockally::ThreadMessageBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **direction** | **String** |  |  |
+| **rfc_message_id** | **String** | The Internet Message-ID |  |
+| **in_reply_to** | **String** |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **from** | **String** |  |  |
+| **to** | **Array<String>** |  |  |
+| **snippet** | **String** |  | [optional] |
+| **has_attachments** | **Boolean** |  |  |
+| **attachments** | **Array<Hash<String, Object>>** |  | [optional] |
+| **annotations** | **Hash<String, Object>** | Signals computed at ingest | [optional] |
+| **received_at** | **Time** |  |  |
+| **body** | [**ThreadMessageBodyAllOfBody**](ThreadMessageBodyAllOfBody.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ThreadMessageBody.new(
+  id: null,
+  direction: null,
+  rfc_message_id: null,
+  in_reply_to: null,
+  subject: null,
+  from: null,
+  to: null,
+  snippet: null,
+  has_attachments: null,
+  attachments: null,
+  annotations: null,
+  received_at: null,
+  body: null
+)
+```
+

data/docs/ThreadMessageBodyAllOfBody.md

@@ -0,0 +1,22 @@
+# Lockally::ThreadMessageBodyAllOfBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** |  | [optional] |
+| **html** | **String** |  | [optional] |
+| **truncated** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ThreadMessageBodyAllOfBody.new(
+  text: null,
+  html: null,
+  truncated: null
+)
+```
+