zyphr 0.1.19 → 0.1.21

data/docs/AuthEmailType.md

@@ -0,0 +1,15 @@
+# Zyphr::AuthEmailType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::AuthEmailType.new()
+```
+

data/docs/BulkUpsertAuthEmailTemplatesRequest.md

@@ -0,0 +1,22 @@
+# Zyphr::BulkUpsertAuthEmailTemplatesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **magic_link** | [**UpsertAuthEmailTemplateRequest**](UpsertAuthEmailTemplateRequest.md) |  | [optional] |
+| **password_reset** | [**UpsertAuthEmailTemplateRequest**](UpsertAuthEmailTemplateRequest.md) |  | [optional] |
+| **email_verification** | [**UpsertAuthEmailTemplateRequest**](UpsertAuthEmailTemplateRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::BulkUpsertAuthEmailTemplatesRequest.new(
+  magic_link: null,
+  password_reset: null,
+  email_verification: null
+)
+```
+

data/docs/BulkUpsertAuthEmailTemplatesResponse.md

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

data/docs/ResubscribeResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**SuccessResultData**](SuccessResultData.md) |  | [optional] |
+| **data** | [**AuthEmailTemplateDeleteResponseData**](AuthEmailTemplateDeleteResponseData.md) |  | [optional] |
 | **meta** | [**RequestMeta**](RequestMeta.md) |  | [optional] |
 
 ## Example

data/docs/SendSlackMessageRequest.md

@@ -0,0 +1,40 @@
+# Zyphr::SendSlackMessageRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connection_id** | **String** | ID of the Slack connection to send through. Defaults to the project's active connection. | [optional] |
+| **channel** | **String** | Slack channel ID (e.g. `C0123456789`). Falls back to the connection's default channel. | [optional] |
+| **text** | **String** | Message text. Supports Slack markdown when `mrkdwn` is true. | [optional] |
+| **blocks** | **Array<Hash<String, Object>>** | Slack Block Kit blocks for rich formatting. | [optional] |
+| **attachments** | **Array<Hash<String, Object>>** | Slack message attachments (legacy formatting). | [optional] |
+| **thread_ts** | **String** | Thread timestamp to reply in a thread. | [optional] |
+| **reply_broadcast** | **Boolean** | Also post thread replies to the channel. | [optional] |
+| **unfurl_links** | **Boolean** | Enable link previews. | [optional] |
+| **unfurl_media** | **Boolean** | Enable media previews. | [optional] |
+| **mrkdwn** | **Boolean** | Enable Slack markdown processing. | [optional] |
+| **metadata** | **Hash<String, Object>** | Custom metadata to attach to the message. | [optional] |
+| **tags** | **Array<String>** | Tags for message categorisation. | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::SendSlackMessageRequest.new(
+  connection_id: null,
+  channel: C0123456789,
+  text: Deploy completed successfully,
+  blocks: null,
+  attachments: null,
+  thread_ts: null,
+  reply_broadcast: null,
+  unfurl_links: null,
+  unfurl_media: null,
+  mrkdwn: null,
+  metadata: null,
+  tags: null
+)
+```
+

data/docs/SendSlackMessageResponse.md

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

data/docs/SendSlackMessageResult.md

@@ -0,0 +1,28 @@
+# Zyphr::SendSlackMessageResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **channel_id** | **String** |  | [optional] |
+| **message_ts** | **String** |  | [optional] |
+| **status** | [**SlackMessageStatus**](SlackMessageStatus.md) |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **sent_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::SendSlackMessageResult.new(
+  id: null,
+  channel_id: null,
+  message_ts: null,
+  status: null,
+  created_at: null,
+  sent_at: null
+)
+```
+

data/docs/SlackApi.md

