lockally 0.2.0 → 0.3.0

data/docs/SignupApi.md

@@ -9,7 +9,7 @@ All URIs are relative to *https://api.lockally.com*
 
 ## signup
 
-> <V1AdminLoginPost200Response> signup(signup_request)
+> <AdminLogin200Response> signup(signup_request)
 
 Sign up a new tenant
 
@@ -35,7 +35,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<V1AdminLoginPost200Response>, Integer, Hash)> signup_with_http_info(signup_request)
+> <Array(<AdminLogin200Response>, Integer, Hash)> signup_with_http_info(signup_request)
 
 ```ruby
 begin
@@ -43,7 +43,7 @@ begin
   data, status_code, headers = api_instance.signup_with_http_info(signup_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1AdminLoginPost200Response>
+  p data # => <AdminLogin200Response>
 rescue Lockally::ApiError => e
   puts "Error when calling SignupApi->signup_with_http_info: #{e}"
 end
@@ -57,7 +57,7 @@ end
 
 ### Return type
 
-[**V1AdminLoginPost200Response**](V1AdminLoginPost200Response.md)
+[**AdminLogin200Response**](AdminLogin200Response.md)
 
 ### Authorization
 

data/docs/SimulatedInbound.md

@@ -0,0 +1,22 @@
+# Lockally::SimulatedInbound
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **thread_id** | **String** |  | [optional] |
+| **message_id** | **String** |  | [optional] |
+| **annotations** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::SimulatedInbound.new(
+  thread_id: null,
+  message_id: null,
+  annotations: null
+)
+```
+

data/docs/{V1InboxesMailboxMessagesPostRequest.md → StartConversationRequest.md}

@@ -1,4 +1,4 @@
-# Lockally::V1InboxesMailboxMessagesPostRequest
+# Lockally::StartConversationRequest
 
 ## Properties
 
@@ -15,7 +15,7 @@
 ```ruby
 require 'lockally'
 
-instance = Lockally::V1InboxesMailboxMessagesPostRequest.new(
+instance = Lockally::StartConversationRequest.new(
   to: null,
   cc: null,
   subject: null,

data/docs/SuppressionsApi.md

@@ -4,17 +4,17 @@ All URIs are relative to *https://api.lockally.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**v1_suppressions_email_delete**](SuppressionsApi.md#v1_suppressions_email_delete) | **DELETE** /v1/suppressions/{email} | Remove a suppression |
-| [**v1_suppressions_email_get**](SuppressionsApi.md#v1_suppressions_email_get) | **GET** /v1/suppressions/{email} | Check whether an address is suppressed |
-| [**v1_suppressions_get**](SuppressionsApi.md#v1_suppressions_get) | **GET** /v1/suppressions | List suppressed recipients |
-| [**v1_suppressions_post**](SuppressionsApi.md#v1_suppressions_post) | **POST** /v1/suppressions | Add a suppression |
+| [**create_suppression**](SuppressionsApi.md#create_suppression) | **POST** /v1/suppressions | Add a suppression |
+| [**delete_suppression**](SuppressionsApi.md#delete_suppression) | **DELETE** /v1/suppressions/{email} | Remove a suppression |
+| [**get_suppression**](SuppressionsApi.md#get_suppression) | **GET** /v1/suppressions/{email} | Check whether an address is suppressed |
+| [**list_suppressions**](SuppressionsApi.md#list_suppressions) | **GET** /v1/suppressions | List suppressed recipients |
 
 
-## v1_suppressions_email_delete
+## create_suppression
 
-> v1_suppressions_email_delete(email)
+> <Suppression> create_suppression(create_suppression_request)
 
-Remove a suppression
+Add a suppression
 
 ### Examples
 
@@ -28,31 +28,32 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::SuppressionsApi.new
-email = 'email_example' # String | 
+create_suppression_request = Lockally::CreateSuppressionRequest.new({email: 'email_example'}) # CreateSuppressionRequest | 
 
 begin
-  # Remove a suppression
-  api_instance.v1_suppressions_email_delete(email)
+  # Add a suppression
+  result = api_instance.create_suppression(create_suppression_request)
+  p result
 rescue Lockally::ApiError => e
-  puts "Error when calling SuppressionsApi->v1_suppressions_email_delete: #{e}"
+  puts "Error when calling SuppressionsApi->create_suppression: #{e}"
 end
 ```
 
