hushscript 1.0.0__py3-none-any.whl

hushscript/generated/catalog.py

@@ -0,0 +1,138 @@
+# Generated by scripts/generate.py from openapi.json and the conformance hints.json. Do not edit.
+
+from dataclasses import dataclass
+from typing import Final
+
+
+@dataclass(frozen=True, slots=True)
+class ErrorCatalogEntry:
+    code: int
+    status: int
+    meaning: str
+
+
+ERROR_CATALOG: Final[dict[str, ErrorCatalogEntry]] = {
+    "bad_request": ErrorCatalogEntry(1000, 400, "The request body could not be parsed, or a required field was missing. Check the request against this operation's schema and resend."),
+    "invalid_email": ErrorCatalogEntry(1001, 400, "The email address failed format or safety validation (address lists, spoofed display names, control characters and quoted local parts are all rejected). Send a single plain address."),
+    "invalid_password": ErrorCatalogEntry(1002, 400, "The password did not meet the length bounds this API enforces. Choose a password between the documented minimum and maximum byte length."),
+    "missing_token": ErrorCatalogEntry(1003, 400, "No longer emitted: GET /api/auth/verify without a token now redirects to the app with ?error=link_expired instead of returning this JSON error. It stays in the catalog, with its code, slug and status unchanged, for clients that may still key on it."),
+    "invalid_locale": ErrorCatalogEntry(1004, 400, "The requested locale is not one this account or API supports. Use one of the documented locale codes."),
+    "bad_part_number": ErrorCatalogEntry(1005, 400, "The part number is outside the plan for this upload (below 1 or past the last part for the declared size). Recompute the part count from the declared size and part size."),
+    "no_payment_method": ErrorCatalogEntry(1006, 400, "No payment method was available to complete this action. Add or select a saved payment method before retrying."),
+    "malformed_event": ErrorCatalogEntry(1007, 400, "An inbound webhook or event payload could not be parsed or verified. This is not actionable from a normal API client."),
+    "invalid_filename": ErrorCatalogEntry(1020, 422, "No longer emitted: no current route returns this code. It stays in the catalog, with its code, slug and status unchanged, for clients that may still key on it. It used to mean: The uploaded file's name failed validation. Rename the file to remove unsupported characters and retry."),
+    "duration_out_of_range": ErrorCatalogEntry(1021, 422, "The declared or verified duration is shorter than 15 seconds or longer than this API's maximum accepted length of 10 hours. Trim or split the recording before uploading."),
+    "size_out_of_range": ErrorCatalogEntry(1022, 422, "The declared byte size is zero or exceeds this API's maximum accepted upload size. Compress or split the file before uploading."),
+    "part_too_large": ErrorCatalogEntry(1023, 422, "One uploaded part exceeded the maximum part size this API accepts. Resend that part split into smaller chunks."),
+    "size_exceeded": ErrorCatalogEntry(1024, 422, "The bytes received for this upload would exceed the size declared at creation. Start a new upload with the correct declared size."),
+    "no_parts": ErrorCatalogEntry(1025, 422, "The upload was marked complete with no parts recorded. Upload at least one part before calling complete."),
+    "invalid_title": ErrorCatalogEntry(1026, 422, "The provided title exceeded the maximum length or contained disallowed content. Shorten or sanitize the title and retry."),
+    "invalid_speaker_names": ErrorCatalogEntry(1027, 422, "The speaker-name mapping was not valid JSON or exceeded the allowed shape. Send a flat object of speaker label to display name."),
+    "too_many_names": ErrorCatalogEntry(1028, 422, "The speaker-name mapping named more speakers than this API allows on one transcript. Remove entries before retrying."),
+    "invalid_clip": ErrorCatalogEntry(1029, 422, "The preview clip could not be read as audio. Send a supported audio format within the preview size and duration limits."),
+    "clip_too_long": ErrorCatalogEntry(1030, 422, "The preview clip exceeds the maximum preview duration. Trim the clip and retry."),
+    "unsupported_format": ErrorCatalogEntry(1031, 422, "No longer emitted: no current route returns this code. It stays in the catalog, with its code, slug and status unchanged, for clients that may still key on it. It used to mean: The audio container or codec could not be probed by this API. Re-encode to one of the documented supported formats."),
+    "unknown_pack": ErrorCatalogEntry(1032, 422, "The requested pack id does not exist in this account's catalogue. Read GET /v1/billing/packs for the current, valid pack ids."),
+    "invalid_transcription_options": ErrorCatalogEntry(1033, 422, "The transcription_options object failed validation (an unsupported language, an invalid combination of options, or an over-limit field). Re-check each option against its documented bounds."),
+    "invalid_edit": ErrorCatalogEntry(1034, 422, "The submitted transcript edit was not valid for the current body (bad utterance shape or an out-of-range index). Reload the current body before editing."),
+    "too_many_tags": ErrorCatalogEntry(1035, 422, "The request would leave more tags on the transcript than this API allows. Remove existing tags before adding new ones."),
+    "no_speech": ErrorCatalogEntry(1036, 422, "No speech was detected in the submitted audio. Confirm the source file actually contains an audio track with speech."),
+    "url_invalid": ErrorCatalogEntry(1037, 400, "The supplied source URL is not a well-formed https URL. Provide a direct https link to the audio or video file."),
+    "url_blocked": ErrorCatalogEntry(1038, 422, "The supplied URL resolves to a host or address this API refuses to fetch (internal ranges, this API's own storage, or a disallowed host). Use a public, third-party hosted URL instead."),
+    "url_needs_app": ErrorCatalogEntry(1039, 422, "This URL source needs interactive authentication this API cannot perform on the caller's behalf. Download the file yourself and upload the bytes directly instead."),
+    "invalid_idempotency_key": ErrorCatalogEntry(1040, 422, "The supplied idempotency_key was outside the accepted length bounds. Send a key between the documented minimum and maximum length, or omit it."),
+    "upload_incomplete": ErrorCatalogEntry(1041, 422, "The assembled object was shorter than the size declared at creation, so the hold was released and nothing was billed. Re-upload every part and call complete again."),
+    "url_target_busy": ErrorCatalogEntry(1042, 429, "This API is already fetching from that target host as fast as it will, so the fetch was refused before it was attempted. This bounds the target site, not the caller: a different source URL will go through immediately, and the same one will after a short wait."),
+    "policy_version_stale": ErrorCatalogEntry(1043, 422, "accept_terms_version did not match the server's current policy version. The server records its own value, never the caller's, so retry with the current version returned by this same error."),
+    "unauthorized": ErrorCatalogEntry(2000, 401, "The bearer token is missing, malformed, expired, or revoked. This is also the answer for a revoked, malformed, or unknown Personal Access Token, so a caller holding a PAT should mint a fresh one rather than retry the same one. Obtain a fresh session token or Personal Access Token and retry with it in the Authorization header."),
+    "invalid_credentials": ErrorCatalogEntry(2001, 401, "The submitted email/password pair did not match an account. Check the credentials or use the password-reset flow."),
+    "turnstile_failed": ErrorCatalogEntry(2010, 403, "The Cloudflare Turnstile challenge could not be verified. Re-run the challenge on the client and resend with a fresh token."),
+    "country_restricted": ErrorCatalogEntry(2011, 403, "This action is not available from the caller's detected jurisdiction. This is a policy decision, not a transient failure; retrying will not help."),
+    "signup_not_allowed": ErrorCatalogEntry(2012, 403, "New account creation is currently closed for this signup path. Retry later or use an already-provisioned account."),
+    "account_suspended": ErrorCatalogEntry(2013, 403, "The account is suspended, most commonly due to an open payment dispute. Resolve the dispute or contact support before retrying."),
+    "bad_signature": ErrorCatalogEntry(2020, 400, "A cryptographic signature on this request could not be verified. Not reachable from this public API; indicates a caller configuration bug elsewhere in the stack."),
+    "org_required": ErrorCatalogEntry(2021, 403, "This action requires the caller to belong to an organization, and the bearer does not. Join or create an organization first. PATCH /api/org also answers it, writing nothing, when the patch names a field whose right the caller lacks: the billing contact, tax identity and auto_renew need the billing right, every other field the admin right. POST /api/org/invites and PATCH /api/org/members/:user_id answer it too when they hand out or take away the billing right (an invite carrying an explicit is_billing true; a patch naming is_billing) for a caller who does not hold it, except that while no member of the workspace holds the right any admin may grant it (a revoke always needs it). A workspace member removal answers it too when the target holds the billing right and the caller neither holds it nor is that member (a member may always leave; removing a holder needs the right, so the recovery rule above is reachable only after the last holder leaves, revokes their own right, or deletes their account). An invite that leaves is_billing out defaults it to the caller's own right for role admin, so an admin without the billing right inviting an admin sends a plain admin invite and is not refused."),
+    "pat_forbidden": ErrorCatalogEntry(2022, 403, "This route is not in the Personal Access Token scope map at all, so no token, regardless of scope, can reach it. Use a session bearer for this call instead."),
+    "pat_scope_missing": ErrorCatalogEntry(2023, 403, "The Personal Access Token does not carry the scope this route requires (see x-required-scope on the operation). Mint or use a token that includes it."),
+    "step_up_required": ErrorCatalogEntry(2024, 403, "Deleting an account needs proof it is the holder asking. DELETE /api/me carried neither current_password nor email_code, or sent current_password for a password set or changed in the last 7 days, or one the requesting session itself set. Send the current password (set more than 7 days ago, not by this session), or a code sent by POST /api/me/deletion-code."),
+    "card_required": ErrorCatalogEntry(3000, 402, "No longer emitted: no current route returns this code. It stays in the catalog, with its code, slug and status unchanged, for clients that may still key on it. It used to mean: This purchase needs a card on file and the account has none. Add a card through the account's payment settings before retrying."),
+    "insufficient_balance": ErrorCatalogEntry(3001, 402, "The account's balance cannot cover the requested seconds. The error body's needed_seconds and balance_seconds report the shortfall; top up before retrying."),
+    "card_declined": ErrorCatalogEntry(3002, 402, "No longer emitted: no current route returns this code. It stays in the catalog, with its code, slug and status unchanged, for clients that may still key on it. It used to mean: The card on file was declined when charged. Use a different payment method or contact the card issuer."),
+    "org_insufficient_balance": ErrorCatalogEntry(3003, 402, "The organization's shared minute pool cannot cover the requested seconds. The error body's org_balance_seconds reports the pool's current balance; an org admin must top it up."),
+    "not_found": ErrorCatalogEntry(4000, 404, "No resource exists at this id for the authenticated caller. Confirm the id and that it belongs to this account."),
+    "wrong_state": ErrorCatalogEntry(4001, 409, "The target resource is not in a state this action allows (for example, an upload that already finished). Read its current state before retrying."),
+    "email_exists": ErrorCatalogEntry(4002, 409, "An account already exists for this email address. Sign in instead of registering again."),
+    "account_has_active_jobs": ErrorCatalogEntry(4003, 409, "This action cannot proceed while the account has active transcription jobs. Wait for them to finish, or cancel them, then retry."),
+    "ai_already_generated": ErrorCatalogEntry(4004, 409, "No longer emitted: no current route returns this code. It stays in the catalog, with its code, slug and status unchanged, for clients that may still key on it. It used to mean: An Insights bundle already exists for this transcript and this call did not ask for a paid regeneration. Pass a mode to request one."),
+    "promo_already_redeemed": ErrorCatalogEntry(4005, 409, "This promo code has already been redeemed on this account. Each code may be redeemed once per account."),
+    "org_already_member": ErrorCatalogEntry(4006, 409, "Creating an organization: the caller founded another organization that is still unpaid and either is still a member of it or created it less than 7 days ago (one unpaid founded organization at a time; leaving it does not lift the bound inside the 7 days and does after them; belonging to other organizations does not block it). Accepting an invite: the account is already a member of that organization."),
+    "org_plan_inactive": ErrorCatalogEntry(4007, 409, "The organization has no active plan, so its pool cannot fund this action. An org admin must renew the plan."),
+    "org_seat_limit": ErrorCatalogEntry(4008, 409, "The organization is already at its seat limit. Remove a member or increase the plan's seat count before inviting another."),
+    "org_wrong_region": ErrorCatalogEntry(4009, 409, "The target account's data region does not match the organization's region. Cross-region membership is not supported; the user needs an account in the org's region."),
+    "link_expired": ErrorCatalogEntry(4010, 410, "The magic link or similar time-boxed link has expired. Request a new one."),
+    "expired": ErrorCatalogEntry(4011, 410, "The referenced token or session has expired. Request a fresh one and retry."),
+    "invalid_code": ErrorCatalogEntry(4012, 410, "The submitted one-time code does not match what was issued. Re-check the code or request a new one."),
+    "no_pending": ErrorCatalogEntry(4013, 404, "No longer emitted: no current route returns this code. It stays in the catalog, with its code, slug and status unchanged, for clients that may still key on it. It used to mean: There is no pending operation of this kind to act on (for example, no pending export). Start the operation before trying to read its result."),
+    "promo_unavailable": ErrorCatalogEntry(4014, 410, "This promo code is not currently redeemable (expired, not yet active, or exhausted). Check the promotion's terms."),
+    "promo_card_required": ErrorCatalogEntry(4015, 409, "This promo requires a verified card on file before it can be redeemed. Add a card first."),
+    "invoice_not_found": ErrorCatalogEntry(4016, 404, "No invoice exists at this id for the caller's organization. Confirm the invoice id from GET /api/org/invoices."),
+    "org_retention_too_loose": ErrorCatalogEntry(4017, 409, "The requested retention setting exceeds the organization's configured maximum. Request a value at or below the org's ceiling."),
+    "org_plan_invoice_open": ErrorCatalogEntry(4018, 409, "The organization already has an open, unpaid plan invoice. Settle or wait for it to be superseded before requesting another."),
+    "pat_exchange_invalid": ErrorCatalogEntry(4019, 410, "The OAuth handoff exchange code is invalid, already used, or expired. Restart the handoff flow to obtain a new code."),
+    "pat_invalid": ErrorCatalogEntry(4020, 422, "The POST /api/pats request body failed validation: an empty or oversized name, an unknown or empty scope list, created_via outside app or oauth, or an invalid client_label. Fix the request body and retry. A bearer token that is itself malformed, revoked, or unknown never reaches this code; that case answers unauthorized (2000) instead."),
+    "pat_purchase_requires_app": ErrorCatalogEntry(4021, 403, "This purchase needs full Checkout, which this API cannot open or let the caller complete. Either the request had no quick_payment_method_id, in which case resend with one set to a card already on file (see GET /v1/billing/cards), or the saved card will not go through as attempted (declined, needs a different payment method, or was canceled), in which case retrying the same card changes nothing: fix or replace it, then retry with a brand new idempotency_key, or complete the purchase from the Hushscript app. A card whose issuer wants an interactive challenge is not a decline and answers 4023 instead."),
+    "pat_limit": ErrorCatalogEntry(4022, 409, "The account already holds the maximum number of Personal Access Tokens. Revoke an unused token before minting another."),
+    "pat_purchase_requires_authentication": ErrorCatalogEntry(4023, 403, "The saved card is fine, but the issuer wants a challenge (3DS) before this charge can go through. This API cannot open or let the caller complete that challenge, so the purchase is refused rather than left pending. Complete the purchase from the Hushscript app instead, where the holder can go through authentication."),
+    "org_signups_closed": ErrorCatalogEntry(4024, 403, "Creating a new organization is closed in this environment. Signups are open in every environment today, so this answers only where they were deliberately closed again. Existing organizations keep working normally; every other org route, including renewals, pack purchases, invites, and admin reads, stays open."),
+    "org_plan_frozen": ErrorCatalogEntry(4025, 402, "The organization's plan lapsed and its 30 day grace window has also passed, so no new organization funded upload is admitted. A job already running still settles normally. Paying a plan renewal clears the freeze right away."),
+    "org_pool_expired": ErrorCatalogEntry(4026, 402, "The organization's shared minute pool is present but its 365-day rolling clock has lapsed with no purchase, grant, or completed job to renew it. A pack purchase, an included plan grant, or completing another org-funded job all restart the clock for another year."),
+    "org_member_cap_exceeded": ErrorCatalogEntry(4027, 402, "This pool member has used their whole monthly share of the workspace's pooled seconds. The workspace pool itself may still have a balance; this is the per-member cap, separate from a plain insufficient-balance refusal."),
+    "org_renewal_payment_failed": ErrorCatalogEntry(4028, 402, "The daily renewal lane charged the organization's stored renewal card and Stripe answered with a structured failure. The invoice stays issued, the failure count goes up by one, a renewal-failed email carrying a fresh Checkout link for that same invoice is sent (flagged as the final attempt once the count reaches the cap of 3), and the lapsed term falls into the ordinary grace window. Once the cap is reached the lane stops retrying this organization automatically -- no further charge attempts, no further emails -- until the open invoice is paid by hand, which resets the count. GET /api/org exposes this as a derived renewal_capped boolean."),
+    "org_no_default_payment_method": ErrorCatalogEntry(4029, 409, "The chosen payment method is not one of the caller's own saved, fast checkout eligible cards, the caller has no Stripe customer at all, or auto renew was switched on with no renewal card stored yet. All three answer identically so this route can never be used to learn whether a given payment method id exists."),
+    "org_refund_window_closed": ErrorCatalogEntry(4030, 409, "The operator's signed fee-refund command came more than 30 days after the workspace's plan was first paid for, so the plan fee refund window has closed. No customer route returns this code; the fee refund exists only as that operator command. Packs are never refundable and never reach this check."),
+    "org_refund_not_eligible": ErrorCatalogEntry(4031, 409, "The target invoice of the operator's signed fee-refund command is not a paid, unrefunded plan invoice of this workspace, or the workspace already took its one refund. No customer route returns this code; the fee refund exists only as that operator command. Packs are never refundable regardless of this check."),
+    "org_refund_currency_mismatch": ErrorCatalogEntry(4032, 409, "No longer emitted: no current route returns this code. It stays in the catalog, with its code, slug and status unchanged, for clients that may still key on it. The signed admin fee-refund command answers its own currency_mismatch refusal instead. It used to mean: The Stripe charge settled in a currency different from the invoice's currency, so a partial refund amount cannot be computed. Contact support for a manual refund."),
+    "org_tax_id_invalid": ErrorCatalogEntry(4033, 400, "The tax id or its label does not match a shape this system accepts. This is a shape check only, never a registry lookup against a tax authority."),
+    "agent_signup_pending": ErrorCatalogEntry(4035, 409, "A signup already exists for this contact_email and has not yet been claimed, refunded, or expired. Wait for it to resolve or use a different contact address."),
+    "agent_claim_invalid": ErrorCatalogEntry(4036, 401, "The claim secret did not match, or the signup does not exist, has already been claimed, was refunded, or has expired. These cases answer identically on purpose. A confirmed-but-unpaid Checkout Session answers wrong_state (4001) instead once the secret itself has checked out."),
+    "agent_pack_locked": ErrorCatalogEntry(4037, 403, "An agent account's pack tier does not allow the requested pack yet. A fresh agent account is limited to the small packs; a larger pack unlocks only once enough prior payments have settled past the dispute window. Reached on POST /v1/agent/accounts (signup, always tier 0) and POST /v1/billing/purchase for an agent caller. The response carries details.allowed_packs, the pack ids currently buyable; retry with one of those. Never reached by a human account."),
+    "agent_purchase_capped": ErrorCatalogEntry(4038, 429, "An agent account has reached its per-credential spend cap for the current rolling window: 3 purchases, paid or declined, in the trailing 24 hours. The cap is counted per account across every credential the account has ever held, not per token, so rotating a credential does not reset it. Reached on POST /v1/billing/purchase for an agent caller, and for a human account's personal access token caller, which has its own cap of the same size counted the same way. A human purchasing through the app is never capped. The response carries details.limit, details.window_seconds and details.retry_after_seconds, and a Retry-After header naming the same wait in seconds."),
+    "org_last_admin": ErrorCatalogEntry(4039, 409, "A rights change or a member removal would leave the workspace with no member carrying is_admin. This is refused by a count check evaluated inside the update itself, not by a pre-read, so two admins concurrently dropping each other's flag cannot both succeed."),
+    "org_rights_invalid": ErrorCatalogEntry(4040, 422, "The member rights update carried no changed field, or monthly_cap_seconds fell outside the allowed range for a pooled member cap."),
+    "org_custody_unsupported": ErrorCatalogEntry(4043, 409, "The requested custody change is refused: the workspace is already firm custody, a custody switch is already scheduled, or the request asks to move to private custody, which is not reversible once transcripts carry an org_id."),
+    "org_reviewer_required": ErrorCatalogEntry(4044, 403, "The route needs the reviewer right. Carrying the admin flag alone never satisfies it, since the reviewer right is kept deliberately separate."),
+    "org_custodian_required": ErrorCatalogEntry(4045, 409, "Offboarding a member from a firm-custody workspace named no custodian to receive that member's work product."),
+    "org_custodian_invalid": ErrorCatalogEntry(4046, 422, "The named custodian is not a reviewer member of this workspace, or is the member being removed. The admin right does not qualify on its own."),
+    "transcript_legal_hold": ErrorCatalogEntry(4047, 409, "Deletion, an edit (body, translation, cleaned text, revert, retranslate), an AI-output delete or paid regeneration, a retention change or a re-file to another matter was refused because the transcript is under a legal hold, placed by a workspace admin or derived from its matter."),
+    "org_not_member": ErrorCatalogEntry(4048, 403, "The request named a workspace that the caller does not belong to."),
+    "org_matter_code_required": ErrorCatalogEntry(4049, 422, "The workspace sets matter_code_policy to required and the upload carried no matter_code. Send one, or ask a workspace admin to relax the policy."),
+    "org_matter_code_invalid": ErrorCatalogEntry(4050, 422, "matter_code or client_code is longer than 64 characters after trimming. Both are free text fields checked on length alone, and a blank or whitespace-only value is accepted and stored as no code. For a workspace (org) upload, client_code is validated here but the stored value always comes from the resolved matter's client, never from this field; a personal (no org) upload's client_code is stored exactly as sent."),
+    "org_usage_range_invalid": ErrorCatalogEntry(4051, 422, "GET /api/org/usage: from or to is missing, not a positive unix timestamp, reversed, or spans more than 366 days."),
+    "org_usage_group_invalid": ErrorCatalogEntry(4052, 422, "GET /api/org/usage: group_by is present and is not member, matter or client."),
+    "org_rebill_rate_invalid": ErrorCatalogEntry(4053, 422, "PATCH /api/org: rebill_rate_cents_per_hour is negative or above 100000. The rate is report only and never charges anyone."),
+    "org_asset_forbidden": ErrorCatalogEntry(4054, 403, "A workspace dictionary or prompt preset was created, edited or deleted by a member who holds neither the admin nor the reviewer right."),
+    "org_asset_limit": ErrorCatalogEntry(4055, 409, "The workspace already owns the maximum number of dictionaries or prompt presets. Delete one first before creating another."),
+    "org_letterhead_invalid": ErrorCatalogEntry(4056, 422, "PATCH /api/org: letterhead failed shape or length validation. Send null to clear the letterhead instead."),
+    "org_matter_hold_forbidden": ErrorCatalogEntry(4057, 403, "POST or DELETE /api/org/holds/matter from a workspace that is not in firm custody, or from a member without the reviewer right."),
+    "org_matter_hold_empty": ErrorCatalogEntry(4058, 404, "POST /api/org/holds/matter: no workspace transcript carries that matter code, so there was nothing to hold."),
+    "org_refund_term_renewed": ErrorCatalogEntry(4061, 409, "The workspace holds another paid plan term besides the invoice being refunded, so the operator's signed fee-refund command refuses and the refund is handled manually through support. No customer route returns this code; the fee refund exists only as that operator command."),
+    "org_self_grant_refused": ErrorCatalogEntry(4062, 409, "The member rights update targeted the caller's own row and asked for a right the caller does not already hold. Self-revocation, a self-targeted monthly cap change and a self-grant of the reviewer right are still allowed; a self-grant of the billing right is allowed only while no member of the workspace holds it. Otherwise another admin has to grant the right."),
+    "org_matter_not_found": ErrorCatalogEntry(4063, 404, "The matter id named in the request does not exist in this workspace."),
+    "org_matter_code_taken": ErrorCatalogEntry(4064, 409, "Another matter in this workspace already uses that matter code."),
+    "org_matter_closed": ErrorCatalogEntry(4065, 409, "That matter is closed and cannot take new work."),
+    "org_matter_limit": ErrorCatalogEntry(4066, 409, "This workspace has reached its configured matter limit."),
+    "org_client_not_found": ErrorCatalogEntry(4067, 404, "The client id named in the request does not exist in this workspace."),
+    "org_client_code_taken": ErrorCatalogEntry(4068, 409, "Another client in this workspace already uses that client code."),
+    "org_client_closed": ErrorCatalogEntry(4069, 409, "That client is closed, so its matters cannot take new work either."),
+    "org_client_limit": ErrorCatalogEntry(4070, 409, "This workspace has reached its configured client limit."),
+    "deletion_code_invalid": ErrorCatalogEntry(4071, 422, "The email_code sent to DELETE /api/me is wrong, expired, already used, or has had five wrong guesses. Request a new code with POST /api/me/deletion-code."),
+    "rate_limited": ErrorCatalogEntry(5000, 429, "The caller has been rate limited. PAT-authenticated traffic carries a Retry-After header naming the wait in seconds; other rate-limited routes may not."),
+    "too_many_active_jobs": ErrorCatalogEntry(5001, 429, "The account already has the maximum number of concurrent pipeline jobs in flight. Wait for one to finish before starting another."),
+    "ai_cap_reached": ErrorCatalogEntry(5002, 503, "The Insights provider's own capacity is temporarily exhausted. Retry the generation after a short delay."),
+    "preview_daily_limit": ErrorCatalogEntry(5003, 429, "The caller's IP has reached the daily limit for the anonymous preview endpoint. Retry after the daily window resets, or authenticate to use the ordinary upload flow instead."),
+    "provider_error": ErrorCatalogEntry(6001, 502, "The transcription provider returned an error or could not be reached. This is usually transient; retry after a delay."),
+    "stripe_error": ErrorCatalogEntry(6002, 502, "The payment provider returned an error or could not be reached. This is usually transient; retry after a delay."),
+    "email_error": ErrorCatalogEntry(6003, 502, "The transactional email provider could not be reached or refused the message. Not directly actionable by an API caller; the underlying action may still have succeeded."),
+    "internal_error": ErrorCatalogEntry(9000, 500, "An unexpected server-side failure occurred. Retry later; if it persists, it is a bug on the backend, not the request."),
+    "transcript_data_missing": ErrorCatalogEntry(9001, 500, "No longer emitted: no current route returns this code. It stays in the catalog, with its code, slug and status unchanged, for clients that may still key on it. It used to mean: The transcript's stored body could not be found or read where this action expected it. Treat as a transient storage fault and retry, or contact support if it persists."),
+}