@@ -0,0 +1,233 @@
+# Zyphr::SlackApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_slack_message**](SlackApi.md#get_slack_message) | **GET** /slack/messages/{id} | Get a Slack message |
+| [**list_slack_messages**](SlackApi.md#list_slack_messages) | **GET** /slack/messages | List Slack messages |
+| [**send_slack_message**](SlackApi.md#send_slack_message) | **POST** /slack/send | Send a Slack message |
+
+
+## get_slack_message
+
+> <SlackMessageResponse> get_slack_message(id)
+
+Get a Slack message
+
+Retrieve a single Slack message by ID, including its full block/attachment payload and status timestamps.
+
+### 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::SlackApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get a Slack message
+  result = api_instance.get_slack_message(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SlackApi->get_slack_message: #{e}"
+end
+```
+
+#### Using the get_slack_message_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SlackMessageResponse>, Integer, Hash)> get_slack_message_with_http_info(id)
+
+```ruby
+begin
+  # Get a Slack message
+  data, status_code, headers = api_instance.get_slack_message_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SlackMessageResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SlackApi->get_slack_message_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**SlackMessageResponse**](SlackMessageResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_slack_messages
+
+> <SlackMessageListResponse> list_slack_messages(opts)
+
+List Slack messages
+
+List Slack messages sent through the project, with optional filtering by connection, channel, and status.
+
+### 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::SlackApi.new
+opts = {
+  connection_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Filter by Slack connection ID.
+  channel_id: 'channel_id_example', # String | Filter by Slack channel ID.
+  status: 'queued', # String | Filter by message status.
+  limit: 56, # Integer | 
+  offset: 56 # Integer | 
+}
+
+begin
+  # List Slack messages
+  result = api_instance.list_slack_messages(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SlackApi->list_slack_messages: #{e}"
+end
+```
+
+#### Using the list_slack_messages_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SlackMessageListResponse>, Integer, Hash)> list_slack_messages_with_http_info(opts)
+
+```ruby
+begin
+  # List Slack messages
+  data, status_code, headers = api_instance.list_slack_messages_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SlackMessageListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SlackApi->list_slack_messages_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connection_id** | **String** | Filter by Slack connection ID. | [optional] |
+| **channel_id** | **String** | Filter by Slack channel ID. | [optional] |
+| **status** | **String** | Filter by message status. | [optional] |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+
+### Return type
+
+[**SlackMessageListResponse**](SlackMessageListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## send_slack_message
+
+> <SendSlackMessageResponse> send_slack_message(send_slack_message_request)
+
+Send a Slack message
+
+Send a message to a Slack channel through a connected Slack workspace. Either `text` or `blocks` must be provided. If `connection_id` is omitted, the project's active Slack connection is used. If `channel` is omitted, the connection's default channel is used. 
+
+### 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::SlackApi.new
+send_slack_message_request = Zyphr::SendSlackMessageRequest.new # SendSlackMessageRequest | 
+
+begin
+  # Send a Slack message
+  result = api_instance.send_slack_message(send_slack_message_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SlackApi->send_slack_message: #{e}"
+end
+```
+
+#### Using the send_slack_message_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SendSlackMessageResponse>, Integer, Hash)> send_slack_message_with_http_info(send_slack_message_request)
+
+```ruby
+begin
+  # Send a Slack message
+  data, status_code, headers = api_instance.send_slack_message_with_http_info(send_slack_message_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SendSlackMessageResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SlackApi->send_slack_message_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_slack_message_request** | [**SendSlackMessageRequest**](SendSlackMessageRequest.md) |  |  |
+
+### Return type
+
+[**SendSlackMessageResponse**](SendSlackMessageResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/SlackMessage.md

@@ -0,0 +1,50 @@
+# Zyphr::SlackMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **slack_connection_id** | **String** |  | [optional] |
+| **channel_id** | **String** |  | [optional] |
+| **channel_name** | **String** |  | [optional] |
+| **text** | **String** |  | [optional] |
+| **blocks** | **Array<Hash<String, Object>>** |  | [optional] |
+| **attachments** | **Array<Hash<String, Object>>** |  | [optional] |
+| **message_ts** | **String** |  | [optional] |
+| **thread_ts** | **String** |  | [optional] |
+| **status** | [**SlackMessageStatus**](SlackMessageStatus.md) |  | [optional] |
+| **status_reason** | **String** |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **queued_at** | **Time** |  | [optional] |
+| **sent_at** | **Time** |  | [optional] |
+| **failed_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::SlackMessage.new(
+  id: null,
+  slack_connection_id: null,
+  channel_id: null,
+  channel_name: null,
+  text: null,
+  blocks: null,
+  attachments: null,
+  message_ts: null,
+  thread_ts: null,
+  status: null,
+  status_reason: null,
+  tags: null,
+  metadata: null,
+  created_at: null,
+  queued_at: null,
+  sent_at: null,
+  failed_at: null
+)
+```
+

data/docs/SlackMessageListResponse.md

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

data/docs/SlackMessageListResponseMeta.md

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

data/docs/SlackMessageResponse.md

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

data/docs/SlackMessageStatus.md

@@ -0,0 +1,15 @@
+# Zyphr::SlackMessageStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::SlackMessageStatus.new()
+```
+

data/docs/SlackMessageSummary.md

@@ -0,0 +1,38 @@
+# Zyphr::SlackMessageSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **slack_connection_id** | **String** |  | [optional] |
+| **channel_id** | **String** |  | [optional] |
+| **channel_name** | **String** |  | [optional] |
+| **text** | **String** |  | [optional] |
+| **message_ts** | **String** |  | [optional] |
+| **status** | [**SlackMessageStatus**](SlackMessageStatus.md) |  | [optional] |
+| **status_reason** | **String** |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **sent_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::SlackMessageSummary.new(
+  id: null,
+  slack_connection_id: null,
+  channel_id: null,
+  channel_name: null,
+  text: null,
+  message_ts: null,
+  status: null,
+  status_reason: null,
+  tags: null,
+  created_at: null,
+  sent_at: null
+)
+```
+

data/docs/SuccessResult.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**SuccessResultData**](SuccessResultData.md) |  | [optional] |
+| **data** | [**AuthEmailTemplateDeleteResponseData**](AuthEmailTemplateDeleteResponseData.md) |  | [optional] |
 | **meta** | [**RequestMeta**](RequestMeta.md) |  | [optional] |
 
 ## Example

data/docs/UpsertAuthEmailTemplateRequest.md

@@ -0,0 +1,34 @@
+# Zyphr::UpsertAuthEmailTemplateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject** | **String** |  | [optional] |
+| **html** | **String** |  | [optional] |
+| **text** | **String** |  | [optional] |
+| **mjml_source** | **String** |  | [optional] |
+| **design_json** | **Hash<String, Object>** |  | [optional] |
+| **editor_type** | **String** |  | [optional] |
+| **from_name** | **String** |  | [optional] |
+| **reply_to** | **String** |  | [optional] |
+| **is_enabled** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::UpsertAuthEmailTemplateRequest.new(
+  subject: null,
+  html: null,
+  text: null,
+  mjml_source: null,
+  design_json: null,
+  editor_type: null,
+  from_name: null,
+  reply_to: null,
+  is_enabled: null
+)
+```
+