zyphr 0.1.39 → 0.1.40

data/spec/api/muse_api_spec.rb

@@ -1,156 +0,0 @@
-=begin
-#Zyphr API
-
-#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Account Sending Status  Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call:  - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`)  This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message.  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
-
-The version of the OpenAPI document: 1.0.0
-Contact: support@zyphr.dev
-Generated by: https://openapi-generator.tech
-Generator version: 7.12.0
-
-=end
-
-require 'spec_helper'
-require 'json'
-
-# Unit tests for Zyphr::MuseApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'MuseApi' do
-  before do
-    # run before each test
-    @api_instance = Zyphr::MuseApi.new
-  end
-
-  after do
-    # run after each test
-  end
-
-  describe 'test an instance of MuseApi' do
-    it 'should create an instance of MuseApi' do
-      expect(@api_instance).to be_instance_of(Zyphr::MuseApi)
-    end
-  end
-
-  # unit tests for 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). 
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_muse_audit_log_get test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for 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. 
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_muse_broadcasts_analyze_post test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for 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). 
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_muse_entitlement_get test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for 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. 
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_muse_eval_baselines_get test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for v1_muse_settings_project_id_get
-  # 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. 
-  # @param project_id 
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_muse_settings_project_id_get test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for v1_muse_settings_project_id_patch
-  # 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. 
-  # @param project_id 
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_muse_settings_project_id_patch test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for v1_muse_subjects_suggest_post
-  # Suggest 5 ranked subject-line candidates for a template
-  # @param v1_muse_subjects_suggest_post_request 
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_muse_subjects_suggest_post test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for v1_muse_templates_draft_post
-  # Stream a draft template from a natural-language brief
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_muse_templates_draft_post test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for v1_muse_templates_rewrite_post
-  # Stream a rewritten block per the user's instruction
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_muse_templates_rewrite_post test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for 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). 
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_muse_usage_get test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for 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. 
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_muse_workflows_generate_post test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-end