{
  "components": {
    "responses": {
      "BadRequest": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorEnvelope"
            }
          }
        },
        "description": "The request cannot be read or is refused as sent, for example invalid_request."
      },
      "Conflict": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorEnvelope"
            }
          }
        },
        "description": "The resource is in a state that refuses the call. A state with a code of its own is named by error.code, for example quote_expired. Otherwise error.code is conflict and error.message says what is in the way. idempotency_key_conflict: the Idempotency-Key was used with a different request, or that request is still being processed."
      },
      "Forbidden": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorEnvelope"
            }
          }
        },
        "description": "The credential is valid and is not allowed to do this. scope_missing puts the scope in error.details.scope. Other codes are agent_forbidden and approval_required. A session can also meet csrf_invalid and reauth_required."
      },
      "Gone": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorEnvelope"
            }
          }
        },
        "description": "organization_deleted: the organization is being deleted, so the call is refused."
      },
      "NotFound": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorEnvelope"
            }
          }
        },
        "description": "not_found: no such resource for this credential. A resource of another organization answers the same."
      },
      "PayloadTooLarge": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorEnvelope"
            }
          }
        },
        "description": "The body is larger than the limit of this call: payload_too_large."
      },
      "PaymentRequired": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorEnvelope"
            }
          }
        },
        "description": "The prepaid balance does not cover the call: insufficient_balance."
      },
      "ServiceUnavailable": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorEnvelope"
            }
          }
        },
        "description": "Something this call depends on is not available or not set up here, for example billing_unavailable or provider_unavailable. error.retryable says whether to send the same call again."
      },
      "TooManyRequests": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorEnvelope"
            }
          }
        },
        "description": "rate_limited. Retry-After and the RateLimit-* headers say when to try again."
      },
      "Unauthorized": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorEnvelope"
            }
          }
        },
        "description": "No credential, or one that was not accepted: invalid_token for an API key, unauthenticated where a signed-in session is needed. error.details.reason says why a key was refused."
      },
      "UnprocessableContent": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorEnvelope"
            }
          }
        },
        "description": "A field failed validation: invalid_request, with one entry per field in error.details, or a code that names the rule."
      }
    },
    "schemas": {
      "Accepted": {
        "additionalProperties": true,
        "properties": {
          "organization": {
            "$ref": "#/components/schemas/OrganizationSummary"
          }
        },
        "required": [
          "organization"
        ],
        "title": "Accepted",
        "type": "object"
      },
      "Agent": {
        "additionalProperties": true,
        "properties": {
          "archived_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Set on an archived agent: disabled for good and left out of the list.",
            "title": "Archived At"
          },
          "budget_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Budget Id"
          },
          "budgets": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Budgets",
            "type": "array"
          },
          "contact_email": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Contact Email"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "created_by": {
            "title": "Created By",
            "type": "string"
          },
          "disabled_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Disabled At"
          },
          "enabled": {
            "title": "Enabled",
            "type": "boolean"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "keys": {
            "items": {
              "$ref": "#/components/schemas/ApiKey"
            },
            "title": "Keys",
            "type": "array"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "policy_ids": {
            "items": {
              "type": "string"
            },
            "title": "Policy Ids",
            "type": "array"
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Project Id"
          },
          "purpose": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Purpose"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "updated_at": {
            "title": "Updated At",
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "purpose",
          "enabled",
          "status",
          "project_id",
          "policy_ids",
          "contact_email",
          "budget_id",
          "budgets",
          "keys",
          "created_by",
          "created_at",
          "updated_at",
          "disabled_at"
        ],
        "title": "Agent",
        "type": "object"
      },
      "AgentActivity": {
        "additionalProperties": true,
        "properties": {
          "action": {
            "title": "Action",
            "type": "string"
          },
          "actor": {
            "title": "Actor",
            "type": "string"
          },
          "actor_label": {
            "default": "unknown",
            "description": "The actor in words: a member's email, the agent's name, an API key's prefix.",
            "title": "Actor Label",
            "type": "string"
          },
          "correlation_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Correlation Id"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "data": {
            "additionalProperties": true,
            "title": "Data",
            "type": "object"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "resource_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Resource Id"
          },
          "resource_type": {
            "title": "Resource Type",
            "type": "string"
          }
        },
        "required": [
          "id",
          "actor",
          "action",
          "resource_type",
          "resource_id",
          "data",
          "correlation_id",
          "created_at"
        ],
        "title": "AgentActivity",
        "type": "object"
      },
      "AgentActivityPage": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/AgentActivity"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          }
        },
        "required": [
          "items"
        ],
        "title": "AgentActivityPage",
        "type": "object"
      },
      "AgentArchived": {
        "additionalProperties": true,
        "description": "What archiving an agent did: it is disabled for good and out of the list, and its keys are revoked.",
        "properties": {
          "archived": {
            "title": "Archived",
            "type": "boolean"
          },
          "deleted": {
            "description": "Always false: an agent has history and its row is kept.",
            "title": "Deleted",
            "type": "boolean"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "keys_revoked": {
            "title": "Keys Revoked",
            "type": "integer"
          }
        },
        "required": [
          "id",
          "deleted",
          "archived",
          "keys_revoked"
        ],
        "title": "AgentArchived",
        "type": "object"
      },
      "AgentCreate": {
        "additionalProperties": false,
        "properties": {
          "contact_email": {
            "anyOf": [
              {
                "format": "email",
                "maxLength": 254,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Where decided approvals are mailed.",
            "title": "Contact Email"
          },
          "name": {
            "maxLength": 120,
            "minLength": 1,
            "title": "Name",
            "type": "string"
          },
          "policy_ids": {
            "items": {
              "type": "string"
            },
            "title": "Policy Ids",
            "type": "array"
          },
          "purpose": {
            "anyOf": [
              {
                "maxLength": 500,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Shown to humans, never evaluated.",
            "title": "Purpose"
          }
        },
        "required": [
          "name"
        ],
        "title": "AgentCreate",
        "type": "object"
      },
      "AgentKeyCreate": {
        "additionalProperties": false,
        "properties": {
          "environment": {
            "default": "test",
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "expires_in_days": {
            "anyOf": [
              {
                "maximum": 3650,
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expires In Days"
          },
          "label": {
            "default": "agent key",
            "maxLength": 120,
            "minLength": 1,
            "title": "Label",
            "type": "string"
          },
          "scopes": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Omit for the default agent set. Never approval:decide, key:admin, policy:admin, agent:admin.",
            "title": "Scopes"
          }
        },
        "title": "AgentKeyCreate",
        "type": "object"
      },
      "AgentList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Agent"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "AgentList",
        "type": "object"
      },
      "AgentUpdate": {
        "additionalProperties": false,
        "properties": {
          "contact_email": {
            "anyOf": [
              {
                "format": "email",
                "maxLength": 254,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Contact Email"
          },
          "enabled": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "description": "false revokes every key of the agent.",
            "title": "Enabled"
          },
          "name": {
            "anyOf": [
              {
                "maxLength": 120,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Name"
          },
          "policy_ids": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Policy Ids"
          },
          "purpose": {
            "anyOf": [
              {
                "maxLength": 500,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Purpose"
          }
        },
        "title": "AgentUpdate",
        "type": "object"
      },
      "AlreadyAllowed": {
        "additionalProperties": true,
        "description": "A number of a draft's allowed_destinations that one of its countries or prefixes already allows.",
        "properties": {
          "countries": {
            "description": "The listed countries whose route serves this number.",
            "items": {
              "type": "string"
            },
            "title": "Countries",
            "type": "array"
          },
          "number": {
            "title": "Number",
            "type": "string"
          },
          "prefixes": {
            "description": "The listed prefixes this number's route carries.",
            "items": {
              "type": "string"
            },
            "title": "Prefixes",
            "type": "array"
          }
        },
        "required": [
          "number",
          "countries",
          "prefixes"
        ],
        "title": "AlreadyAllowed",
        "type": "object"
      },
      "ApiKey": {
        "additionalProperties": true,
        "properties": {
          "agent_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Agent Id"
          },
          "connected_app": {
            "default": false,
            "description": "The key belongs to a connected app used over stdio, such as the Gemini CLI extension. The organization's auto-send setting (Settings, Connected apps) binds it like an OAuth connection.",
            "title": "Connected App",
            "type": "boolean"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expires At"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "label": {
            "title": "Label",
            "type": "string"
          },
          "last_used_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last Used At"
          },
          "prefix": {
            "title": "Prefix",
            "type": "string"
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Project Id"
          },
          "revoked_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Revoked At"
          },
          "rotated_from_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rotated From Id"
          },
          "scopes": {
            "items": {
              "type": "string"
            },
            "title": "Scopes",
            "type": "array"
          }
        },
        "required": [
          "id",
          "label",
          "prefix",
          "environment",
          "project_id",
          "agent_id",
          "scopes",
          "created_at",
          "last_used_at",
          "expires_at",
          "revoked_at",
          "rotated_from_id"
        ],
        "title": "ApiKey",
        "type": "object"
      },
      "ApiKeyCreate": {
        "additionalProperties": false,
        "properties": {
          "connected_app": {
            "default": false,
            "description": "This key is for a connected app such as the Gemini CLI extension: the auto-send setting binds it. Not available on an agent's key.",
            "title": "Connected App",
            "type": "boolean"
          },
          "environment": {
            "default": "test",
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "expires_in_days": {
            "anyOf": [
              {
                "maximum": 3650,
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expires In Days"
          },
          "label": {
            "maxLength": 120,
            "minLength": 1,
            "title": "Label",
            "type": "string"
          },
          "scopes": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Omit for the default agent set; '*' for all.",
            "title": "Scopes"
          }
        },
        "required": [
          "label"
        ],
        "title": "ApiKeyCreate",
        "type": "object"
      },
      "ApiKeyList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiKey"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "ApiKeyList",
        "type": "object"
      },
      "ApiKeyWithSecret": {
        "additionalProperties": true,
        "properties": {
          "agent_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Agent Id"
          },
          "connected_app": {
            "default": false,
            "description": "The key belongs to a connected app used over stdio, such as the Gemini CLI extension. The organization's auto-send setting (Settings, Connected apps) binds it like an OAuth connection.",
            "title": "Connected App",
            "type": "boolean"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expires At"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "label": {
            "title": "Label",
            "type": "string"
          },
          "last_used_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last Used At"
          },
          "prefix": {
            "title": "Prefix",
            "type": "string"
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Project Id"
          },
          "revoked_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Revoked At"
          },
          "rotated_from_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rotated From Id"
          },
          "scopes": {
            "items": {
              "type": "string"
            },
            "title": "Scopes",
            "type": "array"
          },
          "secret": {
            "description": "Shown once. Store it now; it cannot be read back.",
            "title": "Secret",
            "type": "string"
          }
        },
        "required": [
          "id",
          "label",
          "prefix",
          "environment",
          "project_id",
          "agent_id",
          "scopes",
          "created_at",
          "last_used_at",
          "expires_at",
          "revoked_at",
          "rotated_from_id",
          "secret"
        ],
        "title": "ApiKeyWithSecret",
        "type": "object"
      },
      "ApprovalDecision": {
        "additionalProperties": false,
        "properties": {
          "reason": {
            "anyOf": [
              {
                "maxLength": 500,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reason"
          }
        },
        "title": "ApprovalDecision",
        "type": "object"
      },
      "ApprovalDocument": {
        "additionalProperties": true,
        "description": "The document a send request binds, as it is now: its name, its pages and whether a send can use it.",
        "properties": {
          "filename": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The file's name; null when the document row is gone.",
            "title": "Filename"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "page_count": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Page Count"
          },
          "state": {
            "description": "available: the document is the one the request binds. deleted: it was deleted. changed: its sha256 is no longer the bound one. A send with this approval is refused in the last two.",
            "enum": [
              "available",
              "deleted",
              "changed"
            ],
            "title": "State",
            "type": "string"
          }
        },
        "required": [
          "id",
          "filename",
          "page_count",
          "state"
        ],
        "title": "ApprovalDocument",
        "type": "object"
      },
      "ApprovalRequest": {
        "additionalProperties": true,
        "properties": {
          "bound": {
            "additionalProperties": true,
            "title": "Bound",
            "type": "object"
          },
          "consumed_by_job_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Consumed By Job Id"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "decided_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Decided At"
          },
          "decided_by": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Decided By"
          },
          "decided_by_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The decider, named the same way.",
            "title": "Decided By Name"
          },
          "document": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ApprovalDocument"
              },
              {
                "type": "null"
              }
            ],
            "description": "The document a send request binds (bound.document_id). null for a help request."
          },
          "expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expires At"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "kind": {
            "enum": [
              "send",
              "help"
            ],
            "title": "Kind",
            "type": "string"
          },
          "message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Message"
          },
          "notified": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "description": "On creation: whether the organization was mailed. false when the request repeats a pending one or the organization's daily cap of request mails is reached; the request is still shown in the dashboard.",
            "title": "Notified"
          },
          "quote_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Quote Id"
          },
          "reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reason"
          },
          "requested_by": {
            "title": "Requested By",
            "type": "string"
          },
          "requested_by_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The requester as people read it: the key's label, the agent's name, the connected app's name or the person's address. null when the actor has no row in the organization any more.",
            "title": "Requested By Name"
          },
          "status": {
            "enum": [
              "pending",
              "approved",
              "rejected",
              "revoked",
              "expired"
            ],
            "title": "Status",
            "type": "string"
          }
        },
        "required": [
          "id",
          "kind",
          "status",
          "quote_id",
          "bound",
          "message",
          "requested_by",
          "decided_by",
          "reason",
          "consumed_by_job_id",
          "created_at",
          "expires_at",
          "decided_at"
        ],
        "title": "ApprovalRequest",
        "type": "object"
      },
      "ApprovalRequestCreate": {
        "additionalProperties": false,
        "properties": {
          "fax_job_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Fax Job Id"
          },
          "kind": {
            "default": "send",
            "enum": [
              "send",
              "help"
            ],
            "title": "Kind",
            "type": "string"
          },
          "message": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "What the person should know (kind help). Shown as data.",
            "title": "Message"
          },
          "quote_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The quote to bind (kind send).",
            "title": "Quote Id"
          }
        },
        "title": "ApprovalRequestCreate",
        "type": "object"
      },
      "ApprovalRequestPage": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApprovalRequest"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          }
        },
        "required": [
          "items"
        ],
        "title": "ApprovalRequestPage",
        "type": "object"
      },
      "Attempt": {
        "additionalProperties": true,
        "properties": {
          "attempt_number": {
            "title": "Attempt Number",
            "type": "integer"
          },
          "error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error"
          },
          "evidence": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Evidence"
          },
          "failure_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Failure Code"
          },
          "fax_job_id": {
            "title": "Fax Job Id",
            "type": "string"
          },
          "finished_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Finished At"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "pages_sent": {
            "title": "Pages Sent",
            "type": "integer"
          },
          "provider": {
            "title": "Provider",
            "type": "string"
          },
          "provider_ref": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Provider Ref"
          },
          "started_at": {
            "title": "Started At",
            "type": "string"
          },
          "status": {
            "title": "Status",
            "type": "string"
          }
        },
        "required": [
          "id",
          "fax_job_id",
          "attempt_number",
          "provider",
          "provider_ref",
          "status",
          "pages_sent",
          "failure_code",
          "evidence",
          "error",
          "started_at",
          "finished_at"
        ],
        "title": "Attempt",
        "type": "object"
      },
      "AttemptPage": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Attempt"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "AttemptPage",
        "type": "object"
      },
      "AutoSendSetting": {
        "additionalProperties": true,
        "description": "The organization's auto-send setting for one environment: Settings, Connected apps, \"Let connected\napps send without asking\". Stored as the managed policy ``policy_id``. The setting is described at\nhttps://faxforagents.com/docs/chatgpt-send-within-limits/.",
        "properties": {
          "daily_max_jobs": {
            "description": "Faxes per UTC day, at most, across every connected app.",
            "title": "Daily Max Jobs",
            "type": "integer"
          },
          "enabled": {
            "title": "Enabled",
            "type": "boolean"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "max_amount_micro": {
            "description": "Amount per fax, at most, in micro-units of USD.",
            "title": "Max Amount Micro",
            "type": "integer"
          },
          "policy_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The managed policy; null before the first enable.",
            "title": "Policy Id"
          },
          "version": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Version"
          }
        },
        "required": [
          "environment",
          "enabled",
          "max_amount_micro",
          "daily_max_jobs",
          "policy_id",
          "version"
        ],
        "title": "AutoSendSetting",
        "type": "object"
      },
      "AutoSendUpdate": {
        "additionalProperties": false,
        "properties": {
          "daily_max_jobs": {
            "default": 20,
            "description": "Faxes per UTC day.",
            "maximum": 100000,
            "minimum": 1,
            "title": "Daily Max Jobs",
            "type": "integer"
          },
          "enabled": {
            "title": "Enabled",
            "type": "boolean"
          },
          "max_amount_micro": {
            "default": 5000000,
            "description": "Amount per fax, at most, in micro-units of USD (5000000 = $5.00).",
            "maximum": 1000000000000,
            "minimum": 0,
            "title": "Max Amount Micro",
            "type": "integer"
          }
        },
        "required": [
          "enabled"
        ],
        "title": "AutoSendUpdate",
        "type": "object"
      },
      "AutoTopup": {
        "additionalProperties": true,
        "properties": {
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "daily_cap_micro": {
            "title": "Daily Cap Micro",
            "type": "integer"
          },
          "disabled_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Disabled At"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "last_attempt_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last Attempt At"
          },
          "payment_method_saved": {
            "title": "Payment Method Saved",
            "type": "boolean"
          },
          "setup_session_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Setup Session Id"
          },
          "setup_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Where to save the card while status is pending_setup.",
            "title": "Setup Url"
          },
          "status": {
            "enum": [
              "pending_setup",
              "active",
              "disabled"
            ],
            "title": "Status",
            "type": "string"
          },
          "threshold_micro": {
            "title": "Threshold Micro",
            "type": "integer"
          },
          "updated_at": {
            "title": "Updated At",
            "type": "string"
          }
        },
        "required": [
          "id",
          "environment",
          "status",
          "threshold_micro",
          "amount_micro",
          "daily_cap_micro",
          "payment_method_saved",
          "setup_session_id",
          "created_at",
          "updated_at",
          "last_attempt_at",
          "disabled_at"
        ],
        "title": "AutoTopup",
        "type": "object"
      },
      "AutoTopupCreate": {
        "additionalProperties": false,
        "properties": {
          "amount_micro": {
            "description": "Whole dollars, 10 to 1000 USD.",
            "maximum": 1000000000,
            "minimum": 10000000,
            "title": "Amount Micro",
            "type": "integer"
          },
          "daily_cap_micro": {
            "description": "Never more than this per UTC day.",
            "minimum": 10000000,
            "title": "Daily Cap Micro",
            "type": "integer"
          },
          "threshold_micro": {
            "description": "Top up when a hold or a charge leaves the available balance below this. At most 1000 USD, the largest single top-up.",
            "maximum": 1000000000,
            "minimum": 0,
            "title": "Threshold Micro",
            "type": "integer"
          }
        },
        "required": [
          "threshold_micro",
          "amount_micro",
          "daily_cap_micro"
        ],
        "title": "AutoTopupCreate",
        "type": "object"
      },
      "AutoTopupList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/AutoTopup"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "AutoTopupList",
        "type": "object"
      },
      "Balance": {
        "additionalProperties": true,
        "examples": [
          {
            "available_micro": 100000000,
            "currency": "USD",
            "environment": "test",
            "held_jobs": 0,
            "held_micro": 0,
            "top_up_url": "https://app.faxforagents.com/app/billing"
          }
        ],
        "properties": {
          "available_micro": {
            "title": "Available Micro",
            "type": "integer"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "held_jobs": {
            "default": 0,
            "description": "How many fax jobs still have their hold in place: queued, sending, or ended unknown and waiting for a reconcile. Their holds add up to held_micro.",
            "title": "Held Jobs",
            "type": "integer"
          },
          "held_micro": {
            "title": "Held Micro",
            "type": "integer"
          },
          "top_up_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The dashboard page where a person adds funds to the wallet. A key cannot top up.",
            "title": "Top Up Url"
          }
        },
        "required": [
          "environment",
          "currency",
          "available_micro",
          "held_micro"
        ],
        "title": "Balance",
        "type": "object"
      },
      "BillingSettings": {
        "additionalProperties": true,
        "properties": {
          "billing_email": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Billing Email"
          },
          "disputed": {
            "title": "Disputed",
            "type": "boolean"
          },
          "low_balance_active": {
            "title": "Low Balance Active",
            "type": "boolean"
          },
          "low_balance_threshold_micro": {
            "title": "Low Balance Threshold Micro",
            "type": "integer"
          },
          "org_id": {
            "title": "Org Id",
            "type": "string"
          },
          "stripe_customer": {
            "title": "Stripe Customer",
            "type": "boolean"
          },
          "workspace": {
            "title": "Workspace",
            "type": "boolean"
          }
        },
        "required": [
          "org_id",
          "billing_email",
          "low_balance_threshold_micro",
          "low_balance_active",
          "workspace",
          "disputed",
          "stripe_customer"
        ],
        "title": "BillingSettings",
        "type": "object"
      },
      "BillingSettingsPatch": {
        "additionalProperties": false,
        "properties": {
          "billing_email": {
            "anyOf": [
              {
                "format": "email",
                "maxLength": 254,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Billing Email"
          },
          "low_balance_threshold_micro": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Low Balance Threshold Micro"
          }
        },
        "title": "BillingSettingsPatch",
        "type": "object"
      },
      "Budget": {
        "additionalProperties": true,
        "properties": {
          "agent_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Agent Id"
          },
          "archived_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Set on a removed budget that has history. It is disabled for good.",
            "title": "Archived At"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "limit_micro": {
            "title": "Limit Micro",
            "type": "integer"
          },
          "period": {
            "enum": [
              "daily",
              "monthly"
            ],
            "title": "Period",
            "type": "string"
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Project Id"
          },
          "remaining_micro": {
            "title": "Remaining Micro",
            "type": "integer"
          },
          "resets_at": {
            "title": "Resets At",
            "type": "string"
          },
          "scope": {
            "enum": [
              "organization",
              "project",
              "agent"
            ],
            "title": "Scope",
            "type": "string"
          },
          "spent_micro": {
            "title": "Spent Micro",
            "type": "integer"
          },
          "status": {
            "enum": [
              "active",
              "disabled"
            ],
            "title": "Status",
            "type": "string"
          },
          "updated_at": {
            "title": "Updated At",
            "type": "string"
          }
        },
        "required": [
          "id",
          "environment",
          "scope",
          "project_id",
          "agent_id",
          "period",
          "limit_micro",
          "spent_micro",
          "remaining_micro",
          "status",
          "resets_at",
          "created_at",
          "updated_at"
        ],
        "title": "Budget",
        "type": "object"
      },
      "BudgetCreate": {
        "additionalProperties": false,
        "properties": {
          "agent_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Agent Id"
          },
          "limit_micro": {
            "minimum": 0,
            "title": "Limit Micro",
            "type": "integer"
          },
          "period": {
            "enum": [
              "daily",
              "monthly"
            ],
            "title": "Period",
            "type": "string"
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Project Id"
          },
          "scope": {
            "default": "organization",
            "enum": [
              "organization",
              "project",
              "agent"
            ],
            "title": "Scope",
            "type": "string"
          }
        },
        "required": [
          "period",
          "limit_micro"
        ],
        "title": "BudgetCreate",
        "type": "object"
      },
      "BudgetList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Budget"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "BudgetList",
        "type": "object"
      },
      "BudgetPatch": {
        "additionalProperties": false,
        "properties": {
          "limit_micro": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Limit Micro"
          },
          "status": {
            "anyOf": [
              {
                "enum": [
                  "active",
                  "disabled"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Status"
          }
        },
        "title": "BudgetPatch",
        "type": "object"
      },
      "BudgetRemoved": {
        "additionalProperties": true,
        "description": "What removing a budget did: deleted when it never charged a hold, archived when it has history.",
        "properties": {
          "archived": {
            "description": "True when the budget has history: disabled and hidden, row kept.",
            "title": "Archived",
            "type": "boolean"
          },
          "deleted": {
            "description": "True when the budget never charged a hold and its row is gone.",
            "title": "Deleted",
            "type": "boolean"
          },
          "id": {
            "title": "Id",
            "type": "string"
          }
        },
        "required": [
          "id",
          "deleted",
          "archived"
        ],
        "title": "BudgetRemoved",
        "type": "object"
      },
      "Capabilities": {
        "additionalProperties": true,
        "properties": {
          "admin_scopes": {
            "description": "The scopes that administer the organization: keys, webhooks, billing, members, policies, agents, approval decisions and number purchases. An agent's own key never carries one.",
            "items": {
              "type": "string"
            },
            "title": "Admin Scopes",
            "type": "array"
          },
          "approvals": {
            "title": "Approvals",
            "type": "boolean"
          },
          "default_scopes": {
            "description": "The scopes a key gets when POST /v1/api-keys names none.",
            "items": {
              "type": "string"
            },
            "title": "Default Scopes",
            "type": "array"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "extraction": {
            "title": "Extraction",
            "type": "boolean"
          },
          "extraction_pricing": {
            "additionalProperties": true,
            "description": "What POST /v1/extractions charges, in micro-units. page_micro is for every page read. escalated_page_micro is added for a page the stronger model reads again. max_pages is the most pages one extraction reads. With a test key, extractions are free.",
            "title": "Extraction Pricing",
            "type": "object"
          },
          "formats": {
            "items": {
              "type": "string"
            },
            "title": "Formats",
            "type": "array"
          },
          "limits": {
            "additionalProperties": {
              "type": "integer"
            },
            "description": "requests_per_minute is the limit of the calling credential: 3000 while the organization's Agent workspace is active, 600 otherwise. The RateLimit-Limit header of every answer says the same. The other keys are the life of a quote and of a download link in seconds, and the largest HTML document in bytes.",
            "title": "Limits",
            "type": "object"
          },
          "max_pages": {
            "title": "Max Pages",
            "type": "integer"
          },
          "max_upload_bytes": {
            "title": "Max Upload Bytes",
            "type": "integer"
          },
          "numbers": {
            "title": "Numbers",
            "type": "boolean"
          },
          "one_time": {
            "additionalProperties": true,
            "description": "One fax paid by card on this server. enabled: orders are taken here. published: the price card offers the product. routes: the routes sold one fax at a time, empty while not enabled. max_document_pages: the most document pages one order takes. Prices are in GET /v1/one-time-sends/config.",
            "title": "One Time",
            "type": "object"
          },
          "price_version": {
            "title": "Price Version",
            "type": "string"
          },
          "provider": {
            "title": "Provider",
            "type": "string"
          },
          "rates": {
            "additionalProperties": true,
            "title": "Rates",
            "type": "object"
          },
          "receive": {
            "title": "Receive",
            "type": "boolean"
          },
          "routes": {
            "items": {
              "type": "string"
            },
            "title": "Routes",
            "type": "array"
          },
          "scopes": {
            "description": "Every scope the platform defines, the list a new key is made from. It is not what the calling credential holds: GET /v1/me returns that under scopes.",
            "items": {
              "type": "string"
            },
            "title": "Scopes",
            "type": "array"
          },
          "send": {
            "title": "Send",
            "type": "boolean"
          }
        },
        "required": [
          "environment",
          "provider",
          "send",
          "receive",
          "numbers",
          "routes",
          "formats",
          "max_pages",
          "max_upload_bytes",
          "price_version",
          "rates",
          "scopes",
          "approvals",
          "extraction",
          "limits",
          "one_time"
        ],
        "title": "Capabilities",
        "type": "object"
      },
      "ClassificationCreate": {
        "additionalProperties": false,
        "properties": {
          "abstain_below": {
            "default": 0.6,
            "maximum": 1,
            "minimum": 0,
            "title": "Abstain Below",
            "type": "number"
          },
          "document_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Document Id"
          },
          "document_types": {
            "items": {
              "type": "string"
            },
            "maxItems": 30,
            "minItems": 1,
            "title": "Document Types",
            "type": "array"
          },
          "inbox_item_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Inbox Item Id"
          },
          "max_pages": {
            "anyOf": [
              {
                "maximum": 200,
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Max Pages"
          },
          "strict": {
            "default": false,
            "description": "Refuse with page_limit_exceeded when the document has more pages than would be read, instead of reading the first ones and warning.",
            "title": "Strict",
            "type": "boolean"
          },
          "strong_model_if_below": {
            "default": 0.75,
            "maximum": 1,
            "minimum": 0,
            "title": "Strong Model If Below",
            "type": "number"
          }
        },
        "required": [
          "document_types"
        ],
        "title": "ClassificationCreate",
        "type": "object"
      },
      "Correction": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "created_by": {
            "title": "Created By",
            "type": "string"
          },
          "extraction_id": {
            "title": "Extraction Id",
            "type": "string"
          },
          "field": {
            "title": "Field",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "note": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Note"
          },
          "value": {
            "title": "Value"
          }
        },
        "required": [
          "id",
          "extraction_id",
          "field",
          "value",
          "note",
          "created_by",
          "created_at"
        ],
        "title": "Correction",
        "type": "object"
      },
      "CorrectionCreate": {
        "additionalProperties": false,
        "properties": {
          "field": {
            "anyOf": [
              {
                "maxLength": 120,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Field"
          },
          "note": {
            "anyOf": [
              {
                "maxLength": 1000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Note"
          },
          "value": {
            "title": "Value"
          }
        },
        "title": "CorrectionCreate",
        "type": "object"
      },
      "Coverage": {
        "additionalProperties": true,
        "properties": {
          "coverage_version": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Coverage Version"
          },
          "excluded": {
            "additionalProperties": true,
            "title": "Excluded",
            "type": "object"
          },
          "generated_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Generated At"
          },
          "inbound": {
            "additionalProperties": true,
            "title": "Inbound",
            "type": "object"
          },
          "note": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Note"
          },
          "orderable_now": {
            "items": {
              "type": "string"
            },
            "title": "Orderable Now",
            "type": "array"
          },
          "outbound": {
            "additionalProperties": true,
            "title": "Outbound",
            "type": "object"
          }
        },
        "required": [
          "coverage_version",
          "generated_at",
          "orderable_now",
          "outbound",
          "inbound",
          "excluded",
          "note"
        ],
        "title": "Coverage",
        "type": "object"
      },
      "DataRequest": {
        "additionalProperties": true,
        "description": "An export or deletion request of the organization and where it stands.",
        "properties": {
          "closed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Closed At"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "due_at": {
            "description": "30 days after the request: when it is answered at the latest.",
            "title": "Due At",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "kind": {
            "enum": [
              "export",
              "deletion"
            ],
            "title": "Kind",
            "type": "string"
          },
          "status": {
            "description": "open until a person at Fax for Agents answers it; withdrawn by an owner; else closed.",
            "enum": [
              "open",
              "closed",
              "withdrawn"
            ],
            "title": "Status",
            "type": "string"
          }
        },
        "required": [
          "id",
          "kind",
          "status",
          "created_at",
          "due_at",
          "closed_at"
        ],
        "title": "DataRequest",
        "type": "object"
      },
      "DataRequestList": {
        "additionalProperties": true,
        "description": "The organization's export and deletion requests, each with where it stands.",
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/DataRequest"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "DataRequestList",
        "type": "object"
      },
      "Deleted": {
        "additionalProperties": true,
        "properties": {
          "deleted": {
            "default": true,
            "title": "Deleted",
            "type": "boolean"
          },
          "id": {
            "title": "Id",
            "type": "string"
          }
        },
        "required": [
          "id"
        ],
        "title": "Deleted",
        "type": "object"
      },
      "Delivery": {
        "additionalProperties": true,
        "description": "One delivery of an event to a webhook destination: its attempts so far and the last answer.",
        "properties": {
          "attempt": {
            "description": "How many attempts were made so far.",
            "title": "Attempt",
            "type": "integer"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "delivered_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the destination answered 2xx. Null until then.",
            "title": "Delivered At"
          },
          "duration_ms": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "How long the last attempt took, in milliseconds.",
            "title": "Duration Ms"
          },
          "error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Why the last attempt failed, in words. Null once delivered.",
            "title": "Error"
          },
          "event_id": {
            "description": "The event sent. The webhook-id header carries the same id.",
            "title": "Event Id",
            "type": "string"
          },
          "event_type": {
            "description": "The event's type, such as fax.delivered.",
            "title": "Event Type",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "next_attempt_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the next attempt is due. Null once the delivery has ended.",
            "title": "Next Attempt At"
          },
          "replay_of": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The delivery this one sends again (POST /v1/webhook-deliveries/{delivery_id}/replay). Null for a first delivery.",
            "title": "Replay Of"
          },
          "response_status": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "The HTTP status of the last attempt's answer. Null before an attempt, or when none came.",
            "title": "Response Status"
          },
          "schedule_s": {
            "description": "The wait before each attempt, in seconds after the one before. The first attempt waits 0 seconds.",
            "items": {
              "type": "integer"
            },
            "title": "Schedule S",
            "type": "array"
          },
          "status": {
            "description": "pending: an attempt is due or waits for its time. delivered: the destination answered 2xx. exhausted: every attempt of the schedule failed. failed: it stopped early, because the destination was deleted or paused, or its address was refused.",
            "title": "Status",
            "type": "string"
          },
          "webhook_deleted": {
            "description": "True when the destination was deleted since. The deliveries that were waiting are not sent, and no delivery to it can be replayed.",
            "title": "Webhook Deleted",
            "type": "boolean"
          },
          "webhook_id": {
            "description": "The destination the event is sent to.",
            "title": "Webhook Id",
            "type": "string"
          },
          "webhook_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The destination's URL, kept after the destination is deleted.",
            "title": "Webhook Url"
          }
        },
        "required": [
          "id",
          "webhook_id",
          "event_id",
          "event_type",
          "attempt",
          "status",
          "response_status",
          "error",
          "duration_ms",
          "replay_of",
          "schedule_s",
          "next_attempt_at",
          "created_at",
          "delivered_at",
          "webhook_deleted"
        ],
        "title": "Delivery",
        "type": "object"
      },
      "DeliveryDetail": {
        "additionalProperties": true,
        "description": "One delivery with the headers and the body that every attempt sends.",
        "properties": {
          "attempt": {
            "description": "How many attempts were made so far.",
            "title": "Attempt",
            "type": "integer"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "delivered_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the destination answered 2xx. Null until then.",
            "title": "Delivered At"
          },
          "duration_ms": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "How long the last attempt took, in milliseconds.",
            "title": "Duration Ms"
          },
          "error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Why the last attempt failed, in words. Null once delivered.",
            "title": "Error"
          },
          "event_id": {
            "description": "The event sent. The webhook-id header carries the same id.",
            "title": "Event Id",
            "type": "string"
          },
          "event_type": {
            "description": "The event's type, such as fax.delivered.",
            "title": "Event Type",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "next_attempt_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the next attempt is due. Null once the delivery has ended.",
            "title": "Next Attempt At"
          },
          "payload": {
            "additionalProperties": true,
            "description": "The JSON body that is sent, the same at every attempt.",
            "title": "Payload",
            "type": "object"
          },
          "replay_of": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The delivery this one sends again (POST /v1/webhook-deliveries/{delivery_id}/replay). Null for a first delivery.",
            "title": "Replay Of"
          },
          "request_headers": {
            "additionalProperties": {
              "type": "string"
            },
            "description": "The headers every attempt carries. webhook-id is the event id. webhook-timestamp and webhook-signature are made at each attempt and are not stored, so their values here say what they hold. The signing secret is never returned.",
            "title": "Request Headers",
            "type": "object"
          },
          "response_status": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "The HTTP status of the last attempt's answer. Null before an attempt, or when none came.",
            "title": "Response Status"
          },
          "schedule_s": {
            "description": "The wait before each attempt, in seconds after the one before. The first attempt waits 0 seconds.",
            "items": {
              "type": "integer"
            },
            "title": "Schedule S",
            "type": "array"
          },
          "status": {
            "description": "pending: an attempt is due or waits for its time. delivered: the destination answered 2xx. exhausted: every attempt of the schedule failed. failed: it stopped early, because the destination was deleted or paused, or its address was refused.",
            "title": "Status",
            "type": "string"
          },
          "webhook_deleted": {
            "description": "True when the destination was deleted since. The deliveries that were waiting are not sent, and no delivery to it can be replayed.",
            "title": "Webhook Deleted",
            "type": "boolean"
          },
          "webhook_id": {
            "description": "The destination the event is sent to.",
            "title": "Webhook Id",
            "type": "string"
          },
          "webhook_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The destination's URL, kept after the destination is deleted.",
            "title": "Webhook Url"
          }
        },
        "required": [
          "id",
          "webhook_id",
          "event_id",
          "event_type",
          "attempt",
          "status",
          "response_status",
          "error",
          "duration_ms",
          "replay_of",
          "schedule_s",
          "next_attempt_at",
          "created_at",
          "delivered_at",
          "webhook_deleted",
          "request_headers",
          "payload"
        ],
        "title": "DeliveryDetail",
        "type": "object"
      },
      "DeliveryPage": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Delivery"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          }
        },
        "required": [
          "items"
        ],
        "title": "DeliveryPage",
        "type": "object"
      },
      "Document": {
        "additionalProperties": true,
        "examples": [
          {
            "content_type": "application/pdf",
            "converted_from": null,
            "created_at": "2026-11-14T19:58:38.630Z",
            "deleted_at": null,
            "environment": "test",
            "expires_at": "2026-12-14T19:58:38.739Z",
            "filename": "contract.pdf",
            "id": "doc_01a1dba3f82e734db276332829bc4f2f",
            "page_count": 2,
            "received": null,
            "render_reason": null,
            "render_status": "rendered",
            "sha256": "c00b74dede1923d27ba294643d5e79cb5454089e3f1b7b151cc46aa520a2410f",
            "size_bytes": 551,
            "source": "upload",
            "status": "ready",
            "upload_id": "up_01a1dba3f80475159f9195dc92d38428",
            "validation": {
              "warnings": []
            }
          }
        ],
        "properties": {
          "content_type": {
            "title": "Content Type",
            "type": "string"
          },
          "converted_from": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The name of the image this PDF was converted from, as the person gave it. filename is the PDF's own name. Null for a document that was not an image.",
            "title": "Converted From"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "deleted_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Deleted At"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expires At"
          },
          "filename": {
            "title": "Filename",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "page_count": {
            "title": "Page Count",
            "type": "integer"
          },
          "received": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/DocumentReceived"
              },
              {
                "type": "null"
              }
            ],
            "description": "Set in the list (GET /v1/documents) on the file of a received fax, source inbound. It names the inbox item, the sender as the sending machine gave it, and the time. Null everywhere else."
          },
          "render_reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Render Reason"
          },
          "render_status": {
            "title": "Render Status",
            "type": "string"
          },
          "sha256": {
            "title": "Sha256",
            "type": "string"
          },
          "size_bytes": {
            "title": "Size Bytes",
            "type": "integer"
          },
          "source": {
            "title": "Source",
            "type": "string"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "upload_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Upload Id"
          },
          "validation": {
            "additionalProperties": true,
            "title": "Validation",
            "type": "object"
          }
        },
        "required": [
          "id",
          "environment",
          "status",
          "source",
          "filename",
          "content_type",
          "size_bytes",
          "sha256",
          "page_count",
          "render_status",
          "render_reason",
          "validation",
          "upload_id",
          "created_at",
          "expires_at",
          "deleted_at"
        ],
        "title": "Document",
        "type": "object"
      },
      "DocumentCreate": {
        "additionalProperties": false,
        "description": "Send exactly one of text, markdown, html or upload_id.",
        "examples": [
          {
            "text": "Hello from Fax for Agents"
          }
        ],
        "properties": {
          "filename": {
            "anyOf": [
              {
                "maxLength": 255,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Filename"
          },
          "html": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "HTML rendered to PDF by a headless browser with scripts off and no network: inline CSS and data: images print, external resources are counted as blocked. US letter unless @page says otherwise. At most 2 MiB.",
            "title": "Html"
          },
          "markdown": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Markdown (headings, lists, emphasis, code) rendered to PDF.",
            "title": "Markdown"
          },
          "text": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Plain text rendered to a letter PDF.",
            "examples": [
              "Hello from Fax for Agents"
            ],
            "title": "Text"
          },
          "upload_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Upload Id"
          }
        },
        "title": "DocumentCreate",
        "type": "object"
      },
      "DocumentPage": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Document"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          },
          "total": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "How many documents the filters match in all, across every page.",
            "title": "Total"
          }
        },
        "required": [
          "items"
        ],
        "title": "DocumentPage",
        "type": "object"
      },
      "DocumentPages": {
        "additionalProperties": true,
        "properties": {
          "document_id": {
            "title": "Document Id",
            "type": "string"
          },
          "items": {
            "items": {
              "$ref": "#/components/schemas/PagePreview"
            },
            "title": "Items",
            "type": "array"
          },
          "page_count": {
            "title": "Page Count",
            "type": "integer"
          },
          "render_reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Render Reason"
          },
          "render_status": {
            "title": "Render Status",
            "type": "string"
          }
        },
        "required": [
          "document_id",
          "page_count",
          "render_status",
          "render_reason",
          "items"
        ],
        "title": "DocumentPages",
        "type": "object"
      },
      "DocumentReceived": {
        "additionalProperties": true,
        "description": "The received fax a document is the file of.",
        "properties": {
          "from": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "From"
          },
          "inbox_item_id": {
            "title": "Inbox Item Id",
            "type": "string"
          },
          "received_at": {
            "title": "Received At",
            "type": "string"
          }
        },
        "required": [
          "inbox_item_id",
          "received_at"
        ],
        "title": "DocumentReceived",
        "type": "object"
      },
      "DocumentUpdate": {
        "additionalProperties": false,
        "description": "A new file name for a document.",
        "properties": {
          "filename": {
            "description": "The new file name. The stored file is a PDF: a name without .pdf gets it added.",
            "maxLength": 255,
            "minLength": 1,
            "title": "Filename",
            "type": "string"
          }
        },
        "required": [
          "filename"
        ],
        "title": "DocumentUpdate",
        "type": "object"
      },
      "DocumentValidation": {
        "additionalProperties": true,
        "properties": {
          "id": {
            "title": "Id",
            "type": "string"
          },
          "page_count": {
            "title": "Page Count",
            "type": "integer"
          },
          "render_reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Render Reason"
          },
          "render_status": {
            "title": "Render Status",
            "type": "string"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "warnings": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Warnings",
            "type": "array"
          }
        },
        "required": [
          "id",
          "status",
          "page_count",
          "render_status",
          "render_reason",
          "warnings"
        ],
        "title": "DocumentValidation",
        "type": "object"
      },
      "EffectivePolicies": {
        "additionalProperties": true,
        "properties": {
          "actor": {
            "title": "Actor",
            "type": "string"
          },
          "approval_required_without_policy": {
            "title": "Approval Required Without Policy",
            "type": "boolean"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "policies": {
            "items": {
              "$ref": "#/components/schemas/Policy"
            },
            "title": "Policies",
            "type": "array"
          },
          "requires_human_approval": {
            "default": false,
            "description": "Server-set for hosted integration clients and their keys: every send needs a person's approval, whatever the policies say.",
            "title": "Requires Human Approval",
            "type": "boolean"
          },
          "rules_order": {
            "items": {
              "type": "string"
            },
            "title": "Rules Order",
            "type": "array"
          },
          "under_policy": {
            "title": "Under Policy",
            "type": "boolean"
          }
        },
        "required": [
          "actor",
          "environment",
          "under_policy",
          "approval_required_without_policy",
          "policies",
          "rules_order"
        ],
        "title": "EffectivePolicies",
        "type": "object"
      },
      "ErrorBody": {
        "additionalProperties": true,
        "properties": {
          "code": {
            "title": "Code",
            "type": "string"
          },
          "correlation_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Correlation Id"
          },
          "details": {
            "title": "Details"
          },
          "message": {
            "title": "Message",
            "type": "string"
          },
          "retryable": {
            "description": "True when the failure passes on its own: the same call, sent again unchanged after a short wait, is expected to work. False when the same call gets the same answer until the request or the resource changes.",
            "title": "Retryable",
            "type": "boolean"
          }
        },
        "required": [
          "code",
          "message",
          "retryable"
        ],
        "title": "ErrorBody",
        "type": "object"
      },
      "ErrorEnvelope": {
        "additionalProperties": true,
        "properties": {
          "error": {
            "$ref": "#/components/schemas/ErrorBody"
          }
        },
        "required": [
          "error"
        ],
        "title": "ErrorEnvelope",
        "type": "object"
      },
      "Event": {
        "additionalProperties": true,
        "properties": {
          "correlation_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Correlation Id"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "data": {
            "additionalProperties": true,
            "title": "Data",
            "type": "object"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "fax_job_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Fax Job Id"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "org_id": {
            "title": "Org Id",
            "type": "string"
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Project Id"
          },
          "resource_id": {
            "title": "Resource Id",
            "type": "string"
          },
          "resource_type": {
            "title": "Resource Type",
            "type": "string"
          },
          "schema_version": {
            "title": "Schema Version",
            "type": "integer"
          },
          "type": {
            "title": "Type",
            "type": "string"
          }
        },
        "required": [
          "id",
          "type",
          "created_at",
          "org_id",
          "environment",
          "project_id",
          "resource_type",
          "resource_id",
          "fax_job_id",
          "schema_version",
          "correlation_id",
          "data"
        ],
        "title": "Event",
        "type": "object"
      },
      "EventPage": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Event"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          }
        },
        "required": [
          "items"
        ],
        "title": "EventPage",
        "type": "object"
      },
      "Extraction": {
        "additionalProperties": true,
        "properties": {
          "completed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "confidence": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ],
            "title": "Confidence"
          },
          "corrections": {
            "anyOf": [
              {
                "items": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Corrections"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "created_by": {
            "title": "Created By",
            "type": "string"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "document_id": {
            "title": "Document Id",
            "type": "string"
          },
          "document_pages": {
            "description": "The document's page count. Above pages_processed on a completed row means the cap left pages unread; output.truncated and a warning say so.",
            "title": "Document Pages",
            "type": "integer"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "error_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Code"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "inbox_item_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Inbox Item Id"
          },
          "kind": {
            "enum": [
              "extract",
              "classify",
              "summarize"
            ],
            "title": "Kind",
            "type": "string"
          },
          "models": {
            "additionalProperties": true,
            "title": "Models",
            "type": "object"
          },
          "options": {
            "additionalProperties": true,
            "title": "Options",
            "type": "object"
          },
          "output": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Output"
          },
          "pages": {
            "items": {
              "$ref": "#/components/schemas/ExtractionPage"
            },
            "title": "Pages",
            "type": "array"
          },
          "pages_escalated": {
            "title": "Pages Escalated",
            "type": "integer"
          },
          "pages_processed": {
            "title": "Pages Processed",
            "type": "integer"
          },
          "pages_requested": {
            "title": "Pages Requested",
            "type": "integer"
          },
          "price_micro": {
            "title": "Price Micro",
            "type": "integer"
          },
          "schema": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Schema"
          },
          "schema_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Schema Id"
          },
          "started_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Started At"
          },
          "status": {
            "enum": [
              "pending",
              "queued",
              "running",
              "completed",
              "failed"
            ],
            "title": "Status",
            "type": "string"
          }
        },
        "required": [
          "id",
          "kind",
          "status",
          "environment",
          "document_id",
          "inbox_item_id",
          "schema_id",
          "options",
          "pages_requested",
          "pages_processed",
          "pages_escalated",
          "document_pages",
          "confidence",
          "pages",
          "output",
          "models",
          "price_micro",
          "currency",
          "error_code",
          "created_by",
          "created_at",
          "started_at",
          "completed_at"
        ],
        "title": "Extraction",
        "type": "object"
      },
      "ExtractionCreate": {
        "additionalProperties": false,
        "properties": {
          "document_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Document Id"
          },
          "inbox_item_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Inbox Item Id"
          },
          "max_pages": {
            "anyOf": [
              {
                "maximum": 200,
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Max Pages"
          },
          "schema": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "A JSON Schema object of string, number, boolean or date fields with descriptions.",
            "title": "Schema"
          },
          "schema_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Schema Id"
          },
          "strict": {
            "default": false,
            "description": "Refuse with page_limit_exceeded when the document has more pages than would be read, instead of reading the first ones and warning.",
            "title": "Strict",
            "type": "boolean"
          },
          "strong_model_if_below": {
            "default": 0.75,
            "maximum": 1,
            "minimum": 0,
            "title": "Strong Model If Below",
            "type": "number"
          }
        },
        "title": "ExtractionCreate",
        "type": "object"
      },
      "ExtractionPage": {
        "additionalProperties": true,
        "properties": {
          "confidence": {
            "title": "Confidence",
            "type": "number"
          },
          "escalated": {
            "default": false,
            "title": "Escalated",
            "type": "boolean"
          },
          "language": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Language"
          },
          "model": {
            "title": "Model",
            "type": "string"
          },
          "page": {
            "title": "Page",
            "type": "integer"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "text": {
            "title": "Text",
            "type": "string"
          },
          "warnings": {
            "default": [],
            "items": {
              "type": "string"
            },
            "title": "Warnings",
            "type": "array"
          }
        },
        "required": [
          "page",
          "text",
          "confidence",
          "status",
          "model"
        ],
        "title": "ExtractionPage",
        "type": "object"
      },
      "ExtractionPageList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Extraction"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          }
        },
        "required": [
          "items"
        ],
        "title": "ExtractionPageList",
        "type": "object"
      },
      "ExtractionSchema": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "created_by": {
            "title": "Created By",
            "type": "string"
          },
          "description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Description"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "schema": {
            "additionalProperties": true,
            "title": "Schema",
            "type": "object"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "version": {
            "title": "Version",
            "type": "integer"
          }
        },
        "required": [
          "id",
          "name",
          "version",
          "description",
          "schema",
          "status",
          "created_by",
          "created_at"
        ],
        "title": "ExtractionSchema",
        "type": "object"
      },
      "ExtractionSchemaList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ExtractionSchema"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "ExtractionSchemaList",
        "type": "object"
      },
      "FaxCreate": {
        "additionalProperties": false,
        "description": "M9: an approved request authorizes the send; without one a quote that needs authorization is\nevaluated against the caller's delegated policies.",
        "examples": [
          {
            "quote_id": "quote_01a1dba3f8b371f6aaa8664b3bf14d20"
          }
        ],
        "properties": {
          "approval_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "An approved approval request bound to this quote. Consumed by this one send.",
            "title": "Approval Id"
          },
          "client_reference": {
            "anyOf": [
              {
                "maxLength": 200,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Client Reference"
          },
          "quote_id": {
            "title": "Quote Id",
            "type": "string"
          }
        },
        "required": [
          "quote_id"
        ],
        "title": "FaxCreate",
        "type": "object"
      },
      "FaxJob": {
        "additionalProperties": true,
        "examples": [
          {
            "amount_micro": 0,
            "approval_id": null,
            "attempt_count": 1,
            "billable_pages": 2,
            "cancel_requested_at": null,
            "captured_micro": 0,
            "client_reference": null,
            "completed_at": "2026-11-14T19:58:38.910Z",
            "cover_pages": 0,
            "created_at": "2026-11-14T19:58:38.794Z",
            "currency": "USD",
            "delete_after_send": false,
            "direction": "outbound",
            "document_id": "doc_01a1dba3f82e734db276332829bc4f2f",
            "document_sha256": "c00b74dede1923d27ba294643d5e79cb5454089e3f1b7b151cc46aa520a2410f",
            "environment": "test",
            "evidence": {
              "attempt_number": 1,
              "completed_at": "2026-11-14T19:58:38.905Z",
              "duration_s": 24,
              "pages_sent": 2,
              "pages_total": 2,
              "provider": "sandbox",
              "quality": "fine",
              "remote_station_id": "SBX-OK",
              "sender_name": null
            },
            "failure_code": null,
            "from": null,
            "id": "fax_01a1dba3f8dc7609be5d7b497690cf47",
            "one_time": null,
            "one_time_order_id": null,
            "pages_sent": 2,
            "policy_version_id": null,
            "provider": "sandbox",
            "provider_ref": "sbx_311dd5d5bc5dfd76",
            "quality": "fine",
            "quote_id": "quote_01a1dba3f8b371f6aaa8664b3bf14d20",
            "route": "us_ca",
            "route_paused": false,
            "sender_name": null,
            "state": "delivered",
            "to": "+15550000001",
            "transmitted_sha256": "9f18c276fb5160f70fecb50f8e53768a7aa631e3e2a140447d3cb4f0377eb6e4",
            "updated_at": "2026-11-14T19:58:38.910Z"
          }
        ],
        "properties": {
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "approval_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The approval request a person approved for this send. Null when another path authorized it: a delegated policy (policy_version_id), a test key no policy binds, or the payer's confirmation of a one-time order.",
            "title": "Approval Id"
          },
          "attempt_count": {
            "title": "Attempt Count",
            "type": "integer"
          },
          "billable_pages": {
            "title": "Billable Pages",
            "type": "integer"
          },
          "cancel_requested_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cancel Requested At"
          },
          "captured_micro": {
            "title": "Captured Micro",
            "type": "integer"
          },
          "client_reference": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Client Reference"
          },
          "completed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "cover_pages": {
            "title": "Cover Pages",
            "type": "integer"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "delete_after_send": {
            "default": false,
            "title": "Delete After Send",
            "type": "boolean"
          },
          "direction": {
            "title": "Direction",
            "type": "string"
          },
          "document_id": {
            "title": "Document Id",
            "type": "string"
          },
          "document_sha256": {
            "title": "Document Sha256",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "evidence": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "The carrier's evidence once delivered or partial; null before.",
            "title": "Evidence"
          },
          "failure_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Failure Code"
          },
          "from": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "From"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "one_time": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OneTimeJob"
              },
              {
                "type": "null"
              }
            ]
          },
          "one_time_order_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The one-time order this fax was paid by; null for a wallet fax.",
            "title": "One Time Order Id"
          },
          "pages_sent": {
            "title": "Pages Sent",
            "type": "integer"
          },
          "policy_version_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The version of the delegated policy that allowed this send. A version never changes, so it shows the limits the send was allowed under. Null when no policy decided the send.",
            "title": "Policy Version Id"
          },
          "provider": {
            "title": "Provider",
            "type": "string"
          },
          "provider_ref": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Provider Ref"
          },
          "quality": {
            "default": "fine",
            "title": "Quality",
            "type": "string"
          },
          "quote_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Quote Id"
          },
          "route": {
            "title": "Route",
            "type": "string"
          },
          "route_paused": {
            "default": false,
            "description": "An operator has paused sends on this fax's route while the fax waits for a line (queued or between tries). It goes out when the route is resumed. Read when the fax is read, not stored.",
            "title": "Route Paused",
            "type": "boolean"
          },
          "sender_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Sender Name"
          },
          "state": {
            "enum": [
              "queued",
              "active",
              "partial",
              "failed",
              "unknown",
              "delivered"
            ],
            "title": "State",
            "type": "string"
          },
          "to": {
            "title": "To",
            "type": "string"
          },
          "transmitted_sha256": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Transmitted Sha256"
          },
          "updated_at": {
            "title": "Updated At",
            "type": "string"
          }
        },
        "required": [
          "id",
          "environment",
          "direction",
          "state",
          "failure_code",
          "to",
          "route",
          "document_id",
          "document_sha256",
          "transmitted_sha256",
          "quote_id",
          "billable_pages",
          "cover_pages",
          "pages_sent",
          "amount_micro",
          "captured_micro",
          "currency",
          "provider",
          "provider_ref",
          "client_reference",
          "attempt_count",
          "created_at",
          "updated_at",
          "completed_at",
          "cancel_requested_at"
        ],
        "title": "FaxJob",
        "type": "object"
      },
      "FaxJobPage": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/FaxJob"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          }
        },
        "required": [
          "items"
        ],
        "title": "FaxJobPage",
        "type": "object"
      },
      "Grant": {
        "additionalProperties": true,
        "properties": {
          "client_host": {
            "title": "Client Host",
            "type": "string"
          },
          "client_id": {
            "title": "Client Id",
            "type": "string"
          },
          "client_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Client Name"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "environment": {
            "enum": [
              "test",
              "live"
            ],
            "title": "Environment",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "last_used_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last Used At"
          },
          "org_id": {
            "title": "Org Id",
            "type": "string"
          },
          "organization": {
            "title": "Organization",
            "type": "string"
          },
          "revoked_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Revoked At"
          },
          "scopes": {
            "items": {
              "type": "string"
            },
            "title": "Scopes",
            "type": "array"
          },
          "user_id": {
            "title": "User Id",
            "type": "string"
          }
        },
        "required": [
          "id",
          "org_id",
          "organization",
          "user_id",
          "client_id",
          "client_host",
          "client_name",
          "environment",
          "scopes",
          "created_at",
          "last_used_at",
          "revoked_at"
        ],
        "title": "Grant",
        "type": "object"
      },
      "GrantList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Grant"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          }
        },
        "required": [
          "items"
        ],
        "title": "GrantList",
        "type": "object"
      },
      "InboxItemDetail": {
        "additionalProperties": true,
        "examples": [
          {
            "amount_micro": 0,
            "document": {
              "download": "/v1/inbox/inb_01a1dba3f9a170e4bfe4f79df926fce6/download",
              "id": "doc_01a1dba3f9a877228761c3894daefe4b",
              "page_count": 2,
              "sha256": "e918cbc6023a846d99025bfe490299eb7cb18829b1d9f48fed91e59a15c87ed0",
              "status": "ready"
            },
            "document_id": "doc_01a1dba3f9a877228761c3894daefe4b",
            "duration_secs": null,
            "environment": "test",
            "expires_at": "2027-02-12T19:58:39.009Z",
            "extraction_id": null,
            "file_deleted_at": null,
            "from": "+15550000009",
            "id": "inb_01a1dba3f9a170e4bfe4f79df926fce6",
            "media_status": "stored",
            "note": null,
            "number_id": null,
            "pages": 2,
            "partial_content": false,
            "project_id": "proj_01a1dba3f790751897c1a738a5631341",
            "provider": "sandbox",
            "read_at": null,
            "received_at": "2026-11-14T19:58:39.009Z",
            "status": "received",
            "text": null,
            "to": "+15550100001"
          }
        ],
        "properties": {
          "amount_micro": {
            "default": 0,
            "description": "What the received pages were charged, in micro-USD. 0 in test.",
            "title": "Amount Micro",
            "type": "integer"
          },
          "document": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Document"
          },
          "document_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Document Id"
          },
          "duration_secs": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Duration Secs"
          },
          "environment": {
            "default": "live",
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expires At"
          },
          "extraction_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Extraction Id"
          },
          "file_deleted_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the file of this fax was deleted. media_status is then deleted and there is no download. Null while the file is kept.",
            "title": "File Deleted At"
          },
          "from": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "From"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "media_status": {
            "default": "stored",
            "title": "Media Status",
            "type": "string"
          },
          "note": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Note"
          },
          "number_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Number Id"
          },
          "pages": {
            "title": "Pages",
            "type": "integer"
          },
          "partial_content": {
            "default": false,
            "title": "Partial Content",
            "type": "boolean"
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Project Id"
          },
          "provider": {
            "default": "",
            "title": "Provider",
            "type": "string"
          },
          "read_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Read At"
          },
          "received_at": {
            "title": "Received At",
            "type": "string"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "text": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Text"
          },
          "to": {
            "title": "To",
            "type": "string"
          }
        },
        "required": [
          "id",
          "to",
          "pages",
          "status",
          "document_id",
          "received_at"
        ],
        "title": "InboxItemDetail",
        "type": "object"
      },
      "InboxPage": {
        "additionalProperties": true,
        "examples": [
          {
            "items": [
              {
                "amount_micro": 0,
                "document_id": "doc_01a1dba3f9a877228761c3894daefe4b",
                "duration_secs": null,
                "environment": "test",
                "expires_at": "2027-02-12T19:58:39.009Z",
                "file_deleted_at": null,
                "from": "+15550000009",
                "id": "inb_01a1dba3f9a170e4bfe4f79df926fce6",
                "media_status": "stored",
                "note": null,
                "number_id": null,
                "pages": 2,
                "partial_content": false,
                "project_id": "proj_01a1dba3f790751897c1a738a5631341",
                "provider": "sandbox",
                "read_at": null,
                "received_at": "2026-11-14T19:58:39.009Z",
                "status": "received",
                "to": "+15550100001"
              }
            ],
            "next_cursor": null,
            "unread": 1
          }
        ],
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/faxforagents__api__routes__inbox__InboxItem"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          },
          "unread": {
            "default": 0,
            "description": "The faxes nobody has opened yet in this environment, whatever the filters.",
            "title": "Unread",
            "type": "integer"
          }
        },
        "required": [
          "items"
        ],
        "title": "InboxPage",
        "type": "object"
      },
      "InboxUpdate": {
        "additionalProperties": false,
        "properties": {
          "status": {
            "anyOf": [
              {
                "enum": [
                  "received",
                  "read",
                  "archived"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Status"
          }
        },
        "title": "InboxUpdate",
        "type": "object"
      },
      "Inventory": {
        "additionalProperties": true,
        "properties": {
          "country": {
            "title": "Country",
            "type": "string"
          },
          "items": {
            "items": {
              "$ref": "#/components/schemas/InventoryNumber"
            },
            "title": "Items",
            "type": "array"
          },
          "locality": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The area that was searched for. Null in test: test numbers are made up and have no city.",
            "title": "Locality"
          },
          "note": {
            "title": "Note",
            "type": "string"
          },
          "number_type": {
            "title": "Number Type",
            "type": "string"
          },
          "recurring_period": {
            "title": "Recurring Period",
            "type": "string"
          }
        },
        "required": [
          "country",
          "number_type",
          "locality",
          "items",
          "recurring_period",
          "note"
        ],
        "title": "Inventory",
        "type": "object"
      },
      "InventoryNumber": {
        "additionalProperties": true,
        "properties": {
          "country": {
            "title": "Country",
            "type": "string"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "e164": {
            "title": "E164",
            "type": "string"
          },
          "locality": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Locality"
          },
          "monthly_micro": {
            "title": "Monthly Micro",
            "type": "integer"
          },
          "number_type": {
            "title": "Number Type",
            "type": "string"
          },
          "owned": {
            "default": false,
            "description": "True when your organization already holds this number. An order of it is refused.",
            "title": "Owned",
            "type": "boolean"
          },
          "setup_micro": {
            "title": "Setup Micro",
            "type": "integer"
          }
        },
        "required": [
          "e164",
          "country",
          "number_type",
          "locality",
          "monthly_micro",
          "currency",
          "setup_micro"
        ],
        "title": "InventoryNumber",
        "type": "object"
      },
      "Invitation": {
        "additionalProperties": true,
        "properties": {
          "accepted_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Accepted At"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "email": {
            "title": "Email",
            "type": "string"
          },
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "invited_by": {
            "title": "Invited By",
            "type": "string"
          },
          "role": {
            "enum": [
              "owner",
              "admin",
              "member",
              "viewer"
            ],
            "title": "Role",
            "type": "string"
          }
        },
        "required": [
          "id",
          "email",
          "role",
          "invited_by",
          "created_at",
          "expires_at",
          "accepted_at"
        ],
        "title": "Invitation",
        "type": "object"
      },
      "InvitationCreate": {
        "additionalProperties": false,
        "properties": {
          "email": {
            "format": "email",
            "title": "Email",
            "type": "string"
          },
          "role": {
            "default": "member",
            "enum": [
              "owner",
              "admin",
              "member",
              "viewer"
            ],
            "title": "Role",
            "type": "string"
          }
        },
        "required": [
          "email"
        ],
        "title": "InvitationCreate",
        "type": "object"
      },
      "InvitationLink": {
        "additionalProperties": true,
        "description": "A new link for an open invitation, shown once, which replaces the old link.",
        "properties": {
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "url": {
            "description": "The new invitation link. Shown once.",
            "title": "Url",
            "type": "string"
          }
        },
        "required": [
          "id",
          "url",
          "expires_at"
        ],
        "title": "InvitationLink",
        "type": "object"
      },
      "InvitationList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Invitation"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "InvitationList",
        "type": "object"
      },
      "InvitationPreview": {
        "additionalProperties": true,
        "description": "What the holder of an invitation link may know before joining.",
        "properties": {
          "email": {
            "description": "The address the invitation was sent to. Only that person can accept.",
            "title": "Email",
            "type": "string"
          },
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "invited_by": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The inviter's address, when a person invited.",
            "title": "Invited By"
          },
          "organization_name": {
            "title": "Organization Name",
            "type": "string"
          },
          "role": {
            "enum": [
              "owner",
              "admin",
              "member",
              "viewer"
            ],
            "title": "Role",
            "type": "string"
          }
        },
        "required": [
          "organization_name",
          "email",
          "role",
          "invited_by",
          "expires_at"
        ],
        "title": "InvitationPreview",
        "type": "object"
      },
      "Invoice": {
        "additionalProperties": true,
        "properties": {
          "amount_due_micro": {
            "title": "Amount Due Micro",
            "type": "integer"
          },
          "amount_paid_micro": {
            "title": "Amount Paid Micro",
            "type": "integer"
          },
          "created_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Created At"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "hosted_invoice_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Hosted Invoice Url"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "invoice_pdf": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Invoice Pdf"
          },
          "number": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Number"
          },
          "status": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Status"
          },
          "subscription_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Subscription Id"
          }
        },
        "required": [
          "id",
          "number",
          "status",
          "currency",
          "amount_due_micro",
          "amount_paid_micro",
          "subscription_id",
          "hosted_invoice_url",
          "invoice_pdf",
          "created_at"
        ],
        "title": "Invoice",
        "type": "object"
      },
      "InvoicePage": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Invoice"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          }
        },
        "required": [
          "items"
        ],
        "title": "InvoicePage",
        "type": "object"
      },
      "LeaveOrganization": {
        "additionalProperties": false,
        "properties": {
          "org_id": {
            "description": "The organization to leave: the one the question to the person named. You must be a member of it.",
            "examples": [
              "org_0123456789abcdef0123456789abcdef"
            ],
            "pattern": "^org_[0-9a-f]{32}$",
            "title": "Org Id",
            "type": "string"
          }
        },
        "required": [
          "org_id"
        ],
        "title": "LeaveOrganization",
        "type": "object"
      },
      "LedgerEntry": {
        "additionalProperties": true,
        "properties": {
          "account": {
            "title": "Account",
            "type": "string"
          },
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "kind": {
            "title": "Kind",
            "type": "string"
          },
          "memo": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Memo"
          },
          "ref_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ref Id"
          },
          "ref_type": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ref Type"
          },
          "txn_id": {
            "title": "Txn Id",
            "type": "string"
          }
        },
        "required": [
          "id",
          "txn_id",
          "account",
          "amount_micro",
          "kind",
          "ref_type",
          "ref_id",
          "memo",
          "created_at"
        ],
        "title": "LedgerEntry",
        "type": "object"
      },
      "LedgerPage": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/LedgerEntry"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          }
        },
        "required": [
          "items"
        ],
        "title": "LedgerPage",
        "type": "object"
      },
      "LeftOrganization": {
        "additionalProperties": true,
        "properties": {
          "left_organization_id": {
            "description": "The organization you left.",
            "title": "Left Organization Id",
            "type": "string"
          },
          "organization_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The organization this session looks at now. That is the one it looked at before, or another of yours when it was looking at the one you left. Null when you belong to no organization any more and the session was signed out.",
            "title": "Organization Id"
          },
          "signed_out": {
            "description": "true when you belong to no organization any more: every session of yours ended and this answer clears the session cookie.",
            "title": "Signed Out",
            "type": "boolean"
          }
        },
        "required": [
          "left_organization_id",
          "organization_id",
          "signed_out"
        ],
        "title": "LeftOrganization",
        "type": "object"
      },
      "MagicLinkRequest": {
        "additionalProperties": false,
        "properties": {
          "email": {
            "format": "email",
            "title": "Email",
            "type": "string"
          },
          "next": {
            "anyOf": [
              {
                "maxLength": 400,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "An in-app path to open after sign-in.",
            "title": "Next"
          },
          "ref": {
            "anyOf": [
              {
                "maxLength": 64,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "A referral code from the link that brought the person, when the page has one.",
            "title": "Ref"
          },
          "sub": {
            "anyOf": [
              {
                "maxLength": 128,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The referral link's tag.",
            "title": "Sub"
          }
        },
        "required": [
          "email"
        ],
        "title": "MagicLinkRequest",
        "type": "object"
      },
      "Member": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "email": {
            "title": "Email",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Name"
          },
          "role": {
            "enum": [
              "owner",
              "admin",
              "member",
              "viewer"
            ],
            "title": "Role",
            "type": "string"
          },
          "user_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "User Id"
          }
        },
        "required": [
          "id",
          "email",
          "name",
          "role",
          "user_id",
          "created_at"
        ],
        "title": "Member",
        "type": "object"
      },
      "MemberList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Member"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "MemberList",
        "type": "object"
      },
      "MemberPatch": {
        "additionalProperties": false,
        "properties": {
          "role": {
            "anyOf": [
              {
                "enum": [
                  "owner",
                  "admin",
                  "member",
                  "viewer"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Required. Optional in the schema so a foreign id is a 404 first.",
            "title": "Role"
          }
        },
        "title": "MemberPatch",
        "type": "object"
      },
      "Notice": {
        "additionalProperties": true,
        "description": "What happened while the person was away: a removal, told once, or an invitation, while it is open.",
        "properties": {
          "at": {
            "description": "When the person was removed, or when the waiting invitation ends. UTC, ISO 8601.",
            "title": "At",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "kind": {
            "enum": [
              "removed_from_organization",
              "invitation_waiting"
            ],
            "title": "Kind",
            "type": "string"
          },
          "organization_name": {
            "title": "Organization Name",
            "type": "string"
          }
        },
        "required": [
          "id",
          "kind",
          "organization_name",
          "at"
        ],
        "title": "Notice",
        "type": "object"
      },
      "Number": {
        "additionalProperties": true,
        "properties": {
          "activated_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Activated At"
          },
          "country": {
            "title": "Country",
            "type": "string"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "e164": {
            "title": "E164",
            "type": "string"
          },
          "email_pdf": {
            "default": false,
            "description": "When true, the notice mail of a fax received on this number carries the PDF as an attachment. Live numbers only. Off by default.",
            "title": "Email Pdf",
            "type": "boolean"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "inbound_status": {
            "title": "Inbound Status",
            "type": "string"
          },
          "inbound_webhook_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Inbound Webhook Id"
          },
          "included_with_workspace": {
            "default": false,
            "description": "True while the organization's Agent workspace pays this number's monthly charge: the oldest live local number, pending or active, while the plan is active. Its renewals then take nothing from the wallet. When the plan ends, the next renewal charges monthly_micro.",
            "title": "Included With Workspace",
            "type": "boolean"
          },
          "label": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Label"
          },
          "locality": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Locality"
          },
          "monthly_micro": {
            "title": "Monthly Micro",
            "type": "integer"
          },
          "number_type": {
            "title": "Number Type",
            "type": "string"
          },
          "order_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Order Id"
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Project Id"
          },
          "provider": {
            "title": "Provider",
            "type": "string"
          },
          "released_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Released At"
          },
          "renews_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Renews At"
          },
          "status": {
            "title": "Status",
            "type": "string"
          }
        },
        "required": [
          "id",
          "environment",
          "e164",
          "country",
          "number_type",
          "locality",
          "status",
          "label",
          "project_id",
          "inbound_webhook_id",
          "inbound_status",
          "provider",
          "monthly_micro",
          "currency",
          "order_id",
          "created_at",
          "activated_at",
          "renews_at",
          "released_at"
        ],
        "title": "Number",
        "type": "object"
      },
      "NumberList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Number"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "NumberList",
        "type": "object"
      },
      "NumberOrder": {
        "additionalProperties": true,
        "properties": {
          "completed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "country": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Country"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "dismissed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When a person put this failed order away. Null until then.",
            "title": "Dismissed At"
          },
          "e164": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "E164"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error"
          },
          "first_month_hold_micro": {
            "description": "Held now, captured when the number activates. 0 for a test number, and 0 when the Agent workspace pays the first month: the number's included_with_workspace is then true.",
            "title": "First Month Hold Micro",
            "type": "integer"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "number": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Number"
              },
              {
                "type": "null"
              }
            ]
          },
          "number_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Number Id"
          },
          "number_type": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Number Type"
          },
          "provider": {
            "title": "Provider",
            "type": "string"
          },
          "recurring_charge_micro": {
            "description": "Charged every month on the activation day.",
            "title": "Recurring Charge Micro",
            "type": "integer"
          },
          "recurring_period": {
            "title": "Recurring Period",
            "type": "string"
          },
          "status": {
            "title": "Status",
            "type": "string"
          }
        },
        "required": [
          "id",
          "environment",
          "status",
          "e164",
          "country",
          "number_type",
          "number_id",
          "number",
          "provider",
          "recurring_charge_micro",
          "recurring_period",
          "first_month_hold_micro",
          "currency",
          "error",
          "created_at",
          "completed_at"
        ],
        "title": "NumberOrder",
        "type": "object"
      },
      "NumberOrderCreate": {
        "additionalProperties": false,
        "properties": {
          "e164": {
            "description": "A number from GET /v1/number-inventory, E.164.",
            "title": "E164",
            "type": "string"
          },
          "inbound_webhook_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The webhook that receives fax.received for this number (default: all).",
            "title": "Inbound Webhook Id"
          },
          "label": {
            "anyOf": [
              {
                "maxLength": 120,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Label"
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Inbound faxes are filed under this project.",
            "title": "Project Id"
          }
        },
        "required": [
          "e164"
        ],
        "title": "NumberOrderCreate",
        "type": "object"
      },
      "NumberOrderList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/NumberOrder"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "NumberOrderList",
        "type": "object"
      },
      "NumberUpdate": {
        "additionalProperties": false,
        "properties": {
          "email_pdf": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "description": "Attach the PDF of each received fax to the notice mail. The mail goes to the verified address of an owner of the organization and to no other address. A PDF over 15 MiB is not attached. It needs the scope number:buy. An agent, an OAuth connection and a connected app are refused.",
            "title": "Email Pdf"
          },
          "inbound_webhook_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Inbound Webhook Id"
          },
          "label": {
            "anyOf": [
              {
                "maxLength": 120,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Label"
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Project Id"
          }
        },
        "title": "NumberUpdate",
        "type": "object"
      },
      "OAuthConsent": {
        "additionalProperties": true,
        "properties": {
          "client": {
            "$ref": "#/components/schemas/OAuthConsentClient"
          },
          "default_environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Default Environment",
            "type": "string"
          },
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "organizations": {
            "items": {
              "$ref": "#/components/schemas/OAuthConsentOrganization"
            },
            "title": "Organizations",
            "type": "array"
          },
          "redirect_host": {
            "title": "Redirect Host",
            "type": "string"
          },
          "scopes_requested": {
            "items": {
              "type": "string"
            },
            "title": "Scopes Requested",
            "type": "array"
          }
        },
        "required": [
          "id",
          "client",
          "redirect_host",
          "scopes_requested",
          "organizations",
          "default_environment",
          "expires_at"
        ],
        "title": "OAuthConsent",
        "type": "object"
      },
      "OAuthConsentAutoSend": {
        "additionalProperties": true,
        "properties": {
          "daily_max_jobs": {
            "title": "Daily Max Jobs",
            "type": "integer"
          },
          "enabled": {
            "title": "Enabled",
            "type": "boolean"
          },
          "max_amount_micro": {
            "title": "Max Amount Micro",
            "type": "integer"
          }
        },
        "required": [
          "enabled",
          "max_amount_micro",
          "daily_max_jobs"
        ],
        "title": "OAuthConsentAutoSend",
        "type": "object"
      },
      "OAuthConsentClient": {
        "additionalProperties": true,
        "properties": {
          "first_seen": {
            "description": "This client was registered during this request.",
            "title": "First Seen",
            "type": "boolean"
          },
          "host": {
            "description": "The host the person is sending a credential to: the trust anchor.",
            "title": "Host",
            "type": "string"
          },
          "loopback": {
            "description": "The redirect goes to the person's own computer (an app they started).",
            "title": "Loopback",
            "type": "boolean"
          },
          "name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The client's own name, shown as text beside the host.",
            "title": "Name"
          }
        },
        "required": [
          "name",
          "host",
          "loopback",
          "first_seen"
        ],
        "title": "OAuthConsentClient",
        "type": "object"
      },
      "OAuthConsentDecision": {
        "additionalProperties": false,
        "properties": {
          "auto_send": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "description": "The consent screen's checkbox, owners only: false turns the organization's auto-send setting off for this environment, true turns it on with its current limits. Omitted leaves it.",
            "title": "Auto Send"
          },
          "environment": {
            "default": "test",
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "org_id": {
            "maxLength": 64,
            "minLength": 1,
            "title": "Org Id",
            "type": "string"
          }
        },
        "required": [
          "org_id"
        ],
        "title": "OAuthConsentDecision",
        "type": "object"
      },
      "OAuthConsentOrganization": {
        "additionalProperties": true,
        "properties": {
          "auto_send": {
            "additionalProperties": {
              "$ref": "#/components/schemas/OAuthConsentAutoSend"
            },
            "description": "The organization's auto-send setting per environment: whether connected apps send within the limits with no approval per fax (https://faxforagents.com/docs/chatgpt-send-within-limits/).",
            "propertyNames": {
              "enum": [
                "live",
                "test"
              ]
            },
            "title": "Auto Send",
            "type": "object"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "role": {
            "title": "Role",
            "type": "string"
          },
          "scopes": {
            "description": "What the grant would carry for this organization and role.",
            "items": {
              "type": "string"
            },
            "title": "Scopes",
            "type": "array"
          }
        },
        "required": [
          "id",
          "name",
          "role",
          "scopes"
        ],
        "title": "OAuthConsentOrganization",
        "type": "object"
      },
      "OAuthRedirect": {
        "additionalProperties": true,
        "properties": {
          "redirect_to": {
            "description": "Where the browser goes next: the client's registered redirect URI.",
            "title": "Redirect To",
            "type": "string"
          }
        },
        "required": [
          "redirect_to"
        ],
        "title": "OAuthRedirect",
        "type": "object"
      },
      "OneTimeAttempts": {
        "additionalProperties": true,
        "description": "The tries of an order's fax while it is still going out. A busy line or one that does not answer\nis dialed again, up to ``max`` tries in all, about ``retry_delay_seconds`` apart. The field\n``last_failure_code`` says why the last finished try did not get through. It is null when no try has\nended.",
        "properties": {
          "last_failure_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last Failure Code"
          },
          "last_finished_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last Finished At"
          },
          "made": {
            "title": "Made",
            "type": "integer"
          },
          "max": {
            "title": "Max",
            "type": "integer"
          },
          "retry_delay_seconds": {
            "title": "Retry Delay Seconds",
            "type": "integer"
          }
        },
        "required": [
          "made",
          "max",
          "last_failure_code",
          "last_finished_at",
          "retry_delay_seconds"
        ],
        "title": "OneTimeAttempts",
        "type": "object"
      },
      "OneTimeCard": {
        "additionalProperties": true,
        "properties": {
          "brand": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Brand"
          },
          "last4": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last4"
          }
        },
        "required": [
          "last4",
          "brand"
        ],
        "title": "OneTimeCard",
        "type": "object"
      },
      "OneTimeCheckout": {
        "additionalProperties": true,
        "properties": {
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "checkout_url": {
            "title": "Checkout Url",
            "type": "string"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "order_id": {
            "title": "Order Id",
            "type": "string"
          }
        },
        "required": [
          "order_id",
          "checkout_url",
          "expires_at",
          "amount_micro",
          "currency"
        ],
        "title": "OneTimeCheckout",
        "type": "object"
      },
      "OneTimeConfig": {
        "additionalProperties": true,
        "description": "What the public send page and an agent read before an order. It says whether the product is open\nhere, and while it is open it gives the card the order will be priced from. It also gives the document\nlimits and the policy the sender accepts. Prices are integer micro-USD, and the client formats the\ndollar figure.",
        "properties": {
          "aup_url": {
            "title": "Aup Url",
            "type": "string"
          },
          "aup_version": {
            "title": "Aup Version",
            "type": "string"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "effective_from": {
            "title": "Effective From",
            "type": "string"
          },
          "enabled": {
            "title": "Enabled",
            "type": "boolean"
          },
          "formats": {
            "items": {
              "type": "string"
            },
            "title": "Formats",
            "type": "array"
          },
          "max_document_pages": {
            "title": "Max Document Pages",
            "type": "integer"
          },
          "max_text_chars": {
            "title": "Max Text Chars",
            "type": "integer"
          },
          "max_upload_bytes": {
            "title": "Max Upload Bytes",
            "type": "integer"
          },
          "price_version": {
            "title": "Price Version",
            "type": "string"
          },
          "queue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OneTimeQueue"
              },
              {
                "type": "null"
              }
            ],
            "description": "The wait a fax ordered now would face for a carrier line. Null when one-time sends are closed here or the carrier has no line limit."
          },
          "reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reason"
          },
          "routes": {
            "additionalProperties": {
              "$ref": "#/components/schemas/OneTimeRoute"
            },
            "title": "Routes",
            "type": "object"
          },
          "terms_url": {
            "title": "Terms Url",
            "type": "string"
          }
        },
        "required": [
          "enabled",
          "price_version",
          "effective_from",
          "currency",
          "routes",
          "max_document_pages",
          "max_upload_bytes",
          "max_text_chars",
          "formats",
          "aup_version",
          "aup_url",
          "terms_url"
        ],
        "title": "OneTimeConfig",
        "type": "object"
      },
      "OneTimeConfirm": {
        "additionalProperties": false,
        "properties": {
          "token": {
            "description": "The token of the link in the confirmation mail.",
            "maxLength": 128,
            "minLength": 1,
            "title": "Token",
            "type": "string"
          }
        },
        "required": [
          "token"
        ],
        "title": "OneTimeConfirm",
        "type": "object"
      },
      "OneTimeConfirmSummary": {
        "additionalProperties": true,
        "description": "What the confirm page shows before the click. ``state`` is ``ok`` while the link can still be used,\nelse ``link_used``, ``link_canceled`` (the order was canceled and its hold released) or\n``link_expired``. Reading it consumes nothing.",
        "properties": {
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "confirm_deadline_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Confirm Deadline At"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "document_pages": {
            "title": "Document Pages",
            "type": "integer"
          },
          "email": {
            "title": "Email",
            "type": "string"
          },
          "order_id": {
            "title": "Order Id",
            "type": "string"
          },
          "sender_name": {
            "title": "Sender Name",
            "type": "string"
          },
          "state": {
            "enum": [
              "ok",
              "link_used",
              "link_canceled",
              "link_expired"
            ],
            "title": "State",
            "type": "string"
          },
          "status": {
            "enum": [
              "draft",
              "checkout_open",
              "authorized",
              "awaiting_confirmation",
              "released",
              "capturing",
              "canceling",
              "captured",
              "released_hold",
              "expired",
              "refused",
              "settle_failed",
              "refunding",
              "refunded",
              "canceled"
            ],
            "title": "Status",
            "type": "string"
          },
          "to": {
            "title": "To",
            "type": "string"
          }
        },
        "required": [
          "order_id",
          "state",
          "status",
          "to",
          "sender_name",
          "email",
          "document_pages",
          "amount_micro",
          "currency",
          "confirm_deadline_at"
        ],
        "title": "OneTimeConfirmSummary",
        "type": "object"
      },
      "OneTimeConfirmed": {
        "additionalProperties": true,
        "description": "``signed_in`` says whether this browser now holds a session for the payer; ``me`` is then the same\nobject ``GET /v1/auth/me`` answers (the CSRF token included).",
        "properties": {
          "me": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Me"
          },
          "order": {
            "$ref": "#/components/schemas/OneTimeOrder"
          },
          "signed_in": {
            "title": "Signed In",
            "type": "boolean"
          }
        },
        "required": [
          "order",
          "signed_in"
        ],
        "title": "OneTimeConfirmed",
        "type": "object"
      },
      "OneTimeCoverCheck": {
        "additionalProperties": false,
        "description": "The fields a one-time order prints on its cover sheet, as a form holds them before the order exists.\nEvery field may be empty. to_name, subject and message have the create's limits, and a longer one is\nrefused as the create refuses it: 422 invalid_request on cover.",
        "properties": {
          "email": {
            "anyOf": [
              {
                "maxLength": 1000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Printed in the From line.",
            "title": "Email"
          },
          "message": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The note printed under the Message heading. It has to fit on the one cover page. At most 2,000 characters, not counting spaces at either end.",
            "title": "Message"
          },
          "sender_name": {
            "anyOf": [
              {
                "maxLength": 1000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Printed in the From line.",
            "title": "Sender Name"
          },
          "subject": {
            "anyOf": [
              {
                "maxLength": 200,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Printed in a Subject line when it is given. At most 200 characters, not counting spaces at either end.",
            "title": "Subject"
          },
          "to": {
            "anyOf": [
              {
                "maxLength": 100,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The destination, when one is typed.",
            "title": "To"
          },
          "to_name": {
            "anyOf": [
              {
                "maxLength": 120,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The recipient's name, printed in the To line. At most 120 characters, not counting spaces at either end.",
            "title": "To Name"
          }
        },
        "title": "OneTimeCoverCheck",
        "type": "object"
      },
      "OneTimeCoverRoom": {
        "additionalProperties": true,
        "description": "How the message sits on the one cover page, measured as the create measures it. Nothing is stored\nand no order is made.",
        "properties": {
          "fits": {
            "description": "The cover with this message fits on its one page.",
            "title": "Fits",
            "type": "boolean"
          },
          "fits_chars": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the message runs over: how much of its start fits with the same line breaks. Null when it fits, and when the page is full without any message.",
            "title": "Fits Chars"
          },
          "lines_left": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "How many more lines of message text fit on the page. Null when the message is empty, since the first line also brings its heading, and when it does not fit.",
            "title": "Lines Left"
          },
          "message_chars": {
            "description": "The length of the message as it will be printed.",
            "title": "Message Chars",
            "type": "integer"
          }
        },
        "required": [
          "fits",
          "message_chars"
        ],
        "title": "OneTimeCoverRoom",
        "type": "object"
      },
      "OneTimeFromQuote": {
        "additionalProperties": false,
        "properties": {
          "accept_aup": {
            "default": false,
            "description": "A session sends true: the signed-in person accepts the acceptable use policy and the terms. A key's value is not recorded: the person who pays accepts on the order's page.",
            "title": "Accept Aup",
            "type": "boolean"
          },
          "approval_id": {
            "anyOf": [
              {
                "maxLength": 64,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "An approved, unused approval request for this quote (POST /v1/approval-requests). A key needs it unless a delegated policy allows the send. A session needs none.",
            "title": "Approval Id"
          },
          "delete_after_send": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "description": "Delete the document and the transmitted copy the moment the fax ends in delivered, partial or failed. The order, the receipt and the carrier evidence stay; they hold no document content. A fax that ends unknown keeps the document until the carrier reports, or until the retention period ends. Left out, the quote's own delete_after_send applies.",
            "title": "Delete After Send"
          },
          "email": {
            "anyOf": [
              {
                "maxLength": 254,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Email"
          },
          "quote_id": {
            "title": "Quote Id",
            "type": "string"
          },
          "sender_name": {
            "description": "Printed on the cover sheet. 2 to 120 characters.",
            "maxLength": 200,
            "title": "Sender Name",
            "type": "string"
          },
          "source_ref": {
            "anyOf": [
              {
                "maxLength": 32,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Source Ref"
          }
        },
        "required": [
          "quote_id",
          "sender_name"
        ],
        "title": "OneTimeFromQuote",
        "type": "object"
      },
      "OneTimeInspection": {
        "additionalProperties": true,
        "description": "What a file would be as a one-time order's document: its page count and its first page as a small\nPNG. The PNG is base64, or null when this server cannot draw one. Nothing is stored and no order is\nmade.",
        "properties": {
          "document_pages": {
            "title": "Document Pages",
            "type": "integer"
          },
          "thumbnail_png_base64": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Thumbnail Png Base64"
          },
          "warnings": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Warnings",
            "type": "array"
          }
        },
        "required": [
          "document_pages",
          "thumbnail_png_base64"
        ],
        "title": "OneTimeInspection",
        "type": "object"
      },
      "OneTimeJob": {
        "additionalProperties": true,
        "description": "The order behind a fax job that a one-time send made: what was held on the card, what was charged.",
        "properties": {
          "amount_micro": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Amount Micro"
          },
          "authorized_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "On a receipt: when the card was held.",
            "title": "Authorized At"
          },
          "captured_micro": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Captured Micro"
          },
          "card": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OneTimeCard"
              },
              {
                "type": "null"
              }
            ]
          },
          "document_pages": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "The pages of the order's document. The cover sheet is not counted.",
            "title": "Document Pages"
          },
          "email": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "On a receipt: the address the order was made with.",
            "title": "Email"
          },
          "failure_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "On a receipt: why the order ended unpaid.",
            "title": "Failure Code"
          },
          "order_id": {
            "title": "Order Id",
            "type": "string"
          },
          "price": {
            "anyOf": [
              {
                "additionalProperties": {
                  "type": "integer"
                },
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "On a receipt: flat_micro, included_pages and extra_page_micro the amount follows from.",
            "title": "Price"
          },
          "refunded_micro": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "What was refunded to the card after the charge, in micro-units.",
            "title": "Refunded Micro"
          },
          "sender_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "On a receipt: the sender's name.",
            "title": "Sender Name"
          },
          "settled_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "On a receipt: when the payment provider confirmed the charge, or the release.",
            "title": "Settled At"
          },
          "status": {
            "anyOf": [
              {
                "enum": [
                  "draft",
                  "checkout_open",
                  "authorized",
                  "awaiting_confirmation",
                  "released",
                  "capturing",
                  "canceling",
                  "captured",
                  "released_hold",
                  "expired",
                  "refused",
                  "settle_failed",
                  "refunding",
                  "refunded",
                  "canceled"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Status"
          }
        },
        "required": [
          "order_id"
        ],
        "title": "OneTimeJob",
        "type": "object"
      },
      "OneTimeOrder": {
        "additionalProperties": true,
        "description": "One order of the one-time send. The field ``next`` is what the caller does now: ``checkout`` (pay),\n``confirm`` (click the mailed link), ``wait`` (read again later) or ``done``. Money is integer\nmicro-USD. The field ``captured_micro`` is what the card was charged, written only once the payment\nprovider confirmed it. The field ``fax`` is the fax job once the order was released, with the\ncarrier's evidence once it has any. Three statuses come from a person at Fax for Agents. With\n``refunding`` a refund is on its way to the card, and with ``refunded`` the whole charge went back. With\n``canceled`` the order was canceled and the hold on the card released, so nothing was charged.",
        "properties": {
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "attempts": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OneTimeAttempts"
              },
              {
                "type": "null"
              }
            ],
            "description": "The tries of the order's fax while it has not ended. It says how many were made, of how many, and why the last one did not get through. Null before the fax exists and once it ended."
          },
          "aup_accepted": {
            "default": true,
            "description": "Whether a person accepted the acceptable use policy and the terms for this order. False for an order a key created until the payer accepts on the order's page; the checkout needs it.",
            "title": "Aup Accepted",
            "type": "boolean"
          },
          "aup_version": {
            "title": "Aup Version",
            "type": "string"
          },
          "authorized_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Authorized At"
          },
          "capture_deadline_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Capture Deadline At"
          },
          "captured_micro": {
            "title": "Captured Micro",
            "type": "integer"
          },
          "card": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OneTimeCard"
              },
              {
                "type": "null"
              }
            ]
          },
          "checkout_expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Checkout Expires At"
          },
          "checkout_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Checkout Url"
          },
          "confirm_deadline_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Confirm Deadline At"
          },
          "confirm_mail_sent_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Confirm Mail Sent At"
          },
          "cover": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cover"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "delete_after_send": {
            "default": false,
            "description": "The sender asked for the document and the transmitted copy to be deleted the moment the fax ends in delivered, partial or failed.",
            "title": "Delete After Send",
            "type": "boolean"
          },
          "document_deleted": {
            "default": false,
            "description": "True once no copy of the document is held. It was deleted after the send, by the retention period or by its owner. Or the order ended before its release and the uploaded file was removed. The order, the fax and the carrier evidence stay, and they hold no document content.",
            "title": "Document Deleted",
            "type": "boolean"
          },
          "document_expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the retention period deletes the stored document. Null before the release and once the document is deleted.",
            "title": "Document Expires At"
          },
          "document_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Document Id"
          },
          "document_pages": {
            "title": "Document Pages",
            "type": "integer"
          },
          "document_sha256": {
            "title": "Document Sha256",
            "type": "string"
          },
          "email": {
            "title": "Email",
            "type": "string"
          },
          "email_verified": {
            "title": "Email Verified",
            "type": "boolean"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "failure_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Failure Code"
          },
          "fax": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "The fax job (the FaxJob shape) once the order was released; null before.",
            "title": "Fax"
          },
          "fax_job_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Fax Job Id"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "next": {
            "enum": [
              "checkout",
              "confirm",
              "wait",
              "done"
            ],
            "title": "Next",
            "type": "string"
          },
          "preview": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OneTimePreview"
              },
              {
                "type": "null"
              }
            ],
            "description": "Whether the order's pages can be looked at (the cover sheet and the document). Present on the read of one order; null in a list and in the create's answer."
          },
          "price": {
            "$ref": "#/components/schemas/OneTimePrice"
          },
          "queue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OneTimeQueue"
              },
              {
                "type": "null"
              }
            ],
            "description": "The wait for a carrier line while the order has not ended and its fax is not on a line yet. Null for an ended order, a fax that is sending, and a test order."
          },
          "quote_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Quote Id"
          },
          "refund_pending_micro": {
            "default": 0,
            "description": "A refund on its way to the card that the payment provider has not confirmed yet, in micro-units, while the order is refunding. Zero otherwise.",
            "title": "Refund Pending Micro",
            "type": "integer"
          },
          "refunded_micro": {
            "default": 0,
            "description": "What was refunded to the card after the charge, in micro-units, as the ledger holds it. Zero when nothing was refunded. captured_micro stays what was charged.",
            "title": "Refunded Micro",
            "type": "integer"
          },
          "released_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Released At"
          },
          "resend_allowed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the confirmation mail may be asked for again; null when it may not.",
            "title": "Resend Allowed At"
          },
          "route": {
            "title": "Route",
            "type": "string"
          },
          "sender_name": {
            "title": "Sender Name",
            "type": "string"
          },
          "settled_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Settled At"
          },
          "source": {
            "enum": [
              "web",
              "api",
              "mcp"
            ],
            "title": "Source",
            "type": "string"
          },
          "status": {
            "enum": [
              "draft",
              "checkout_open",
              "authorized",
              "awaiting_confirmation",
              "released",
              "capturing",
              "canceling",
              "captured",
              "released_hold",
              "expired",
              "refused",
              "settle_failed",
              "refunding",
              "refunded",
              "canceled"
            ],
            "title": "Status",
            "type": "string"
          },
          "status_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The order's page for the person who pays or confirms, with a fresh status token. Present on a read by a key or session of the order's organization while the order is not done.",
            "title": "Status Url"
          },
          "to": {
            "title": "To",
            "type": "string"
          },
          "updated_at": {
            "title": "Updated At",
            "type": "string"
          },
          "warnings": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Warnings",
            "type": "array"
          }
        },
        "required": [
          "id",
          "status",
          "next",
          "environment",
          "source",
          "email",
          "email_verified",
          "sender_name",
          "to",
          "route",
          "cover",
          "document_pages",
          "document_sha256",
          "document_id",
          "price",
          "amount_micro",
          "captured_micro",
          "card",
          "checkout_url",
          "checkout_expires_at",
          "authorized_at",
          "confirm_deadline_at",
          "capture_deadline_at",
          "confirm_mail_sent_at",
          "released_at",
          "settled_at",
          "quote_id",
          "fax_job_id",
          "failure_code",
          "aup_version",
          "created_at",
          "updated_at"
        ],
        "title": "OneTimeOrder",
        "type": "object"
      },
      "OneTimeOrderCreated": {
        "additionalProperties": true,
        "description": "The create answer: the order plus the status token. The token reads this one order, opens its\ncheckout and asks for the confirmation mail again, with no key and no session, for seven days. Send it\nas ``X-FFA-Order-Token`` (or ``?t=``). ``status_url`` is the order's page in the app with the token.",
        "properties": {
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "attempts": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OneTimeAttempts"
              },
              {
                "type": "null"
              }
            ],
            "description": "The tries of the order's fax while it has not ended. It says how many were made, of how many, and why the last one did not get through. Null before the fax exists and once it ended."
          },
          "aup_accepted": {
            "default": true,
            "description": "Whether a person accepted the acceptable use policy and the terms for this order. False for an order a key created until the payer accepts on the order's page; the checkout needs it.",
            "title": "Aup Accepted",
            "type": "boolean"
          },
          "aup_version": {
            "title": "Aup Version",
            "type": "string"
          },
          "authorized_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Authorized At"
          },
          "capture_deadline_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Capture Deadline At"
          },
          "captured_micro": {
            "title": "Captured Micro",
            "type": "integer"
          },
          "card": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OneTimeCard"
              },
              {
                "type": "null"
              }
            ]
          },
          "checkout_expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Checkout Expires At"
          },
          "checkout_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Checkout Url"
          },
          "confirm_deadline_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Confirm Deadline At"
          },
          "confirm_mail_sent_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Confirm Mail Sent At"
          },
          "cover": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cover"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "delete_after_send": {
            "default": false,
            "description": "The sender asked for the document and the transmitted copy to be deleted the moment the fax ends in delivered, partial or failed.",
            "title": "Delete After Send",
            "type": "boolean"
          },
          "document_deleted": {
            "default": false,
            "description": "True once no copy of the document is held. It was deleted after the send, by the retention period or by its owner. Or the order ended before its release and the uploaded file was removed. The order, the fax and the carrier evidence stay, and they hold no document content.",
            "title": "Document Deleted",
            "type": "boolean"
          },
          "document_expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the retention period deletes the stored document. Null before the release and once the document is deleted.",
            "title": "Document Expires At"
          },
          "document_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Document Id"
          },
          "document_pages": {
            "title": "Document Pages",
            "type": "integer"
          },
          "document_sha256": {
            "title": "Document Sha256",
            "type": "string"
          },
          "email": {
            "title": "Email",
            "type": "string"
          },
          "email_verified": {
            "title": "Email Verified",
            "type": "boolean"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "failure_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Failure Code"
          },
          "fax": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "The fax job (the FaxJob shape) once the order was released; null before.",
            "title": "Fax"
          },
          "fax_job_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Fax Job Id"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "next": {
            "enum": [
              "checkout",
              "confirm",
              "wait",
              "done"
            ],
            "title": "Next",
            "type": "string"
          },
          "preview": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OneTimePreview"
              },
              {
                "type": "null"
              }
            ],
            "description": "Whether the order's pages can be looked at (the cover sheet and the document). Present on the read of one order; null in a list and in the create's answer."
          },
          "price": {
            "$ref": "#/components/schemas/OneTimePrice"
          },
          "queue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OneTimeQueue"
              },
              {
                "type": "null"
              }
            ],
            "description": "The wait for a carrier line while the order has not ended and its fax is not on a line yet. Null for an ended order, a fax that is sending, and a test order."
          },
          "quote_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Quote Id"
          },
          "refund_pending_micro": {
            "default": 0,
            "description": "A refund on its way to the card that the payment provider has not confirmed yet, in micro-units, while the order is refunding. Zero otherwise.",
            "title": "Refund Pending Micro",
            "type": "integer"
          },
          "refunded_micro": {
            "default": 0,
            "description": "What was refunded to the card after the charge, in micro-units, as the ledger holds it. Zero when nothing was refunded. captured_micro stays what was charged.",
            "title": "Refunded Micro",
            "type": "integer"
          },
          "released_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Released At"
          },
          "resend_allowed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the confirmation mail may be asked for again; null when it may not.",
            "title": "Resend Allowed At"
          },
          "route": {
            "title": "Route",
            "type": "string"
          },
          "sender_name": {
            "title": "Sender Name",
            "type": "string"
          },
          "settled_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Settled At"
          },
          "source": {
            "enum": [
              "web",
              "api",
              "mcp"
            ],
            "title": "Source",
            "type": "string"
          },
          "status": {
            "enum": [
              "draft",
              "checkout_open",
              "authorized",
              "awaiting_confirmation",
              "released",
              "capturing",
              "canceling",
              "captured",
              "released_hold",
              "expired",
              "refused",
              "settle_failed",
              "refunding",
              "refunded",
              "canceled"
            ],
            "title": "Status",
            "type": "string"
          },
          "status_token": {
            "title": "Status Token",
            "type": "string"
          },
          "status_url": {
            "title": "Status Url",
            "type": "string"
          },
          "to": {
            "title": "To",
            "type": "string"
          },
          "updated_at": {
            "title": "Updated At",
            "type": "string"
          },
          "warnings": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Warnings",
            "type": "array"
          }
        },
        "required": [
          "id",
          "status",
          "next",
          "environment",
          "source",
          "email",
          "email_verified",
          "sender_name",
          "to",
          "route",
          "cover",
          "document_pages",
          "document_sha256",
          "document_id",
          "price",
          "amount_micro",
          "captured_micro",
          "card",
          "checkout_url",
          "checkout_expires_at",
          "authorized_at",
          "confirm_deadline_at",
          "capture_deadline_at",
          "confirm_mail_sent_at",
          "released_at",
          "settled_at",
          "quote_id",
          "fax_job_id",
          "failure_code",
          "aup_version",
          "status_url",
          "created_at",
          "updated_at",
          "status_token"
        ],
        "title": "OneTimeOrderCreated",
        "type": "object"
      },
      "OneTimeOrderPage": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/OneTimeOrder"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          }
        },
        "required": [
          "items"
        ],
        "title": "OneTimeOrderPage",
        "type": "object"
      },
      "OneTimePreview": {
        "additionalProperties": true,
        "description": "Whether the pages of an order can be looked at, and how many. ``draft``: the cover sheet as it\nwill be printed and the uploaded document, before the fax is released. ``sent``: the file that went\nto the carrier, cover sheet first. ``deleted``: no copy is held any more (the sender asked for the\ndeletion, the retention ended, or the order ended before a fax was made). ``unavailable``: nothing\nto show right now. Page ``n`` is ``GET /v1/one-time-sends/{id}/pages/{n}``, 1 to ``pages``.",
        "properties": {
          "cover_pages": {
            "title": "Cover Pages",
            "type": "integer"
          },
          "pages": {
            "title": "Pages",
            "type": "integer"
          },
          "state": {
            "enum": [
              "draft",
              "sent",
              "deleted",
              "unavailable"
            ],
            "title": "State",
            "type": "string"
          }
        },
        "required": [
          "state",
          "pages",
          "cover_pages"
        ],
        "title": "OneTimePreview",
        "type": "object"
      },
      "OneTimePrice": {
        "additionalProperties": true,
        "properties": {
          "cover_included": {
            "title": "Cover Included",
            "type": "boolean"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "extra_page_micro": {
            "title": "Extra Page Micro",
            "type": "integer"
          },
          "flat_micro": {
            "title": "Flat Micro",
            "type": "integer"
          },
          "included_pages": {
            "title": "Included Pages",
            "type": "integer"
          },
          "price_version": {
            "title": "Price Version",
            "type": "string"
          }
        },
        "required": [
          "price_version",
          "currency",
          "flat_micro",
          "included_pages",
          "extra_page_micro",
          "cover_included"
        ],
        "title": "OneTimePrice",
        "type": "object"
      },
      "OneTimeQueue": {
        "additionalProperties": true,
        "description": "The wait for a carrier line. The field ``queued`` is true when a fax sent now, or this order's\nwaiting fax, is estimated to wait over ten minutes for a line. The order is kept and sent in turn,\nnever dropped. The minutes are an estimate from the number of faxes ahead and the carrier's line\ncount.",
        "properties": {
          "estimated_wait_minutes": {
            "title": "Estimated Wait Minutes",
            "type": "integer"
          },
          "jobs_ahead": {
            "title": "Jobs Ahead",
            "type": "integer"
          },
          "paused": {
            "default": false,
            "description": "An operator has paused sends on this route. A fax to it is kept and goes out when the route is resumed; no time can be estimated. A one-time order that is not sent within 48 hours of its release is canceled and the card is not charged.",
            "title": "Paused",
            "type": "boolean"
          },
          "queued": {
            "title": "Queued",
            "type": "boolean"
          }
        },
        "required": [
          "queued",
          "jobs_ahead",
          "estimated_wait_minutes"
        ],
        "title": "OneTimeQueue",
        "type": "object"
      },
      "OneTimeRoute": {
        "additionalProperties": true,
        "properties": {
          "cover_included": {
            "title": "Cover Included",
            "type": "boolean"
          },
          "extra_page_micro": {
            "title": "Extra Page Micro",
            "type": "integer"
          },
          "flat_micro": {
            "title": "Flat Micro",
            "type": "integer"
          },
          "included_pages": {
            "title": "Included Pages",
            "type": "integer"
          },
          "label": {
            "title": "Label",
            "type": "string"
          }
        },
        "required": [
          "label",
          "flat_micro",
          "included_pages",
          "extra_page_micro",
          "cover_included"
        ],
        "title": "OneTimeRoute",
        "type": "object"
      },
      "Organization": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "members": {
            "title": "Members",
            "type": "integer"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "role": {
            "anyOf": [
              {
                "enum": [
                  "owner",
                  "admin",
                  "member",
                  "viewer"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Role"
          }
        },
        "required": [
          "id",
          "name",
          "role",
          "created_at",
          "members"
        ],
        "title": "Organization",
        "type": "object"
      },
      "OrganizationList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/OrganizationSummary"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "OrganizationList",
        "type": "object"
      },
      "OrganizationPatch": {
        "additionalProperties": false,
        "properties": {
          "name": {
            "maxLength": 80,
            "minLength": 1,
            "title": "Name",
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "title": "OrganizationPatch",
        "type": "object"
      },
      "OrganizationSummary": {
        "additionalProperties": true,
        "properties": {
          "id": {
            "title": "Id",
            "type": "string"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "role": {
            "enum": [
              "owner",
              "admin",
              "member",
              "viewer"
            ],
            "title": "Role",
            "type": "string"
          },
          "suspended_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Set while a review has paused sending for the whole organization. A send answers `account_suspended` until it is cleared. Reads keep working.",
            "title": "Suspended At"
          }
        },
        "required": [
          "id",
          "name",
          "role"
        ],
        "title": "OrganizationSummary",
        "type": "object"
      },
      "PagePreview": {
        "additionalProperties": true,
        "properties": {
          "height_px": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Height Px"
          },
          "page_number": {
            "title": "Page Number",
            "type": "integer"
          },
          "url": {
            "title": "Url",
            "type": "string"
          },
          "width_px": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Width Px"
          }
        },
        "required": [
          "page_number",
          "width_px",
          "height_px",
          "url"
        ],
        "title": "PagePreview",
        "type": "object"
      },
      "Passkey": {
        "additionalProperties": true,
        "properties": {
          "aaguid": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Aaguid"
          },
          "backup_eligible": {
            "title": "Backup Eligible",
            "type": "boolean"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "label": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Label"
          },
          "last_used_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last Used At"
          },
          "transports": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Transports"
          }
        },
        "required": [
          "id",
          "label",
          "aaguid",
          "transports",
          "backup_eligible",
          "created_at",
          "last_used_at"
        ],
        "title": "Passkey",
        "type": "object"
      },
      "PasskeyList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Passkey"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "PasskeyList",
        "type": "object"
      },
      "PasskeyLoginVerify": {
        "additionalProperties": false,
        "properties": {
          "credential": {
            "additionalProperties": true,
            "title": "Credential",
            "type": "object"
          }
        },
        "required": [
          "credential"
        ],
        "title": "PasskeyLoginVerify",
        "type": "object"
      },
      "PasskeyPatch": {
        "additionalProperties": false,
        "description": "A new name for a passkey.",
        "properties": {
          "label": {
            "description": "The name shown in Settings.",
            "maxLength": 80,
            "minLength": 1,
            "title": "Label",
            "type": "string"
          }
        },
        "required": [
          "label"
        ],
        "title": "PasskeyPatch",
        "type": "object"
      },
      "PasskeyRegisterVerify": {
        "additionalProperties": false,
        "properties": {
          "credential": {
            "additionalProperties": true,
            "title": "Credential",
            "type": "object"
          },
          "label": {
            "anyOf": [
              {
                "maxLength": 80,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Label"
          }
        },
        "required": [
          "credential"
        ],
        "title": "PasskeyRegisterVerify",
        "type": "object"
      },
      "PaymentReceipt": {
        "additionalProperties": true,
        "properties": {
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "amount_refunded_micro": {
            "title": "Amount Refunded Micro",
            "type": "integer"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "invoice_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Invoice Id"
          },
          "paid_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid At"
          },
          "payment_intent_id": {
            "title": "Payment Intent Id",
            "type": "string"
          },
          "pdf_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The same receipt as a PDF, where Stripe has one: the receipt of a paid invoice, which a top-up paid in Checkout has. Null for a charge without an invoice, such as an automatic top-up: its receipt is the page at url.",
            "title": "Pdf Url"
          },
          "topup_session_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Topup Session Id"
          },
          "url": {
            "description": "Stripe's hosted receipt for the payment. It says what was paid and when.",
            "title": "Url",
            "type": "string"
          }
        },
        "required": [
          "url",
          "amount_micro",
          "amount_refunded_micro",
          "currency",
          "payment_intent_id",
          "paid_at"
        ],
        "title": "PaymentReceipt",
        "type": "object"
      },
      "Policy": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "created_by": {
            "title": "Created By",
            "type": "string"
          },
          "current_version_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Current Version Id"
          },
          "enabled": {
            "title": "Enabled",
            "type": "boolean"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "managed": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "connected_apps when a Settings switch (the auto-send setting) manages this policy. Such a policy is read here and changed only through PUT /v1/organizations/current/auto-send.",
            "title": "Managed"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "purpose": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Purpose"
          },
          "rules": {
            "additionalProperties": true,
            "title": "Rules",
            "type": "object"
          },
          "updated_at": {
            "title": "Updated At",
            "type": "string"
          },
          "version": {
            "title": "Version",
            "type": "integer"
          }
        },
        "required": [
          "id",
          "name",
          "purpose",
          "enabled",
          "version",
          "current_version_id",
          "rules",
          "created_by",
          "created_at",
          "updated_at"
        ],
        "title": "Policy",
        "type": "object"
      },
      "PolicyCreate": {
        "additionalProperties": false,
        "properties": {
          "enabled": {
            "default": true,
            "title": "Enabled",
            "type": "boolean"
          },
          "name": {
            "maxLength": 120,
            "minLength": 1,
            "title": "Name",
            "type": "string"
          },
          "purpose": {
            "anyOf": [
              {
                "maxLength": 500,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Why this policy exists. Shown, never evaluated.",
            "title": "Purpose"
          },
          "rules": {
            "additionalProperties": true,
            "description": "The rules of the policy. Each field is described at https://faxforagents.com/docs/policies/#the-rules.",
            "title": "Rules",
            "type": "object"
          }
        },
        "required": [
          "name",
          "rules"
        ],
        "title": "PolicyCreate",
        "type": "object"
      },
      "PolicyEvaluation": {
        "additionalProperties": true,
        "description": "A dry run: the verdict for one planned send, the plan as the server read it, and what a send of it\nwould need. Nothing is sent.",
        "properties": {
          "approval_required": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "description": "What a send of this plan by that caller would need: true when a person has to approve it. false when a policy allows it, and for a test send by a caller no policy binds. It is false for a signed-in owner's own live send too, which needs no approval.",
            "title": "Approval Required"
          },
          "decision": {
            "enum": [
              "allow",
              "deny"
            ],
            "title": "Decision",
            "type": "string"
          },
          "denials": {
            "description": "Every policy that denied the plan, each with its policy_id, policy_version_id, decision, rule and reason. Empty on allow.",
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Denials",
            "type": "array"
          },
          "executed": {
            "default": false,
            "title": "Executed",
            "type": "boolean"
          },
          "managed": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "connected_apps when the organization's auto-send setting decided, else null.",
            "title": "Managed"
          },
          "plan": {
            "additionalProperties": true,
            "title": "Plan",
            "type": "object"
          },
          "policy_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The policy that allowed the plan, or the first one that denied it. Null when none binds.",
            "title": "Policy Id"
          },
          "policy_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The name of that policy. Null when none binds.",
            "title": "Policy Name"
          },
          "policy_version_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The version of that policy that decided.",
            "title": "Policy Version Id"
          },
          "reason": {
            "description": "Why, in one sentence.",
            "title": "Reason",
            "type": "string"
          },
          "rule": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The rule that failed first when a policy denied the plan. Null on allow, and when no policy binds the caller.",
            "title": "Rule"
          },
          "subject": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The caller the plan was evaluated for: the calling principal, or the key, agent or connected app the request named.",
            "title": "Subject"
          },
          "under_policy": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "description": "Whether any policy binds that caller. false with decision deny means no policy applies, not that a policy refused the plan.",
            "title": "Under Policy"
          },
          "usage": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/PolicyUsage"
              },
              {
                "type": "null"
              }
            ],
            "description": "On allow: the deciding policy's counters for the day and the month before this send."
          },
          "version": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "The number of that version: 1 for the policy's first rules, one more for each change. Null when none binds.",
            "title": "Version"
          }
        },
        "required": [
          "decision",
          "rule",
          "reason",
          "policy_id",
          "policy_version_id",
          "policy_name",
          "version",
          "denials",
          "plan"
        ],
        "title": "PolicyEvaluation",
        "type": "object"
      },
      "PolicyEvaluationCreate": {
        "additionalProperties": false,
        "properties": {
          "agent_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Evaluate as this agent of your organization (bindings to single keys excluded).",
            "title": "Agent Id"
          },
          "connection_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Evaluate as this connected app (an OAuth grant, GET /v1/oauth/grants), in the connection's environment. A signed-in person may name their own.",
            "title": "Connection Id"
          },
          "document_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Or plan: this document ...",
            "title": "Document Id"
          },
          "from": {
            "anyOf": [
              {
                "maxLength": 32,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "From"
          },
          "key_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Evaluate as this API key of your organization instead of the caller, in the key's environment. Choose at most one of key_id, agent_id and connection_id.",
            "title": "Key Id"
          },
          "quote_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Evaluate an existing quote.",
            "title": "Quote Id"
          },
          "to": {
            "anyOf": [
              {
                "maxLength": 32,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "... to this E.164 destination.",
            "title": "To"
          }
        },
        "title": "PolicyEvaluationCreate",
        "type": "object"
      },
      "PolicyList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Policy"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "PolicyList",
        "type": "object"
      },
      "PolicyRuleCheck": {
        "additionalProperties": true,
        "description": "Which of a draft's numbers its countries or prefixes already allow.",
        "properties": {
          "already_allowed": {
            "description": "The listed numbers a listed country or prefix allows anyway. A destination passes a policy when it matches any of the three lists, so for these numbers the number list adds nothing.",
            "items": {
              "$ref": "#/components/schemas/AlreadyAllowed"
            },
            "title": "Already Allowed",
            "type": "array"
          }
        },
        "required": [
          "already_allowed"
        ],
        "title": "PolicyRuleCheck",
        "type": "object"
      },
      "PolicyRuleCheckCreate": {
        "additionalProperties": false,
        "description": "The three destination lists of a draft policy, to check against each other.",
        "properties": {
          "allowed_countries": {
            "description": "The draft's ISO 3166-1 alpha-2 country codes, such as US or GB.",
            "items": {
              "type": "string"
            },
            "maxItems": 300,
            "title": "Allowed Countries",
            "type": "array"
          },
          "allowed_country_prefixes": {
            "description": "The draft's dialing prefixes, written as the rate card routes on them, such as +44.",
            "items": {
              "type": "string"
            },
            "maxItems": 300,
            "title": "Allowed Country Prefixes",
            "type": "array"
          },
          "allowed_destinations": {
            "description": "The draft's exact E.164 numbers.",
            "items": {
              "type": "string"
            },
            "maxItems": 500,
            "title": "Allowed Destinations",
            "type": "array"
          }
        },
        "title": "PolicyRuleCheckCreate",
        "type": "object"
      },
      "PolicyUpdate": {
        "additionalProperties": false,
        "properties": {
          "enabled": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "title": "Enabled"
          },
          "name": {
            "anyOf": [
              {
                "maxLength": 120,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Name"
          },
          "purpose": {
            "anyOf": [
              {
                "maxLength": 500,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Purpose"
          },
          "rules": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rules"
          }
        },
        "title": "PolicyUpdate",
        "type": "object"
      },
      "PolicyUsage": {
        "additionalProperties": true,
        "description": "What the deciding policy had counted before the send it was asked about, in UTC periods.",
        "properties": {
          "day_amount_micro": {
            "description": "The amount of those sends in micro-USD, as priced when the policy allowed each one. A fax that fails later still counts.",
            "title": "Day Amount Micro",
            "type": "integer"
          },
          "day_jobs": {
            "description": "Sends this policy allowed so far in the current UTC day.",
            "title": "Day Jobs",
            "type": "integer"
          },
          "month_amount_micro": {
            "description": "The amount of this month's sends in micro-USD, counted the same way as the day's.",
            "title": "Month Amount Micro",
            "type": "integer"
          },
          "month_jobs": {
            "description": "Sends this policy allowed so far in the current UTC month.",
            "title": "Month Jobs",
            "type": "integer"
          }
        },
        "required": [
          "day_jobs",
          "day_amount_micro",
          "month_jobs",
          "month_amount_micro"
        ],
        "title": "PolicyUsage",
        "type": "object"
      },
      "PolicyVerdict": {
        "additionalProperties": true,
        "description": "One evaluation of the delegated policies that bind a caller: the first policy that allows the plan,\nor every policy that denies it.",
        "properties": {
          "decision": {
            "enum": [
              "allow",
              "deny"
            ],
            "title": "Decision",
            "type": "string"
          },
          "denials": {
            "description": "Every policy that denied the plan, each with its policy_id, policy_version_id, decision, rule and reason. Empty on allow.",
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Denials",
            "type": "array"
          },
          "managed": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "connected_apps when the organization's auto-send setting decided, else null.",
            "title": "Managed"
          },
          "policy_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The policy that allowed the plan, or the first one that denied it. Null when none binds.",
            "title": "Policy Id"
          },
          "policy_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The name of that policy. Null when none binds.",
            "title": "Policy Name"
          },
          "policy_version_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The version of that policy that decided.",
            "title": "Policy Version Id"
          },
          "reason": {
            "description": "Why, in one sentence.",
            "title": "Reason",
            "type": "string"
          },
          "rule": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The rule that failed first when a policy denied the plan. Null on allow, and when no policy binds the caller.",
            "title": "Rule"
          },
          "usage": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/PolicyUsage"
              },
              {
                "type": "null"
              }
            ],
            "description": "On allow: the deciding policy's counters for the day and the month before this send."
          },
          "version": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "The number of that version: 1 for the policy's first rules, one more for each change. Null when none binds.",
            "title": "Version"
          }
        },
        "required": [
          "decision",
          "rule",
          "reason",
          "policy_id",
          "policy_version_id",
          "policy_name",
          "version",
          "denials"
        ],
        "title": "PolicyVerdict",
        "type": "object"
      },
      "PolicyVersion": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "created_by": {
            "title": "Created By",
            "type": "string"
          },
          "created_by_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Who wrote the version as people read it: a person's address or a key's label.",
            "title": "Created By Name"
          },
          "enabled": {
            "title": "Enabled",
            "type": "boolean"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "policy_id": {
            "title": "Policy Id",
            "type": "string"
          },
          "purpose": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Purpose"
          },
          "rules": {
            "additionalProperties": true,
            "title": "Rules",
            "type": "object"
          },
          "version": {
            "title": "Version",
            "type": "integer"
          }
        },
        "required": [
          "id",
          "policy_id",
          "version",
          "name",
          "purpose",
          "enabled",
          "rules",
          "created_by",
          "created_at"
        ],
        "title": "PolicyVersion",
        "type": "object"
      },
      "PolicyVersionList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/PolicyVersion"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "PolicyVersionList",
        "type": "object"
      },
      "PortOrder": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "direction": {
            "title": "Direction",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "milestones": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Milestones",
            "type": "array"
          },
          "numbers": {
            "items": {
              "type": "string"
            },
            "title": "Numbers",
            "type": "array"
          },
          "provider": {
            "title": "Provider",
            "type": "string"
          },
          "request": {
            "additionalProperties": true,
            "title": "Request",
            "type": "object"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "updated_at": {
            "title": "Updated At",
            "type": "string"
          }
        },
        "required": [
          "id",
          "environment",
          "direction",
          "status",
          "numbers",
          "request",
          "milestones",
          "provider",
          "created_at",
          "updated_at"
        ],
        "title": "PortOrder",
        "type": "object"
      },
      "PortOrderCreate": {
        "additionalProperties": false,
        "properties": {
          "note": {
            "anyOf": [
              {
                "maxLength": 500,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Note"
          },
          "numbers": {
            "items": {
              "type": "string"
            },
            "maxItems": 50,
            "minItems": 1,
            "title": "Numbers",
            "type": "array"
          }
        },
        "required": [
          "numbers"
        ],
        "title": "PortOrderCreate",
        "type": "object"
      },
      "PortOrderList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/PortOrder"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "PortOrderList",
        "type": "object"
      },
      "PortOutRequestCreate": {
        "additionalProperties": false,
        "properties": {
          "note": {
            "anyOf": [
              {
                "maxLength": 500,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Note"
          },
          "number_id": {
            "title": "Number Id",
            "type": "string"
          }
        },
        "required": [
          "number_id"
        ],
        "title": "PortOutRequestCreate",
        "type": "object"
      },
      "PortabilityCheck": {
        "additionalProperties": true,
        "properties": {
          "checked_at": {
            "title": "Checked At",
            "type": "string"
          },
          "items": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items",
          "checked_at"
        ],
        "title": "PortabilityCheck",
        "type": "object"
      },
      "PortabilityCheckCreate": {
        "additionalProperties": false,
        "properties": {
          "numbers": {
            "items": {
              "type": "string"
            },
            "maxItems": 50,
            "minItems": 1,
            "title": "Numbers",
            "type": "array"
          }
        },
        "required": [
          "numbers"
        ],
        "title": "PortabilityCheckCreate",
        "type": "object"
      },
      "PortalSession": {
        "additionalProperties": true,
        "properties": {
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "url": {
            "title": "Url",
            "type": "string"
          }
        },
        "required": [
          "url",
          "expires_at"
        ],
        "title": "PortalSession",
        "type": "object"
      },
      "Providers": {
        "additionalProperties": true,
        "properties": {
          "github": {
            "title": "Github",
            "type": "boolean"
          },
          "google": {
            "title": "Google",
            "type": "boolean"
          },
          "magic_link": {
            "default": true,
            "title": "Magic Link",
            "type": "boolean"
          },
          "passkeys": {
            "default": true,
            "title": "Passkeys",
            "type": "boolean"
          }
        },
        "required": [
          "github",
          "google"
        ],
        "title": "Providers",
        "type": "object"
      },
      "Quote": {
        "additionalProperties": true,
        "examples": [
          {
            "amount_micro": 0,
            "authorization_required": false,
            "billable_pages": 2,
            "consumed_by_job_id": null,
            "cover": null,
            "cover_pages": 0,
            "created_at": "2026-11-14T19:58:38.762Z",
            "currency": "USD",
            "delete_after_send": false,
            "document_id": "doc_01a1dba3f82e734db276332829bc4f2f",
            "document_pages": 2,
            "document_sha256": "c00b74dede1923d27ba294643d5e79cb5454089e3f1b7b151cc46aa520a2410f",
            "environment": "test",
            "expired": false,
            "expires_at": "2026-11-14T20:08:38.771Z",
            "from": null,
            "id": "quote_01a1dba3f8b371f6aaa8664b3bf14d20",
            "live_amount_micro": 78000,
            "per_page_micro": 0,
            "policy_evaluation": null,
            "price_version": "launch-v3",
            "pricing": "per_page",
            "quality": "fine",
            "route": "us_ca",
            "route_label": "United States and Canada",
            "route_paused": false,
            "sender_name": null,
            "to": "+15550000001",
            "warnings": [
              {
                "code": "sandbox",
                "message": "test key: sandbox provider, not charged"
              }
            ]
          }
        ],
        "properties": {
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "authorization_required": {
            "title": "Authorization Required",
            "type": "boolean"
          },
          "billable_pages": {
            "title": "Billable Pages",
            "type": "integer"
          },
          "consumed_by_job_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Consumed By Job Id"
          },
          "cover": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cover"
          },
          "cover_pages": {
            "title": "Cover Pages",
            "type": "integer"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "delete_after_send": {
            "default": false,
            "title": "Delete After Send",
            "type": "boolean"
          },
          "document_id": {
            "title": "Document Id",
            "type": "string"
          },
          "document_pages": {
            "title": "Document Pages",
            "type": "integer"
          },
          "document_sha256": {
            "title": "Document Sha256",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "expired": {
            "title": "Expired",
            "type": "boolean"
          },
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "from": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "From"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "live_amount_micro": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "What the same fax costs with a live key, in micro-units. It is the billable pages at the live rate of the destination, priced by the rule a live quote uses. A test quote is free (amount_micro 0), and this field says what the fax would cost live. On a live quote it equals amount_micro. Null when the rate card in force is not the one the quote was priced on (price_version) or no longer serves the destination.",
            "title": "Live Amount Micro"
          },
          "per_page_micro": {
            "default": 0,
            "title": "Per Page Micro",
            "type": "integer"
          },
          "policy_evaluation": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/PolicyVerdict"
              },
              {
                "type": "null"
              }
            ],
            "description": "The dry run of the delegated policies that bind the caller, made with the quote. Null when no policy binds the caller. The send evaluates the policies again, with their counters locked."
          },
          "price_version": {
            "title": "Price Version",
            "type": "string"
          },
          "pricing": {
            "default": "per_page",
            "description": "per_page: priced from the rate card, paid from the wallet and sent with POST /v1/faxes. one_time: the quote of a one-time order, priced at the card's price for the order. Only the order sends it, and POST /v1/faxes refuses it with quote_pricing_mismatch.",
            "enum": [
              "per_page",
              "one_time"
            ],
            "title": "Pricing",
            "type": "string"
          },
          "quality": {
            "default": "fine",
            "title": "Quality",
            "type": "string"
          },
          "route": {
            "title": "Route",
            "type": "string"
          },
          "route_label": {
            "default": "",
            "title": "Route Label",
            "type": "string"
          },
          "route_paused": {
            "default": false,
            "description": "An operator has paused sends on this quote's route. A fax sent now is accepted and stays queued until the route is resumed. Read when the quote is answered, not stored.",
            "title": "Route Paused",
            "type": "boolean"
          },
          "sender_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Sender Name"
          },
          "to": {
            "title": "To",
            "type": "string"
          },
          "warnings": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Warnings",
            "type": "array"
          }
        },
        "required": [
          "id",
          "environment",
          "document_id",
          "document_sha256",
          "to",
          "route",
          "document_pages",
          "cover_pages",
          "billable_pages",
          "amount_micro",
          "currency",
          "price_version",
          "cover",
          "authorization_required",
          "warnings",
          "expires_at",
          "expired",
          "consumed_by_job_id",
          "created_at"
        ],
        "title": "Quote",
        "type": "object"
      },
      "QuoteCreate": {
        "additionalProperties": false,
        "examples": [
          {
            "document_id": "doc_01a1dba3f82e734db276332829bc4f2f",
            "to": "+15550000001"
          }
        ],
        "properties": {
          "cover": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Cover sheet fields: to_name, from_name, subject, message. Counts as a page.",
            "title": "Cover"
          },
          "delete_after_send": {
            "default": false,
            "description": "Delete the document and the transmitted copy the moment the fax ends in delivered, partial or failed. The job, its receipt and the carrier evidence stay; they hold no document content. A fax that ends unknown keeps the document until a reconcile settles it. Default: keep the document for the retention period.",
            "title": "Delete After Send",
            "type": "boolean"
          },
          "document_id": {
            "title": "Document Id",
            "type": "string"
          },
          "from": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "A number you own; omit for the shared pool.",
            "title": "From"
          },
          "quality": {
            "default": "fine",
            "description": "Fax resolution. standard is the fax standard's 204 by 98 dpi, fine (the default) 204 by 196, superfine 204 by 392. ultra asks the carrier for its darkest text processing at the same superfine resolution and takes longer to process: measured 2026-11-09, a page sent at ultra and one at superfine both arrived as 1728 by 4112 pixels, 204 by 391 dpi. The price does not change. The job echoes the level.",
            "enum": [
              "standard",
              "fine",
              "superfine",
              "ultra"
            ],
            "title": "Quality",
            "type": "string"
          },
          "sender_name": {
            "anyOf": [
              {
                "maxLength": 128,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The name that identifies the sender. The carrier gets it as the caller name for its header line. A fax without a cover sheet prints it in one line at the top of page one. The line also gives the sending number and the time in UTC. Letters, digits, spaces and - _ ~ ! . + only, at most 128 characters. Omit to use the organization's name.",
            "title": "Sender Name"
          },
          "to": {
            "description": "Destination in E.164, for example +12025550123.",
            "title": "To",
            "type": "string"
          }
        },
        "required": [
          "document_id",
          "to"
        ],
        "title": "QuoteCreate",
        "type": "object"
      },
      "Reauth": {
        "additionalProperties": false,
        "properties": {
          "action": {
            "anyOf": [
              {
                "maxLength": 300,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "With `magic_link`: the call that was refused, as `METHOD /v1/path`. The mail names the action when the server knows it.",
            "title": "Action"
          },
          "credential": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Credential"
          },
          "method": {
            "enum": [
              "passkey",
              "magic_link"
            ],
            "title": "Method",
            "type": "string"
          },
          "next": {
            "anyOf": [
              {
                "maxLength": 400,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "With `magic_link`: the in-app path the person is on, where the link returns them.",
            "title": "Next"
          }
        },
        "required": [
          "method"
        ],
        "title": "Reauth",
        "type": "object"
      },
      "ReauthConfirm": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "description": "The code the page that asked for the link shows.",
            "maxLength": 16,
            "minLength": 1,
            "title": "Code",
            "type": "string"
          },
          "token": {
            "description": "The token of the mailed confirm link.",
            "maxLength": 128,
            "minLength": 1,
            "title": "Token",
            "type": "string"
          }
        },
        "required": [
          "token",
          "code"
        ],
        "title": "ReauthConfirm",
        "type": "object"
      },
      "ReauthConfirmed": {
        "additionalProperties": true,
        "properties": {
          "action": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "What the session asked to do, as a key the app words for the person (for example `create_key`). Null when the link names none.",
            "title": "Action"
          },
          "confirmed": {
            "title": "Confirmed",
            "type": "boolean"
          },
          "next": {
            "description": "The in-app path the session asked from.",
            "title": "Next",
            "type": "string"
          }
        },
        "required": [
          "confirmed",
          "next"
        ],
        "title": "ReauthConfirmed",
        "type": "object"
      },
      "ReauthLinkSent": {
        "additionalProperties": true,
        "description": "The answer to `POST /v1/auth/reauth` with `magic_link`: the link is on its way.",
        "properties": {
          "code": {
            "description": "Four digits for the page to show while it waits. Opened in this browser, the link confirms this session at once. Opened anywhere else, it asks for this code and then confirms this session, and that browser is not signed in. A link sent again before the last one expires has the same code.",
            "title": "Code",
            "type": "string"
          },
          "expires_at": {
            "description": "When the link stops working, 15 minutes after it was sent.",
            "title": "Expires At",
            "type": "string"
          },
          "message": {
            "title": "Message",
            "type": "string"
          },
          "sent": {
            "title": "Sent",
            "type": "boolean"
          }
        },
        "required": [
          "sent",
          "message",
          "code",
          "expires_at"
        ],
        "title": "ReauthLinkSent",
        "type": "object"
      },
      "Receipt": {
        "additionalProperties": true,
        "examples": [
          {
            "amount_micro": 0,
            "attempts": [
              {
                "attempt_number": 1,
                "error": null,
                "evidence": {
                  "attempt_number": 1,
                  "completed_at": "2026-11-14T19:58:38.905Z",
                  "duration_s": 24,
                  "pages_sent": 2,
                  "pages_total": 2,
                  "provider": "sandbox",
                  "quality": "fine",
                  "remote_station_id": "SBX-OK",
                  "sender_name": null
                },
                "failure_code": null,
                "fax_job_id": "fax_01a1dba3f8dc7609be5d7b497690cf47",
                "finished_at": "2026-11-14T19:58:38.907Z",
                "id": "att_01a1dba3f93171b4b1f537d98d422723",
                "pages_sent": 2,
                "provider": "sandbox",
                "provider_ref": "sbx_311dd5d5bc5dfd76",
                "started_at": "2026-11-14T19:58:38.860Z",
                "status": "delivered"
              }
            ],
            "billable_pages": 2,
            "captured_micro": 0,
            "completed_at": "2026-11-14T19:58:38.910Z",
            "cover_pages": 0,
            "created_at": "2026-11-14T19:58:38.794Z",
            "currency": "USD",
            "document_sha256": "c00b74dede1923d27ba294643d5e79cb5454089e3f1b7b151cc46aa520a2410f",
            "evidence": {
              "attempt_number": 1,
              "completed_at": "2026-11-14T19:58:38.905Z",
              "duration_s": 24,
              "pages_sent": 2,
              "pages_total": 2,
              "provider": "sandbox",
              "quality": "fine",
              "remote_station_id": "SBX-OK",
              "sender_name": null
            },
            "failure_code": null,
            "fax_job_id": "fax_01a1dba3f8dc7609be5d7b497690cf47",
            "from": null,
            "generated_at": "2026-11-14T19:58:38.943Z",
            "note": "Delivery evidence as the carrier reported it. It is not legal proof of acceptance by the recipient.",
            "one_time": null,
            "pages_sent": 2,
            "provider": "sandbox",
            "provider_ref": "sbx_311dd5d5bc5dfd76",
            "seller": {
              "address": "8 The Green, Dover, DE 19901, US",
              "email": "hello@faxforagents.com",
              "name": "JSB Holdings LLC",
              "product": "Fax for Agents"
            },
            "sender_name": null,
            "state": "delivered",
            "to": "+15550000001",
            "transmitted_sha256": "9f18c276fb5160f70fecb50f8e53768a7aa631e3e2a140447d3cb4f0377eb6e4"
          }
        ],
        "properties": {
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "attempts": {
            "items": {
              "$ref": "#/components/schemas/Attempt"
            },
            "title": "Attempts",
            "type": "array"
          },
          "billable_pages": {
            "title": "Billable Pages",
            "type": "integer"
          },
          "captured_micro": {
            "title": "Captured Micro",
            "type": "integer"
          },
          "completed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "cover_pages": {
            "default": 0,
            "description": "How many of the billable pages are the cover sheet: 0 or 1.",
            "title": "Cover Pages",
            "type": "integer"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "document_sha256": {
            "title": "Document Sha256",
            "type": "string"
          },
          "evidence": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Evidence"
          },
          "failure_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Failure Code"
          },
          "fax_job_id": {
            "title": "Fax Job Id",
            "type": "string"
          },
          "from": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "From"
          },
          "generated_at": {
            "title": "Generated At",
            "type": "string"
          },
          "note": {
            "title": "Note",
            "type": "string"
          },
          "one_time": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OneTimeJob"
              },
              {
                "type": "null"
              }
            ],
            "description": "Set on the receipt of a fax that a one-time order paid for. It names the order, its status, the card and the amount held on the card. captured_micro in it is the amount charged, written once the payment provider confirmed the capture. For a card order read the money here. Null for a fax paid from the wallet."
          },
          "pages_sent": {
            "title": "Pages Sent",
            "type": "integer"
          },
          "provider": {
            "title": "Provider",
            "type": "string"
          },
          "provider_ref": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The carrier's own reference for the last attempt, when it gave one.",
            "title": "Provider Ref"
          },
          "seller": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Seller"
              },
              {
                "type": "null"
              }
            ],
            "description": "The company that issues the receipt."
          },
          "sender_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The sender name the fax was sent with, when one was given.",
            "title": "Sender Name"
          },
          "state": {
            "title": "State",
            "type": "string"
          },
          "to": {
            "title": "To",
            "type": "string"
          },
          "transmitted_sha256": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Transmitted Sha256"
          }
        },
        "required": [
          "fax_job_id",
          "state",
          "failure_code",
          "to",
          "document_sha256",
          "transmitted_sha256",
          "billable_pages",
          "pages_sent",
          "amount_micro",
          "captured_micro",
          "currency",
          "provider",
          "created_at",
          "completed_at",
          "evidence",
          "attempts",
          "note",
          "generated_at"
        ],
        "title": "Receipt",
        "type": "object"
      },
      "ReleaseRequest": {
        "additionalProperties": false,
        "properties": {
          "confirm": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The number itself, typed out, to confirm.",
            "title": "Confirm"
          }
        },
        "title": "ReleaseRequest",
        "type": "object"
      },
      "Requested": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Created At"
          },
          "id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The request, as `GET .../data-requests` lists it.",
            "title": "Id"
          },
          "kind": {
            "enum": [
              "export",
              "deletion"
            ],
            "title": "Kind",
            "type": "string"
          },
          "message": {
            "title": "Message",
            "type": "string"
          },
          "requested": {
            "title": "Requested",
            "type": "boolean"
          }
        },
        "required": [
          "requested",
          "kind",
          "message"
        ],
        "title": "Requested",
        "type": "object"
      },
      "ReviewSignIn": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "format": "password",
            "maxLength": 256,
            "minLength": 1,
            "title": "Code",
            "type": "string",
            "writeOnly": true
          },
          "email": {
            "format": "email",
            "title": "Email",
            "type": "string"
          }
        },
        "required": [
          "email",
          "code"
        ],
        "title": "ReviewSignIn",
        "type": "object"
      },
      "Revoked": {
        "additionalProperties": true,
        "properties": {
          "revoked": {
            "title": "Revoked",
            "type": "integer"
          }
        },
        "required": [
          "revoked"
        ],
        "title": "Revoked",
        "type": "object"
      },
      "SandboxFixture": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "destination": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Destination"
          },
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "scenario": {
            "title": "Scenario",
            "type": "string"
          }
        },
        "required": [
          "id",
          "scenario",
          "destination",
          "created_at",
          "expires_at"
        ],
        "title": "SandboxFixture",
        "type": "object"
      },
      "SandboxInboundCreate": {
        "additionalProperties": false,
        "examples": [
          {
            "from": "+15550000009",
            "pages": 2,
            "to": "+15550100001"
          }
        ],
        "properties": {
          "from": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "From"
          },
          "pages": {
            "default": 1,
            "maximum": 200,
            "minimum": 1,
            "title": "Pages",
            "type": "integer"
          },
          "partial_content": {
            "default": false,
            "description": "Rehearse a cut-off transmission.",
            "title": "Partial Content",
            "type": "boolean"
          },
          "to": {
            "title": "To",
            "type": "string"
          }
        },
        "required": [
          "to"
        ],
        "title": "SandboxInboundCreate",
        "type": "object"
      },
      "SandboxReset": {
        "additionalProperties": true,
        "properties": {
          "deleted": {
            "additionalProperties": {
              "type": "integer"
            },
            "title": "Deleted",
            "type": "object"
          },
          "reset": {
            "title": "Reset",
            "type": "boolean"
          },
          "wallet_available_micro": {
            "title": "Wallet Available Micro",
            "type": "integer"
          }
        },
        "required": [
          "reset",
          "deleted",
          "wallet_available_micro"
        ],
        "title": "SandboxReset",
        "type": "object"
      },
      "SandboxScenarioCreate": {
        "additionalProperties": false,
        "properties": {
          "destination": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Apply to one destination; omit for every send.",
            "title": "Destination"
          },
          "scenario": {
            "title": "Scenario",
            "type": "string"
          }
        },
        "required": [
          "scenario"
        ],
        "title": "SandboxScenarioCreate",
        "type": "object"
      },
      "SandboxScenarios": {
        "additionalProperties": true,
        "properties": {
          "destinations": {
            "items": {
              "additionalProperties": {
                "type": "string"
              },
              "type": "object"
            },
            "title": "Destinations",
            "type": "array"
          },
          "fixtures": {
            "items": {
              "$ref": "#/components/schemas/SandboxFixture"
            },
            "title": "Fixtures",
            "type": "array"
          },
          "scenarios": {
            "items": {
              "additionalProperties": {
                "type": "string"
              },
              "type": "object"
            },
            "title": "Scenarios",
            "type": "array"
          }
        },
        "required": [
          "scenarios",
          "destinations",
          "fixtures"
        ],
        "title": "SandboxScenarios",
        "type": "object"
      },
      "SchemaCreate": {
        "additionalProperties": false,
        "properties": {
          "description": {
            "anyOf": [
              {
                "maxLength": 500,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Description"
          },
          "name": {
            "maxLength": 120,
            "minLength": 1,
            "title": "Name",
            "type": "string"
          },
          "schema": {
            "additionalProperties": true,
            "title": "Schema",
            "type": "object"
          }
        },
        "required": [
          "name",
          "schema"
        ],
        "title": "SchemaCreate",
        "type": "object"
      },
      "Seller": {
        "additionalProperties": true,
        "description": "The company a receipt is issued by.",
        "properties": {
          "address": {
            "title": "Address",
            "type": "string"
          },
          "email": {
            "title": "Email",
            "type": "string"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "product": {
            "title": "Product",
            "type": "string"
          }
        },
        "required": [
          "name",
          "address",
          "product",
          "email"
        ],
        "title": "Seller",
        "type": "object"
      },
      "SenderVerification": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "from": {
            "title": "From",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "method": {
            "title": "Method",
            "type": "string"
          },
          "number_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Number Id"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "verified_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Verified At"
          }
        },
        "required": [
          "id",
          "environment",
          "from",
          "status",
          "method",
          "number_id",
          "created_at",
          "verified_at"
        ],
        "title": "SenderVerification",
        "type": "object"
      },
      "SenderVerificationCreate": {
        "additionalProperties": false,
        "properties": {
          "from": {
            "description": "A number your organization owns, E.164.",
            "title": "From",
            "type": "string"
          }
        },
        "required": [
          "from"
        ],
        "title": "SenderVerificationCreate",
        "type": "object"
      },
      "Sent": {
        "additionalProperties": true,
        "properties": {
          "message": {
            "title": "Message",
            "type": "string"
          },
          "retry_after_s": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "When sent is false: the seconds until a link can be asked for again. The limit that refused decides it: a minute, the hour or the day. Null when a link was sent.",
            "title": "Retry After S"
          },
          "sent": {
            "title": "Sent",
            "type": "boolean"
          }
        },
        "required": [
          "sent",
          "message"
        ],
        "title": "Sent",
        "type": "object"
      },
      "ServiceStatus": {
        "additionalProperties": true,
        "properties": {
          "database": {
            "title": "Database",
            "type": "boolean"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "provider": {
            "title": "Provider",
            "type": "string"
          },
          "status": {
            "enum": [
              "ok",
              "degraded"
            ],
            "title": "Status",
            "type": "string"
          },
          "status_page": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Status Page"
          },
          "version": {
            "title": "Version",
            "type": "string"
          },
          "worker_beat_age_s": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Worker Beat Age S"
          }
        },
        "required": [
          "status",
          "version",
          "environment",
          "provider",
          "database"
        ],
        "title": "ServiceStatus",
        "type": "object"
      },
      "SessionInfo": {
        "additionalProperties": true,
        "properties": {
          "auth_method": {
            "title": "Auth Method",
            "type": "string"
          },
          "authenticated_at": {
            "title": "Authenticated At",
            "type": "string"
          },
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "fresh": {
            "title": "Fresh",
            "type": "boolean"
          },
          "fresh_until": {
            "title": "Fresh Until",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          }
        },
        "required": [
          "id",
          "auth_method",
          "authenticated_at",
          "fresh_until",
          "fresh",
          "expires_at"
        ],
        "title": "SessionInfo",
        "type": "object"
      },
      "SessionList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/SessionOut"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "SessionList",
        "type": "object"
      },
      "SessionOut": {
        "additionalProperties": true,
        "properties": {
          "auth_method": {
            "title": "Auth Method",
            "type": "string"
          },
          "authenticated_at": {
            "title": "Authenticated At",
            "type": "string"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "current": {
            "title": "Current",
            "type": "boolean"
          },
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "ip": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ip"
          },
          "last_seen_at": {
            "title": "Last Seen At",
            "type": "string"
          },
          "user_agent": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "User Agent"
          }
        },
        "required": [
          "id",
          "current",
          "auth_method",
          "ip",
          "user_agent",
          "created_at",
          "authenticated_at",
          "last_seen_at",
          "expires_at"
        ],
        "title": "SessionOut",
        "type": "object"
      },
      "SignedUrl": {
        "additionalProperties": true,
        "properties": {
          "content_type": {
            "title": "Content Type",
            "type": "string"
          },
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "url": {
            "title": "Url",
            "type": "string"
          }
        },
        "required": [
          "url",
          "expires_at",
          "content_type"
        ],
        "title": "SignedUrl",
        "type": "object"
      },
      "StatementLine": {
        "additionalProperties": true,
        "description": "One event on the wallet, signed the way the balance moved, with the balance after it.",
        "properties": {
          "amount_micro": {
            "description": "Signed the way the wallet moved: positive is money in.",
            "title": "Amount Micro",
            "type": "integer"
          },
          "balance_after_micro": {
            "description": "The available balance right after this line.",
            "title": "Balance After Micro",
            "type": "integer"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "description": {
            "description": "What happened, in plain words. Never an account name.",
            "title": "Description",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "ref_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The id of that object, such as fax_..., ext_..., nord_... or inb_..., or the payment's id at the card processor. Null when the line names none.",
            "title": "Ref Id"
          },
          "ref_type": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "What ref_id is. A hold or its release names what it was for: fax_job, extraction or number_order. Other lines name what they were booked against, such as stripe_payment_intent for a top-up or inbox_item for a received fax.",
            "title": "Ref Type"
          },
          "type": {
            "description": "What the line is, in one word. The type filter of the statement takes these values.",
            "enum": [
              "topup",
              "fax",
              "received_fax",
              "number",
              "extraction",
              "release",
              "refund",
              "dispute",
              "credit",
              "adjustment",
              "other"
            ],
            "title": "Type",
            "type": "string"
          }
        },
        "required": [
          "id",
          "created_at",
          "type",
          "description",
          "amount_micro",
          "balance_after_micro",
          "ref_type",
          "ref_id"
        ],
        "title": "StatementLine",
        "type": "object"
      },
      "StatementPage": {
        "additionalProperties": true,
        "description": "A page of the wallet statement, newest line first.",
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/StatementLine"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          }
        },
        "required": [
          "items"
        ],
        "title": "StatementPage",
        "type": "object"
      },
      "Subscription": {
        "additionalProperties": true,
        "properties": {
          "cancel_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When Stripe is set to end the subscription. A cancel in the billing portal sets it to the end of the period and leaves cancel_at_period_end false.",
            "title": "Cancel At"
          },
          "cancel_at_period_end": {
            "title": "Cancel At Period End",
            "type": "boolean"
          },
          "canceled_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Canceled At"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "current_period_end": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Current Period End"
          },
          "ends_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the subscription ends without being charged again. That is cancel_at when it comes no later than current_period_end, or current_period_end after a cancel at the period's end. Null while it renews, and whenever entitled is false, as after it ended.",
            "title": "Ends At"
          },
          "entitled": {
            "title": "Entitled",
            "type": "boolean"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "product": {
            "title": "Product",
            "type": "string"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "stripe_price_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Stripe Price Id"
          },
          "stripe_subscription_id": {
            "title": "Stripe Subscription Id",
            "type": "string"
          },
          "updated_at": {
            "title": "Updated At",
            "type": "string"
          }
        },
        "required": [
          "id",
          "product",
          "status",
          "stripe_subscription_id",
          "stripe_price_id",
          "cancel_at_period_end",
          "cancel_at",
          "ends_at",
          "current_period_end",
          "entitled",
          "created_at",
          "updated_at",
          "canceled_at"
        ],
        "title": "Subscription",
        "type": "object"
      },
      "SubscriptionCheckout": {
        "additionalProperties": true,
        "properties": {
          "product": {
            "title": "Product",
            "type": "string"
          },
          "stripe_session_id": {
            "title": "Stripe Session Id",
            "type": "string"
          },
          "url": {
            "title": "Url",
            "type": "string"
          }
        },
        "required": [
          "url",
          "stripe_session_id",
          "product"
        ],
        "title": "SubscriptionCheckout",
        "type": "object"
      },
      "SubscriptionList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Subscription"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          },
          "plan": {
            "$ref": "#/components/schemas/WorkspacePlan"
          },
          "workspace": {
            "title": "Workspace",
            "type": "boolean"
          }
        },
        "required": [
          "items",
          "workspace",
          "plan"
        ],
        "title": "SubscriptionList",
        "type": "object"
      },
      "SummaryCreate": {
        "additionalProperties": false,
        "properties": {
          "document_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Document Id"
          },
          "inbox_item_id": {
            "anyOf": [
              {
                "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Inbox Item Id"
          },
          "max_pages": {
            "anyOf": [
              {
                "maximum": 200,
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Max Pages"
          },
          "strict": {
            "default": false,
            "description": "Refuse with page_limit_exceeded when the document has more pages than would be read, instead of reading the first ones and warning.",
            "title": "Strict",
            "type": "boolean"
          },
          "strong_model_if_below": {
            "default": 0.75,
            "maximum": 1,
            "minimum": 0,
            "title": "Strong Model If Below",
            "type": "number"
          }
        },
        "title": "SummaryCreate",
        "type": "object"
      },
      "SwitchOrganization": {
        "additionalProperties": false,
        "properties": {
          "org_id": {
            "title": "Org Id",
            "type": "string"
          }
        },
        "required": [
          "org_id"
        ],
        "title": "SwitchOrganization",
        "type": "object"
      },
      "TopupCreate": {
        "additionalProperties": false,
        "properties": {
          "amount_usd": {
            "description": "Whole US dollars, 10 to 1000 per session.",
            "maximum": 1000,
            "minimum": 10,
            "title": "Amount Usd",
            "type": "integer"
          }
        },
        "required": [
          "amount_usd"
        ],
        "title": "TopupCreate",
        "type": "object"
      },
      "TopupSession": {
        "additionalProperties": true,
        "properties": {
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "auto_topup_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Auto Topup Id"
          },
          "checkout_status": {
            "anyOf": [
              {
                "enum": [
                  "open",
                  "complete",
                  "processing",
                  "expired"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Stripe's own state of the hosted Checkout, read from Stripe when a read of an open top-up asks with check_checkout=true. complete: the payment was made at Stripe, and the wallet is credited when Stripe's event arrives, usually within seconds. processing: the person finished at Stripe with a payment method that confirms later, such as a bank debit, which can take days. Null when not asked, when the top-up is not open (Stripe is asked about an open top-up only), or when Stripe could not be read.",
            "title": "Checkout Status"
          },
          "completed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error"
          },
          "expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expires At"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "kind": {
            "enum": [
              "manual",
              "auto",
              "setup"
            ],
            "title": "Kind",
            "type": "string"
          },
          "status": {
            "enum": [
              "open",
              "completed",
              "expired",
              "canceled",
              "failed"
            ],
            "title": "Status",
            "type": "string"
          },
          "stripe_payment_intent_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Stripe Payment Intent Id"
          },
          "stripe_session_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Stripe Session Id"
          },
          "url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The hosted Checkout page while the session is open.",
            "title": "Url"
          }
        },
        "required": [
          "id",
          "environment",
          "kind",
          "amount_micro",
          "currency",
          "status",
          "stripe_session_id",
          "stripe_payment_intent_id",
          "auto_topup_id",
          "error",
          "created_at",
          "expires_at",
          "completed_at"
        ],
        "title": "TopupSession",
        "type": "object"
      },
      "TopupSessionPage": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/TopupSession"
            },
            "title": "Items",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Cursor"
          }
        },
        "required": [
          "items"
        ],
        "title": "TopupSessionPage",
        "type": "object"
      },
      "UploadComplete": {
        "additionalProperties": false,
        "properties": {
          "sha256": {
            "anyOf": [
              {
                "maxLength": 64,
                "minLength": 64,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Optional: fail if the bytes differ.",
            "title": "Sha256"
          }
        },
        "title": "UploadComplete",
        "type": "object"
      },
      "UploadCreate": {
        "additionalProperties": false,
        "examples": [
          {
            "filename": "contract.pdf",
            "size_bytes": 551
          }
        ],
        "properties": {
          "content_type": {
            "anyOf": [
              {
                "maxLength": 100,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "application/pdf, image/png, image/jpeg or image/tiff. An image becomes 8-bit gray letter pages, since fax is monochrome. A frame wider than it is tall is rotated. A frame above 300 dpi letter is downsampled. Every TIFF frame is a page. PNG and JPEG take the first frame. The bytes must be the declared type. Left out, the type is read from the filename: .pdf, .png, .jpg, .jpeg, .tif or .tiff. A name with no known ending is taken as application/pdf. A filename that ends in an office, text or other image format is refused here with unsupported_format.",
            "title": "Content Type"
          },
          "filename": {
            "maxLength": 255,
            "minLength": 1,
            "title": "Filename",
            "type": "string"
          },
          "size_bytes": {
            "description": "The exact number of bytes of the file. The session is refused at complete with 409 conflict when the bytes received differ.",
            "minimum": 1,
            "title": "Size Bytes",
            "type": "integer"
          }
        },
        "required": [
          "filename",
          "size_bytes"
        ],
        "title": "UploadCreate",
        "type": "object"
      },
      "UploadSession": {
        "additionalProperties": true,
        "examples": [
          {
            "completed_at": null,
            "content_type": "application/pdf",
            "created_at": "2026-11-14T19:58:38.595Z",
            "declared_size": 551,
            "expires_at": "2026-11-14T20:58:38.596Z",
            "filename": "contract.pdf",
            "id": "up_01a1dba3f80475159f9195dc92d38428",
            "received_size": 0,
            "sha256": null,
            "status": "pending",
            "upload_method": "PUT",
            "upload_url": "https://api.faxforagents.com/v1/uploads/up_01a1dba3f80475159f9195dc92d38428/content?exp=1794689918&sig=3f6c...",
            "upload_url_expires_at": "2026-11-14T20:58:38.596Z"
          }
        ],
        "properties": {
          "completed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "content_type": {
            "title": "Content Type",
            "type": "string"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "declared_size": {
            "title": "Declared Size",
            "type": "integer"
          },
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "filename": {
            "title": "Filename",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "received_size": {
            "title": "Received Size",
            "type": "integer"
          },
          "sha256": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Sha256"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "upload_method": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Upload Method"
          },
          "upload_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Upload Url"
          },
          "upload_url_expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Upload Url Expires At"
          }
        },
        "required": [
          "id",
          "status",
          "filename",
          "content_type",
          "declared_size",
          "received_size",
          "sha256",
          "created_at",
          "expires_at",
          "completed_at"
        ],
        "title": "UploadSession",
        "type": "object"
      },
      "UsageExport": {
        "additionalProperties": true,
        "properties": {
          "content_type": {
            "title": "Content Type",
            "type": "string"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "expires_at": {
            "title": "Expires At",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "params": {
            "additionalProperties": true,
            "title": "Params",
            "type": "object"
          },
          "row_count": {
            "title": "Row Count",
            "type": "integer"
          },
          "status": {
            "enum": [
              "ready",
              "expired"
            ],
            "title": "Status",
            "type": "string"
          },
          "url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Url"
          }
        },
        "required": [
          "id",
          "environment",
          "status",
          "params",
          "row_count",
          "content_type",
          "url",
          "created_at",
          "expires_at"
        ],
        "title": "UsageExport",
        "type": "object"
      },
      "UsageExportCreate": {
        "additionalProperties": false,
        "properties": {
          "from": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "ISO date; default 30 days ago.",
            "title": "From"
          },
          "to": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "ISO date; default today.",
            "title": "To"
          }
        },
        "title": "UsageExportCreate",
        "type": "object"
      },
      "UsageItem": {
        "additionalProperties": true,
        "properties": {
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "day": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Day"
          },
          "destination": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Destination"
          },
          "direction": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Direction"
          },
          "jobs": {
            "title": "Jobs",
            "type": "integer"
          },
          "pages": {
            "title": "Pages",
            "type": "integer"
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Project Id"
          },
          "route": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Route"
          }
        },
        "required": [
          "pages",
          "jobs",
          "amount_micro"
        ],
        "title": "UsageItem",
        "type": "object"
      },
      "UsageReport": {
        "additionalProperties": true,
        "properties": {
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "from": {
            "title": "From",
            "type": "string"
          },
          "group_by": {
            "items": {
              "type": "string"
            },
            "title": "Group By",
            "type": "array"
          },
          "items": {
            "items": {
              "$ref": "#/components/schemas/UsageItem"
            },
            "title": "Items",
            "type": "array"
          },
          "to": {
            "title": "To",
            "type": "string"
          },
          "totals": {
            "additionalProperties": {
              "type": "integer"
            },
            "title": "Totals",
            "type": "object"
          }
        },
        "required": [
          "environment",
          "from",
          "to",
          "group_by",
          "currency",
          "items",
          "totals"
        ],
        "title": "UsageReport",
        "type": "object"
      },
      "UserOut": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "email": {
            "title": "Email",
            "type": "string"
          },
          "email_verified": {
            "title": "Email Verified",
            "type": "boolean"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "last_login_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last Login At"
          },
          "name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Name"
          }
        },
        "required": [
          "id",
          "email",
          "name",
          "email_verified",
          "created_at",
          "last_login_at"
        ],
        "title": "UserOut",
        "type": "object"
      },
      "Webhook": {
        "additionalProperties": true,
        "examples": [
          {
            "created_at": "2026-11-14T19:58:39.486Z",
            "description": null,
            "event_types": [
              "fax.delivered",
              "fax.failed"
            ],
            "failing": false,
            "id": "wh_01a1dba3fb7f70a2b6be610f4ee731d5",
            "previous_secret_expires_at": null,
            "status": "active",
            "updated_at": "2026-11-14T19:58:39.486Z",
            "url": "https://example.com/hooks/fax"
          }
        ],
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Description"
          },
          "event_types": {
            "items": {
              "type": "string"
            },
            "title": "Event Types",
            "type": "array"
          },
          "failing": {
            "default": false,
            "description": "True when the latest delivery this destination was sent did not get a 2xx answer. It turns false with the next delivery that does.",
            "title": "Failing",
            "type": "boolean"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "previous_secret_expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Previous Secret Expires At"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "updated_at": {
            "title": "Updated At",
            "type": "string"
          },
          "url": {
            "title": "Url",
            "type": "string"
          }
        },
        "required": [
          "id",
          "url",
          "description",
          "event_types",
          "status",
          "previous_secret_expires_at",
          "created_at",
          "updated_at"
        ],
        "title": "Webhook",
        "type": "object"
      },
      "WebhookCreate": {
        "additionalProperties": false,
        "examples": [
          {
            "event_types": [
              "fax.delivered",
              "fax.failed"
            ],
            "url": "https://example.com/hooks/fax"
          }
        ],
        "properties": {
          "description": {
            "anyOf": [
              {
                "maxLength": 200,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Description"
          },
          "event_types": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Empty or omitted: every event type.",
            "title": "Event Types"
          },
          "url": {
            "maxLength": 2000,
            "title": "Url",
            "type": "string"
          }
        },
        "required": [
          "url"
        ],
        "title": "WebhookCreate",
        "type": "object"
      },
      "WebhookList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Webhook"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "WebhookList",
        "type": "object"
      },
      "WebhookUpdate": {
        "additionalProperties": false,
        "properties": {
          "description": {
            "anyOf": [
              {
                "maxLength": 200,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Description"
          },
          "event_types": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Event Types"
          },
          "status": {
            "anyOf": [
              {
                "enum": [
                  "active",
                  "paused"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Status"
          },
          "url": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Url"
          }
        },
        "title": "WebhookUpdate",
        "type": "object"
      },
      "WebhookWithSecret": {
        "additionalProperties": true,
        "examples": [
          {
            "created_at": "2026-11-14T19:58:39.486Z",
            "description": null,
            "event_types": [
              "fax.delivered",
              "fax.failed"
            ],
            "failing": false,
            "id": "wh_01a1dba3fb7f70a2b6be610f4ee731d5",
            "previous_secret_expires_at": null,
            "secret": "whsec_...",
            "status": "active",
            "updated_at": "2026-11-14T19:58:39.486Z",
            "url": "https://example.com/hooks/fax"
          }
        ],
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Description"
          },
          "event_types": {
            "items": {
              "type": "string"
            },
            "title": "Event Types",
            "type": "array"
          },
          "failing": {
            "default": false,
            "description": "True when the latest delivery this destination was sent did not get a 2xx answer. It turns false with the next delivery that does.",
            "title": "Failing",
            "type": "boolean"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "previous_secret_expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Previous Secret Expires At"
          },
          "secret": {
            "description": "whsec_... Shown once. Verify webhook-signature with it.",
            "title": "Secret",
            "type": "string"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "updated_at": {
            "title": "Updated At",
            "type": "string"
          },
          "url": {
            "title": "Url",
            "type": "string"
          }
        },
        "required": [
          "id",
          "url",
          "description",
          "event_types",
          "status",
          "previous_secret_expires_at",
          "created_at",
          "updated_at",
          "secret"
        ],
        "title": "WebhookWithSecret",
        "type": "object"
      },
      "WorkspacePlan": {
        "additionalProperties": true,
        "description": "What the Agent workspace gives and where the organization stands with it.",
        "properties": {
          "active": {
            "description": "The plan is active: a subscription is active, trialing or past due.",
            "title": "Active",
            "type": "boolean"
          },
          "cleanup_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When records older than the standard time (30 days for a document, 90 for a received fax) are deleted after the plan ended. Null while the plan is active.",
            "title": "Cleanup At"
          },
          "credit_micro": {
            "description": "The fax credit each paid invoice of the plan adds to the live wallet.",
            "title": "Credit Micro",
            "type": "integer"
          },
          "document_keep_days": {
            "description": "How long a document is kept without the plan.",
            "title": "Document Keep Days",
            "type": "integer"
          },
          "ended_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the plan last ended. Null while it is active or if it never was.",
            "title": "Ended At"
          },
          "export_open": {
            "description": "GET /v1/records/faxes.csv and /v1/records/audit.csv answer: while the plan is active and until cleanup_at.",
            "title": "Export Open",
            "type": "boolean"
          },
          "inbox_keep_days": {
            "description": "How long a received fax is kept without the plan.",
            "title": "Inbox Keep Days",
            "type": "integer"
          },
          "included_number": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "That number, E.164.",
            "title": "Included Number"
          },
          "included_number_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The number the plan pays for now: the oldest live local number, while the plan is active.",
            "title": "Included Number Id"
          },
          "included_numbers": {
            "description": "Local numbers whose monthly charge the plan pays.",
            "title": "Included Numbers",
            "type": "integer"
          },
          "plan_requests_per_minute": {
            "description": "The request limit of each credential while the plan is active.",
            "title": "Plan Requests Per Minute",
            "type": "integer"
          },
          "records_keep_days": {
            "description": "How long live documents and received faxes are kept while the plan is active.",
            "title": "Records Keep Days",
            "type": "integer"
          },
          "requests_per_minute": {
            "description": "The request limit of each credential of the organization now.",
            "title": "Requests Per Minute",
            "type": "integer"
          },
          "standard_requests_per_minute": {
            "description": "The request limit of each credential without it.",
            "title": "Standard Requests Per Minute",
            "type": "integer"
          }
        },
        "required": [
          "active",
          "credit_micro",
          "records_keep_days",
          "document_keep_days",
          "inbox_keep_days",
          "requests_per_minute",
          "plan_requests_per_minute",
          "standard_requests_per_minute",
          "included_numbers",
          "included_number_id",
          "included_number",
          "ended_at",
          "cleanup_at",
          "export_open"
        ],
        "title": "WorkspacePlan",
        "type": "object"
      },
      "faxforagents__api__routes__inbox__InboxItem": {
        "additionalProperties": true,
        "properties": {
          "amount_micro": {
            "default": 0,
            "description": "What the received pages were charged, in micro-USD. 0 in test.",
            "title": "Amount Micro",
            "type": "integer"
          },
          "document_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Document Id"
          },
          "duration_secs": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Duration Secs"
          },
          "environment": {
            "default": "live",
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expires At"
          },
          "file_deleted_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the file of this fax was deleted. media_status is then deleted and there is no download. Null while the file is kept.",
            "title": "File Deleted At"
          },
          "from": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "From"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "media_status": {
            "default": "stored",
            "title": "Media Status",
            "type": "string"
          },
          "note": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Note"
          },
          "number_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Number Id"
          },
          "pages": {
            "title": "Pages",
            "type": "integer"
          },
          "partial_content": {
            "default": false,
            "title": "Partial Content",
            "type": "boolean"
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Project Id"
          },
          "provider": {
            "default": "",
            "title": "Provider",
            "type": "string"
          },
          "read_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Read At"
          },
          "received_at": {
            "title": "Received At",
            "type": "string"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "to": {
            "title": "To",
            "type": "string"
          }
        },
        "required": [
          "id",
          "to",
          "pages",
          "status",
          "document_id",
          "received_at"
        ],
        "title": "InboxItem",
        "type": "object"
      },
      "faxforagents__api__schemas__InboxItem": {
        "additionalProperties": true,
        "properties": {
          "amount_micro": {
            "default": 0,
            "description": "What the received pages were charged, in micro-USD. 0 in test.",
            "title": "Amount Micro",
            "type": "integer"
          },
          "document_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Document Id"
          },
          "from": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "From"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "note": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Note"
          },
          "pages": {
            "title": "Pages",
            "type": "integer"
          },
          "received_at": {
            "title": "Received At",
            "type": "string"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "to": {
            "title": "To",
            "type": "string"
          }
        },
        "required": [
          "id",
          "to",
          "pages",
          "status",
          "document_id",
          "received_at"
        ],
        "title": "InboxItem",
        "type": "object"
      },
      "faxforagents__api__schemas__Me": {
        "additionalProperties": true,
        "properties": {
          "actor": {
            "title": "Actor",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "key_id": {
            "title": "Key Id",
            "type": "string"
          },
          "key_prefix": {
            "title": "Key Prefix",
            "type": "string"
          },
          "org_id": {
            "title": "Org Id",
            "type": "string"
          },
          "project_id": {
            "title": "Project Id",
            "type": "string"
          },
          "scopes": {
            "items": {
              "type": "string"
            },
            "title": "Scopes",
            "type": "array"
          }
        },
        "required": [
          "org_id",
          "project_id",
          "key_id",
          "key_prefix",
          "environment",
          "scopes",
          "actor"
        ],
        "title": "Me",
        "type": "object"
      },
      "faxforagents__auth__schemas__Me": {
        "additionalProperties": true,
        "properties": {
          "csrf_token": {
            "title": "Csrf Token",
            "type": "string"
          },
          "default_environment": {
            "default": "test",
            "description": "The environment the dashboard opens on: live once the organization has a funded wallet or a paid one-time order, else test.",
            "enum": [
              "live",
              "test"
            ],
            "title": "Default Environment",
            "type": "string"
          },
          "notices": {
            "description": "Removals from an organization the person has not been told about yet, and the open invitations sent to the person's address by an organization they do not belong to. Dismissing notices marks the removals read. An invitation stays until it is used, withdrawn or ends.",
            "items": {
              "$ref": "#/components/schemas/Notice"
            },
            "title": "Notices",
            "type": "array"
          },
          "one_time_only": {
            "default": false,
            "description": "True while everything the organization has done is a fax paid by card on the send page: no API key, no wallet top-up, no connected app and no fax of its own. The dashboard then opens on that fax.",
            "title": "One Time Only",
            "type": "boolean"
          },
          "organization": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OrganizationSummary"
              },
              {
                "type": "null"
              }
            ]
          },
          "organizations": {
            "items": {
              "$ref": "#/components/schemas/OrganizationSummary"
            },
            "title": "Organizations",
            "type": "array"
          },
          "passkeys": {
            "title": "Passkeys",
            "type": "integer"
          },
          "providers": {
            "$ref": "#/components/schemas/Providers"
          },
          "scopes": {
            "description": "What the person's role allows in the organization they are looking at, as scope names. The app reads it to show a page read-only or to leave it out of the menu.",
            "items": {
              "type": "string"
            },
            "title": "Scopes",
            "type": "array"
          },
          "session": {
            "$ref": "#/components/schemas/SessionInfo"
          },
          "user": {
            "$ref": "#/components/schemas/UserOut"
          }
        },
        "required": [
          "user",
          "organization",
          "organizations",
          "session",
          "csrf_token",
          "passkeys",
          "providers"
        ],
        "title": "Me",
        "type": "object"
      }
    },
    "securitySchemes": {
      "apiKeyHeader": {
        "description": "The same API key in X-API-Key, for a client that cannot set Authorization.",
        "in": "header",
        "name": "X-API-Key",
        "type": "apiKey"
      },
      "bearerAuth": {
        "description": "An API key from the dashboard: Authorization: Bearer ffa_live_... (or ffa_test_... for test mode). Scopes are chosen when the key is made. An operation names the one it asks for in x-required-scope.",
        "scheme": "bearer",
        "type": "http"
      },
      "orderToken": {
        "description": "The status token the create call of a one-time order answered. It gives access to that order alone. ?t= carries it where a header cannot be set.",
        "in": "header",
        "name": "X-FFA-Order-Token",
        "type": "apiKey"
      },
      "sessionCookie": {
        "description": "The dashboard's signed-in session. A state-changing call also repeats the session's CSRF token in X-CSRF-Token. The member's role decides the scopes.",
        "in": "cookie",
        "name": "__Host-ffa_session",
        "type": "apiKey"
      },
      "signedUrl": {
        "description": "A short-lived signed URL the API handed out (exp and sig in the query). Use the URL as it was given. No API key is sent with it.",
        "in": "query",
        "name": "sig",
        "type": "apiKey"
      }
    }
  },
  "info": {
    "contact": {
      "email": "hello@faxforagents.com",
      "name": "Fax for Agents",
      "url": "https://faxforagents.com/contact/"
    },
    "description": "A fax API built for AI agents. Keys: Authorization: Bearer ffa_test_... (test mode) or ffa_live_..., or the same key in X-API-Key. Each operation lists the credentials it takes under security and the scope it asks for in x-required-scope. An operation with an empty security list takes no credential. Every error is one envelope: error.code, error.message, error.retryable, error.correlation_id. OAuth access tokens of the hosted MCP server are not accepted here.",
    "termsOfService": "https://faxforagents.com/terms/",
    "title": "Fax for Agents API",
    "version": "1.21.14",
    "x-snapshot": {
      "taken_at": "2026-11-18",
      "source": "the API server's own OpenAPI document, generated from its code",
      "stripped": [
        "tag admin",
        "tag affiliate",
        "paths /webhooks/*"
      ]
    }
  },
  "openapi": "3.1.0",
  "paths": {
    "/v1/agents": {
      "get": {
        "operationId": "list_agents",
        "parameters": [
          {
            "description": "Also list archived agents.",
            "in": "query",
            "name": "include_archived",
            "required": false,
            "schema": {
              "default": false,
              "description": "Also list archived agents.",
              "title": "Include Archived",
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "List agent identities",
        "tags": [
          "agents"
        ],
        "x-required-scope": "agent:read"
      },
      "post": {
        "operationId": "create_agent",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AgentCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Agent"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Register an agent identity",
        "tags": [
          "agents"
        ],
        "x-required-scope": "agent:admin"
      }
    },
    "/v1/agents/{agent_id}": {
      "delete": {
        "operationId": "archive_agent",
        "parameters": [
          {
            "in": "path",
            "name": "agent_id",
            "required": true,
            "schema": {
              "title": "Agent Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentArchived"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Archive an agent: its keys are revoked, it leaves the list and its name is free again",
        "tags": [
          "agents"
        ],
        "x-required-scope": "agent:admin"
      },
      "get": {
        "operationId": "get_agent",
        "parameters": [
          {
            "in": "path",
            "name": "agent_id",
            "required": true,
            "schema": {
              "title": "Agent Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Agent"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Read an agent with its keys and budgets",
        "tags": [
          "agents"
        ],
        "x-required-scope": "agent:read"
      },
      "patch": {
        "operationId": "update_agent",
        "parameters": [
          {
            "in": "path",
            "name": "agent_id",
            "required": true,
            "schema": {
              "title": "Agent Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AgentUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Agent"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Change an agent; disabling revokes its keys",
        "tags": [
          "agents"
        ],
        "x-required-scope": "agent:admin"
      }
    },
    "/v1/agents/{agent_id}/activity": {
      "get": {
        "operationId": "get_agent_activity",
        "parameters": [
          {
            "in": "path",
            "name": "agent_id",
            "required": true,
            "schema": {
              "title": "Agent Id",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentActivityPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "The agent's audit trail",
        "tags": [
          "agents"
        ],
        "x-required-scope": "agent:read"
      }
    },
    "/v1/agents/{agent_id}/keys": {
      "post": {
        "operationId": "create_agent_key",
        "parameters": [
          {
            "in": "path",
            "name": "agent_id",
            "required": true,
            "schema": {
              "title": "Agent Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AgentKeyCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKeyWithSecret"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Create a key for the agent (bounded scopes, secret shown once)",
        "tags": [
          "agents"
        ],
        "x-required-scope": "agent:admin"
      }
    },
    "/v1/api-keys": {
      "get": {
        "operationId": "list_api_keys",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKeyList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "List API keys (metadata only)",
        "tags": [
          "identity"
        ],
        "x-required-scope": "key:admin"
      },
      "post": {
        "operationId": "create_api_key",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiKeyCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKeyWithSecret"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Create an API key (the secret is shown once)",
        "tags": [
          "identity"
        ],
        "x-required-scope": "key:admin"
      }
    },
    "/v1/api-keys/{key_id}": {
      "delete": {
        "operationId": "revoke_api_key",
        "parameters": [
          {
            "in": "path",
            "name": "key_id",
            "required": true,
            "schema": {
              "title": "Key Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deleted"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Revoke a key",
        "tags": [
          "identity"
        ],
        "x-required-scope": "key:admin"
      }
    },
    "/v1/api-keys/{key_id}/rotate": {
      "post": {
        "description": "The replacement keeps the original expires_at, including no expiry. The old secret works for up to 24 hours, capped by its existing expiry. Once a key expired, rotation answers 409: create a new one to replace it.",
        "operationId": "rotate_api_key",
        "parameters": [
          {
            "in": "path",
            "name": "key_id",
            "required": true,
            "schema": {
              "title": "Key Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKeyWithSecret"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "The key expired, so it cannot be rotated. error.code is conflict, error.details.reason is \"key_expired\" and error.details.expires_at says when it expired. Create a new key to replace it. idempotency_key_conflict: the Idempotency-Key was used with a different request, or that request is still being processed."
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Rotate an API key and preserve its expiry",
        "tags": [
          "identity"
        ],
        "x-required-scope": "key:admin"
      }
    },
    "/v1/approval-requests": {
      "get": {
        "operationId": "list_approval_requests",
        "parameters": [
          {
            "description": "pending, approved, used, rejected, revoked or expired. used finds the approvals a send consumed; their status reads approved and consumed_by_job_id names the fax.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "pending, approved, used, rejected, revoked or expired. used finds the approvals a send consumed; their status reads approved and consumed_by_job_id names the fax.",
              "title": "Status"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalRequestPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Approval requests, pending first",
        "tags": [
          "approvals"
        ],
        "x-required-scope": "approval:read"
      },
      "post": {
        "operationId": "create_approval_request",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApprovalRequestCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalRequest"
                }
              }
            },
            "description": "The quote already has a pending request. It is returned as it stands and no second request is made."
          },
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalRequest"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Ask a human to approve a quoted send, or ask for help (grants nothing)",
        "tags": [
          "approvals"
        ],
        "x-required-scope": "approval:request"
      }
    },
    "/v1/approval-requests/{approval_id}": {
      "get": {
        "operationId": "get_approval_request",
        "parameters": [
          {
            "in": "path",
            "name": "approval_id",
            "required": true,
            "schema": {
              "title": "Approval Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalRequest"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Read one request",
        "tags": [
          "approvals"
        ],
        "x-required-scope": "approval:read"
      }
    },
    "/v1/approval-requests/{approval_id}/approve": {
      "post": {
        "operationId": "approve_request",
        "parameters": [
          {
            "in": "path",
            "name": "approval_id",
            "required": true,
            "schema": {
              "title": "Approval Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApprovalDecision"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalRequest"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Approve the bound quote (approval:decide, fresh session or independent API credential)",
        "tags": [
          "approvals"
        ],
        "x-required-scope": "approval:decide"
      }
    },
    "/v1/approval-requests/{approval_id}/reject": {
      "post": {
        "operationId": "reject_request",
        "parameters": [
          {
            "in": "path",
            "name": "approval_id",
            "required": true,
            "schema": {
              "title": "Approval Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApprovalDecision"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalRequest"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Reject with a reason (a help request closes without one)",
        "tags": [
          "approvals"
        ],
        "x-required-scope": "approval:decide"
      }
    },
    "/v1/approvals/{approval_id}/revoke": {
      "post": {
        "operationId": "revoke_approval",
        "parameters": [
          {
            "in": "path",
            "name": "approval_id",
            "required": true,
            "schema": {
              "title": "Approval Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApprovalDecision"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalRequest"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Revoke an approval nobody has used yet",
        "tags": [
          "approvals"
        ],
        "x-required-scope": "approval:decide"
      }
    },
    "/v1/auth/invitations/{token}": {
      "get": {
        "description": "No session is needed: the token in the link is the credential, as it is in the mail. A link that was used, withdrawn, has expired or never existed answers the same 404, so the answer says nothing about a token nobody holds.",
        "operationId": "preview_invitation",
        "parameters": [
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "title": "Token",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvitationPreview"
                }
              }
            },
            "description": "Successful Response"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [],
        "summary": "What an invitation link offers, before joining (the link is the credential)",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/invitations/{token}/accept": {
      "post": {
        "operationId": "accept_invitation",
        "parameters": [
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "title": "Token",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Accepted"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Join the organization an invitation link names (the signed-in email must match)",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/leave-organization": {
      "post": {
        "description": "Ends your membership of the organization `org_id` names, at once: you can no longer open it, and your connected apps in it are disconnected. Anyone can leave except the organization's last owner, who is refused with 409 last_owner and has to make another member an owner first. A session that was looking at that organization moves to another one of yours. When you belong to no organization any more, every session of yours ends and the answer clears the cookie. The mail member_removed goes to your address and the audit row names you. No fresh sign-in is needed: leaving takes access away and grants, spends and shows nothing. Idempotency-Key is honoured. A repeat after the sign-out answers 401.",
        "operationId": "leave_organization",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LeaveOrganization"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LeftOrganization"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Leave an organization you belong to",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/logout": {
      "post": {
        "description": "Idempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges. Authentication, one-time challenge checks and rate limits still apply.",
        "operationId": "logout",
        "responses": {
          "204": {
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "End this session",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/magic-links": {
      "post": {
        "description": "Idempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges. Authentication, one-time challenge checks and rate limits still apply.",
        "operationId": "request_magic_link",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MagicLinkRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Sent"
                }
              }
            },
            "description": "Successful Response"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [],
        "summary": "Send a sign-in link to an email address (always 202)",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/magic-links/{token}": {
      "get": {
        "operationId": "open_magic_link",
        "parameters": [
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "title": "Token",
              "type": "string"
            }
          }
        ],
        "responses": {
          "303": {
            "description": "Redirect to the app, signed in or with an error code in the query."
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [],
        "summary": "Open a sign-in link: sets the session cookie and redirects to the app",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/me": {
      "get": {
        "operationId": "get_auth_me",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/faxforagents__auth__schemas__Me"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "The signed-in person, their organizations and the CSRF token",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/notices/dismiss": {
      "post": {
        "description": "Idempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges. Authentication, one-time challenge checks and rate limits still apply.",
        "operationId": "dismiss_notices",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/faxforagents__auth__schemas__Me"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Mark the notices in `me.notices` as read",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/oauth/{provider}/callback": {
      "get": {
        "operationId": "oauth_callback",
        "parameters": [
          {
            "in": "path",
            "name": "provider",
            "required": true,
            "schema": {
              "title": "Provider",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "code",
            "required": false,
            "schema": {
              "default": "",
              "title": "Code",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "state",
            "required": false,
            "schema": {
              "default": "",
              "title": "State",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "error",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Error"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/faxforagents__auth__schemas__Me"
                }
              }
            },
            "description": "Successful Response"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [],
        "summary": "Finish GitHub or Google sign-in (the app forwards its /auth/{provider}/callback here)",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/oauth/{provider}/start": {
      "get": {
        "operationId": "oauth_start",
        "parameters": [
          {
            "in": "path",
            "name": "provider",
            "required": true,
            "schema": {
              "title": "Provider",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "next",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 400,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Next"
            }
          },
          {
            "description": "A referral code from the link.",
            "in": "query",
            "name": "ref",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 64,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "A referral code from the link.",
              "title": "Ref"
            }
          },
          {
            "description": "The referral link's tag.",
            "in": "query",
            "name": "sub",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 128,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "The referral link's tag.",
              "title": "Sub"
            }
          }
        ],
        "responses": {
          "303": {
            "description": "Successful Response"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [],
        "summary": "Begin GitHub or Google sign-in (redirects to the provider)",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/passkeys": {
      "get": {
        "operationId": "list_passkeys",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PasskeyList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Your passkeys",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/passkeys/login/options": {
      "post": {
        "description": "Idempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges. Authentication, one-time challenge checks and rate limits still apply.",
        "operationId": "passkey_login_options",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "title": "Response Passkey Login Options",
                  "type": "object"
                }
              }
            },
            "description": "Successful Response"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [],
        "summary": "Options for navigator.credentials.get() (discoverable, no email needed)",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/passkeys/login/verify": {
      "post": {
        "description": "Idempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges. Authentication, one-time challenge checks and rate limits still apply.",
        "operationId": "passkey_login_verify",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PasskeyLoginVerify"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/faxforagents__auth__schemas__Me"
                }
              }
            },
            "description": "Successful Response"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [],
        "summary": "Sign in with a passkey assertion",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/passkeys/register/options": {
      "post": {
        "description": "Idempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges. Authentication, one-time challenge checks and rate limits still apply.",
        "operationId": "passkey_register_options",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "title": "Response Passkey Register Options",
                  "type": "object"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Options for navigator.credentials.create() (fresh session required)",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/passkeys/register/verify": {
      "post": {
        "operationId": "passkey_register_verify",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PasskeyRegisterVerify"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Passkey"
                }
              }
            },
            "description": "Successful Response"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Store a new passkey after the browser created it",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/passkeys/{passkey_id}": {
      "delete": {
        "operationId": "delete_passkey",
        "parameters": [
          {
            "in": "path",
            "name": "passkey_id",
            "required": true,
            "schema": {
              "title": "Passkey Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Remove one of your passkeys",
        "tags": [
          "auth"
        ]
      },
      "patch": {
        "operationId": "rename_passkey",
        "parameters": [
          {
            "in": "path",
            "name": "passkey_id",
            "required": true,
            "schema": {
              "title": "Passkey Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PasskeyPatch"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Passkey"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Rename one of your passkeys (fresh session required)",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/providers": {
      "get": {
        "operationId": "get_auth_providers",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Providers"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "security": [],
        "summary": "Which sign-in methods are available",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/reauth": {
      "post": {
        "description": "Idempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges. Authentication, one-time challenge checks and rate limits still apply.",
        "operationId": "reauth",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Reauth"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/faxforagents__auth__schemas__Me"
                }
              }
            },
            "description": "Successful Response"
          },
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReauthLinkSent"
                }
              }
            },
            "description": "A confirm link was sent. Opened in this browser it refreshes this session and returns to the page named in `next`. Opened anywhere else it asks for `code`, then refreshes this session; that browser is not signed in (`POST /v1/auth/reauth/confirm`)."
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Prove it is you again (passkey now, or a fresh link by mail) before a sensitive action",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/reauth/confirm": {
      "post": {
        "description": "A confirm link opened away from the session that asked for it sends the browser to a page that asks for the code that session shows (`code` of `POST /v1/auth/reauth`). This call checks the code and refreshes the asking session. The browser that sends it is not signed in and its own session, if it has one, is not changed. The link works once; the fifth wrong code spends it. Idempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges. Authentication, one-time challenge checks and rate limits still apply.",
        "operationId": "confirm_reauth_link",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReauthConfirm"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReauthConfirmed"
                }
              }
            },
            "description": "Successful Response"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [],
        "summary": "Confirm the session that asked for a confirm link, from the browser the link opened in",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/review-access": {
      "post": {
        "description": "Idempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges. Authentication, one-time challenge checks and rate limits still apply.",
        "operationId": "review_sign_in",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReviewSignIn"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/faxforagents__auth__schemas__Me"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [],
        "summary": "Sign in with reviewer credentials",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/sessions": {
      "delete": {
        "description": "Idempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges. Authentication, one-time challenge checks and rate limits still apply.",
        "operationId": "revoke_other_sessions",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Revoked"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Sign out everywhere else",
        "tags": [
          "auth"
        ]
      },
      "get": {
        "operationId": "list_sessions",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SessionList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Your live sessions",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/sessions/{session_id}": {
      "delete": {
        "description": "Idempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges. Authentication, one-time challenge checks and rate limits still apply.",
        "operationId": "revoke_session",
        "parameters": [
          {
            "in": "path",
            "name": "session_id",
            "required": true,
            "schema": {
              "title": "Session Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Revoke one of your sessions",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/switch-organization": {
      "post": {
        "description": "Idempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges. Authentication, one-time challenge checks and rate limits still apply.",
        "operationId": "switch_organization",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SwitchOrganization"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/faxforagents__auth__schemas__Me"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Look at another organization you belong to",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auto-topups": {
      "get": {
        "operationId": "list_auto_topups",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutoTopupList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Auto top-up settings",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      },
      "post": {
        "operationId": "create_auto_topup",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AutoTopupCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutoTopup"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentRequired"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "The credential is valid and is not allowed to do this. scope_missing puts the scope in error.details.scope. Other codes are agent_forbidden and approval_required. A session can also meet csrf_invalid and reauth_required. A test key, or a session switched to Test, gets environment_not_billable here: the test wallet is never funded, so billing takes live."
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Opt in to auto top-up (threshold, amount, daily cap); the card is saved at the first payment",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:write"
      }
    },
    "/v1/auto-topups/{auto_topup_id}": {
      "delete": {
        "operationId": "delete_auto_topup",
        "parameters": [
          {
            "in": "path",
            "name": "auto_topup_id",
            "required": true,
            "schema": {
              "title": "Auto Topup Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deleted"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Turn auto top-up off",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:write"
      }
    },
    "/v1/balance": {
      "get": {
        "operationId": "get_balance",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Balance"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Available and held balance",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/billing-portal-sessions": {
      "post": {
        "operationId": "create_portal_session",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortalSession"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentRequired"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "The credential is valid and is not allowed to do this. scope_missing puts the scope in error.details.scope. Other codes are agent_forbidden and approval_required. A session can also meet csrf_invalid and reauth_required. A test key, or a session switched to Test, gets environment_not_billable here: the test wallet is never funded, so billing takes live."
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Open the Stripe customer portal (cards, invoices, the subscription)",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:write"
      }
    },
    "/v1/billing-settings": {
      "get": {
        "operationId": "get_billing_settings",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingSettings"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Billing settings of the organization",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      },
      "patch": {
        "operationId": "patch_billing_settings",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BillingSettingsPatch"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingSettings"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Change the billing email or the low-balance threshold",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:write"
      }
    },
    "/v1/budgets": {
      "get": {
        "operationId": "list_budgets",
        "parameters": [
          {
            "description": "Also list removed budgets with history.",
            "in": "query",
            "name": "include_archived",
            "required": false,
            "schema": {
              "default": false,
              "description": "Also list removed budgets with history.",
              "title": "Include Archived",
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BudgetList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Spending caps of this environment",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      },
      "post": {
        "operationId": "create_budget",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BudgetCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Budget"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Create a daily or monthly cap for the organization, a project or an agent",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:write"
      }
    },
    "/v1/budgets/{budget_id}": {
      "delete": {
        "operationId": "delete_budget",
        "parameters": [
          {
            "in": "path",
            "name": "budget_id",
            "required": true,
            "schema": {
              "title": "Budget Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BudgetRemoved"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Remove a cap: deleted when it never charged a hold, archived when it has history",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:write"
      },
      "patch": {
        "operationId": "patch_budget",
        "parameters": [
          {
            "in": "path",
            "name": "budget_id",
            "required": true,
            "schema": {
              "title": "Budget Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BudgetPatch"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Budget"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Change a cap's limit or status",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:write"
      }
    },
    "/v1/capabilities": {
      "get": {
        "operationId": "get_capabilities",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Capabilities"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Limits and features in force",
        "tags": [
          "platform"
        ]
      }
    },
    "/v1/classifications": {
      "get": {
        "operationId": "list_classifications",
        "parameters": [
          {
            "in": "query",
            "name": "inbox_item_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Inbox Item Id"
            }
          },
          {
            "in": "query",
            "name": "document_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Document Id"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtractionPageList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Classifications, newest first",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      },
      "post": {
        "operationId": "create_classification",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ClassificationCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Extraction"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Classify a received fax or a document into one of your document types, or abstain",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      }
    },
    "/v1/classifications/{classification_id}": {
      "get": {
        "operationId": "get_classification",
        "parameters": [
          {
            "in": "path",
            "name": "classification_id",
            "required": true,
            "schema": {
              "title": "Classification Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Extraction"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "One classification",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      }
    },
    "/v1/coverage": {
      "get": {
        "operationId": "get_coverage",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Coverage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Where we send and where we host numbers",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:read"
      }
    },
    "/v1/document-summaries": {
      "get": {
        "operationId": "list_document_summaries",
        "parameters": [
          {
            "in": "query",
            "name": "inbox_item_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Inbox Item Id"
            }
          },
          {
            "in": "query",
            "name": "document_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Document Id"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtractionPageList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Summaries, newest first",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      },
      "post": {
        "operationId": "create_document_summary",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SummaryCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Extraction"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Summarise a received fax or a document; every sentence cites its pages",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      }
    },
    "/v1/document-summaries/{summary_id}": {
      "get": {
        "operationId": "get_document_summary",
        "parameters": [
          {
            "in": "path",
            "name": "summary_id",
            "required": true,
            "schema": {
              "title": "Summary Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Extraction"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "One summary",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      }
    },
    "/v1/documents": {
      "get": {
        "operationId": "list_documents",
        "parameters": [
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          },
          {
            "description": "Only documents of this source; \"inbound\" is the files of received faxes.",
            "in": "query",
            "name": "source",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "upload",
                    "image",
                    "text",
                    "markdown",
                    "html",
                    "inbound"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Only documents of this source; \"inbound\" is the files of received faxes.",
              "title": "Source"
            }
          },
          {
            "description": "Leave this source out; \"inbound\" lists the documents you made.",
            "in": "query",
            "name": "exclude_source",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "upload",
                    "image",
                    "text",
                    "markdown",
                    "html",
                    "inbound"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Leave this source out; \"inbound\" lists the documents you made.",
              "title": "Exclude Source"
            }
          },
          {
            "description": "Part of a file name, or of the sender's number for a received fax.",
            "in": "query",
            "name": "q",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 255,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Part of a file name, or of the sender's number for a received fax.",
              "title": "Q"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DocumentPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "List documents, newest first",
        "tags": [
          "documents"
        ],
        "x-required-scope": "document:read"
      },
      "post": {
        "operationId": "create_document",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DocumentCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Document"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Create an immutable document from an upload or from text",
        "tags": [
          "documents"
        ],
        "x-required-scope": "document:write"
      }
    },
    "/v1/documents/{document_id}": {
      "delete": {
        "operationId": "delete_document",
        "parameters": [
          {
            "in": "path",
            "name": "document_id",
            "required": true,
            "schema": {
              "title": "Document Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deleted"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Delete a document (its bytes and previews)",
        "tags": [
          "documents"
        ],
        "x-required-scope": "document:write"
      },
      "get": {
        "operationId": "get_document",
        "parameters": [
          {
            "in": "path",
            "name": "document_id",
            "required": true,
            "schema": {
              "title": "Document Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Document"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "document_expired: the document passed its retention date and is no longer kept. organization_deleted: the organization is being deleted, so the call is refused."
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Read a document's hash, pages and validation state",
        "tags": [
          "documents"
        ],
        "x-required-scope": "document:read"
      },
      "patch": {
        "operationId": "rename_document",
        "parameters": [
          {
            "in": "path",
            "name": "document_id",
            "required": true,
            "schema": {
              "title": "Document Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DocumentUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Document"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "document_expired: the document passed its retention date and is no longer kept. organization_deleted: the organization is being deleted, so the call is refused."
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Rename a document",
        "tags": [
          "documents"
        ],
        "x-required-scope": "document:write"
      }
    },
    "/v1/documents/{document_id}/content": {
      "get": {
        "operationId": "get_document_content",
        "parameters": [
          {
            "in": "path",
            "name": "document_id",
            "required": true,
            "schema": {
              "title": "Document Id",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "exp",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Exp"
            }
          },
          {
            "in": "query",
            "name": "sig",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Sig"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "document_expired: the document passed its retention date and is no longer kept."
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          }
        },
        "security": [
          {
            "signedUrl": []
          }
        ],
        "summary": "The PDF bytes behind a signed URL (no API key)",
        "tags": [
          "documents"
        ]
      }
    },
    "/v1/documents/{document_id}/download": {
      "get": {
        "operationId": "get_document_download",
        "parameters": [
          {
            "in": "path",
            "name": "document_id",
            "required": true,
            "schema": {
              "title": "Document Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignedUrl"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "document_expired: the document passed its retention date and is no longer kept. organization_deleted: the organization is being deleted, so the call is refused."
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "A short-lived signed download URL",
        "tags": [
          "documents"
        ],
        "x-required-scope": "document:read"
      }
    },
    "/v1/documents/{document_id}/pages": {
      "get": {
        "operationId": "list_document_pages",
        "parameters": [
          {
            "in": "path",
            "name": "document_id",
            "required": true,
            "schema": {
              "title": "Document Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DocumentPages"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "document_expired: the document passed its retention date and is no longer kept. organization_deleted: the organization is being deleted, so the call is refused."
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Rendered pages with signed preview URLs",
        "tags": [
          "documents"
        ],
        "x-required-scope": "document:read"
      }
    },
    "/v1/documents/{document_id}/pages/{page_number}/content": {
      "get": {
        "operationId": "get_document_page_content",
        "parameters": [
          {
            "in": "path",
            "name": "document_id",
            "required": true,
            "schema": {
              "title": "Document Id",
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "page_number",
            "required": true,
            "schema": {
              "title": "Page Number",
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "exp",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Exp"
            }
          },
          {
            "in": "query",
            "name": "sig",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Sig"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          }
        },
        "security": [
          {
            "signedUrl": []
          }
        ],
        "summary": "A page PNG behind a signed URL (no API key)",
        "tags": [
          "documents"
        ]
      }
    },
    "/v1/documents/{document_id}/validation": {
      "get": {
        "operationId": "get_document_validation",
        "parameters": [
          {
            "in": "path",
            "name": "document_id",
            "required": true,
            "schema": {
              "title": "Document Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DocumentValidation"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "document_expired: the document passed its retention date and is no longer kept. organization_deleted: the organization is being deleted, so the call is refused."
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Validation warnings",
        "tags": [
          "documents"
        ],
        "x-required-scope": "document:read"
      }
    },
    "/v1/events": {
      "get": {
        "operationId": "list_events",
        "parameters": [
          {
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Type"
            }
          },
          {
            "description": "The cursor from the previous page (opaque).",
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "The cursor from the previous page (opaque).",
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 100,
              "maximum": 500,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Events for reconciliation, oldest first from the cursor",
        "tags": [
          "events"
        ],
        "x-required-scope": "fax:read"
      }
    },
    "/v1/extraction-schemas": {
      "get": {
        "operationId": "list_extraction_schemas",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtractionSchemaList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Your extraction schemas",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      },
      "post": {
        "operationId": "create_extraction_schema",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SchemaCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtractionSchema"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Save a versioned extraction schema (the same name again is the next version)",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      }
    },
    "/v1/extraction-schemas/{schema_id}": {
      "get": {
        "operationId": "get_extraction_schema",
        "parameters": [
          {
            "in": "path",
            "name": "schema_id",
            "required": true,
            "schema": {
              "title": "Schema Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtractionSchema"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "One schema version",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      }
    },
    "/v1/extractions": {
      "get": {
        "operationId": "list_extractions",
        "parameters": [
          {
            "in": "query",
            "name": "inbox_item_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Inbox Item Id"
            }
          },
          {
            "in": "query",
            "name": "document_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Document Id"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtractionPageList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Extractions, newest first",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      },
      "post": {
        "operationId": "create_extraction",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExtractionCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Extraction"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Read a received fax or a document: OCR per page, then fields against a schema",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      }
    },
    "/v1/extractions/{extraction_id}": {
      "get": {
        "operationId": "get_extraction",
        "parameters": [
          {
            "in": "path",
            "name": "extraction_id",
            "required": true,
            "schema": {
              "title": "Extraction Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Extraction"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "One extraction with its corrections",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      }
    },
    "/v1/extractions/{extraction_id}/corrections": {
      "post": {
        "operationId": "create_correction",
        "parameters": [
          {
            "in": "path",
            "name": "extraction_id",
            "required": true,
            "schema": {
              "title": "Extraction Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CorrectionCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Correction"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Record a reviewer's correction of one field (stored beside the extraction, never merged)",
        "tags": [
          "extractions"
        ],
        "x-required-scope": "document:extract"
      }
    },
    "/v1/fax-quotes": {
      "post": {
        "operationId": "create_fax_quote",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QuoteCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Quote"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Price an exact document to one destination",
        "tags": [
          "quotes"
        ],
        "x-required-scope": "fax:quote"
      }
    },
    "/v1/fax-quotes/{quote_id}": {
      "get": {
        "operationId": "get_fax_quote",
        "parameters": [
          {
            "in": "path",
            "name": "quote_id",
            "required": true,
            "schema": {
              "title": "Quote Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Quote"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Read a quote",
        "tags": [
          "quotes"
        ],
        "x-required-scope": "fax:quote"
      }
    },
    "/v1/faxes": {
      "get": {
        "description": "Fax jobs of the credential's organization and environment, newest first, in pages of `limit`. Every filter combines with the others and with `cursor`: pass the same filters with the `next_cursor` of the page before. `created_after` and `created_before` narrow the list to the jobs created in a time range, the start included and the end left out. A range whose start is after its end is refused with 422 invalid_request.",
        "operationId": "list_faxes",
        "parameters": [
          {
            "in": "query",
            "name": "state",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "State"
            }
          },
          {
            "description": "Find the send job using its Idempotency-Key. This lookup requires the stored replay record. An empty result does not prove no fax was sent.",
            "in": "query",
            "name": "idempotency_key",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 255,
                  "minLength": 1,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Find the send job using its Idempotency-Key. This lookup requires the stored replay record. An empty result does not prove no fax was sent.",
              "title": "Idempotency Key"
            }
          },
          {
            "description": "Find faxes by destination or by id. Text that starts with fax_ is the beginning of a job id. Anything else is read as a fax number in any spelling: its digits are looked for anywhere in the destination. Combines with state.",
            "in": "query",
            "name": "q",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 64,
                  "minLength": 1,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Find faxes by destination or by id. Text that starts with fax_ is the beginning of a job id. Anything else is read as a fax number in any spelling: its digits are looked for anywhere in the destination. Combines with state.",
              "title": "Q"
            }
          },
          {
            "description": "Only jobs created at or after this time. ISO 8601, for example 2026-11-16T00:00:00Z. A time without an offset is read as UTC. Combines with created_before, the other filters and cursor.",
            "in": "query",
            "name": "created_after",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "format": "date-time",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Only jobs created at or after this time. ISO 8601, for example 2026-11-16T00:00:00Z. A time without an offset is read as UTC. Combines with created_before, the other filters and cursor.",
              "examples": [
                "2026-11-16T00:00:00Z"
              ],
              "title": "Created After"
            }
          },
          {
            "description": "Only jobs created before this time, which is left out. ISO 8601, for example 2026-11-17T00:00:00Z. A time without an offset is read as UTC. With created_after, a range that starts after it ends is refused.",
            "in": "query",
            "name": "created_before",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "format": "date-time",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Only jobs created before this time, which is left out. ISO 8601, for example 2026-11-17T00:00:00Z. A time without an offset is read as UTC. With created_after, a range that starts after it ends is refused.",
              "examples": [
                "2026-11-17T00:00:00Z"
              ],
              "title": "Created Before"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FaxJobPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "List fax jobs, newest first",
        "tags": [
          "faxes"
        ],
        "x-required-scope": "fax:read"
      },
      "post": {
        "operationId": "create_fax",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FaxCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FaxJob"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Send a quoted fax (Idempotency-Key recommended)",
        "tags": [
          "faxes"
        ],
        "x-required-scope": "fax:send"
      }
    },
    "/v1/faxes/{fax_id}": {
      "get": {
        "operationId": "get_fax",
        "parameters": [
          {
            "in": "path",
            "name": "fax_id",
            "required": true,
            "schema": {
              "title": "Fax Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FaxJob"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Read a fax job (with evidence once delivered)",
        "tags": [
          "faxes"
        ],
        "x-required-scope": "fax:read"
      }
    },
    "/v1/faxes/{fax_id}/attempts": {
      "get": {
        "operationId": "list_fax_attempts",
        "parameters": [
          {
            "in": "path",
            "name": "fax_id",
            "required": true,
            "schema": {
              "title": "Fax Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AttemptPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Attempt history",
        "tags": [
          "faxes"
        ],
        "x-required-scope": "fax:read"
      }
    },
    "/v1/faxes/{fax_id}/cancel": {
      "post": {
        "operationId": "cancel_fax",
        "parameters": [
          {
            "in": "path",
            "name": "fax_id",
            "required": true,
            "schema": {
              "title": "Fax Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FaxJob"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Cancel if still possible (best effort once sending)",
        "tags": [
          "faxes"
        ],
        "x-required-scope": "fax:cancel"
      }
    },
    "/v1/faxes/{fax_id}/events": {
      "get": {
        "operationId": "list_fax_events",
        "parameters": [
          {
            "in": "path",
            "name": "fax_id",
            "required": true,
            "schema": {
              "title": "Fax Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Ordered events of one fax",
        "tags": [
          "faxes"
        ],
        "x-required-scope": "fax:read"
      }
    },
    "/v1/faxes/{fax_id}/receipt": {
      "get": {
        "operationId": "get_fax_receipt",
        "parameters": [
          {
            "in": "path",
            "name": "fax_id",
            "required": true,
            "schema": {
              "title": "Fax Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Receipt"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Delivery evidence as a receipt (JSON)",
        "tags": [
          "faxes"
        ],
        "x-required-scope": "fax:read"
      }
    },
    "/v1/faxes/{fax_id}/receipt.pdf": {
      "get": {
        "operationId": "get_fax_receipt_pdf",
        "parameters": [
          {
            "in": "path",
            "name": "fax_id",
            "required": true,
            "schema": {
              "title": "Fax Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/pdf": {}
            },
            "description": "The receipt as a PDF"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "The same receipt as a one-page PDF",
        "tags": [
          "faxes"
        ],
        "x-required-scope": "fax:read"
      }
    },
    "/v1/inbox": {
      "get": {
        "operationId": "list_inbox",
        "parameters": [
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "received",
                    "read",
                    "archived"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Status"
            }
          },
          {
            "description": "false leaves archived faxes out; true lists only those.",
            "in": "query",
            "name": "archived",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "description": "false leaves archived faxes out; true lists only those.",
              "title": "Archived"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InboxPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Received faxes, newest first (metadata only)",
        "tags": [
          "inbox"
        ],
        "x-required-scope": "inbox:read"
      }
    },
    "/v1/inbox/{inbox_id}": {
      "delete": {
        "operationId": "delete_inbox_item",
        "parameters": [
          {
            "in": "path",
            "name": "inbox_id",
            "required": true,
            "schema": {
              "title": "Inbox Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deleted"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "inbox_item_expired: the received fax passed its retention date and is no longer kept. organization_deleted: the organization is being deleted, so the call is refused."
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Delete a received fax: its file and the text read from it",
        "tags": [
          "inbox"
        ],
        "x-required-scope": "inbox:write"
      },
      "get": {
        "operationId": "get_inbox_item",
        "parameters": [
          {
            "in": "path",
            "name": "inbox_id",
            "required": true,
            "schema": {
              "title": "Inbox Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InboxItemDetail"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "inbox_item_expired: the received fax passed its retention date and is no longer kept. organization_deleted: the organization is being deleted, so the call is refused."
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "One received fax with its text as data",
        "tags": [
          "inbox"
        ],
        "x-required-scope": "inbox:read"
      },
      "patch": {
        "operationId": "update_inbox_item",
        "parameters": [
          {
            "in": "path",
            "name": "inbox_id",
            "required": true,
            "schema": {
              "title": "Inbox Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InboxUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/faxforagents__api__routes__inbox__InboxItem"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "inbox_item_expired: the received fax passed its retention date and is no longer kept. organization_deleted: the organization is being deleted, so the call is refused."
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Mark a received fax read or archived",
        "tags": [
          "inbox"
        ],
        "x-required-scope": "inbox:write"
      }
    },
    "/v1/inbox/{inbox_id}/content": {
      "get": {
        "operationId": "get_inbox_content",
        "parameters": [
          {
            "in": "path",
            "name": "inbox_id",
            "required": true,
            "schema": {
              "title": "Inbox Id",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "exp",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Exp"
            }
          },
          {
            "in": "query",
            "name": "sig",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Sig"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "inbox_item_expired: the received fax passed its retention date and is no longer kept."
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          }
        },
        "security": [
          {
            "signedUrl": []
          }
        ],
        "summary": "The received PDF behind a signed URL (no API key)",
        "tags": [
          "inbox"
        ]
      }
    },
    "/v1/inbox/{inbox_id}/download": {
      "get": {
        "operationId": "get_inbox_download",
        "parameters": [
          {
            "in": "path",
            "name": "inbox_id",
            "required": true,
            "schema": {
              "title": "Inbox Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignedUrl"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "inbox_item_expired: the received fax passed its retention date and is no longer kept. organization_deleted: the organization is being deleted, so the call is refused."
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "A short-lived signed link to the received PDF",
        "tags": [
          "inbox"
        ],
        "x-required-scope": "inbox:read"
      }
    },
    "/v1/integration-reviews/{org_id}/{environment}/{operation_id}/{binding_id}": {
      "get": {
        "operationId": "get_integration_review",
        "parameters": [
          {
            "in": "path",
            "name": "org_id",
            "required": true,
            "schema": {
              "title": "Org Id",
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environment",
            "required": true,
            "schema": {
              "title": "Environment",
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "operation_id",
            "required": true,
            "schema": {
              "title": "Operation Id",
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "binding_id",
            "required": true,
            "schema": {
              "title": "Binding Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalRequest"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Get Integration Review",
        "tags": [
          "approvals"
        ],
        "x-required-scope": "approval:read"
      }
    },
    "/v1/invitations": {
      "get": {
        "operationId": "list_invitations",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvitationList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Open invitations",
        "tags": [
          "members"
        ],
        "x-required-scope": "member:admin"
      },
      "post": {
        "operationId": "create_invitation",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InvitationCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Invitation"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Invite someone by email (a link that works for 7 days)",
        "tags": [
          "members"
        ],
        "x-required-scope": "member:admin"
      }
    },
    "/v1/invitations/{invitation_id}": {
      "delete": {
        "operationId": "revoke_invitation",
        "parameters": [
          {
            "in": "path",
            "name": "invitation_id",
            "required": true,
            "schema": {
              "title": "Invitation Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Withdraw an invitation",
        "tags": [
          "members"
        ],
        "x-required-scope": "member:admin"
      }
    },
    "/v1/invitations/{invitation_id}/link": {
      "post": {
        "description": "No mail is sent. The link is shown once, like a key's secret: the server keeps only its hash. It joins the organization only for a person signed in with the invited address.",
        "operationId": "link_invitation",
        "parameters": [
          {
            "in": "path",
            "name": "invitation_id",
            "required": true,
            "schema": {
              "title": "Invitation Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvitationLink"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Make a new link for an open invitation, to hand over yourself (the old link stops working)",
        "tags": [
          "members"
        ],
        "x-required-scope": "member:admin"
      }
    },
    "/v1/invitations/{invitation_id}/resend": {
      "post": {
        "operationId": "resend_invitation",
        "parameters": [
          {
            "in": "path",
            "name": "invitation_id",
            "required": true,
            "schema": {
              "title": "Invitation Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Invitation"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Send an open invitation again (a new link for 7 days; the old link stops working)",
        "tags": [
          "members"
        ],
        "x-required-scope": "member:admin"
      }
    },
    "/v1/invoices": {
      "get": {
        "operationId": "list_invoices",
        "parameters": [
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 20,
              "maximum": 100,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoicePage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "The credential is valid and is not allowed to do this. scope_missing puts the scope in error.details.scope. Other codes are agent_forbidden and approval_required. A session can also meet csrf_invalid and reauth_required. A test key, or a session switched to Test, gets environment_not_billable here: the test wallet is never funded, so billing takes live."
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Stripe invoices and receipts (hosted links)",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/invoices/{invoice_id}": {
      "get": {
        "operationId": "get_invoice",
        "parameters": [
          {
            "in": "path",
            "name": "invoice_id",
            "required": true,
            "schema": {
              "title": "Invoice Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Invoice"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "The credential is valid and is not allowed to do this. scope_missing puts the scope in error.details.scope. Other codes are agent_forbidden and approval_required. A session can also meet csrf_invalid and reauth_required. A test key, or a session switched to Test, gets environment_not_billable here: the test wallet is never funded, so billing takes live."
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "One Stripe invoice",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/invoices/{invoice_id}/receipt": {
      "get": {
        "operationId": "get_invoice_receipt",
        "parameters": [
          {
            "in": "path",
            "name": "invoice_id",
            "required": true,
            "schema": {
              "title": "Invoice Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentReceipt"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "The credential is valid and is not allowed to do this. scope_missing puts the scope in error.details.scope. Other codes are agent_forbidden and approval_required. A session can also meet csrf_invalid and reauth_required. A test key, or a session switched to Test, gets environment_not_billable here: the test wallet is never funded, so billing takes live."
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Stripe's receipt for a paid invoice",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/ledger": {
      "get": {
        "operationId": "list_ledger",
        "parameters": [
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LedgerPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Wallet transactions, newest first",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/me": {
      "get": {
        "operationId": "get_me",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/faxforagents__api__schemas__Me"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Who am I",
        "tags": [
          "identity"
        ]
      }
    },
    "/v1/members": {
      "get": {
        "operationId": "list_members",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MemberList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "The organization's members",
        "tags": [
          "members"
        ],
        "x-required-scope": "account:read"
      }
    },
    "/v1/members/{member_id}": {
      "delete": {
        "operationId": "remove_member",
        "parameters": [
          {
            "in": "path",
            "name": "member_id",
            "required": true,
            "schema": {
              "title": "Member Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Remove a member (owner)",
        "tags": [
          "members"
        ],
        "x-required-scope": "org:admin"
      },
      "patch": {
        "operationId": "update_member",
        "parameters": [
          {
            "in": "path",
            "name": "member_id",
            "required": true,
            "schema": {
              "title": "Member Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MemberPatch"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Member"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Change a member's role",
        "tags": [
          "members"
        ],
        "x-required-scope": "member:admin"
      }
    },
    "/v1/number-inventory": {
      "get": {
        "operationId": "get_number_inventory",
        "parameters": [
          {
            "in": "query",
            "name": "country",
            "required": false,
            "schema": {
              "default": "US",
              "maxLength": 2,
              "minLength": 2,
              "title": "Country",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "locality",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 80,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Locality"
            }
          },
          {
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "default": "local",
              "enum": [
                "local",
                "toll_free"
              ],
              "title": "Type",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 10,
              "maximum": 50,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Inventory"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Fax-capable numbers for sale",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:read"
      }
    },
    "/v1/number-orders": {
      "get": {
        "operationId": "list_number_orders",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NumberOrderList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "List your number orders",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:read"
      },
      "post": {
        "description": "Returns 201 with the created order, including when the carrier refuses the purchase. A refused order has status failed and an error describing the carrier's reason. Its first-month hold is released and nothing is charged. Reusing the same Idempotency-Key returns the same response body without another purchase. An unconfirmed carrier response leaves the order pending for reconciliation.",
        "operationId": "create_number_order",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NumberOrderCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NumberOrder"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Buy a number (the first month is held now, charged on activation)",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:buy"
      }
    },
    "/v1/number-orders/{order_id}": {
      "get": {
        "operationId": "get_number_order",
        "parameters": [
          {
            "in": "path",
            "name": "order_id",
            "required": true,
            "schema": {
              "title": "Order Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NumberOrder"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Read a number order",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:read"
      }
    },
    "/v1/number-orders/{order_id}/dismissals": {
      "post": {
        "description": "Sets dismissed_at on an order that failed. The order stays in the list. An order that did not fail answers 409 conflict.",
        "operationId": "dismiss_number_order",
        "parameters": [
          {
            "in": "path",
            "name": "order_id",
            "required": true,
            "schema": {
              "title": "Order Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NumberOrder"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Put a failed number order away",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:buy"
      }
    },
    "/v1/numbers": {
      "get": {
        "operationId": "list_numbers",
        "parameters": [
          {
            "in": "query",
            "name": "include_released",
            "required": false,
            "schema": {
              "default": false,
              "title": "Include Released",
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NumberList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Your numbers",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:read"
      }
    },
    "/v1/numbers/{number_id}": {
      "get": {
        "operationId": "get_number",
        "parameters": [
          {
            "in": "path",
            "name": "number_id",
            "required": true,
            "schema": {
              "title": "Number Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Number"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "One number",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:read"
      },
      "patch": {
        "operationId": "update_number",
        "parameters": [
          {
            "in": "path",
            "name": "number_id",
            "required": true,
            "schema": {
              "title": "Number Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NumberUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Number"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Label, inbound route and PDF by mail of a number",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:buy"
      }
    },
    "/v1/numbers/{number_id}/release-requests": {
      "post": {
        "operationId": "create_release_request",
        "parameters": [
          {
            "in": "path",
            "name": "number_id",
            "required": true,
            "schema": {
              "title": "Number Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReleaseRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Number"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Release a number (confirm with the number itself; 30-day quarantine follows)",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:buy"
      }
    },
    "/v1/oauth/authorizations/{authorization_id}": {
      "get": {
        "operationId": "get_oauth_authorization",
        "parameters": [
          {
            "in": "path",
            "name": "authorization_id",
            "required": true,
            "schema": {
              "title": "Authorization Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OAuthConsent"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "The pending consent behind a consent URL: the app, the scopes and your organizations",
        "tags": [
          "oauth"
        ]
      }
    },
    "/v1/oauth/authorizations/{authorization_id}/approve": {
      "post": {
        "operationId": "approve_oauth_authorization",
        "parameters": [
          {
            "in": "path",
            "name": "authorization_id",
            "required": true,
            "schema": {
              "title": "Authorization Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OAuthConsentDecision"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OAuthRedirect"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Allow: mint the authorization code and return where the browser goes next",
        "tags": [
          "oauth"
        ]
      }
    },
    "/v1/oauth/authorizations/{authorization_id}/deny": {
      "post": {
        "operationId": "deny_oauth_authorization",
        "parameters": [
          {
            "in": "path",
            "name": "authorization_id",
            "required": true,
            "schema": {
              "title": "Authorization Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OAuthRedirect"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "sessionCookie": []
          }
        ],
        "summary": "Deny: send the app an access_denied answer",
        "tags": [
          "oauth"
        ]
      }
    },
    "/v1/oauth/grants": {
      "get": {
        "operationId": "list_oauth_grants",
        "parameters": [
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 64,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 100,
              "maximum": 100,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GrantList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Your connected apps in this organization",
        "tags": [
          "oauth"
        ],
        "x-required-scope": "key:admin"
      }
    },
    "/v1/oauth/grants/{grant_id}": {
      "delete": {
        "operationId": "revoke_oauth_grant",
        "parameters": [
          {
            "in": "path",
            "name": "grant_id",
            "required": true,
            "schema": {
              "title": "Grant Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Revoke a connected app",
        "tags": [
          "oauth"
        ],
        "x-required-scope": "key:admin"
      }
    },
    "/v1/one-time-sends": {
      "get": {
        "operationId": "list_one_time_orders",
        "parameters": [
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "draft",
                    "checkout_open",
                    "authorized",
                    "awaiting_confirmation",
                    "released",
                    "capturing",
                    "canceling",
                    "captured",
                    "released_hold",
                    "expired",
                    "refused",
                    "settle_failed",
                    "refunding",
                    "refunded",
                    "canceled"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Status"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneTimeOrderPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "List the organization's one-time orders, newest first",
        "tags": [
          "one-time-sends"
        ],
        "x-required-scope": "fax:read"
      },
      "post": {
        "description": "No credential is needed. The answer carries the price, the page count and the status token; the next step is the checkout. A live key with fax:send or a signed-in session may create an order for its organization. Nothing is charged and nothing is sent by this call.",
        "operationId": "create_one_time_order",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "additionalProperties": false,
                "description": "The JSON form of an order: text only. A file (PDF, PNG, JPEG, TIFF) goes as ``multipart/form-data``\nwith the same field names and the part ``file``.",
                "properties": {
                  "accept_aup": {
                    "description": "True: the sender accepts the acceptable use policy and the terms the config route names.",
                    "title": "Accept Aup",
                    "type": "boolean"
                  },
                  "delete_after_send": {
                    "default": false,
                    "description": "Delete the document and the transmitted copy the moment the fax ends in delivered, partial or failed. The order, the receipt and the carrier evidence stay; they hold no document content. A fax that ends unknown keeps the document until the carrier reports, or until the retention period ends. Default: keep the document for the retention period.",
                    "title": "Delete After Send",
                    "type": "boolean"
                  },
                  "email": {
                    "anyOf": [
                      {
                        "maxLength": 254,
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Where the confirmation link, the receipt and the evidence go. Required without a credential; a signed-in session uses its own address; a key may leave it out to use the organization's.",
                    "title": "Email"
                  },
                  "message": {
                    "anyOf": [
                      {
                        "maxLength": 2000,
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "title": "Message"
                  },
                  "sender_name": {
                    "description": "Printed on the cover sheet. 2 to 120 characters.",
                    "maxLength": 200,
                    "title": "Sender Name",
                    "type": "string"
                  },
                  "source_ref": {
                    "anyOf": [
                      {
                        "maxLength": 32,
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Where the sender came from (a short tag, never a URL).",
                    "title": "Source Ref"
                  },
                  "subject": {
                    "anyOf": [
                      {
                        "maxLength": 200,
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "title": "Subject"
                  },
                  "text": {
                    "description": "The document as plain text or Markdown.",
                    "title": "Text",
                    "type": "string"
                  },
                  "text_format": {
                    "default": "text",
                    "enum": [
                      "text",
                      "markdown"
                    ],
                    "title": "Text Format",
                    "type": "string"
                  },
                  "to": {
                    "description": "The destination fax number, E.164.",
                    "maxLength": 40,
                    "title": "To",
                    "type": "string"
                  },
                  "to_name": {
                    "anyOf": [
                      {
                        "maxLength": 120,
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "title": "To Name"
                  }
                },
                "required": [
                  "sender_name",
                  "to",
                  "accept_aup",
                  "text"
                ],
                "type": "object"
              }
            },
            "multipart/form-data": {
              "schema": {
                "additionalProperties": false,
                "description": "The JSON form of an order: text only. A file (PDF, PNG, JPEG, TIFF) goes as ``multipart/form-data``\nwith the same field names and the part ``file``.",
                "properties": {
                  "accept_aup": {
                    "description": "True: the sender accepts the acceptable use policy and the terms the config route names.",
                    "title": "Accept Aup",
                    "type": "boolean"
                  },
                  "delete_after_send": {
                    "default": false,
                    "description": "Delete the document and the transmitted copy the moment the fax ends in delivered, partial or failed. The order, the receipt and the carrier evidence stay; they hold no document content. A fax that ends unknown keeps the document until the carrier reports, or until the retention period ends. Default: keep the document for the retention period.",
                    "title": "Delete After Send",
                    "type": "boolean"
                  },
                  "email": {
                    "anyOf": [
                      {
                        "maxLength": 254,
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Where the confirmation link, the receipt and the evidence go. Required without a credential; a signed-in session uses its own address; a key may leave it out to use the organization's.",
                    "title": "Email"
                  },
                  "file": {
                    "description": "The document: PDF, PNG, JPEG or TIFF. Send this or text, not both.",
                    "format": "binary",
                    "type": "string"
                  },
                  "message": {
                    "anyOf": [
                      {
                        "maxLength": 2000,
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "title": "Message"
                  },
                  "sender_name": {
                    "description": "Printed on the cover sheet. 2 to 120 characters.",
                    "maxLength": 200,
                    "title": "Sender Name",
                    "type": "string"
                  },
                  "source_ref": {
                    "anyOf": [
                      {
                        "maxLength": 32,
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Where the sender came from (a short tag, never a URL).",
                    "title": "Source Ref"
                  },
                  "subject": {
                    "anyOf": [
                      {
                        "maxLength": 200,
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "title": "Subject"
                  },
                  "text": {
                    "description": "The document as plain text or Markdown.",
                    "title": "Text",
                    "type": "string"
                  },
                  "text_format": {
                    "default": "text",
                    "enum": [
                      "text",
                      "markdown"
                    ],
                    "title": "Text Format",
                    "type": "string"
                  },
                  "to": {
                    "description": "The destination fax number, E.164.",
                    "maxLength": 40,
                    "title": "To",
                    "type": "string"
                  },
                  "to_name": {
                    "anyOf": [
                      {
                        "maxLength": 120,
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "title": "To Name"
                  }
                },
                "required": [
                  "sender_name",
                  "to",
                  "accept_aup"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneTimeOrderCreated"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {},
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Create a one-time order: one document to one fax number, priced from the card",
        "tags": [
          "one-time-sends"
        ],
        "x-required-scope": "fax:send"
      }
    },
    "/v1/one-time-sends/by-token": {
      "post": {
        "description": "The confirm page reads this before the click, with the token in the body. Nothing is consumed by reading it, and nothing is changed: the call is a read that keeps the token out of the address. Idempotency-Key is accepted but ignored.",
        "operationId": "read_one_time_order_by_token",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OneTimeConfirm"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneTimeConfirmSummary"
                }
              }
            },
            "description": "Successful Response"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [],
        "summary": "What a confirmation link is for, without using it",
        "tags": [
          "one-time-sends"
        ]
      }
    },
    "/v1/one-time-sends/by-token/{token}": {
      "get": {
        "deprecated": true,
        "description": "Kept for pages loaded before 2026-11-12. The token in a path reaches access logs, so new callers post it to /v1/one-time-sends/by-token instead. Nothing is consumed by reading it.",
        "operationId": "get_one_time_order_by_token",
        "parameters": [
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "title": "Token",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneTimeConfirmSummary"
                }
              }
            },
            "description": "Successful Response"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [],
        "summary": "What a confirmation link is for, without using it (token in the path)",
        "tags": [
          "one-time-sends"
        ]
      }
    },
    "/v1/one-time-sends/config": {
      "get": {
        "operationId": "get_one_time_config",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneTimeConfig"
                }
              }
            },
            "description": "Successful Response"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [],
        "summary": "Whether one-time sends are open here, and the card and limits an order is priced and checked by",
        "tags": [
          "one-time-sends"
        ]
      }
    },
    "/v1/one-time-sends/cover-checks": {
      "post": {
        "description": "Lays out the cover sheet exactly as the create would, with the fields given so far, and answers whether the message fits on its one page and how many more lines fit, or how much of it fits when it runs over. The create refuses a cover that does not fit with invalid_request on cover; this call says so while the message is written. Every field may be empty. Nothing is stored and no credential is needed. Idempotency-Key is accepted but ignored: the call changes nothing.",
        "operationId": "create_one_time_cover_check",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OneTimeCoverCheck"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneTimeCoverRoom"
                }
              }
            },
            "description": "Successful Response"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [],
        "summary": "Measure the room the cover sheet leaves for its message, before an order is made",
        "tags": [
          "one-time-sends"
        ]
      }
    },
    "/v1/one-time-sends/from-quote": {
      "post": {
        "description": "The quote supplies the document, the destination and the cover; the price is the card's one-time price, not the quote's. The quote then belongs to the order. Needs a live key with fax:send. A key needs what a wallet send of the quote needs: approval_id, or a delegated policy that allows the send. Paying by card replaces neither; without one the answer is 403 approval_required.",
        "operationId": "create_one_time_order_from_quote",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OneTimeFromQuote"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneTimeOrderCreated"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Create a one-time order from a live quote the wallet does not cover",
        "tags": [
          "one-time-sends"
        ],
        "x-required-scope": "fax:send"
      }
    },
    "/v1/one-time-sends/preview": {
      "post": {
        "description": "Reads a file (or text) exactly as the create would and answers its page count and its first page as a small picture, or the create's own refusal: too_many_pages, encrypted_pdf, unsupported_format, document_too_large and the other document codes. The price of the document follows from the count and the route of GET /v1/one-time-sends/config. Nothing is stored: no order, no account, no file. No credential is needed. Idempotency-Key is accepted but ignored: the call changes nothing, so a repeat reads the file again.",
        "operationId": "preview_one_time_document",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "text": {
                    "description": "The text of the fax.",
                    "type": "string"
                  },
                  "text_format": {
                    "enum": [
                      "text",
                      "markdown"
                    ],
                    "type": "string"
                  }
                },
                "required": [
                  "text"
                ],
                "type": "object"
              }
            },
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "description": "The document: PDF, PNG, JPEG or TIFF. Send this or text.",
                    "format": "binary",
                    "type": "string"
                  },
                  "text": {
                    "description": "The text of the fax, in place of a file.",
                    "type": "string"
                  },
                  "text_format": {
                    "enum": [
                      "text",
                      "markdown"
                    ],
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneTimeInspection"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {},
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Count the pages of a document before an order is made",
        "tags": [
          "one-time-sends"
        ],
        "x-required-scope": "fax:send"
      }
    },
    "/v1/one-time-sends/{one_time_order_id}": {
      "get": {
        "operationId": "get_one_time_order",
        "parameters": [
          {
            "in": "path",
            "name": "one_time_order_id",
            "required": true,
            "schema": {
              "title": "One Time Order Id",
              "type": "string"
            }
          },
          {
            "description": "The status token, when no header carries it.",
            "in": "query",
            "name": "t",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "The status token, when no header carries it.",
              "title": "T"
            }
          },
          {
            "description": "The status token of the order, for a caller without a key or a session.",
            "in": "header",
            "name": "X-FFA-Order-Token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneTimeOrder"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          },
          {
            "orderToken": []
          }
        ],
        "summary": "Read a one-time order: where it stands, what to do next, and the fax with its evidence",
        "tags": [
          "one-time-sends"
        ],
        "x-required-scope": "fax:read"
      }
    },
    "/v1/one-time-sends/{one_time_order_id}/checkout": {
      "post": {
        "description": "Answers the hosted payment page of the order. The card is held there, not charged. A failed fax costs nothing. A fax that stops part way is charged the price of the pages the carrier confirms, and the rest of the hold is released. A second call answers the same page while it can still be paid, and a new one after it expired. An order whose aup_accepted is false needs {\"accept_aup\": true} in the body once, from the status token or a session: the person who pays accepts the policy, never a key.",
        "operationId": "create_one_time_checkout",
        "parameters": [
          {
            "in": "path",
            "name": "one_time_order_id",
            "required": true,
            "schema": {
              "title": "One Time Order Id",
              "type": "string"
            }
          },
          {
            "description": "The status token, when no header carries it.",
            "in": "query",
            "name": "t",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "The status token, when no header carries it.",
              "title": "T"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          },
          {
            "description": "The status token of the order, for a caller without a key or a session.",
            "in": "header",
            "name": "X-FFA-Order-Token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "accept_aup": {
                    "default": false,
                    "description": "True: the person who pays accepts the acceptable use policy and the terms. Needed once, for an order whose aup_accepted is false, and taken only from the status token or a session.",
                    "title": "Accept Aup",
                    "type": "boolean"
                  }
                },
                "title": "OneTimeCheckoutRequest",
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneTimeCheckout"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          },
          {
            "orderToken": []
          }
        ],
        "summary": "Open the card payment of a one-time order",
        "tags": [
          "one-time-sends"
        ],
        "x-required-scope": "fax:send"
      }
    },
    "/v1/one-time-sends/{one_time_order_id}/confirm": {
      "post": {
        "description": "Proves the sender's address and releases the fax. In a browser without a session it also signs the payer in and sets the session cookies. Idempotency-Key is accepted but ignored: the link works once. A repeat by the same signed-in person answers the confirmed order again; any other repeat answers 409 link_used and sends nothing.",
        "operationId": "confirm_one_time_order",
        "parameters": [
          {
            "in": "path",
            "name": "one_time_order_id",
            "required": true,
            "schema": {
              "title": "One Time Order Id",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OneTimeConfirm"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneTimeConfirmed"
                }
              }
            },
            "description": "Successful Response"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [],
        "summary": "Confirm a one-time order with the token of the mailed link: the fax is released",
        "tags": [
          "one-time-sends"
        ]
      }
    },
    "/v1/one-time-sends/{one_time_order_id}/pages/{page_number}": {
      "get": {
        "description": "Page 1 is the cover sheet. Before the fax is released the cover is drawn from the order as it will be printed, and the other pages from the uploaded document. After the release the pages are the file that went to the carrier. order.preview says how many pages can be asked for. 404 not_found for a page that does not exist or a copy that is no longer held (deleted after the send, or after its retention). A key or session of the order's organization may read it, and so may the status token, as the header or as ?t=.",
        "operationId": "get_one_time_order_page",
        "parameters": [
          {
            "in": "path",
            "name": "one_time_order_id",
            "required": true,
            "schema": {
              "title": "One Time Order Id",
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "page_number",
            "required": true,
            "schema": {
              "title": "Page Number",
              "type": "integer"
            }
          },
          {
            "description": "The status token, when no header carries it.",
            "in": "query",
            "name": "t",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "The status token, when no header carries it.",
              "title": "T"
            }
          },
          {
            "description": "The status token of the order, for a caller without a key or a session.",
            "in": "header",
            "name": "X-FFA-Order-Token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "image/png": {}
            },
            "description": "The page as a PNG"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          },
          {
            "orderToken": []
          }
        ],
        "summary": "One page of a one-time order as a picture: the cover sheet, then the document",
        "tags": [
          "one-time-sends"
        ],
        "x-required-scope": "fax:read"
      }
    },
    "/v1/one-time-sends/{one_time_order_id}/receipt.pdf": {
      "get": {
        "description": "The delivery receipt of the order's fax: the state, the pages, the document hash, the carrier's evidence as it was reported, and what became of the card. It says charged only once the payment provider confirmed the capture. A key or session of the order's organization may read it, and so may the status token, as the header or as ?t=. 409 conflict while the fax has not ended or the order has no fax.",
        "operationId": "get_one_time_receipt_pdf",
        "parameters": [
          {
            "in": "path",
            "name": "one_time_order_id",
            "required": true,
            "schema": {
              "title": "One Time Order Id",
              "type": "string"
            }
          },
          {
            "description": "The status token, when no header carries it.",
            "in": "query",
            "name": "t",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "The status token, when no header carries it.",
              "title": "T"
            }
          },
          {
            "description": "The status token of the order, for a caller without a key or a session.",
            "in": "header",
            "name": "X-FFA-Order-Token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/pdf": {}
            },
            "description": "The receipt as a PDF"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          },
          {
            "orderToken": []
          }
        ],
        "summary": "The receipt of a one-time order's fax as a one-page PDF",
        "tags": [
          "one-time-sends"
        ],
        "x-required-scope": "fax:read"
      }
    },
    "/v1/one-time-sends/{one_time_order_id}/resend-confirmation": {
      "post": {
        "description": "At most three times per order and once in ten minutes. The earlier links keep working.",
        "operationId": "resend_one_time_confirmation",
        "parameters": [
          {
            "in": "path",
            "name": "one_time_order_id",
            "required": true,
            "schema": {
              "title": "One Time Order Id",
              "type": "string"
            }
          },
          {
            "description": "The status token, when no header carries it.",
            "in": "query",
            "name": "t",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "The status token, when no header carries it.",
              "title": "T"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          },
          {
            "description": "The status token of the order, for a caller without a key or a session.",
            "in": "header",
            "name": "X-FFA-Order-Token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneTimeOrder"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          },
          {
            "orderToken": []
          }
        ],
        "summary": "Mail the confirmation link of a one-time order again",
        "tags": [
          "one-time-sends"
        ],
        "x-required-scope": "fax:send"
      }
    },
    "/v1/organization/export-archives/{token}": {
      "get": {
        "operationId": "download_export_archive",
        "parameters": [
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "title": "Token",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "exp",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Exp"
            }
          },
          {
            "in": "query",
            "name": "sig",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Sig"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          }
        },
        "security": [
          {
            "signedUrl": []
          }
        ],
        "summary": "Download an organization archive with a signed link valid for 72 hours",
        "tags": [
          "organizations"
        ]
      }
    },
    "/v1/organizations": {
      "get": {
        "operationId": "list_organizations",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrganizationList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "The organizations you belong to",
        "tags": [
          "organizations"
        ]
      }
    },
    "/v1/organizations/current": {
      "get": {
        "operationId": "get_current_organization",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Organization"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "The organization you are looking at",
        "tags": [
          "organizations"
        ],
        "x-required-scope": "account:read"
      },
      "patch": {
        "operationId": "update_current_organization",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrganizationPatch"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Organization"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Rename the organization",
        "tags": [
          "organizations"
        ],
        "x-required-scope": "member:admin"
      }
    },
    "/v1/organizations/current/auto-send": {
      "get": {
        "operationId": "get_auto_send",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutoSendSetting"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Read the auto-send setting for connected apps in this environment",
        "tags": [
          "policies",
          "organizations"
        ],
        "x-required-scope": "policy:read"
      },
      "put": {
        "description": "The environment comes from X-FFA-Environment. When enabled, every connected app of the organization (OAuth connections such as ChatGPT or Claude, and API keys flagged connected_app) sends in that environment with no approval per fax, inside the amount per fax and the faxes per day. A hosted integration the server marks requires_human_approval still needs a person. The first enable creates a managed policy; every later save is a new policy version with its audit row. A browser session needs a sign-in from the last 15 minutes.",
        "operationId": "put_auto_send",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AutoSendUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutoSendSetting"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Let connected apps send without asking, inside two limits (owner)",
        "tags": [
          "policies",
          "organizations"
        ],
        "x-required-scope": "org:admin"
      }
    },
    "/v1/organizations/current/data-requests": {
      "get": {
        "operationId": "list_data_requests",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DataRequestList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "The organization's export and deletion requests and where each stands",
        "tags": [
          "organizations"
        ],
        "x-required-scope": "account:read"
      }
    },
    "/v1/organizations/current/deletion-requests": {
      "post": {
        "operationId": "request_data_deletion",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Requested"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Ask for the organization and its data to be deleted (owner)",
        "tags": [
          "organizations"
        ],
        "x-required-scope": "org:admin"
      }
    },
    "/v1/organizations/current/deletion-requests/{request_id}": {
      "delete": {
        "description": "Works while the request is open. Once a person at Fax for Agents has started the deletion the organization answers 410 to every call, this one included.",
        "operationId": "withdraw_data_deletion",
        "parameters": [
          {
            "in": "path",
            "name": "request_id",
            "required": true,
            "schema": {
              "title": "Request Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DataRequest"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Withdraw an open deletion request (owner)",
        "tags": [
          "organizations"
        ],
        "x-required-scope": "org:admin"
      }
    },
    "/v1/organizations/current/export-requests": {
      "post": {
        "operationId": "request_data_export",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Requested"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Ask for an export of the organization's data (owner)",
        "tags": [
          "organizations"
        ],
        "x-required-scope": "org:admin"
      }
    },
    "/v1/policies": {
      "get": {
        "operationId": "list_policies",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "List the organization's policies",
        "tags": [
          "policies"
        ],
        "x-required-scope": "policy:read"
      },
      "post": {
        "operationId": "create_policy",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Policy"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Create a delegated policy (version 1)",
        "tags": [
          "policies"
        ],
        "x-required-scope": "policy:admin"
      }
    },
    "/v1/policies/effective": {
      "get": {
        "operationId": "get_effective_policies",
        "parameters": [
          {
            "description": "An API key in your organization. Uses the key's environment. Choose either key_id or agent_id.",
            "in": "query",
            "name": "key_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "An API key in your organization. Uses the key's environment. Choose either key_id or agent_id.",
              "title": "Key Id"
            }
          },
          {
            "description": "An agent in your organization. Uses the current environment and excludes bindings to individual keys.",
            "in": "query",
            "name": "agent_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "An agent in your organization. Uses the current environment and excludes bindings to individual keys.",
              "title": "Agent Id"
            }
          },
          {
            "description": "A connected app (an OAuth grant, GET /v1/oauth/grants) in your organization; a signed-in person sees their own. Uses the connection's environment. Choose at most one of key_id, agent_id and connection_id.",
            "in": "query",
            "name": "connection_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^[a-z]{2,8}_[0-9a-f]{32}$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "A connected app (an OAuth grant, GET /v1/oauth/grants) in your organization; a signed-in person sees their own. Uses the connection's environment. Choose at most one of key_id, agent_id and connection_id.",
              "title": "Connection Id"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EffectivePolicies"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Read the rules bound to the caller, an API key, an agent or a connected app",
        "tags": [
          "policies"
        ],
        "x-required-scope": "policy:read"
      }
    },
    "/v1/policies/{policy_id}": {
      "get": {
        "operationId": "get_policy",
        "parameters": [
          {
            "in": "path",
            "name": "policy_id",
            "required": true,
            "schema": {
              "title": "Policy Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Policy"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Read a policy (its current version)",
        "tags": [
          "policies"
        ],
        "x-required-scope": "policy:read"
      },
      "patch": {
        "operationId": "update_policy",
        "parameters": [
          {
            "in": "path",
            "name": "policy_id",
            "required": true,
            "schema": {
              "title": "Policy Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Policy"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Change a policy: a new immutable version",
        "tags": [
          "policies"
        ],
        "x-required-scope": "policy:admin"
      }
    },
    "/v1/policies/{policy_id}/versions": {
      "get": {
        "operationId": "list_policy_versions",
        "parameters": [
          {
            "in": "path",
            "name": "policy_id",
            "required": true,
            "schema": {
              "title": "Policy Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyVersionList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Every version, oldest first",
        "tags": [
          "policies"
        ],
        "x-required-scope": "policy:read"
      }
    },
    "/v1/policy-evaluations": {
      "post": {
        "operationId": "create_policy_evaluation",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyEvaluationCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyEvaluation"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Dry run: would the policies of the caller, or of a named key, agent or app, allow this send?",
        "tags": [
          "policies"
        ],
        "x-required-scope": "policy:read"
      }
    },
    "/v1/policy-rule-checks": {
      "post": {
        "description": "For the editor of a policy: which numbers of allowed_destinations are already allowed by one of allowed_countries or allowed_country_prefixes. Routed with the rate card, the way an evaluation routes a destination. Entries that are not numbers the card serves are left out. Nothing is stored and no policy is read. Idempotency-Key is accepted but ignored: a repeat checks the lists again.",
        "operationId": "create_policy_rule_check",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyRuleCheckCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyRuleCheck"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Check a draft's destination lists against each other. Writes nothing",
        "tags": [
          "policies"
        ],
        "x-required-scope": "policy:read"
      }
    },
    "/v1/port-orders": {
      "get": {
        "operationId": "list_port_orders",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortOrderList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Port orders and port-out requests",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:read"
      },
      "post": {
        "operationId": "create_port_order",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PortOrderCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortOrder"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Request a port-in (handled with you)",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:buy"
      }
    },
    "/v1/port-orders/{port_id}": {
      "get": {
        "operationId": "get_port_order",
        "parameters": [
          {
            "in": "path",
            "name": "port_id",
            "required": true,
            "schema": {
              "title": "Port Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortOrder"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "One port order",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:read"
      }
    },
    "/v1/port-out-requests": {
      "post": {
        "operationId": "create_port_out_request",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PortOutRequestCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortOrder"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Note a port-out of one of your numbers",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:buy"
      }
    },
    "/v1/portability-checks": {
      "post": {
        "operationId": "create_portability_check",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PortabilityCheckCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortabilityCheck"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Can these numbers port in",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:read"
      }
    },
    "/v1/records/audit.csv": {
      "get": {
        "description": "One line per audit row of the organization, oldest first: when, who (actor and a label), what (action), on what (resource_type and resource_id) and the row's data as JSON. Never a document's content. A range of more than 20000 lines answers 422: choose fewer days. Needs the scope org:admin, which an owner has. An agent is refused.",
        "operationId": "get_audit_csv",
        "parameters": [
          {
            "description": "First UTC day, YYYY-MM-DD, included.",
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "First UTC day, YYYY-MM-DD, included.",
              "title": "From"
            }
          },
          {
            "description": "Last UTC day, YYYY-MM-DD, included.",
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Last UTC day, YYYY-MM-DD, included.",
              "title": "To"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "error.code is workspace_required while the organization's Agent workspace plan is not active and ended more than 30 days ago, or never started. error.details.ended_at is when it ended and error.details.closed_at when the export closed. scope_missing names a scope the credential lacks, and an agent gets agent_forbidden."
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "The audit trail as CSV: every action on the organization in the range",
        "tags": [
          "organizations"
        ],
        "x-required-scope": "org:admin"
      }
    },
    "/v1/records/faxes.csv": {
      "get": {
        "description": "Needs two scopes: fax:read, which x-required-scope names, and inbox:read as well. One line per fax of the key's environment, sent and received, oldest first. A sent fax counts by when it was created and a received one by when it arrived. The lines carry what each fax cost the wallet, never the document or its text. A range of more than 20000 lines answers 422: choose fewer days.",
        "operationId": "get_fax_history_csv",
        "parameters": [
          {
            "description": "First UTC day, YYYY-MM-DD, included.",
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "First UTC day, YYYY-MM-DD, included.",
              "title": "From"
            }
          },
          {
            "description": "Last UTC day, YYYY-MM-DD, included.",
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Last UTC day, YYYY-MM-DD, included.",
              "title": "To"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "error.code is workspace_required while the organization's Agent workspace plan is not active and ended more than 30 days ago, or never started. error.details.ended_at is when it ended and error.details.closed_at when the export closed. scope_missing names a scope the credential lacks: fax:read, or inbox:read, which this export needs as well."
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "The fax history as CSV: every fax sent and received in the range",
        "tags": [
          "organizations"
        ],
        "x-required-scope": "fax:read"
      }
    },
    "/v1/sandbox/data": {
      "delete": {
        "operationId": "reset_sandbox_data",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SandboxReset"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Reset this organization's test data",
        "tags": [
          "sandbox"
        ],
        "x-required-scope": "sandbox:write"
      }
    },
    "/v1/sandbox/inbound-faxes": {
      "post": {
        "description": "A synthetic PDF goes through ``inbox.service.receive_now``: the private document, the inbox item,\nthe ``fax.received`` event with its download reference, exactly as a carrier delivery (M8).",
        "operationId": "create_sandbox_inbound_fax",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SandboxInboundCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/faxforagents__api__schemas__InboxItem"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Create a synthetic inbound fax (the same pipeline as a real one)",
        "tags": [
          "sandbox"
        ],
        "x-required-scope": "sandbox:write"
      }
    },
    "/v1/sandbox/scenarios": {
      "get": {
        "operationId": "list_sandbox_scenarios",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SandboxScenarios"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "The scenario catalog and active fixtures",
        "tags": [
          "sandbox"
        ],
        "x-required-scope": "sandbox:write"
      },
      "post": {
        "description": "The choice lasts 24 hours. A destination has one fixture: a second call for the same destination replaces the first, and a call with no destination replaces the organization-wide one.",
        "operationId": "create_sandbox_scenario",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SandboxScenarioCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SandboxFixture"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Select the outcome of the next sends",
        "tags": [
          "sandbox"
        ],
        "x-required-scope": "sandbox:write"
      }
    },
    "/v1/sender-verifications": {
      "post": {
        "operationId": "create_sender_verification",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SenderVerificationCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SenderVerification"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Verify a number of yours as a sender (only numbers you own)",
        "tags": [
          "numbers"
        ],
        "x-required-scope": "number:buy"
      }
    },
    "/v1/service-status": {
      "get": {
        "operationId": "get_service_status",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceStatus"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Customer-safe availability",
        "tags": [
          "platform"
        ]
      }
    },
    "/v1/statement": {
      "get": {
        "description": "One line per event on the wallet, signed the way the balance moved. type filters the lines by the type they carry. kind is the same filter by its older name, and both at once answer 422 unless they agree. A hold and its release name what they were for in ref_type: fax_job, extraction or number_order. GET /v1/ledger keeps the reference as it was booked, fax_job for every hold.",
        "operationId": "get_statement",
        "parameters": [
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 64,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          },
          {
            "description": "Only the lines whose type is this one: topup, fax, received_fax, number, extraction, release, refund, dispute, credit, adjustment, other.",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(topup|fax|received_fax|number|extraction|release|refund|dispute|credit|adjustment|other)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Only the lines whose type is this one: topup, fax, received_fax, number, extraction, release, refund, dispute, credit, adjustment, other.",
              "title": "Type"
            }
          },
          {
            "description": "The same filter as type, by the name it had before 2026-11-15. Sent with type, it has to name the same type.",
            "in": "query",
            "name": "kind",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(topup|fax|received_fax|number|extraction|release|refund|dispute|credit|adjustment|other)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "The same filter as type, by the name it had before 2026-11-15. Sent with type, it has to name the same type.",
              "title": "Kind"
            }
          },
          {
            "description": "First UTC day, YYYY-MM-DD, included.",
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "First UTC day, YYYY-MM-DD, included.",
              "title": "From"
            }
          },
          {
            "description": "Last UTC day, YYYY-MM-DD, included.",
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Last UTC day, YYYY-MM-DD, included.",
              "title": "To"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StatementPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "The wallet statement: one line per event with the balance after it, newest first",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/statement.csv": {
      "get": {
        "description": "One line per event on the wallet, signed the way the balance moved. type filters the lines by the type they carry. kind is the same filter by its older name, and both at once answer 422 unless they agree. A hold and its release name what they were for in ref_type: fax_job, extraction or number_order. GET /v1/ledger keeps the reference as it was booked, fax_job for every hold. The file's columns for them are reference_type and reference_id.",
        "operationId": "get_statement_csv",
        "parameters": [
          {
            "description": "Only the lines whose type is this one: topup, fax, received_fax, number, extraction, release, refund, dispute, credit, adjustment, other.",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(topup|fax|received_fax|number|extraction|release|refund|dispute|credit|adjustment|other)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Only the lines whose type is this one: topup, fax, received_fax, number, extraction, release, refund, dispute, credit, adjustment, other.",
              "title": "Type"
            }
          },
          {
            "description": "The same filter as type, by the name it had before 2026-11-15. Sent with type, it has to name the same type.",
            "in": "query",
            "name": "kind",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(topup|fax|received_fax|number|extraction|release|refund|dispute|credit|adjustment|other)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "The same filter as type, by the name it had before 2026-11-15. Sent with type, it has to name the same type.",
              "title": "Kind"
            }
          },
          {
            "description": "First UTC day, YYYY-MM-DD, included.",
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "First UTC day, YYYY-MM-DD, included.",
              "title": "From"
            }
          },
          {
            "description": "Last UTC day, YYYY-MM-DD, included.",
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Last UTC day, YYYY-MM-DD, included.",
              "title": "To"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "The wallet statement as CSV: every line the filters select",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/subscriptions": {
      "get": {
        "operationId": "list_subscriptions",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Subscriptions and the workspace entitlement",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/subscriptions/checkout": {
      "post": {
        "description": "Answers the address of Stripe's payment page for the plan. It is refused with 409 while the plan is active or a Checkout of it is still open, so the plan is never paid twice.",
        "operationId": "create_subscription_checkout",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionCheckout"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentRequired"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "The credential is valid and is not allowed to do this. scope_missing puts the scope in error.details.scope. Other codes are agent_forbidden and approval_required. A session can also meet csrf_invalid and reauth_required. A test key, or a session switched to Test, gets environment_not_billable here: the test wallet is never funded, so billing takes live."
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "The plan cannot be bought twice. error.code is conflict and error.details.reason says why. \"plan_active\": the Agent workspace is active, here or at Stripe after a payment of a moment ago. \"checkout_open\": a Checkout of the plan is still open, and error.details.url is its page, error.details.expires_at when it closes. idempotency_key_conflict: the Idempotency-Key was used with a different request, or that request is still being processed."
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Open a hosted Checkout for the Agent workspace subscription",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:write"
      }
    },
    "/v1/topup-sessions": {
      "get": {
        "operationId": "list_topup_sessions",
        "parameters": [
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TopupSessionPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Top-up sessions, newest first",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      },
      "post": {
        "operationId": "create_topup_session",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TopupCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TopupSession"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentRequired"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "The credential is valid and is not allowed to do this. scope_missing puts the scope in error.details.scope. Other codes are agent_forbidden and approval_required. A session can also meet csrf_invalid and reauth_required. A test key, or a session switched to Test, gets environment_not_billable here: the test wallet is never funded, so billing takes live."
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Open a hosted Checkout to fund the live wallet (10 to 1000 USD)",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:write"
      }
    },
    "/v1/topup-sessions/{topup_session_id}": {
      "get": {
        "operationId": "get_topup_session",
        "parameters": [
          {
            "in": "path",
            "name": "topup_session_id",
            "required": true,
            "schema": {
              "title": "Topup Session Id",
              "type": "string"
            }
          },
          {
            "description": "Ask Stripe about the Checkout of an open top-up and answer its state as checkout_status. The page Stripe returns the person to asks it, because the event that credits the wallet can arrive seconds after the payment.",
            "in": "query",
            "name": "check_checkout",
            "required": false,
            "schema": {
              "default": false,
              "description": "Ask Stripe about the Checkout of an open top-up and answer its state as checkout_status. The page Stripe returns the person to asks it, because the event that credits the wallet can arrive seconds after the payment.",
              "title": "Check Checkout",
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TopupSession"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Read a top-up session",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/topup-sessions/{topup_session_id}/cancel": {
      "post": {
        "description": "Closes the Checkout of a manual or setup top-up that is still open and answers the session with status canceled. Canceling a setup payment also turns off the auto top-up that waited on it. A top-up already canceled or expired is answered as it is. One that was paid, declined or charged off session answers 409.",
        "operationId": "cancel_topup_session",
        "parameters": [
          {
            "in": "path",
            "name": "topup_session_id",
            "required": true,
            "schema": {
              "title": "Topup Session Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TopupSession"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "The credential is valid and is not allowed to do this. scope_missing puts the scope in error.details.scope. Other codes are agent_forbidden and approval_required. A session can also meet csrf_invalid and reauth_required. A test key, or a session switched to Test, gets environment_not_billable here: the test wallet is never funded, so billing takes live."
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "The top-up has no open Checkout to cancel: it was paid, declined or charged off session. error.code is conflict and error.details.status is the top-up's status. error.details.reason is \"paid\" when the payment came in before the cancel. idempotency_key_conflict: the Idempotency-Key was used with a different request, or that request is still being processed."
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Cancel an open top-up, so its hosted Checkout can no longer be paid",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:write"
      }
    },
    "/v1/topup-sessions/{topup_session_id}/receipt": {
      "get": {
        "operationId": "get_topup_receipt",
        "parameters": [
          {
            "in": "path",
            "name": "topup_session_id",
            "required": true,
            "schema": {
              "title": "Topup Session Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentReceipt"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Stripe's receipt for a paid top-up (manual, setup or automatic)",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/uploads": {
      "post": {
        "operationId": "create_upload",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UploadCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UploadSession"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Create a bounded upload session",
        "tags": [
          "documents"
        ],
        "x-required-scope": "document:write"
      }
    },
    "/v1/uploads/{upload_id}": {
      "delete": {
        "operationId": "cancel_upload",
        "parameters": [
          {
            "in": "path",
            "name": "upload_id",
            "required": true,
            "schema": {
              "title": "Upload Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deleted"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Cancel an incomplete upload",
        "tags": [
          "documents"
        ],
        "x-required-scope": "document:write"
      }
    },
    "/v1/uploads/{upload_id}/complete": {
      "post": {
        "operationId": "complete_upload",
        "parameters": [
          {
            "in": "path",
            "name": "upload_id",
            "required": true,
            "schema": {
              "title": "Upload Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UploadComplete",
                "default": {}
              }
            }
          }
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UploadSession"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Finalize an upload (size and hash checked)",
        "tags": [
          "documents"
        ],
        "x-required-scope": "document:write"
      }
    },
    "/v1/uploads/{upload_id}/content": {
      "put": {
        "operationId": "put_upload_content",
        "parameters": [
          {
            "in": "path",
            "name": "upload_id",
            "required": true,
            "schema": {
              "title": "Upload Id",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "exp",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Exp"
            }
          },
          {
            "in": "query",
            "name": "sig",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Sig"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UploadSession"
                }
              }
            },
            "description": "Successful Response"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "signedUrl": []
          }
        ],
        "summary": "Send the bytes to a signed upload URL (no API key)",
        "tags": [
          "documents"
        ]
      }
    },
    "/v1/usage": {
      "get": {
        "operationId": "get_usage",
        "parameters": [
          {
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "From"
            }
          },
          {
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "To"
            }
          },
          {
            "description": "Comma-separated subset.",
            "in": "query",
            "name": "group_by",
            "required": false,
            "schema": {
              "default": "day,direction,route,project",
              "description": "Comma-separated subset.",
              "title": "Group By",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "project_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Project Id"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageReport"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Usage rollups by day, direction, destination and project",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/usage-exports": {
      "post": {
        "operationId": "create_usage_export",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UsageExportCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageExport"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Export usage as CSV behind a signed download",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/usage-exports/{export_id}": {
      "get": {
        "operationId": "get_usage_export",
        "parameters": [
          {
            "in": "path",
            "name": "export_id",
            "required": true,
            "schema": {
              "title": "Export Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageExport"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Read a usage export (fresh link)",
        "tags": [
          "billing"
        ],
        "x-required-scope": "billing:read"
      }
    },
    "/v1/usage-exports/{export_id}/content": {
      "get": {
        "operationId": "get_usage_export_content",
        "parameters": [
          {
            "in": "path",
            "name": "export_id",
            "required": true,
            "schema": {
              "title": "Export Id",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "exp",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Exp"
            }
          },
          {
            "in": "query",
            "name": "sig",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Sig"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          }
        },
        "security": [
          {
            "signedUrl": []
          }
        ],
        "summary": "The CSV behind a signed URL (no API key)",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/webhook-deliveries": {
      "get": {
        "operationId": "list_webhook_deliveries",
        "parameters": [
          {
            "in": "query",
            "name": "webhook_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Webhook Id"
            }
          },
          {
            "in": "query",
            "name": "event_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Event Id"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 200,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeliveryPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Delivery attempts (no payload secrets)",
        "tags": [
          "webhooks"
        ],
        "x-required-scope": "webhook:admin"
      }
    },
    "/v1/webhook-deliveries/{delivery_id}": {
      "get": {
        "operationId": "get_webhook_delivery",
        "parameters": [
          {
            "in": "path",
            "name": "delivery_id",
            "required": true,
            "schema": {
              "title": "Delivery Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeliveryDetail"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "One delivery with the body that was sent (no secrets)",
        "tags": [
          "webhooks"
        ],
        "x-required-scope": "webhook:admin"
      }
    },
    "/v1/webhook-deliveries/{delivery_id}/replay": {
      "post": {
        "operationId": "replay_webhook_delivery",
        "parameters": [
          {
            "in": "path",
            "name": "delivery_id",
            "required": true,
            "schema": {
              "title": "Delivery Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Delivery"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "The webhook of this delivery was deleted, so nothing can be sent to it again. error.code is conflict and error.details.reason is \"webhook_deleted\". Replay a delivery of a webhook that still exists. idempotency_key_conflict: the Idempotency-Key was used with a different request, or that request is still being processed."
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Replay the event with the same event id",
        "tags": [
          "webhooks"
        ],
        "x-required-scope": "webhook:admin"
      }
    },
    "/v1/webhooks": {
      "get": {
        "operationId": "list_webhooks",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookList"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "List webhooks",
        "tags": [
          "webhooks"
        ],
        "x-required-scope": "webhook:admin"
      },
      "post": {
        "operationId": "create_webhook",
        "parameters": [
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookWithSecret"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Register a destination (secret shown once)",
        "tags": [
          "webhooks"
        ],
        "x-required-scope": "webhook:admin"
      }
    },
    "/v1/webhooks/{webhook_id}": {
      "delete": {
        "operationId": "delete_webhook",
        "parameters": [
          {
            "in": "path",
            "name": "webhook_id",
            "required": true,
            "schema": {
              "title": "Webhook Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deleted"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Remove a destination",
        "tags": [
          "webhooks"
        ],
        "x-required-scope": "webhook:admin"
      },
      "patch": {
        "operationId": "update_webhook",
        "parameters": [
          {
            "in": "path",
            "name": "webhook_id",
            "required": true,
            "schema": {
              "title": "Webhook Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Webhook"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Change url, filters or pause",
        "tags": [
          "webhooks"
        ],
        "x-required-scope": "webhook:admin"
      }
    },
    "/v1/webhooks/{webhook_id}/rotate-secret": {
      "post": {
        "operationId": "rotate_webhook_secret",
        "parameters": [
          {
            "in": "path",
            "name": "webhook_id",
            "required": true,
            "schema": {
              "title": "Webhook Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookWithSecret"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "New secret; the old one signs too for 24 hours",
        "tags": [
          "webhooks"
        ],
        "x-required-scope": "webhook:admin"
      }
    },
    "/v1/webhooks/{webhook_id}/test": {
      "post": {
        "operationId": "test_webhook",
        "parameters": [
          {
            "in": "path",
            "name": "webhook_id",
            "required": true,
            "schema": {
              "title": "Webhook Id",
              "type": "string"
            }
          },
          {
            "description": "Replay the first successful response for the same request within 24 hours. Reusing the idempotency header with a different request returns 409 idempotency_key_conflict. Responses include Idempotent-Replayed: true on replay.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "maxLength": 255,
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Event"
                }
              }
            },
            "description": "Successful Response"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "410": {
            "$ref": "#/components/responses/Gone"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableContent"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "sessionCookie": []
          }
        ],
        "summary": "Send a signed webhook.test event to this destination",
        "tags": [
          "webhooks"
        ],
        "x-required-scope": "webhook:admin"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.faxforagents.com",
      "description": "Production"
    }
  ]
}