hushscript/generated/client.py

@@ -0,0 +1,282 @@
+import ssl
+from typing import Any
+
+from typing_extensions import Self
+
+import httpx
+from attrs import define, evolve, field
+
+
+@define
+class Client:
+    """A class for keeping track of data related to the API
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: httpx.Timeout | None = field(default=None, kw_only=True, alias="timeout")
+    _verify_ssl: str | bool | ssl.SSLContext = field(
+        default=True, kw_only=True, alias="verify_ssl"
+    )
+    _follow_redirects: bool = field(
+        default=False, kw_only=True, alias="follow_redirects"
+    )
+    _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: httpx.Client | None = field(default=None, init=False)
+    _async_client: httpx.AsyncClient | None = field(default=None, init=False)
+
+    def with_headers(self, headers: dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "Client":
+        """Get a new client matching this one with a new timeout configuration"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> Self:
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> Self:
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> Self:
+        """Manually set the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> Self:
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)
+
+
+@define
+class AuthenticatedClient:
+    """A Client which has been authenticated for use on secured endpoints
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+        token: The token to use for authentication
+        prefix: The prefix to use for the Authorization header
+        auth_header_name: The name of the Authorization header
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: httpx.Timeout | None = field(default=None, kw_only=True, alias="timeout")
+    _verify_ssl: str | bool | ssl.SSLContext = field(
+        default=True, kw_only=True, alias="verify_ssl"
+    )
+    _follow_redirects: bool = field(
+        default=False, kw_only=True, alias="follow_redirects"
+    )
+    _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: httpx.Client | None = field(default=None, init=False)
+    _async_client: httpx.AsyncClient | None = field(default=None, init=False)
+
+    token: str
+    prefix: str = "Bearer"
+    auth_header_name: str = "Authorization"
+
+    def with_headers(self, headers: dict[str, str]) -> "AuthenticatedClient":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: dict[str, str]) -> "AuthenticatedClient":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "AuthenticatedClient":
+        """Get a new client matching this one with a new timeout configuration"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> Self:
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._headers[self.auth_header_name] = (
+                f"{self.prefix} {self.token}" if self.prefix else self.token
+            )
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> Self:
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> Self:
+        """Manually set the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._headers[self.auth_header_name] = (
+                f"{self.prefix} {self.token}" if self.prefix else self.token
+            )
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> Self:
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)

