zyphr 0.1.32 → 0.1.34

data/docs/AuthUserProfileApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**delete_end_user**](AuthUserProfileApi.md#delete_end_user) | **DELETE** /auth/users/me | Delete current end user account |
+| [**delete_end_user_by_application**](AuthUserProfileApi.md#delete_end_user_by_application) | **DELETE** /auth/users/{user_id} | Delete an end user (test environment only) |
 | [**get_end_user**](AuthUserProfileApi.md#get_end_user) | **GET** /auth/users/me | Get current end user profile |
 | [**update_end_user**](AuthUserProfileApi.md#update_end_user) | **PATCH** /auth/users/me | Update current end user profile |
 
@@ -80,6 +81,81 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## delete_end_user_by_application
+
+> delete_end_user_by_application(user_id)
+
+Delete an end user (test environment only)
+
+App-credentialed soft-delete for an end user, scoped to the test environment only. Live-mode credentials receive 403 — this is the intentional safety guard against a misconfigured CI runner nuking production users.  Mirrors the self-service `DELETE /auth/users/me` flow: revokes all sessions, soft-deletes the row (status='deleted'), and emits a `user.deleted` webhook with `method='application_admin'`. The audit log row survives (no FK to end_users), so org-history queries still resolve.  Intended for smoke / test-fixture cleanup. Production deletes should continue to use `DELETE /auth/users/me` from the end-user's own session or the dashboard. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = '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-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-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-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthUserProfileApi.new
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Delete an end user (test environment only)
+  api_instance.delete_end_user_by_application(user_id)
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthUserProfileApi->delete_end_user_by_application: #{e}"
+end
+```
+
+#### Using the delete_end_user_by_application_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_end_user_by_application_with_http_info(user_id)
+
+```ruby
+begin
+  # Delete an end user (test environment only)
+  data, status_code, headers = api_instance.delete_end_user_by_application_with_http_info(user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthUserProfileApi->delete_end_user_by_application_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
 ## get_end_user
 
 > <AuthUserResponse> get_end_user

data/docs/CreateOrganizationRequest.md

@@ -0,0 +1,22 @@
+# Zyphr::CreateOrganizationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **slug** | **String** | Optional human-friendly identifier, unique per environment when present. | [optional] |
+| **metadata** | **Object** | Integrator-owned opaque JSON. | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::CreateOrganizationRequest.new(
+  name: Acme Inc,
+  slug: acme,
+  metadata: null
+)
+```
+

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/LoginRequest.md

@@ -7,6 +7,7 @@
 | **email** | **String** |  |  |
 | **password** | **String** |  |  |
 | **custom_claims** | **Hash<String, Object>** | Custom claims to embed in JWT (max 4KB) | [optional] |
+| **organization_id** | **String** | Optional active organization for the resulting token (sc-5591). If specified the user must be a member; the token's org_id is set to it. If omitted and the user has 0 or 1 non-Default memberships, org_id is auto-populated. If 2+ memberships, omit and call switchOrganization to pick. Requires Pro/Enterprise. | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'zyphr'
 instance = Zyphr::LoginRequest.new(
   email: null,
   password: null,
-  custom_claims: null
+  custom_claims: null,
+  organization_id: null
 )
 ```