-#### Using the v1_suppressions_email_delete_with_http_info variant
+#### Using the create_suppression_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_suppressions_email_delete_with_http_info(email)
+> <Array(<Suppression>, Integer, Hash)> create_suppression_with_http_info(create_suppression_request)
 
 ```ruby
 begin
-  # Remove a suppression
-  data, status_code, headers = api_instance.v1_suppressions_email_delete_with_http_info(email)
+  # Add a suppression
+  data, status_code, headers = api_instance.create_suppression_with_http_info(create_suppression_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <Suppression>
 rescue Lockally::ApiError => e
-  puts "Error when calling SuppressionsApi->v1_suppressions_email_delete_with_http_info: #{e}"
+  puts "Error when calling SuppressionsApi->create_suppression_with_http_info: #{e}"
 end
 ```
 
@@ -60,11 +61,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email** | **String** |  |  |
+| **create_suppression_request** | [**CreateSuppressionRequest**](CreateSuppressionRequest.md) |  |  |
 
 ### Return type
 
-nil (empty response body)
+[**Suppression**](Suppression.md)
 
 ### Authorization
 
@@ -72,15 +73,15 @@ nil (empty response body)
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/problem+json
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
 
 
-## v1_suppressions_email_get
+## delete_suppression
 
-> <Suppression> v1_suppressions_email_get(email)
+> delete_suppression(email)
 
-Check whether an address is suppressed
+Remove a suppression
 
 ### Examples
 
@@ -97,29 +98,28 @@ api_instance = Lockally::SuppressionsApi.new
 email = 'email_example' # String | 
 
 begin
-  # Check whether an address is suppressed
-  result = api_instance.v1_suppressions_email_get(email)
-  p result
+  # Remove a suppression
+  api_instance.delete_suppression(email)
 rescue Lockally::ApiError => e
-  puts "Error when calling SuppressionsApi->v1_suppressions_email_get: #{e}"
+  puts "Error when calling SuppressionsApi->delete_suppression: #{e}"
 end
 ```
 
-#### Using the v1_suppressions_email_get_with_http_info variant
+#### Using the delete_suppression_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(<Suppression>, Integer, Hash)> v1_suppressions_email_get_with_http_info(email)
+> <Array(nil, Integer, Hash)> delete_suppression_with_http_info(email)
 
 ```ruby
 begin
-  # Check whether an address is suppressed
-  data, status_code, headers = api_instance.v1_suppressions_email_get_with_http_info(email)
+  # Remove a suppression
+  data, status_code, headers = api_instance.delete_suppression_with_http_info(email)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Suppression>
+  p data # => nil
 rescue Lockally::ApiError => e
-  puts "Error when calling SuppressionsApi->v1_suppressions_email_get_with_http_info: #{e}"
+  puts "Error when calling SuppressionsApi->delete_suppression_with_http_info: #{e}"
 end
 ```
 
@@ -131,7 +131,7 @@ end
 
 ### Return type
 
-[**Suppression**](Suppression.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -140,14 +140,14 @@ end
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json, application/problem+json
+- **Accept**: application/problem+json
 
 
-## v1_suppressions_get
+## get_suppression
 
-> <V1SuppressionsGet200Response> v1_suppressions_get(opts)
+> <Suppression> get_suppression(email)
 
-List suppressed recipients
+Check whether an address is suppressed
 
 ### Examples
 
@@ -161,36 +161,32 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::SuppressionsApi.new
-opts = {
-  reason: 'unsubscribe', # String | 
-  cursor: 'cursor_example', # String | 
-  limit: 56 # Integer | 
-}
+email = 'email_example' # String | 
 
 begin
-  # List suppressed recipients
-  result = api_instance.v1_suppressions_get(opts)
+  # Check whether an address is suppressed
+  result = api_instance.get_suppression(email)
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling SuppressionsApi->v1_suppressions_get: #{e}"
+  puts "Error when calling SuppressionsApi->get_suppression: #{e}"
 end
 ```
 
