zyphr 0.1.32 → 0.1.34

data/docs/MuseApi.md

@@ -0,0 +1,681 @@
+# Zyphr::MuseApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_muse_audit_log_get**](MuseApi.md#v1_muse_audit_log_get) | **GET** /v1/muse/audit-log | Paginated per-call audit log for Muse |
+| [**v1_muse_broadcasts_analyze_post**](MuseApi.md#v1_muse_broadcasts_analyze_post) | **POST** /v1/muse/broadcasts/analyze | Stream a pre-send advisory for a draft broadcast |
+| [**v1_muse_entitlement_get**](MuseApi.md#v1_muse_entitlement_get) | **GET** /v1/muse/entitlement | Return the current account's Zyphr Muse entitlement |
+| [**v1_muse_eval_baselines_get**](MuseApi.md#v1_muse_eval_baselines_get) | **GET** /v1/muse/eval-baselines | Per-prompt eval baseline snapshots |
+| [**v1_muse_settings_project_id_get**](MuseApi.md#v1_muse_settings_project_id_get) | **GET** /v1/muse/settings/{project_id} | Read Muse settings for a project |
+| [**v1_muse_settings_project_id_patch**](MuseApi.md#v1_muse_settings_project_id_patch) | **PATCH** /v1/muse/settings/{project_id} | Update Muse settings for a project (admin or developer only) |
+| [**v1_muse_subjects_suggest_post**](MuseApi.md#v1_muse_subjects_suggest_post) | **POST** /v1/muse/subjects/suggest | Suggest 5 ranked subject-line candidates for a template |
+| [**v1_muse_templates_draft_post**](MuseApi.md#v1_muse_templates_draft_post) | **POST** /v1/muse/templates/draft | Stream a draft template from a natural-language brief |
+| [**v1_muse_templates_rewrite_post**](MuseApi.md#v1_muse_templates_rewrite_post) | **POST** /v1/muse/templates/rewrite | Stream a rewritten block per the user's instruction |
+| [**v1_muse_usage_get**](MuseApi.md#v1_muse_usage_get) | **GET** /v1/muse/usage | Per-account Zyphr Muse usage + budget tier |
+| [**v1_muse_workflows_generate_post**](MuseApi.md#v1_muse_workflows_generate_post) | **POST** /v1/muse/workflows/generate | Stream a generated workflow from a natural-language description |
+
+
+## v1_muse_audit_log_get
+
+> v1_muse_audit_log_get
+
+Paginated per-call audit log for Muse
+
+Returns Muse invocations for the caller's account, ordered by most recent first. The request_payload is the PII-scrubbed payload we record at call time; the response payload is NOT returned by this endpoint for size reasons (use the per-row detail endpoint when built). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+
+api_instance = Zyphr::MuseApi.new
+
+begin
+  # Paginated per-call audit log for Muse
+  api_instance.v1_muse_audit_log_get
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_audit_log_get: #{e}"
+end
+```
+
+#### Using the v1_muse_audit_log_get_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)> v1_muse_audit_log_get_with_http_info
+
+```ruby
+begin
+  # Paginated per-call audit log for Muse
+  data, status_code, headers = api_instance.v1_muse_audit_log_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_audit_log_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## v1_muse_broadcasts_analyze_post
+
+> v1_muse_broadcasts_analyze_post
+
+Stream a pre-send advisory for a draft broadcast
+
+Streams Opus tokens then emits a structured advisory covering deliverability risks, frequency conflicts, audience warnings, send-time suggestions, and content notes — plus a single recommended_action so the dashboard can render a CTA without interpreting prose. Advisory is purely advisory — the platform does not block sends on AI output. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+
+api_instance = Zyphr::MuseApi.new
+
+begin
+  # Stream a pre-send advisory for a draft broadcast
+  api_instance.v1_muse_broadcasts_analyze_post
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_broadcasts_analyze_post: #{e}"
+end
+```
+
+#### Using the v1_muse_broadcasts_analyze_post_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)> v1_muse_broadcasts_analyze_post_with_http_info
+
+```ruby
+begin
+  # Stream a pre-send advisory for a draft broadcast
+  data, status_code, headers = api_instance.v1_muse_broadcasts_analyze_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_broadcasts_analyze_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## v1_muse_entitlement_get
+
+> v1_muse_entitlement_get
+
+Return the current account's Zyphr Muse entitlement
+
+Returns whether the caller's account plan unlocks Zyphr Muse, the cheapest plan that would unlock it, and the monthly Bedrock spend cap for the current plan. Available to every authenticated caller (including free accounts). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+
+api_instance = Zyphr::MuseApi.new
+
+begin
+  # Return the current account's Zyphr Muse entitlement
+  api_instance.v1_muse_entitlement_get
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_entitlement_get: #{e}"
+end
+```
+
+#### Using the v1_muse_entitlement_get_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)> v1_muse_entitlement_get_with_http_info
+
+```ruby
+begin
+  # Return the current account's Zyphr Muse entitlement
+  data, status_code, headers = api_instance.v1_muse_entitlement_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_entitlement_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## v1_muse_eval_baselines_get
+
+> v1_muse_eval_baselines_get
+
+Per-prompt eval baseline snapshots
+
+Reads the committed baseline JSON files from src/services/muse/evals/baselines/ and returns them keyed by prompt name. Customers don't see this — it's for the internal Muse settings page / admin portal. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+
+api_instance = Zyphr::MuseApi.new
+
+begin
+  # Per-prompt eval baseline snapshots
+  api_instance.v1_muse_eval_baselines_get
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_eval_baselines_get: #{e}"
+end
+```
+
+#### Using the v1_muse_eval_baselines_get_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)> v1_muse_eval_baselines_get_with_http_info
+
+```ruby
+begin
+  # Per-prompt eval baseline snapshots
+  data, status_code, headers = api_instance.v1_muse_eval_baselines_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_eval_baselines_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## v1_muse_settings_project_id_get
+
+> v1_muse_settings_project_id_get(project_id)
+
+Read Muse settings for a project
+
+Returns the project's Muse settings (cap override, allowed roles, blocked tiers). If no row exists yet, returns synthesized defaults so the caller never sees a 404. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+
+api_instance = Zyphr::MuseApi.new
+project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Read Muse settings for a project
+  api_instance.v1_muse_settings_project_id_get(project_id)
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_settings_project_id_get: #{e}"
+end
+```
+
+#### Using the v1_muse_settings_project_id_get_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)> v1_muse_settings_project_id_get_with_http_info(project_id)
+
+```ruby
+begin
+  # Read Muse settings for a project
+  data, status_code, headers = api_instance.v1_muse_settings_project_id_get_with_http_info(project_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_settings_project_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## v1_muse_settings_project_id_patch
+
+> v1_muse_settings_project_id_patch(project_id)
+
+Update Muse settings for a project (admin or developer only)
+
+Partial update — any omitted field keeps its existing value. Pass `monthly_cap_usd_override: null` to clear an override.  Requires project-level role admin or developer. Account owner/admin cascades. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+
+api_instance = Zyphr::MuseApi.new
+project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Update Muse settings for a project (admin or developer only)
+  api_instance.v1_muse_settings_project_id_patch(project_id)
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_settings_project_id_patch: #{e}"
+end
+```
+
+#### Using the v1_muse_settings_project_id_patch_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)> v1_muse_settings_project_id_patch_with_http_info(project_id)
+
+```ruby
+begin
+  # Update Muse settings for a project (admin or developer only)
+  data, status_code, headers = api_instance.v1_muse_settings_project_id_patch_with_http_info(project_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_settings_project_id_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## v1_muse_subjects_suggest_post
+
+> v1_muse_subjects_suggest_post(v1_muse_subjects_suggest_post_request)
+
+Suggest 5 ranked subject-line candidates for a template
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+
+api_instance = Zyphr::MuseApi.new
+v1_muse_subjects_suggest_post_request = Zyphr::V1MuseSubjectsSuggestPostRequest.new({channel: 'email', project_id: 'project_id_example'}) # V1MuseSubjectsSuggestPostRequest | 
+
+begin
+  # Suggest 5 ranked subject-line candidates for a template
+  api_instance.v1_muse_subjects_suggest_post(v1_muse_subjects_suggest_post_request)
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_subjects_suggest_post: #{e}"
+end
+```
+
+#### Using the v1_muse_subjects_suggest_post_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)> v1_muse_subjects_suggest_post_with_http_info(v1_muse_subjects_suggest_post_request)
+
+```ruby
+begin
+  # Suggest 5 ranked subject-line candidates for a template
+  data, status_code, headers = api_instance.v1_muse_subjects_suggest_post_with_http_info(v1_muse_subjects_suggest_post_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_subjects_suggest_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **v1_muse_subjects_suggest_post_request** | [**V1MuseSubjectsSuggestPostRequest**](V1MuseSubjectsSuggestPostRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## v1_muse_templates_draft_post
+
+> v1_muse_templates_draft_post
+
+Stream a draft template from a natural-language brief
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+
+api_instance = Zyphr::MuseApi.new
+
+begin
+  # Stream a draft template from a natural-language brief
+  api_instance.v1_muse_templates_draft_post
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_templates_draft_post: #{e}"
+end
+```
+
+#### Using the v1_muse_templates_draft_post_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)> v1_muse_templates_draft_post_with_http_info
+
+```ruby
+begin
+  # Stream a draft template from a natural-language brief
+  data, status_code, headers = api_instance.v1_muse_templates_draft_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_templates_draft_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## v1_muse_templates_rewrite_post
+
+> v1_muse_templates_rewrite_post
+
+Stream a rewritten block per the user's instruction
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+
+api_instance = Zyphr::MuseApi.new
+
+begin
+  # Stream a rewritten block per the user's instruction
+  api_instance.v1_muse_templates_rewrite_post
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_templates_rewrite_post: #{e}"
+end
+```
+
+#### Using the v1_muse_templates_rewrite_post_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)> v1_muse_templates_rewrite_post_with_http_info
+
+```ruby
+begin
+  # Stream a rewritten block per the user's instruction
+  data, status_code, headers = api_instance.v1_muse_templates_rewrite_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_templates_rewrite_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## v1_muse_usage_get
+
+> v1_muse_usage_get
+
+Per-account Zyphr Muse usage + budget tier
+
+Current calendar-month spend, plan cap, soft warning tier, and breakdowns by action and model tier. Dashboard polls this for the budget meter; 60s edge-cached via Redis is reasonable but not enforced server-side (lightweight aggregate). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+
+api_instance = Zyphr::MuseApi.new
+
+begin
+  # Per-account Zyphr Muse usage + budget tier
+  api_instance.v1_muse_usage_get
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_usage_get: #{e}"
+end
+```
+
+#### Using the v1_muse_usage_get_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)> v1_muse_usage_get_with_http_info
+
+```ruby
+begin
+  # Per-account Zyphr Muse usage + budget tier
+  data, status_code, headers = api_instance.v1_muse_usage_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_usage_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## v1_muse_workflows_generate_post
+
+> v1_muse_workflows_generate_post
+
+Stream a generated workflow from a natural-language description
+
+Streams Opus tokens then emits a fully-validated workflow JSON object (single root, no cycles, branch_path coherent, all step types valid). Channels referenced by the workflow must appear in the project's available_channels grounding; unsupported channels fall back to email via the prompt's hard rules. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+
+api_instance = Zyphr::MuseApi.new
+
+begin
+  # Stream a generated workflow from a natural-language description
+  api_instance.v1_muse_workflows_generate_post
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_workflows_generate_post: #{e}"
+end
+```
+
+#### Using the v1_muse_workflows_generate_post_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)> v1_muse_workflows_generate_post_with_http_info
+
+```ruby
+begin
+  # Stream a generated workflow from a natural-language description
+  data, status_code, headers = api_instance.v1_muse_workflows_generate_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling MuseApi->v1_muse_workflows_generate_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/Organization.md

@@ -0,0 +1,34 @@
+# Zyphr::Organization
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **application_id** | **String** |  |  |
+| **environment_id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **slug** | **String** | Optional human-friendly identifier, unique per environment when present. | [optional] |
+| **metadata** | **Hash<String, Object>** |  |  |
+| **is_default** | **Boolean** | True for the auto-created Default org per environment. Cannot be renamed or deleted via API. |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::Organization.new(
+  id: null,
+  application_id: null,
+  environment_id: null,
+  name: null,
+  slug: null,
+  metadata: null,
+  is_default: null,
+  created_at: null,
+  updated_at: null
+)
+```
+