zyphr 0.1.71 → 0.1.72

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5c56a72e43d597fcc05201dc4eca7a0e965a6a9dfce0c1781b2f9e30dc58fde
-  data.tar.gz: 6b19b8da470182d5ba97a3a65bf0c27af987a14dec20ffad8f724597e531cb0b
+  metadata.gz: bd59671afec98403ff0bfc353066d7bd0bb9199e17b67cd3a78a29a77b07305d
+  data.tar.gz: 8c4830adba43b107e584c81bccf76a944b968572f4289969cbc81147cec45c7f
 SHA512:
-  metadata.gz: 814f2bea2fc95dd0540a90969f8e6e9a22afcf7d7b500c3e9586548651a6c0b624e1f34f1e7287127e98a12ab043f13444dcfa29e14fd112ae8ea5c1c354470d
-  data.tar.gz: 05d8ada5ef8f596d64b5ed9552f856285341802c669cceaead95883e7a110027302ae640c07fa5df5edd960c6a939cda5edceb24aae772af829360ea130fdff0
+  metadata.gz: 0fb6c1aeced8294e471abe02308ce28ce51914eecbe789690d2e48c60ec649427cb9a477f39587ea4793a02cd936504ae7385b65b93c9ad1eedf5fdb6ac10438
+  data.tar.gz: 017cc2735e1f8a2db0dd9f22670e6c593b07dc7db1b93212abf8f9f028f4f30a102b5abda6109e6a26effc5668d45d52c027becceb97715ea457b13fb24dc8fd

data/README.md

