zyphr 0.1.33 → 0.1.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b97a355b1b3ed8acec6bb8fd281575915b1fd1ff645e9bce7946b105909a3923
-  data.tar.gz: 158ef2bc65f0e52255b1b3ed50122334305ddeea220c8c28ed77cb62ab19dbea
+  metadata.gz: f36ed1222d5a3811592b282181dd2f67143e4740fbfe7de4d18df12191ea3850
+  data.tar.gz: 43f947c3f31db15a223c7413363a94c0c0bbf161e59917d648fe56030031fe35
 SHA512:
-  metadata.gz: '078800f631c0017f2b93a2f30d3258439fbb8c0647b132131464072677e37236170e881de4dce27235f4d05d31d2bca9ace1856ae55ed7d910fbf7776e72176f'
-  data.tar.gz: 1dce8ca6758d35c99b0aabfb3a20c3c42347e9315a924b5432532f14846773599ff6769babe238776391e1d3d3cd380d32901e045e3d1ef4e657746b840dd0bb
+  metadata.gz: 9475d1b9bd76ebb758d05850dd196872e08735851fa0ea4cb4ad2ee8860320083411a4d09c0ca2a006770e34f321ed93e936fbc6063731368a5144ac23277fe5
+  data.tar.gz: 0562256d9740f5f67df0facd9d401aed1e7de28e99e43b2124f7cca0dcd78ff6d8d063d486791efb1354294ef0558b34159d88da9c89e71e5f597e1227ac24e7

data/README.md