-#### Using the v1_suppressions_get_with_http_info variant
+#### Using the get_suppression_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<V1SuppressionsGet200Response>, Integer, Hash)> v1_suppressions_get_with_http_info(opts)
+> <Array(<Suppression>, Integer, Hash)> get_suppression_with_http_info(email)
 
 ```ruby
 begin
-  # List suppressed recipients
-  data, status_code, headers = api_instance.v1_suppressions_get_with_http_info(opts)
+  # Check whether an address is suppressed
+  data, status_code, headers = api_instance.get_suppression_with_http_info(email)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1SuppressionsGet200Response>
+  p data # => <Suppression>
 rescue Lockally::ApiError => e
-  puts "Error when calling SuppressionsApi->v1_suppressions_get_with_http_info: #{e}"
+  puts "Error when calling SuppressionsApi->get_suppression_with_http_info: #{e}"
 end
 ```
 
@@ -198,13 +194,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **reason** | **String** |  | [optional] |
-| **cursor** | **String** |  | [optional] |
-| **limit** | **Integer** |  | [optional][default to 50] |
+| **email** | **String** |  |  |
 
 ### Return type
 
-[**V1SuppressionsGet200Response**](V1SuppressionsGet200Response.md)
+[**Suppression**](Suppression.md)
 
 ### Authorization
 
@@ -216,11 +210,11 @@ end
 - **Accept**: application/json, application/problem+json
 
 
-## v1_suppressions_post
+## list_suppressions
 
-> <Suppression> v1_suppressions_post(v1_suppressions_post_request)
+> <ListSuppressions200Response> list_suppressions(opts)
 
-Add a suppression
+List suppressed recipients
 
 ### Examples
 
@@ -234,32 +228,36 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::SuppressionsApi.new
-v1_suppressions_post_request = Lockally::V1SuppressionsPostRequest.new({email: 'email_example'}) # V1SuppressionsPostRequest | 
+opts = {
+  reason: 'unsubscribe', # String | 
+  cursor: 'cursor_example', # String | 
+  limit: 56 # Integer | 
+}
 
 begin
-  # Add a suppression
-  result = api_instance.v1_suppressions_post(v1_suppressions_post_request)
+  # List suppressed recipients
+  result = api_instance.list_suppressions(opts)
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling SuppressionsApi->v1_suppressions_post: #{e}"
+  puts "Error when calling SuppressionsApi->list_suppressions: #{e}"
 end
 ```
 
-#### Using the v1_suppressions_post_with_http_info variant
+#### Using the list_suppressions_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Suppression>, Integer, Hash)> v1_suppressions_post_with_http_info(v1_suppressions_post_request)
+> <Array(<ListSuppressions200Response>, Integer, Hash)> list_suppressions_with_http_info(opts)
 
 ```ruby
 begin
-  # Add a suppression
-  data, status_code, headers = api_instance.v1_suppressions_post_with_http_info(v1_suppressions_post_request)
+  # List suppressed recipients
+  data, status_code, headers = api_instance.list_suppressions_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Suppression>
+  p data # => <ListSuppressions200Response>
 rescue Lockally::ApiError => e
-  puts "Error when calling SuppressionsApi->v1_suppressions_post_with_http_info: #{e}"
+  puts "Error when calling SuppressionsApi->list_suppressions_with_http_info: #{e}"
 end
 ```
 
@@ -267,11 +265,13 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **v1_suppressions_post_request** | [**V1SuppressionsPostRequest**](V1SuppressionsPostRequest.md) |  |  |
+| **reason** | **String** |  | [optional] |
+| **cursor** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional][default to 50] |
 
 ### Return type
 
-[**Suppression**](Suppression.md)
+[**ListSuppressions200Response**](ListSuppressions200Response.md)
 
 ### Authorization
 
@@ -279,6 +279,6 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json