@@ -235,9 +235,15 @@ Class | Method | HTTP request | Description
 *Zyphr::ExecutionsApi* | [**cancel_execution**](docs/ExecutionsApi.md#cancel_execution) | **POST** /executions/{id}/cancel | Cancel a running execution
 *Zyphr::ExecutionsApi* | [**get_execution**](docs/ExecutionsApi.md#get_execution) | **GET** /executions/{id} | Get a workflow execution
 *Zyphr::ExecutionsApi* | [**retry_execution**](docs/ExecutionsApi.md#retry_execution) | **POST** /executions/{id}/retry | Retry a failed or cancelled execution
+*Zyphr::InboundEmailApi* | [**create_inbox**](docs/InboundEmailApi.md#create_inbox) | **POST** /inboxes | Create an inbox
+*Zyphr::InboundEmailApi* | [**delete_inbox**](docs/InboundEmailApi.md#delete_inbox) | **DELETE** /inboxes/{id} | Delete an inbox
 *Zyphr::InboundEmailApi* | [**get_inbound_attachment_url**](docs/InboundEmailApi.md#get_inbound_attachment_url) | **GET** /inbound-emails/{id}/attachments/{attachmentId} | Get an attachment download URL
 *Zyphr::InboundEmailApi* | [**get_inbound_email**](docs/InboundEmailApi.md#get_inbound_email) | **GET** /inbound-emails/{id} | Get a received email
+*Zyphr::InboundEmailApi* | [**get_inbox**](docs/InboundEmailApi.md#get_inbox) | **GET** /inboxes/{id} | Get an inbox
 *Zyphr::InboundEmailApi* | [**list_inbound_emails**](docs/InboundEmailApi.md#list_inbound_emails) | **GET** /inbound-emails | List received emails
+*Zyphr::InboundEmailApi* | [**list_inboxes**](docs/InboundEmailApi.md#list_inboxes) | **GET** /inboxes | List inboxes
+*Zyphr::InboundEmailApi* | [**reply_to_inbound_email**](docs/InboundEmailApi.md#reply_to_inbound_email) | **POST** /inbound-emails/{id}/reply | Reply to a received email
+*Zyphr::InboundEmailApi* | [**update_inbox**](docs/InboundEmailApi.md#update_inbox) | **PATCH** /inboxes/{id} | Update an inbox
 *Zyphr::InboxApi* | [**archive_inbox_notification**](docs/InboxApi.md#archive_inbox_notification) | **POST** /inbox/{id}/archive | Archive a notification
 *Zyphr::InboxApi* | [**archive_subscriber_notification**](docs/InboxApi.md#archive_subscriber_notification) | **POST** /subscriber-inbox/{id}/archive | Archive a notification
 *Zyphr::InboxApi* | [**delete_inbox_notification**](docs/InboxApi.md#delete_inbox_notification) | **DELETE** /inbox/{id} | Delete a notification
@@ -451,6 +457,7 @@ Class | Method | HTTP request | Description
  - [Zyphr::ConvertAnonymousUserRequestOneOf1AppleUser](docs/ConvertAnonymousUserRequestOneOf1AppleUser.md)
  - [Zyphr::ConvertAnonymousUserRequestOneOf1AppleUserName](docs/ConvertAnonymousUserRequestOneOf1AppleUserName.md)
  - [Zyphr::CreateCategoryRequest](docs/CreateCategoryRequest.md)
+ - [Zyphr::CreateInboxRequest](docs/CreateInboxRequest.md)
  - [Zyphr::CreateOrganizationRequest](docs/CreateOrganizationRequest.md)
  - [Zyphr::CreateSubscriberRequest](docs/CreateSubscriberRequest.md)
  - [Zyphr::CreateTemplateRequest](docs/CreateTemplateRequest.md)
@@ -543,9 +550,11 @@ Class | Method | HTTP request | Description
  - [Zyphr::InboundEmailListResponse](docs/InboundEmailListResponse.md)
  - [Zyphr::InboundEmailListResponseMeta](docs/InboundEmailListResponseMeta.md)
  - [Zyphr::InboundEmailResponse](docs/InboundEmailResponse.md)
+ - [Zyphr::Inbox](docs/Inbox.md)
  - [Zyphr::InboxListMeta](docs/InboxListMeta.md)
  - [Zyphr::InboxListResponse](docs/InboxListResponse.md)
  - [Zyphr::InboxNotificationResponse](docs/InboxNotificationResponse.md)
+ - [Zyphr::InboxResponse](docs/InboxResponse.md)
  - [Zyphr::InviteEndUser200Response](docs/InviteEndUser200Response.md)
  - [Zyphr::InviteEndUser200ResponseData](docs/InviteEndUser200ResponseData.md)
  - [Zyphr::InviteEndUserRequest](docs/InviteEndUserRequest.md)
@@ -664,6 +673,7 @@ Class | Method | HTTP request | Description
  - [Zyphr::RenderTemplateRequest](docs/RenderTemplateRequest.md)
  - [Zyphr::ReorderWorkflowStepsRequest](docs/ReorderWorkflowStepsRequest.md)
  - [Zyphr::ReplayWebhookEventsRequest](docs/ReplayWebhookEventsRequest.md)
+ - [Zyphr::ReplyToInboundEmailRequest](docs/ReplyToInboundEmailRequest.md)
  - [Zyphr::RequestMeta](docs/RequestMeta.md)
  - [Zyphr::ResendEmailVerificationRequest](docs/ResendEmailVerificationRequest.md)
  - [Zyphr::ResetPasswordRequest](docs/ResetPasswordRequest.md)
@@ -787,6 +797,7 @@ Class | Method | HTTP request | Description
  - [Zyphr::UpdateCategoryRequest](docs/UpdateCategoryRequest.md)
  - [Zyphr::UpdateEndUserByApplicationRequest](docs/UpdateEndUserByApplicationRequest.md)
  - [Zyphr::UpdateEndUserRequest](docs/UpdateEndUserRequest.md)
+ - [Zyphr::UpdateInboxRequest](docs/UpdateInboxRequest.md)
  - [Zyphr::UpdateOrganizationMemberRoleRequest](docs/UpdateOrganizationMemberRoleRequest.md)
  - [Zyphr::UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)
  - [Zyphr::UpdateSubscriberPreferences200Response](docs/UpdateSubscriberPreferences200Response.md)

data/docs/CreateInboxRequest.md

@@ -0,0 +1,24 @@
+# Zyphr::CreateInboxRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain_id** | **String** | A verified domain with inbound email enabled |  |
+| **local_part** | **String** | The part before `@`. Letters, numbers, `.`, `_` and `-`; cannot start or end with `.` or contain `..`. Stored lowercase. `dmarc-reports` is reserved. Mail to `<local_part>+anything@` also reaches the inbox.  |  |
+| **name** | **String** |  | [optional] |
+| **from_name** | **String** | Display name for replies. No control characters and none of `\" \\ , ; @ : < >`.  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::CreateInboxRequest.new(
+  domain_id: null,
+  local_part: support,
+  name: Support,
+  from_name: Acme Support
+)
+```
+

data/docs/InboundEmail.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional] |
 | **to_email** | **String** | The receiving address the mail was sent to | [optional] |
+| **inbox_id** | **String** | The inbox the mail was addressed to, or null when the domain has no inboxes (or the inbox was deleted) | [optional] |
 | **from** | [**InboundEmailFrom**](InboundEmailFrom.md) |  | [optional] |
 | **cc** | **Array<String>** |  | [optional] |
 | **subject** | **String** |  | [optional] |
@@ -29,6 +30,7 @@ require 'zyphr'
 instance = Zyphr::InboundEmail.new(
   id: null,
   to_email: support@inbound.acme.com,
+  inbox_id: null,
   from: null,
   cc: null,
   subject: null,

data/docs/InboundEmailApi.md

@@ -4,9 +4,156 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**create_inbox**](InboundEmailApi.md#create_inbox) | **POST** /inboxes | Create an inbox |
+| [**delete_inbox**](InboundEmailApi.md#delete_inbox) | **DELETE** /inboxes/{id} | Delete an inbox |
 | [**get_inbound_attachment_url**](InboundEmailApi.md#get_inbound_attachment_url) | **GET** /inbound-emails/{id}/attachments/{attachmentId} | Get an attachment download URL |
 | [**get_inbound_email**](InboundEmailApi.md#get_inbound_email) | **GET** /inbound-emails/{id} | Get a received email |
+| [**get_inbox**](InboundEmailApi.md#get_inbox) | **GET** /inboxes/{id} | Get an inbox |
 | [**list_inbound_emails**](InboundEmailApi.md#list_inbound_emails) | **GET** /inbound-emails | List received emails |
+| [**list_inboxes**](InboundEmailApi.md#list_inboxes) | **GET** /inboxes | List inboxes |
+| [**reply_to_inbound_email**](InboundEmailApi.md#reply_to_inbound_email) | **POST** /inbound-emails/{id}/reply | Reply to a received email |
+| [**update_inbox**](InboundEmailApi.md#update_inbox) | **PATCH** /inboxes/{id} | Update an inbox |
+
+
+## create_inbox
+
+> <InboxResponse> create_inbox(create_inbox_request)
+
+Create an inbox
+
+Create a named receiving address, `<local_part>@inbound.<domain>`, on a domain with inbound email enabled. Test-mode keys cannot create, update or delete inboxes, because inboxes change live mail routing. Once a domain has at least one inbox, mail to any other address on it is dropped; a domain with no inboxes keeps receiving at every address. Requires a plan with inbound email (Starter or higher). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::InboundEmailApi.new
+create_inbox_request = Zyphr::CreateInboxRequest.new({domain_id: 'domain_id_example', local_part: 'support'}) # CreateInboxRequest | 
+
+begin
+  # Create an inbox
+  result = api_instance.create_inbox(create_inbox_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->create_inbox: #{e}"
+end
+```
+
+#### Using the create_inbox_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InboxResponse>, Integer, Hash)> create_inbox_with_http_info(create_inbox_request)
+
+```ruby
+begin
+  # Create an inbox
+  data, status_code, headers = api_instance.create_inbox_with_http_info(create_inbox_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InboxResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->create_inbox_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_inbox_request** | [**CreateInboxRequest**](CreateInboxRequest.md) |  |  |
+
+### Return type
+
+[**InboxResponse**](InboxResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_inbox
+
+> delete_inbox(id)
+
+Delete an inbox
+
+Delete the inbox. Mail it already received is kept (its `inbox_id` becomes null). If it was the domain's last inbox, the domain goes back to receiving at every address. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::InboundEmailApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Delete an inbox
+  api_instance.delete_inbox(id)
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->delete_inbox: #{e}"
+end
+```
+
+#### Using the delete_inbox_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_inbox_with_http_info(id)
+
+```ruby
+begin
+  # Delete an inbox
+  data, status_code, headers = api_instance.delete_inbox_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->delete_inbox_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
 
 
 ## get_inbound_attachment_url
@@ -153,6 +300,75 @@ end
 - **Accept**: application/json
 
 
+## get_inbox
+
+> <InboxResponse> get_inbox(id)
+
+Get an inbox
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::InboundEmailApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get an inbox
+  result = api_instance.get_inbox(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->get_inbox: #{e}"
+end
+```
+
+#### Using the get_inbox_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InboxResponse>, Integer, Hash)> get_inbox_with_http_info(id)
+
+```ruby
+begin
+  # Get an inbox
+  data, status_code, headers = api_instance.get_inbox_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InboxResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->get_inbox_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**InboxResponse**](InboxResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_inbound_emails
 
 > <InboundEmailListResponse> list_inbound_emails(opts)
@@ -233,3 +449,219 @@ end
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## list_inboxes
+
+> <InboxListResponse> list_inboxes
+
+List inboxes
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::InboundEmailApi.new
+
+begin
+  # List inboxes
+  result = api_instance.list_inboxes
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->list_inboxes: #{e}"
+end
+```
+
+#### Using the list_inboxes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InboxListResponse>, Integer, Hash)> list_inboxes_with_http_info
+
+```ruby
+begin
+  # List inboxes
+  data, status_code, headers = api_instance.list_inboxes_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InboxListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->list_inboxes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InboxListResponse**](InboxListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reply_to_inbound_email
+
+> <SendEmailResponse> reply_to_inbound_email(id, reply_to_inbound_email_request, opts)
+
+Reply to a received email
+
+Send a reply to a received email that threads under the original in the recipient's mail client. Zyphr sets `to` (the original sender), the `Re:` subject, and the `In-Reply-To` / `References` headers from the received email; any of those fields in the body are ignored. Everything else behaves exactly like `POST /emails` (`html`/`text`, `send_at`/`delay`, quotas, suppression). Templates are not supported, because a template's own subject would break threading. Quarantined or dropped mail cannot be replied to. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::InboundEmailApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+reply_to_inbound_email_request = Zyphr::ReplyToInboundEmailRequest.new({from: Zyphr::EmailAddress.new}) # ReplyToInboundEmailRequest | 
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | 
+}
+
+begin
+  # Reply to a received email
+  result = api_instance.reply_to_inbound_email(id, reply_to_inbound_email_request, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->reply_to_inbound_email: #{e}"
+end
+```
+
+#### Using the reply_to_inbound_email_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SendEmailResponse>, Integer, Hash)> reply_to_inbound_email_with_http_info(id, reply_to_inbound_email_request, opts)
+
+```ruby
+begin
+  # Reply to a received email
+  data, status_code, headers = api_instance.reply_to_inbound_email_with_http_info(id, reply_to_inbound_email_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SendEmailResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->reply_to_inbound_email_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **reply_to_inbound_email_request** | [**ReplyToInboundEmailRequest**](ReplyToInboundEmailRequest.md) |  |  |
+| **idempotency_key** | **String** |  | [optional] |
+
+### Return type
+
+[**SendEmailResponse**](SendEmailResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_inbox
+
+> <InboxResponse> update_inbox(id, update_inbox_request)
+
+Update an inbox
+
+Rename the inbox or change the display name recipients see. The address cannot change.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::InboundEmailApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+update_inbox_request = Zyphr::UpdateInboxRequest.new # UpdateInboxRequest | 
+
+begin
+  # Update an inbox
+  result = api_instance.update_inbox(id, update_inbox_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->update_inbox: #{e}"
+end
+```
+
+#### Using the update_inbox_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InboxResponse>, Integer, Hash)> update_inbox_with_http_info(id, update_inbox_request)
+
+```ruby
+begin
+  # Update an inbox
+  data, status_code, headers = api_instance.update_inbox_with_http_info(id, update_inbox_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InboxResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->update_inbox_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **update_inbox_request** | [**UpdateInboxRequest**](UpdateInboxRequest.md) |  |  |
+
+### Return type
+
+[**InboxResponse**](InboxResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Inbox.md

@@ -0,0 +1,30 @@
+# Zyphr::Inbox
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **email_address** | **String** | The inbox's receiving address | [optional] |
+| **domain_id** | **String** |  | [optional] |
+| **name** | **String** | Internal name (defaults to the address) | [optional] |
+| **from_name** | **String** | Display name recipients see on replies | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::Inbox.new(
+  id: null,
+  email_address: support@inbound.acme.com,
+  domain_id: null,
+  name: Support,
+  from_name: Acme Support,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/InboxResponse.md

@@ -0,0 +1,20 @@
+# Zyphr::InboxResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Inbox**](Inbox.md) |  | [optional] |
+| **meta** | [**RequestMeta**](RequestMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::InboxResponse.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/ReplyToInboundEmailRequest.md

@@ -0,0 +1,34 @@
+# Zyphr::ReplyToInboundEmailRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | [**EmailAddress**](EmailAddress.md) | Sender, on one of your verified sending domains. The API also accepts a plain email string for convenience.  |  |
+| **html** | **String** |  | [optional] |
+| **text** | **String** |  | [optional] |
+| **reply_to** | **String** |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **classification** | **String** |  | [optional] |
+| **send_at** | **Time** |  | [optional] |
+| **delay** | **Integer** | Seconds to wait before sending | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::ReplyToInboundEmailRequest.new(
+  from: null,
+  html: null,
+  text: null,
+  reply_to: null,
+  tags: null,
+  metadata: null,
+  classification: null,
+  send_at: null,
+  delay: null
+)
+```
+

data/docs/SendEmailRequest.md

@@ -7,6 +7,8 @@
 | **to** | [**Array<EmailAddress>**](EmailAddress.md) | Recipient(s). An array of EmailAddress objects. The API also accepts a single email string or an array of email strings for convenience.  |  |
 | **from** | [**EmailAddress**](EmailAddress.md) | Sender address. The API also accepts a plain email string for convenience.  | [optional] |
 | **reply_to** | [**EmailAddress**](EmailAddress.md) | Reply-to address. The API also accepts a plain email string for convenience.  | [optional] |
+| **in_reply_to** | **String** | RFC 5322 Message-ID of the email this one replies to, e.g. `<abc@example.com>`. Sets the `In-Reply-To` header so the reply threads in the recipient's mail client. To reply to a received email, `POST /inbound-emails/{id}/reply` sets this for you.  | [optional] |
+| **references** | **Array<String>** | RFC 5322 Message-IDs of the thread, oldest first. Sets the `References` header.  | [optional] |
 | **cc** | **Array<String>** | CC recipient email address(es). | [optional] |
 | **bcc** | **Array<String>** | BCC recipient email address(es). | [optional] |
 | **subject** | **String** |  |  |
@@ -31,6 +33,8 @@ instance = Zyphr::SendEmailRequest.new(
   to: [{"email":"user@example.com","name":"John Doe"}],
   from: null,
   reply_to: null,
+  in_reply_to: <010f019efa393e0c@us-east-2.amazonses.com>,
+  references: null,
   cc: null,
   bcc: null,
   subject: Welcome to Zyphr!,

data/docs/UpdateInboxRequest.md

@@ -0,0 +1,20 @@
+# Zyphr::UpdateInboxRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **from_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::UpdateInboxRequest.new(
+  name: null,
+  from_name: null
+)
+```
+