@@ -209,6 +209,7 @@ Class | Method | HTTP request | Description
 *Zyphr::DomainsApi* | [**get_domain**](docs/DomainsApi.md#get_domain) | **GET** /domains/{id} | Get a sending domain
 *Zyphr::DomainsApi* | [**get_domain_verification_status**](docs/DomainsApi.md#get_domain_verification_status) | **GET** /domains/{id}/verification-status | Get domain verification status
 *Zyphr::DomainsApi* | [**list_domains**](docs/DomainsApi.md#list_domains) | **GET** /domains | List sending domains
+*Zyphr::DomainsApi* | [**set_domain_inbound**](docs/DomainsApi.md#set_domain_inbound) | **PUT** /domains/{id}/inbound | Enable or disable inbound email for a domain
 *Zyphr::DomainsApi* | [**verify_domain**](docs/DomainsApi.md#verify_domain) | **POST** /domains/{id}/verify | Trigger domain verification
 *Zyphr::EmailsApi* | [**get_email**](docs/EmailsApi.md#get_email) | **GET** /emails/{id} | Get email details
 *Zyphr::EmailsApi* | [**get_email_events**](docs/EmailsApi.md#get_email_events) | **GET** /emails/{id}/events | Get email events
@@ -219,6 +220,9 @@ 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* | [**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* | [**list_inbound_emails**](docs/InboundEmailApi.md#list_inbound_emails) | **GET** /inbound-emails | List received emails
 *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
@@ -478,6 +482,14 @@ Class | Method | HTTP request | Description
  - [Zyphr::GetWaaSEndpoint200Response](docs/GetWaaSEndpoint200Response.md)
  - [Zyphr::GetWaaSUsage200Response](docs/GetWaaSUsage200Response.md)
  - [Zyphr::InAppNotification](docs/InAppNotification.md)
+ - [Zyphr::InboundAttachmentUrlResponse](docs/InboundAttachmentUrlResponse.md)
+ - [Zyphr::InboundAttachmentUrlResponseData](docs/InboundAttachmentUrlResponseData.md)
+ - [Zyphr::InboundEmail](docs/InboundEmail.md)
+ - [Zyphr::InboundEmailAttachment](docs/InboundEmailAttachment.md)
+ - [Zyphr::InboundEmailFrom](docs/InboundEmailFrom.md)
+ - [Zyphr::InboundEmailListResponse](docs/InboundEmailListResponse.md)
+ - [Zyphr::InboundEmailListResponseMeta](docs/InboundEmailListResponseMeta.md)
+ - [Zyphr::InboundEmailResponse](docs/InboundEmailResponse.md)
  - [Zyphr::InboxListMeta](docs/InboxListMeta.md)
  - [Zyphr::InboxListResponse](docs/InboxListResponse.md)
  - [Zyphr::InboxNotificationResponse](docs/InboxNotificationResponse.md)
@@ -625,6 +637,7 @@ Class | Method | HTTP request | Description
  - [Zyphr::SessionListResponse](docs/SessionListResponse.md)
  - [Zyphr::SessionListResponseData](docs/SessionListResponseData.md)
  - [Zyphr::SessionListResponseDataSessionInfo](docs/SessionListResponseDataSessionInfo.md)
+ - [Zyphr::SetDomainInboundRequest](docs/SetDomainInboundRequest.md)
  - [Zyphr::SetPreferencesRequest](docs/SetPreferencesRequest.md)
  - [Zyphr::SetPreferencesRequestPreferencesInner](docs/SetPreferencesRequestPreferencesInner.md)
  - [Zyphr::SignInAnonymouslyRequest](docs/SignInAnonymouslyRequest.md)

data/docs/DomainsApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 | [**get_domain**](DomainsApi.md#get_domain) | **GET** /domains/{id} | Get a sending domain |
 | [**get_domain_verification_status**](DomainsApi.md#get_domain_verification_status) | **GET** /domains/{id}/verification-status | Get domain verification status |
 | [**list_domains**](DomainsApi.md#list_domains) | **GET** /domains | List sending domains |
+| [**set_domain_inbound**](DomainsApi.md#set_domain_inbound) | **PUT** /domains/{id}/inbound | Enable or disable inbound email for a domain |
 | [**verify_domain**](DomainsApi.md#verify_domain) | **POST** /domains/{id}/verify | Trigger domain verification |
 
 
@@ -364,6 +365,78 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## set_domain_inbound
+
+> set_domain_inbound(id, set_domain_inbound_request)
+
+Enable or disable inbound email for a domain
+
+Toggle email receiving for a domain. When enabled, the domain's DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+). 
+
+### 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::DomainsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+set_domain_inbound_request = Zyphr::SetDomainInboundRequest.new # SetDomainInboundRequest | 
+
+begin
+  # Enable or disable inbound email for a domain
+  api_instance.set_domain_inbound(id, set_domain_inbound_request)
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->set_domain_inbound: #{e}"
+end
+```
+
+#### Using the set_domain_inbound_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)> set_domain_inbound_with_http_info(id, set_domain_inbound_request)
+
+```ruby
+begin
+  # Enable or disable inbound email for a domain
+  data, status_code, headers = api_instance.set_domain_inbound_with_http_info(id, set_domain_inbound_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->set_domain_inbound_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **set_domain_inbound_request** | [**SetDomainInboundRequest**](SetDomainInboundRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
 ## verify_domain
 
 > <VerifyDomainResponse> verify_domain(id)

data/docs/InboundAttachmentUrlResponse.md

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

data/docs/InboundAttachmentUrlResponseData.md

@@ -0,0 +1,22 @@
+# Zyphr::InboundAttachmentUrlResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **download_url** | **String** | Short-lived presigned S3 download URL | [optional] |
+| **filename** | **String** |  | [optional] |
+| **content_type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::InboundAttachmentUrlResponseData.new(
+  download_url: null,
+  filename: null,
+  content_type: null
+)
+```
+

data/docs/InboundEmail.md

@@ -0,0 +1,48 @@
+# Zyphr::InboundEmail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **to_email** | **String** | The receiving address the mail was sent to | [optional] |
+| **from** | [**InboundEmailFrom**](InboundEmailFrom.md) |  | [optional] |
+| **cc** | **Array<String>** |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **text_body** | **String** |  | [optional] |
+| **html_body** | **String** |  | [optional] |
+| **in_reply_to** | **String** | RFC Message-ID this is a reply to, if any | [optional] |
+| **replied_to_message_id** | **String** | Resolved outbound message this is a reply to, if correlated | [optional] |
+| **verified** | **Boolean** | False when SPF or DMARC failed — treat the sender as unverified | [optional] |
+| **spf_verdict** | **String** |  | [optional] |
+| **dkim_verdict** | **String** |  | [optional] |
+| **dmarc_verdict** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **attachments** | [**Array<InboundEmailAttachment>**](InboundEmailAttachment.md) |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::InboundEmail.new(
+  id: null,
+  to_email: support@inbound.acme.com,
+  from: null,
+  cc: null,
+  subject: null,
+  text_body: null,
+  html_body: null,
+  in_reply_to: null,
+  replied_to_message_id: null,
+  verified: null,
+  spf_verdict: null,
+  dkim_verdict: null,
+  dmarc_verdict: null,
+  status: null,
+  attachments: null,
+  created_at: null
+)
+```
+

data/docs/InboundEmailApi.md

@@ -0,0 +1,235 @@
+# Zyphr::InboundEmailApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**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 |
+| [**list_inbound_emails**](InboundEmailApi.md#list_inbound_emails) | **GET** /inbound-emails | List received emails |
+
+
+## get_inbound_attachment_url
+
+> <InboundAttachmentUrlResponse> get_inbound_attachment_url(id, attachment_id)
+
+Get an attachment download URL
+
+Return a short-lived presigned S3 download URL for one attachment of a received email. `attachmentId` is the positional id from the email's `attachments` array. 
+
+### 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 | 
+attachment_id = 'attachment_id_example' # String | 
+
+begin
+  # Get an attachment download URL
+  result = api_instance.get_inbound_attachment_url(id, attachment_id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->get_inbound_attachment_url: #{e}"
+end
+```
+
+#### Using the get_inbound_attachment_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InboundAttachmentUrlResponse>, Integer, Hash)> get_inbound_attachment_url_with_http_info(id, attachment_id)
+
+```ruby
+begin
+  # Get an attachment download URL
+  data, status_code, headers = api_instance.get_inbound_attachment_url_with_http_info(id, attachment_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InboundAttachmentUrlResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->get_inbound_attachment_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **attachment_id** | **String** |  |  |
+
+### Return type
+
+[**InboundAttachmentUrlResponse**](InboundAttachmentUrlResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_inbound_email
+
+> <InboundEmailResponse> get_inbound_email(id)
+
+Get a received email
+
+Retrieve a single inbound email by id (scoped to the project).
+
+### 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 a received email
+  result = api_instance.get_inbound_email(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->get_inbound_email: #{e}"
+end
+```
+
+#### Using the get_inbound_email_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InboundEmailResponse>, Integer, Hash)> get_inbound_email_with_http_info(id)
+
+```ruby
+begin
+  # Get a received email
+  data, status_code, headers = api_instance.get_inbound_email_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InboundEmailResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->get_inbound_email_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**InboundEmailResponse**](InboundEmailResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_inbound_emails
+
+> <InboundEmailListResponse> list_inbound_emails(opts)
+
+List received emails
+
+List inbound (received) emails for the project, newest first. By default only delivered mail (`received`/`processed`) is returned; pass `include_withheld=true` to also see quarantined/dropped. 
+
+### 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
+opts = {
+  status: 'received', # String | 
+  to: 'to_example', # String | Filter by receiving address
+  include_withheld: true, # Boolean | Include quarantined/dropped mail
+  limit: 56, # Integer | 
+  offset: 56 # Integer | 
+}
+
+begin
+  # List received emails
+  result = api_instance.list_inbound_emails(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->list_inbound_emails: #{e}"
+end
+```
+
+#### Using the list_inbound_emails_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InboundEmailListResponse>, Integer, Hash)> list_inbound_emails_with_http_info(opts)
+
+```ruby
+begin
+  # List received emails
+  data, status_code, headers = api_instance.list_inbound_emails_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InboundEmailListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboundEmailApi->list_inbound_emails_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **to** | **String** | Filter by receiving address | [optional] |
+| **include_withheld** | **Boolean** | Include quarantined/dropped mail | [optional] |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+
+### Return type
+
+[**InboundEmailListResponse**](InboundEmailListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/InboundEmailAttachment.md

@@ -0,0 +1,24 @@
+# Zyphr::InboundEmailAttachment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Positional attachment id, used in the attachment download endpoint | [optional] |
+| **filename** | **String** |  | [optional] |
+| **content_type** | **String** |  | [optional] |
+| **size** | **Integer** | Size in bytes | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::InboundEmailAttachment.new(
+  id: 0,
+  filename: invoice.pdf,
+  content_type: application/pdf,
+  size: 84210
+)
+```
+

data/docs/InboundEmailFrom.md

@@ -0,0 +1,20 @@
+# Zyphr::InboundEmailFrom
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::InboundEmailFrom.new(
+  email: customer@example.com,
+  name: Customer Name
+)
+```
+

data/docs/InboundEmailListResponse.md

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

data/docs/InboundEmailListResponseMeta.md

@@ -0,0 +1,24 @@
+# Zyphr::InboundEmailListResponseMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::InboundEmailListResponseMeta.new(
+  request_id: null,
+  total: null,
+  limit: null,
+  offset: null
+)
+```
+

data/docs/InboundEmailResponse.md

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

data/docs/SetDomainInboundRequest.md

@@ -0,0 +1,18 @@
+# Zyphr::SetDomainInboundRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::SetDomainInboundRequest.new(
+  enabled: null
+)
+```
+

data/lib/zyphr/api/domains_api.rb

@@ -333,6 +333,78 @@ module Zyphr
       return data, status_code, headers
     end
 
+    # Enable or disable inbound email for a domain
+    # Toggle email receiving for a domain. When enabled, the domain's DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+). 
+    # @param id [String] 
+    # @param set_domain_inbound_request [SetDomainInboundRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def set_domain_inbound(id, set_domain_inbound_request, opts = {})
+      set_domain_inbound_with_http_info(id, set_domain_inbound_request, opts)
+      nil
+    end
+
+    # Enable or disable inbound email for a domain
+    # Toggle email receiving for a domain. When enabled, the domain's DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+). 
+    # @param id [String] 
+    # @param set_domain_inbound_request [SetDomainInboundRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def set_domain_inbound_with_http_info(id, set_domain_inbound_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainsApi.set_domain_inbound ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.set_domain_inbound"
+      end
+      # verify the required parameter 'set_domain_inbound_request' is set
+      if @api_client.config.client_side_validation && set_domain_inbound_request.nil?
+        fail ArgumentError, "Missing the required parameter 'set_domain_inbound_request' when calling DomainsApi.set_domain_inbound"
+      end
+      # resource path
+      local_var_path = '/domains/{id}/inbound'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(set_domain_inbound_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"DomainsApi.set_domain_inbound",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DomainsApi#set_domain_inbound\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Trigger domain verification
     # Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships.  Returns 409 if a verification is already in progress for this domain (within the last 2 minutes). 
     # @param id [String]