hushscript/generated/errors.py

@@ -0,0 +1,16 @@
+"""Contains shared errors types that can be raised from API functions"""
+
+
+class UnexpectedStatus(Exception):
+    """Raised by api functions when the response status an undocumented status and Client.raise_on_unexpected_status is True"""
+
+    def __init__(self, status_code: int, content: bytes):
+        self.status_code = status_code
+        self.content = content
+
+        super().__init__(
+            f"Unexpected status code: {status_code}\n\nResponse content:\n{content.decode(errors='ignore')}"
+        )
+
+
+__all__ = ["UnexpectedStatus"]

hushscript/generated/hints.py

@@ -0,0 +1,28 @@
+# Generated by scripts/generate.py from openapi.json and the conformance hints.json. Do not edit.
+
+from typing import Final
+
+HINTS: Final[dict[str, str]] = {
+    "unauthorized": "Your token is invalid, revoked or expired. Create a new one in the Hushscript app under Account → MCP. Changing your password revokes all tokens.",
+    "pat_scope_missing": "This call needs the \"{scope}\" permission. Create a token that includes it. For billing, the token also needs \"Let this token buy minutes\" turned on when you create it, and \"Let connected apps buy minutes\" must be on in the app under Account → MCP.",
+    "insufficient_balance": "Not enough minutes: {needed} needed, {balance} available. Buy a pack with the SDK's buy method or in the app.",
+    "rate_limited": "Too many requests. The SDK already waited and retried; slow down or try again in {retryAfter} s.",
+    "too_many_active_jobs": "50 jobs are already in progress. Wait for some to finish.",
+    "agent_purchase_capped": "This account has used its 3 purchase attempts for the last 24 hours. Try again in {retryAfter} s.",
+    "agent_pack_locked": "New agent accounts can buy {allowedPacks} until earlier purchases settle.",
+    "pat_purchase_requires_app": "The saved card was declined or can't be charged automatically. Buy this pack in the Hushscript app.",
+    "pat_purchase_requires_authentication": "Your bank wants to confirm this payment. Buy this pack in the Hushscript app.",
+    "no_default_card": "No saved card. Open the add-card link from the SDK's billing methods in a browser, or add a card in the app.",
+    "unsupported_media": "Supported: MP3, M4A/MP4/MOV, WAV, FLAC, OGG/Opus. Convert it first, e.g. ffmpeg -i input -vn -c:a libopus output.opus",
+    "duration_unreadable": "Could not read the file's duration. Pass durationSeconds.",
+    "duration_out_of_range": "Files must be between 15 seconds and 10 hours long.",
+    "size_out_of_range": "Files must be at most 5 GB.",
+    "daily_limit": "This upload would pass your daily transcription limit ({used} of {max} min used in the last 24 h).",
+    "policy_version_stale": "Accept the current terms version: {currentVersion}.",
+    "wrong_state": "The job has already moved on. Fetch the job to see where it is.",
+    "resume_file_mismatch": "This is not the file the upload started with. Pass the original file, or start a new transcription.",
+    "resume_file_required": "The upload was not finished. Pass the original file to resume it.",
+    "resume_job_missing": "This job no longer exists. Start a new transcription.",
+    "stream_size_mismatch": "The stream did not match the size you passed. Pass the exact size in bytes.",
+    "default_card_required": "You have more than one saved card and none is the default. Set a default card with the SDK's billing methods or in the app.",
+}