{
  "components": {
    "schemas": {
      "Accepted": {
        "additionalProperties": true,
        "properties": {
          "organization": {
            "$ref": "#/components/schemas/OrganizationSummary"
          }
        },
        "required": [
          "organization"
        ],
        "title": "Accepted",
        "type": "object"
      },
      "Agent": {
        "additionalProperties": true,
        "properties": {
          "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"
          },
          "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"
      },
      "AgentCreate": {
        "additionalProperties": false,
        "properties": {
          "contact_email": {
            "anyOf": [
              {
                "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": [
              {
                "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"
      },
      "ApiKey": {
        "additionalProperties": true,
        "properties": {
          "agent_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Agent Id"
          },
          "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": {
          "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"
          },
          "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"
      },
      "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"
          },
          "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"
          },
          "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"
      },
      "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 the available balance drops below this.",
            "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,
        "properties": {
          "available_micro": {
            "title": "Available Micro",
            "type": "integer"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "held_micro": {
            "title": "Held Micro",
            "type": "integer"
          }
        },
        "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": [
              {
                "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"
          },
          "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"
      },
      "Capabilities": {
        "additionalProperties": true,
        "properties": {
          "approvals": {
            "title": "Approvals",
            "type": "boolean"
          },
          "environment": {
            "enum": [
              "live",
              "test"
            ],
            "title": "Environment",
            "type": "string"
          },
          "formats": {
            "items": {
              "type": "string"
            },
            "title": "Formats",
            "type": "array"
          },
          "limits": {
            "additionalProperties": {
              "type": "integer"
            },
            "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"
          },
          "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": {
            "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",
          "limits"
        ],
        "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"
      },
      "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,
        "properties": {
          "attempt": {
            "title": "Attempt",
            "type": "integer"
          },
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "delivered_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Delivered At"
          },
          "duration_ms": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Duration Ms"
          },
          "error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error"
          },
          "event_id": {
            "title": "Event Id",
            "type": "string"
          },
          "event_type": {
            "title": "Event Type",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "next_attempt_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Attempt At"
          },
          "replay_of": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Replay Of"
          },
          "response_status": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Response Status"
          },
          "schedule_s": {
            "items": {
              "type": "integer"
            },
            "title": "Schedule S",
            "type": "array"
          },
          "status": {
            "title": "Status",
            "type": "string"
          },
          "webhook_id": {
            "title": "Webhook Id",
            "type": "string"
          }
        },
        "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"
        ],
        "title": "Delivery",
        "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,
        "properties": {
          "content_type": {
            "title": "Content Type",
            "type": "string"
          },
          "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"
          },
          "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,
        "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.",
            "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"
          }
        },
        "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"
      },
      "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"
          },
          "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"
      },
      "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"
          },
          "provider_cost_micro": {
            "title": "Provider Cost 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",
          "provider_cost_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.",
        "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,
        "properties": {
          "amount_micro": {
            "title": "Amount Micro",
            "type": "integer"
          },
          "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"
          },
          "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"
          },
          "pages_sent": {
            "title": "Pages Sent",
            "type": "integer"
          },
          "provider": {
            "title": "Provider",
            "type": "string"
          },
          "provider_ref": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Provider Ref"
          },
          "quote_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Quote Id"
          },
          "route": {
            "title": "Route",
            "type": "string"
          },
          "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"
      },
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
          }
        },
        "title": "HTTPValidationError",
        "type": "object"
      },
      "InboxItemDetail": {
        "additionalProperties": true,
        "properties": {
          "amount_micro": {
            "default": 0,
            "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"
          },
          "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,
        "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"
          }
        },
        "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"
              }
            ],
            "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"
          },
          "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"
      },
      "InvitationList": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Invitation"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "InvitationList",
        "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"
      },
      "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"
      },
      "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"
          }
        },
        "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"
      },
      "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"
          },
          "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"
          },
          "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"
          },
          "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.",
            "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"
      },
      "NumberUpdate": {
        "additionalProperties": false,
        "properties": {
          "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"
      },
      "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": 200,
            "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"
          }
        },
        "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"
      },
      "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"
      },
      "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"
          },
          "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": "See the PolicyRules schema in docs/APPROVALS.md.",
            "title": "Rules",
            "type": "object"
          }
        },
        "required": [
          "name",
          "rules"
        ],
        "title": "PolicyCreate",
        "type": "object"
      },
      "PolicyEvaluation": {
        "additionalProperties": true,
        "properties": {
          "decision": {
            "title": "Decision",
            "type": "string"
          },
          "denials": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Denials",
            "type": "array"
          },
          "executed": {
            "default": false,
            "title": "Executed",
            "type": "boolean"
          },
          "plan": {
            "additionalProperties": true,
            "title": "Plan",
            "type": "object"
          },
          "policy_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Policy Id"
          },
          "policy_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Policy Name"
          },
          "policy_version_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Policy Version Id"
          },
          "reason": {
            "title": "Reason",
            "type": "string"
          },
          "rule": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rule"
          },
          "version": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Version"
          }
        },
        "required": [
          "decision",
          "rule",
          "reason",
          "policy_id",
          "policy_version_id",
          "policy_name",
          "version",
          "denials",
          "plan"
        ],
        "title": "PolicyEvaluation",
        "type": "object"
      },
      "PolicyEvaluationCreate": {
        "additionalProperties": false,
        "properties": {
          "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"
          },
          "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"
      },
      "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"
      },
      "PolicyVersion": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "title": "Created At",
            "type": "string"
          },
          "created_by": {
            "title": "Created By",
            "type": "string"
          },
          "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,
        "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"
          },
          "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"
          },
          "per_page_micro": {
            "default": 0,
            "title": "Per Page Micro",
            "type": "integer"
          },
          "price_version": {
            "title": "Price Version",
            "type": "string"
          },
          "route": {
            "title": "Route",
            "type": "string"
          },
          "route_label": {
            "default": "",
            "title": "Route Label",
            "type": "string"
          },
          "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,
        "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"
          },
          "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"
          },
          "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": {
          "credential": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Credential"
          },
          "method": {
            "enum": [
              "passkey",
              "magic_link"
            ],
            "title": "Method",
            "type": "string"
          }
        },
        "required": [
          "method"
        ],
        "title": "Reauth",
        "type": "object"
      },
      "Receipt": {
        "additionalProperties": true,
        "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"
          },
          "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"
          },
          "pages_sent": {
            "title": "Pages Sent",
            "type": "integer"
          },
          "provider": {
            "title": "Provider",
            "type": "string"
          },
          "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": {
          "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"
      },
      "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,
        "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"
      },
      "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"
          },
          "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"
      },
      "Subscription": {
        "additionalProperties": true,
        "properties": {
          "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"
          },
          "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",
          "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"
          },
          "workspace": {
            "title": "Workspace",
            "type": "boolean"
          }
        },
        "required": [
          "items",
          "workspace"
        ],
        "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"
          },
          "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,
        "properties": {
          "content_type": {
            "default": "application/pdf",
            "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.",
            "maxLength": 100,
            "title": "Content Type",
            "type": "string"
          },
          "filename": {
            "maxLength": 255,
            "minLength": 1,
            "title": "Filename",
            "type": "string"
          },
          "size_bytes": {
            "minimum": 1,
            "title": "Size Bytes",
            "type": "integer"
          }
        },
        "required": [
          "filename",
          "size_bytes"
        ],
        "title": "UploadCreate",
        "type": "object"
      },
      "UploadSession": {
        "additionalProperties": true,
        "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"
      },
      "ValidationError": {
        "properties": {
          "ctx": {
            "title": "Context",
            "type": "object"
          },
          "input": {
            "title": "Input"
          },
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "title": "Location",
            "type": "array"
          },
          "msg": {
            "title": "Message",
            "type": "string"
          },
          "type": {
            "title": "Error Type",
            "type": "string"
          }
        },
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError",
        "type": "object"
      },
      "Webhook": {
        "additionalProperties": true,
        "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"
          },
          "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,
        "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,
        "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"
          },
          "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"
      },
      "faxforagents__api__routes__inbox__InboxItem": {
        "additionalProperties": true,
        "properties": {
          "amount_micro": {
            "default": 0,
            "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"
          },
          "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,
            "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"
          },
          "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"
          },
          "session": {
            "$ref": "#/components/schemas/SessionInfo"
          },
          "user": {
            "$ref": "#/components/schemas/UserOut"
          }
        },
        "required": [
          "user",
          "organization",
          "organizations",
          "session",
          "csrf_token",
          "passkeys",
          "providers"
        ],
        "title": "Me",
        "type": "object"
      }
    }
  },
  "info": {
    "contact": {
      "email": "hello@faxforagents.com",
      "name": "Fax for Agents",
      "url": "https://faxforagents.com/contact/"
    },
    "description": "The fax API built for AI agents. Keys: Authorization: Bearer ffa_live_... or X-API-Key.",
    "termsOfService": "https://faxforagents.com/terms/",
    "title": "Fax for Agents API",
    "version": "1.3.3",
    "x-snapshot": {
      "taken_at": "2026-10-30",
      "source": "faxforagents package, create_app().openapi() (scripts/openapi-snapshot.sh)",
      "stripped": [
        "tag admin",
        "paths /webhooks/*"
      ]
    }
  },
  "openapi": "3.1.0",
  "paths": {
    "/v1/agents": {
      "get": {
        "operationId": "list_agents",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentList"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "List agent identities",
        "tags": [
          "agents"
        ]
      },
      "post": {
        "operationId": "create_agent",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AgentCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Agent"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Register an agent identity",
        "tags": [
          "agents"
        ]
      }
    },
    "/v1/agents/{agent_id}": {
      "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Read an agent with its keys and budgets",
        "tags": [
          "agents"
        ]
      },
      "patch": {
        "operationId": "update_agent",
        "parameters": [
          {
            "in": "path",
            "name": "agent_id",
            "required": true,
            "schema": {
              "title": "Agent Id",
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Change an agent; disabling revokes its keys",
        "tags": [
          "agents"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "The agent's audit trail",
        "tags": [
          "agents"
        ]
      }
    },
    "/v1/agents/{agent_id}/keys": {
      "post": {
        "operationId": "create_agent_key",
        "parameters": [
          {
            "in": "path",
            "name": "agent_id",
            "required": true,
            "schema": {
              "title": "Agent Id",
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Mint a key for the agent (bounded scopes, secret shown once)",
        "tags": [
          "agents"
        ]
      }
    },
    "/v1/api-keys": {
      "get": {
        "operationId": "list_api_keys",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKeyList"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "List API keys (metadata only)",
        "tags": [
          "identity"
        ]
      },
      "post": {
        "operationId": "create_api_key",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiKeyCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKeyWithSecret"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Create an API key (the secret is shown once)",
        "tags": [
          "identity"
        ]
      }
    },
    "/v1/api-keys/{key_id}": {
      "delete": {
        "operationId": "revoke_api_key",
        "parameters": [
          {
            "in": "path",
            "name": "key_id",
            "required": true,
            "schema": {
              "title": "Key Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deleted"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Revoke a key",
        "tags": [
          "identity"
        ]
      }
    },
    "/v1/api-keys/{key_id}/rotate": {
      "post": {
        "operationId": "rotate_api_key",
        "parameters": [
          {
            "in": "path",
            "name": "key_id",
            "required": true,
            "schema": {
              "title": "Key Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKeyWithSecret"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Rotate a key: a new secret, the old one works for 24 more hours",
        "tags": [
          "identity"
        ]
      }
    },
    "/v1/approval-requests": {
      "get": {
        "operationId": "list_approval_requests",
        "parameters": [
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Approval requests, pending first",
        "tags": [
          "approvals"
        ]
      },
      "post": {
        "operationId": "create_approval_request",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApprovalRequestCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalRequest"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Ask a human to approve a quoted send, or ask for help (grants nothing)",
        "tags": [
          "approvals"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Read one request",
        "tags": [
          "approvals"
        ]
      }
    },
    "/v1/approval-requests/{approval_id}/approve": {
      "post": {
        "operationId": "approve_request",
        "parameters": [
          {
            "in": "path",
            "name": "approval_id",
            "required": true,
            "schema": {
              "title": "Approval Id",
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Approve the bound quote (a human with approval:decide, never the requester)",
        "tags": [
          "approvals"
        ]
      }
    },
    "/v1/approval-requests/{approval_id}/reject": {
      "post": {
        "operationId": "reject_request",
        "parameters": [
          {
            "in": "path",
            "name": "approval_id",
            "required": true,
            "schema": {
              "title": "Approval Id",
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Reject with a reason",
        "tags": [
          "approvals"
        ]
      }
    },
    "/v1/approvals/{approval_id}/revoke": {
      "post": {
        "operationId": "revoke_approval",
        "parameters": [
          {
            "in": "path",
            "name": "approval_id",
            "required": true,
            "schema": {
              "title": "Approval Id",
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Revoke an approval nobody has used yet",
        "tags": [
          "approvals"
        ]
      }
    },
    "/v1/auth/invitations/{token}/accept": {
      "post": {
        "operationId": "accept_invitation",
        "parameters": [
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "title": "Token",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Accepted"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Join the organization an invitation link names (the signed-in email must match)",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/logout": {
      "post": {
        "operationId": "logout",
        "responses": {
          "204": {
            "description": "Successful Response"
          }
        },
        "summary": "End this session",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/magic-links": {
      "post": {
        "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "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."
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "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"
          }
        },
        "summary": "The signed-in person, their organizations and the CSRF token",
        "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "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"
            }
          }
        ],
        "responses": {
          "303": {
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "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"
          }
        },
        "summary": "Your passkeys",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/passkeys/login/options": {
      "post": {
        "operationId": "passkey_login_options",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "title": "Response Passkey Login Options",
                  "type": "object"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Options for navigator.credentials.get() (discoverable, no email needed)",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/passkeys/login/verify": {
      "post": {
        "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Sign in with a passkey assertion",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/passkeys/register/options": {
      "post": {
        "operationId": "passkey_register_options",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "title": "Response Passkey Register Options",
                  "type": "object"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Options for navigator.credentials.create() (fresh session required)",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/passkeys/register/verify": {
      "post": {
        "operationId": "passkey_register_verify",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PasskeyRegisterVerify"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Passkey"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "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"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Remove one of your passkeys",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/providers": {
      "get": {
        "operationId": "get_auth_providers",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Providers"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Which sign-in methods are available",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/reauth": {
      "post": {
        "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": {
            "description": "A sign-in link was sent; opening it in this browser refreshes the session."
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Prove it is you again (passkey now, or a fresh link by mail) before a sensitive action",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/sessions": {
      "delete": {
        "operationId": "revoke_other_sessions",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Revoked"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Sign out everywhere else",
        "tags": [
          "auth"
        ]
      },
      "get": {
        "operationId": "list_sessions",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SessionList"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Your live sessions",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/sessions/{session_id}": {
      "delete": {
        "operationId": "revoke_session",
        "parameters": [
          {
            "in": "path",
            "name": "session_id",
            "required": true,
            "schema": {
              "title": "Session Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Revoke one of your sessions",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/auth/switch-organization": {
      "post": {
        "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "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"
          }
        },
        "summary": "Auto top-up settings",
        "tags": [
          "billing"
        ]
      },
      "post": {
        "operationId": "create_auto_topup",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AutoTopupCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutoTopup"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Opt in to auto top-up (threshold, amount, daily cap); the card is saved at the first payment",
        "tags": [
          "billing"
        ]
      }
    },
    "/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"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deleted"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Turn auto top-up off",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/balance": {
      "get": {
        "operationId": "get_balance",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Balance"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Available and held balance",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/billing-portal-sessions": {
      "post": {
        "operationId": "create_portal_session",
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortalSession"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Open the Stripe customer portal (cards, invoices, the subscription)",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/billing-settings": {
      "get": {
        "operationId": "get_billing_settings",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingSettings"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Billing settings of the organization",
        "tags": [
          "billing"
        ]
      },
      "patch": {
        "operationId": "patch_billing_settings",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BillingSettingsPatch"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingSettings"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Change the billing email or the low-balance threshold",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/budgets": {
      "get": {
        "operationId": "list_budgets",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BudgetList"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Spending caps of this environment",
        "tags": [
          "billing"
        ]
      },
      "post": {
        "operationId": "create_budget",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BudgetCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Budget"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Create a daily or monthly cap for the organization, a project or an agent",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/budgets/{budget_id}": {
      "patch": {
        "operationId": "patch_budget",
        "parameters": [
          {
            "in": "path",
            "name": "budget_id",
            "required": true,
            "schema": {
              "title": "Budget Id",
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Change a cap's limit or status",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/capabilities": {
      "get": {
        "operationId": "get_capabilities",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Capabilities"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Classifications, newest first",
        "tags": [
          "extractions"
        ]
      },
      "post": {
        "operationId": "create_classification",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ClassificationCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Extraction"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Classify a received fax or a document into one of your document types, or abstain",
        "tags": [
          "extractions"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "One classification",
        "tags": [
          "extractions"
        ]
      }
    },
    "/v1/coverage": {
      "get": {
        "operationId": "get_coverage",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Coverage"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Where we send and where we host numbers",
        "tags": [
          "numbers"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Summaries, newest first",
        "tags": [
          "extractions"
        ]
      },
      "post": {
        "operationId": "create_document_summary",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SummaryCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Extraction"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Summarise a received fax or a document; every sentence cites its pages",
        "tags": [
          "extractions"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "One summary",
        "tags": [
          "extractions"
        ]
      }
    },
    "/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"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DocumentPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "List documents, newest first",
        "tags": [
          "documents"
        ]
      },
      "post": {
        "operationId": "create_document",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DocumentCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Document"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Create an immutable document from an upload or from text",
        "tags": [
          "documents"
        ]
      }
    },
    "/v1/documents/{document_id}": {
      "delete": {
        "operationId": "delete_document",
        "parameters": [
          {
            "in": "path",
            "name": "document_id",
            "required": true,
            "schema": {
              "title": "Document Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deleted"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Delete a document (its bytes and previews)",
        "tags": [
          "documents"
        ]
      },
      "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Read a document's hash, pages and validation state",
        "tags": [
          "documents"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "A short-lived signed download URL",
        "tags": [
          "documents"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Rendered pages with signed preview URLs",
        "tags": [
          "documents"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Validation warnings",
        "tags": [
          "documents"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Events for reconciliation, oldest first from the cursor",
        "tags": [
          "events"
        ]
      }
    },
    "/v1/extraction-schemas": {
      "get": {
        "operationId": "list_extraction_schemas",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtractionSchemaList"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Your extraction schemas",
        "tags": [
          "extractions"
        ]
      },
      "post": {
        "operationId": "create_extraction_schema",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SchemaCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtractionSchema"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Save a versioned extraction schema (the same name again is the next version)",
        "tags": [
          "extractions"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "One schema version",
        "tags": [
          "extractions"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Extractions, newest first",
        "tags": [
          "extractions"
        ]
      },
      "post": {
        "operationId": "create_extraction",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExtractionCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Extraction"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Read a received fax or a document: OCR per page, then fields against a schema",
        "tags": [
          "extractions"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "One extraction with its corrections",
        "tags": [
          "extractions"
        ]
      }
    },
    "/v1/extractions/{extraction_id}/corrections": {
      "post": {
        "operationId": "create_correction",
        "parameters": [
          {
            "in": "path",
            "name": "extraction_id",
            "required": true,
            "schema": {
              "title": "Extraction Id",
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Record a reviewer's correction of one field (stored beside the extraction, never merged)",
        "tags": [
          "extractions"
        ]
      }
    },
    "/v1/fax-quotes": {
      "post": {
        "operationId": "create_fax_quote",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QuoteCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Quote"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Price an exact document to one destination",
        "tags": [
          "quotes"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Read a quote",
        "tags": [
          "quotes"
        ]
      }
    },
    "/v1/faxes": {
      "get": {
        "operationId": "list_faxes",
        "parameters": [
          {
            "in": "query",
            "name": "state",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "State"
            }
          },
          {
            "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "List fax jobs, newest first",
        "tags": [
          "faxes"
        ]
      },
      "post": {
        "operationId": "create_fax",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FaxCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FaxJob"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Send a quoted fax (Idempotency-Key recommended)",
        "tags": [
          "faxes"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Read a fax job (with evidence once delivered)",
        "tags": [
          "faxes"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Attempt history",
        "tags": [
          "faxes"
        ]
      }
    },
    "/v1/faxes/{fax_id}/cancel": {
      "post": {
        "operationId": "cancel_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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Cancel if still possible (best effort once sending)",
        "tags": [
          "faxes"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Ordered events of one fax",
        "tags": [
          "faxes"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Delivery evidence as a receipt (JSON)",
        "tags": [
          "faxes"
        ]
      }
    },
    "/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"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InboxPage"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Received faxes, newest first (metadata only)",
        "tags": [
          "inbox"
        ]
      }
    },
    "/v1/inbox/{inbox_id}": {
      "delete": {
        "operationId": "delete_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/Deleted"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Delete a received fax",
        "tags": [
          "inbox"
        ]
      },
      "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "One received fax with its text as data",
        "tags": [
          "inbox"
        ]
      },
      "patch": {
        "operationId": "update_inbox_item",
        "parameters": [
          {
            "in": "path",
            "name": "inbox_id",
            "required": true,
            "schema": {
              "title": "Inbox Id",
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Mark a received fax read or archived",
        "tags": [
          "inbox"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "A short-lived signed link to the received PDF",
        "tags": [
          "inbox"
        ]
      }
    },
    "/v1/invitations": {
      "get": {
        "operationId": "list_invitations",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvitationList"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Open invitations",
        "tags": [
          "members"
        ]
      },
      "post": {
        "operationId": "create_invitation",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InvitationCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Invitation"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Invite someone by email (a link that works for 7 days)",
        "tags": [
          "members"
        ]
      }
    },
    "/v1/invitations/{invitation_id}": {
      "delete": {
        "operationId": "revoke_invitation",
        "parameters": [
          {
            "in": "path",
            "name": "invitation_id",
            "required": true,
            "schema": {
              "title": "Invitation Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Withdraw an invitation",
        "tags": [
          "members"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Stripe invoices and receipts (hosted links)",
        "tags": [
          "billing"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "One Stripe invoice",
        "tags": [
          "billing"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Wallet transactions, newest first",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/me": {
      "get": {
        "operationId": "get_me",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/faxforagents__api__schemas__Me"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "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"
          }
        },
        "summary": "The organization's members",
        "tags": [
          "members"
        ]
      }
    },
    "/v1/members/{member_id}": {
      "delete": {
        "operationId": "remove_member",
        "parameters": [
          {
            "in": "path",
            "name": "member_id",
            "required": true,
            "schema": {
              "title": "Member Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Remove a member (owner)",
        "tags": [
          "members"
        ]
      },
      "patch": {
        "operationId": "update_member",
        "parameters": [
          {
            "in": "path",
            "name": "member_id",
            "required": true,
            "schema": {
              "title": "Member Id",
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Change a member's role",
        "tags": [
          "members"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Fax-capable numbers for sale",
        "tags": [
          "numbers"
        ]
      }
    },
    "/v1/number-orders": {
      "post": {
        "operationId": "create_number_order",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NumberOrderCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NumberOrder"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Buy a number (the first month is held now, charged on activation)",
        "tags": [
          "numbers"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Read a number order",
        "tags": [
          "numbers"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Your numbers",
        "tags": [
          "numbers"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "One number",
        "tags": [
          "numbers"
        ]
      },
      "patch": {
        "operationId": "update_number",
        "parameters": [
          {
            "in": "path",
            "name": "number_id",
            "required": true,
            "schema": {
              "title": "Number Id",
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Label and inbound route of a number",
        "tags": [
          "numbers"
        ]
      }
    },
    "/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"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReleaseRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Number"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Release a number (confirm with the number itself; 30-day quarantine follows)",
        "tags": [
          "numbers"
        ]
      }
    },
    "/v1/organizations": {
      "get": {
        "operationId": "list_organizations",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrganizationList"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "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"
          }
        },
        "summary": "The organization you are looking at",
        "tags": [
          "organizations"
        ]
      },
      "patch": {
        "operationId": "update_current_organization",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrganizationPatch"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Organization"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Rename the organization",
        "tags": [
          "organizations"
        ]
      }
    },
    "/v1/organizations/current/deletion-requests": {
      "post": {
        "operationId": "request_data_deletion",
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Requested"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Ask for the organization and its data to be deleted (owner)",
        "tags": [
          "organizations"
        ]
      }
    },
    "/v1/organizations/current/export-requests": {
      "post": {
        "operationId": "request_data_export",
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Requested"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Ask for an export of the organization's data (owner)",
        "tags": [
          "organizations"
        ]
      }
    },
    "/v1/policies": {
      "get": {
        "operationId": "list_policies",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyList"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "List the organization's policies",
        "tags": [
          "policies"
        ]
      },
      "post": {
        "operationId": "create_policy",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Policy"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Create a delegated policy (version 1)",
        "tags": [
          "policies"
        ]
      }
    },
    "/v1/policies/effective": {
      "get": {
        "operationId": "get_effective_policies",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EffectivePolicies"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "What the calling key may do on its own, and whether a human is needed otherwise",
        "tags": [
          "policies"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Read a policy (its current version)",
        "tags": [
          "policies"
        ]
      },
      "patch": {
        "operationId": "update_policy",
        "parameters": [
          {
            "in": "path",
            "name": "policy_id",
            "required": true,
            "schema": {
              "title": "Policy Id",
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Change a policy: a new immutable version",
        "tags": [
          "policies"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Every version, oldest first",
        "tags": [
          "policies"
        ]
      }
    },
    "/v1/policy-evaluations": {
      "post": {
        "operationId": "create_policy_evaluation",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyEvaluationCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyEvaluation"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Dry run: would the calling key's policies allow this send? Never executes",
        "tags": [
          "policies"
        ]
      }
    },
    "/v1/port-orders": {
      "get": {
        "operationId": "list_port_orders",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortOrderList"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Port orders and port-out requests",
        "tags": [
          "numbers"
        ]
      },
      "post": {
        "operationId": "create_port_order",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PortOrderCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortOrder"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Request a port-in (handled with you)",
        "tags": [
          "numbers"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "One port order",
        "tags": [
          "numbers"
        ]
      }
    },
    "/v1/port-out-requests": {
      "post": {
        "operationId": "create_port_out_request",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PortOutRequestCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortOrder"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Note a port-out of one of your numbers",
        "tags": [
          "numbers"
        ]
      }
    },
    "/v1/portability-checks": {
      "post": {
        "operationId": "create_portability_check",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PortabilityCheckCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortabilityCheck"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Can these numbers port in",
        "tags": [
          "numbers"
        ]
      }
    },
    "/v1/sandbox/data": {
      "delete": {
        "operationId": "reset_sandbox_data",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SandboxReset"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Reset this organization's test data",
        "tags": [
          "sandbox"
        ]
      }
    },
    "/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",
        "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Create a synthetic inbound fax (the same pipeline as a real one)",
        "tags": [
          "sandbox"
        ]
      }
    },
    "/v1/sandbox/scenarios": {
      "get": {
        "operationId": "list_sandbox_scenarios",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SandboxScenarios"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "The scenario catalog and active fixtures",
        "tags": [
          "sandbox"
        ]
      },
      "post": {
        "operationId": "create_sandbox_scenario",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SandboxScenarioCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SandboxFixture"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Select the outcome of the next sends",
        "tags": [
          "sandbox"
        ]
      }
    },
    "/v1/sender-verifications": {
      "post": {
        "operationId": "create_sender_verification",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SenderVerificationCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SenderVerification"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Verify a number of yours as a sender (only numbers you own)",
        "tags": [
          "numbers"
        ]
      }
    },
    "/v1/service-status": {
      "get": {
        "operationId": "get_service_status",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceStatus"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Customer-safe availability",
        "tags": [
          "platform"
        ]
      }
    },
    "/v1/subscriptions": {
      "get": {
        "operationId": "list_subscriptions",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionList"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Subscriptions and the workspace entitlement",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/subscriptions/checkout": {
      "post": {
        "operationId": "create_subscription_checkout",
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionCheckout"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "Open a hosted Checkout for the Agent workspace subscription",
        "tags": [
          "billing"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Top-up sessions, newest first",
        "tags": [
          "billing"
        ]
      },
      "post": {
        "operationId": "create_topup_session",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TopupCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TopupSession"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Open a hosted Checkout to fund the live wallet (10 to 1000 USD)",
        "tags": [
          "billing"
        ]
      }
    },
    "/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"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TopupSession"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Read a top-up session",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/uploads": {
      "post": {
        "operationId": "create_upload",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UploadCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UploadSession"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Create a bounded upload session",
        "tags": [
          "documents"
        ]
      }
    },
    "/v1/uploads/{upload_id}": {
      "delete": {
        "operationId": "cancel_upload",
        "parameters": [
          {
            "in": "path",
            "name": "upload_id",
            "required": true,
            "schema": {
              "title": "Upload Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deleted"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Cancel an incomplete upload",
        "tags": [
          "documents"
        ]
      }
    },
    "/v1/uploads/{upload_id}/complete": {
      "post": {
        "operationId": "complete_upload",
        "parameters": [
          {
            "in": "path",
            "name": "upload_id",
            "required": true,
            "schema": {
              "title": "Upload Id",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UploadComplete"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UploadSession"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Finalize an upload (size and hash checked)",
        "tags": [
          "documents"
        ]
      }
    },
    "/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"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UploadSession"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Usage rollups by day, direction, destination and project",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/usage-exports": {
      "post": {
        "operationId": "create_usage_export",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UsageExportCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageExport"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Export usage as CSV behind a signed download",
        "tags": [
          "billing"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Read a usage export (fresh link)",
        "tags": [
          "billing"
        ]
      }
    },
    "/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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Delivery attempts (no payload secrets)",
        "tags": [
          "webhooks"
        ]
      }
    },
    "/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"
            }
          }
        ],
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Delivery"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Replay the event with the same event id",
        "tags": [
          "webhooks"
        ]
      }
    },
    "/v1/webhooks": {
      "get": {
        "operationId": "list_webhooks",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookList"
                }
              }
            },
            "description": "Successful Response"
          }
        },
        "summary": "List webhooks",
        "tags": [
          "webhooks"
        ]
      },
      "post": {
        "operationId": "create_webhook",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookWithSecret"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Register a destination (secret shown once)",
        "tags": [
          "webhooks"
        ]
      }
    },
    "/v1/webhooks/{webhook_id}": {
      "delete": {
        "operationId": "delete_webhook",
        "parameters": [
          {
            "in": "path",
            "name": "webhook_id",
            "required": true,
            "schema": {
              "title": "Webhook Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deleted"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Remove a destination",
        "tags": [
          "webhooks"
        ]
      },
      "patch": {
        "operationId": "update_webhook",
        "parameters": [
          {
            "in": "path",
            "name": "webhook_id",
            "required": true,
            "schema": {
              "title": "Webhook Id",
              "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"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Change url, filters or pause",
        "tags": [
          "webhooks"
        ]
      }
    },
    "/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"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookWithSecret"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "New secret; the old one signs too for 24 hours",
        "tags": [
          "webhooks"
        ]
      }
    },
    "/v1/webhooks/{webhook_id}/test": {
      "post": {
        "operationId": "test_webhook",
        "parameters": [
          {
            "in": "path",
            "name": "webhook_id",
            "required": true,
            "schema": {
              "title": "Webhook Id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Event"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "summary": "Send a signed webhook.test event to this destination",
        "tags": [
          "webhooks"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.faxforagents.com",
      "description": "Production"
    }
  ]
}