{ "components": { "schemas": { "APIKeyMeta": { "properties": { "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "key_id": { "title": "Key Id", "type": "string" }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Revoked At" }, "scopes": { "default": [], "items": { "type": "string" }, "title": "Scopes", "type": "array" } }, "required": [ "key_id" ], "title": "APIKeyMeta", "type": "object" }, "AcceptIn": { "additionalProperties": false, "properties": { "marketing": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Marketing" }, "reply_number": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Reply Number" }, "same_organization": { "default": false, "title": "Same Organization", "type": "boolean" }, "together": { "default": false, "title": "Together", "type": "boolean" } }, "title": "AcceptIn", "type": "object" }, "AccountInput": { "additionalProperties": false, "properties": { "credentials": { "additionalProperties": { "maxLength": 1024, "type": "string" }, "default": {}, "propertyNames": { "maxLength": 64 }, "title": "Credentials", "type": "object" }, "expected_generation": { "title": "Expected Generation", "type": "integer" }, "key": { "maxLength": 32, "minLength": 1, "title": "Key", "type": "string" }, "label": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Label" }, "limits": { "anyOf": [ { "$ref": "#/components/schemas/Limits" }, { "type": "null" } ] }, "numbers": { "default": [], "items": { "maxLength": 40, "type": "string" }, "maxItems": 200, "title": "Numbers", "type": "array" }, "provider": { "maxLength": 64, "minLength": 1, "title": "Provider", "type": "string" }, "receives": { "default": false, "title": "Receives", "type": "boolean" }, "sends": { "default": true, "title": "Sends", "type": "boolean" }, "settings": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "default": {}, "propertyNames": { "maxLength": 64 }, "title": "Settings", "type": "object" }, "site": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Site" } }, "required": [ "key", "provider", "expected_generation" ], "title": "AccountInput", "type": "object" }, "AccountPatch": { "additionalProperties": false, "properties": { "credentials": { "anyOf": [ { "additionalProperties": { "maxLength": 1024, "type": "string" }, "propertyNames": { "maxLength": 64 }, "type": "object" }, { "type": "null" } ], "title": "Credentials" }, "default_receiving": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "title": "Default Receiving" }, "default_sending": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "title": "Default Sending" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "expected_generation": { "title": "Expected Generation", "type": "integer" }, "label": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Label" }, "limits": { "anyOf": [ { "$ref": "#/components/schemas/Limits" }, { "type": "null" } ] }, "numbers": { "anyOf": [ { "items": { "maxLength": 40, "type": "string" }, "maxItems": 200, "type": "array" }, { "type": "null" } ], "title": "Numbers" }, "receives": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Receives" }, "sends": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sends" }, "settings": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "propertyNames": { "maxLength": 64 }, "type": "object" }, { "type": "null" } ], "title": "Settings" }, "site": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Site" } }, "required": [ "expected_generation" ], "title": "AccountPatch", "type": "object" }, "ActionIn": { "additionalProperties": false, "properties": { "action": { "maxLength": 300, "title": "Action", "type": "string" }, "channel": { "enum": [ "fax", "email", "phone", "other" ], "title": "Channel", "type": "string" }, "evidence_note": { "anyOf": [ { "maxLength": 300, "type": "string" }, { "type": "null" } ], "title": "Evidence Note" }, "fax_job_id": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Fax Job Id" }, "occurred_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Occurred At" }, "operation_id": { "maxLength": 100, "title": "Operation Id", "type": "string" }, "outcome": { "default": "done", "enum": [ "done", "uncertain" ], "title": "Outcome", "type": "string" }, "reference": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Reference" }, "revision": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Revision" } }, "required": [ "operation_id", "action", "channel" ], "title": "ActionIn", "type": "object" }, "AddressChange": { "additionalProperties": false, "properties": { "action": { "enum": [ "confirm", "withdraw", "dismiss" ], "title": "Action", "type": "string" }, "note": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "title": "Note" } }, "required": [ "action" ], "title": "AddressChange", "type": "object" }, "AddressInput": { "additionalProperties": false, "properties": { "account_key": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Account Key" }, "address": { "maxLength": 500, "minLength": 3, "title": "Address", "type": "string" }, "confirm": { "default": false, "title": "Confirm", "type": "boolean" }, "kind": { "enum": [ "direct", "fhir" ], "title": "Kind", "type": "string" }, "note": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "title": "Note" }, "organization": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Organization" } }, "required": [ "kind", "address" ], "title": "AddressInput", "type": "object" }, "AdmissionPartnerIn": { "additionalProperties": false, "properties": { "refusal_reason": { "anyOf": [ { "maxLength": 300, "type": "string" }, { "type": "null" } ], "title": "Refusal Reason" }, "refused_classes": { "items": { "type": "string" }, "maxItems": 50, "title": "Refused Classes", "type": "array" }, "take_part": { "title": "Take Part", "type": "boolean" } }, "required": [ "take_part" ], "title": "AdmissionPartnerIn", "type": "object" }, "AdmissionSettingsIn": { "additionalProperties": false, "properties": { "deadline": { "default": "go", "pattern": "^(go|wait)$", "title": "Deadline", "type": "string" }, "lines": { "anyOf": [ { "maximum": 500.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Lines" }, "reserve": { "default": 1, "maximum": 500.0, "minimum": 0.0, "title": "Reserve", "type": "integer" }, "urgent": { "default": "go", "pattern": "^(go|wait)$", "title": "Urgent", "type": "string" }, "window_minutes": { "default": 10, "maximum": 240.0, "minimum": 1.0, "title": "Window Minutes", "type": "integer" } }, "title": "AdmissionSettingsIn", "type": "object" }, "AfterAnswerChange": { "additionalProperties": false, "properties": { "digits": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Digits" } }, "title": "AfterAnswerChange", "type": "object" }, "AnchorsIn": { "additionalProperties": false, "properties": { "pem": { "anyOf": [ { "maxLength": 524288, "type": "string" }, { "type": "null" } ], "title": "Pem" }, "url": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "title": "Url" } }, "title": "AnchorsIn", "type": "object" }, "ApplyBody": { "additionalProperties": false, "properties": { "expected_revision": { "maxLength": 64, "minLength": 64, "pattern": "^[a-f0-9]{64}$", "title": "Expected Revision", "type": "string" }, "items": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 500, "type": "array" }, { "type": "null" } ], "title": "Items" } }, "required": [ "expected_revision" ], "title": "ApplyBody", "type": "object" }, "AssignIn": { "additionalProperties": false, "properties": { "principal_id": { "maxLength": 40, "minLength": 1, "title": "Principal Id", "type": "string" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "principal_id", "version" ], "title": "AssignIn", "type": "object" }, "AssignmentCreate": { "additionalProperties": false, "properties": { "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "resource_id": { "maxLength": 100, "minLength": 1, "title": "Resource Id", "type": "string" }, "role": { "$ref": "#/components/schemas/EntityRef" }, "subject": { "$ref": "#/components/schemas/SubjectRef" } }, "required": [ "subject", "role", "resource_id", "expected_policy_version" ], "title": "AssignmentCreate", "type": "object" }, "AttachIn": { "additionalProperties": false, "properties": { "kind": { "pattern": "^(mailbox|rule)$", "title": "Kind", "type": "string" }, "on": { "title": "On", "type": "boolean" }, "target": { "maxLength": 100, "minLength": 1, "title": "Target", "type": "string" } }, "required": [ "kind", "target", "on" ], "title": "AttachIn", "type": "object" }, "AuthCurrentSessionResponse": { "additionalProperties": false, "properties": { "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "source_kind": { "enum": [ "password", "key", "bootstrap" ], "title": "Source Kind", "type": "string" } }, "required": [ "id", "source_kind", "expires_at" ], "title": "AuthCurrentSessionResponse", "type": "object" }, "AuthErrorResponse": { "additionalProperties": false, "properties": { "detail": { "description": "Fixed public error message.", "title": "Detail", "type": "string" } }, "required": [ "detail" ], "title": "AuthErrorResponse", "type": "object" }, "AuthGrantableResponse": { "additionalProperties": false, "properties": { "installation": { "description": "Permissions this actor may grant at the installation resource.", "items": { "type": "string" }, "title": "Installation", "type": "array" } }, "required": [ "installation" ], "title": "AuthGrantableResponse", "type": "object" }, "AuthLogoutResponse": { "additionalProperties": false, "properties": { "ok": { "const": true, "title": "Ok", "type": "boolean" } }, "required": [ "ok" ], "title": "AuthLogoutResponse", "type": "object" }, "AuthMeResponse": { "additionalProperties": false, "properties": { "can_enroll_owner": { "title": "Can Enroll Owner", "type": "boolean" }, "csrf_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Present only for an authenticated browser cookie session.", "title": "Csrf Token" }, "grantable": { "$ref": "#/components/schemas/AuthGrantableResponse" }, "is_owner": { "title": "Is Owner", "type": "boolean" }, "password_change_required": { "title": "Password Change Required", "type": "boolean" }, "permissions": { "items": { "type": "string" }, "title": "Permissions", "type": "array" }, "policy_version": { "title": "Policy Version", "type": "integer" }, "principal": { "$ref": "#/components/schemas/AuthPrincipalResponse" }, "session": { "anyOf": [ { "$ref": "#/components/schemas/AuthCurrentSessionResponse" }, { "type": "null" } ] }, "source": { "enum": [ "key", "session" ], "title": "Source", "type": "string" } }, "required": [ "principal", "source", "password_change_required", "policy_version", "permissions", "session", "can_enroll_owner", "is_owner", "grantable" ], "title": "AuthMeResponse", "type": "object" }, "AuthPrincipalResponse": { "additionalProperties": false, "properties": { "display_name": { "title": "Display Name", "type": "string" }, "id": { "title": "Id", "type": "string" }, "kind": { "enum": [ "user", "integration", "bootstrap" ], "title": "Kind", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "kind", "display_name", "version" ], "title": "AuthPrincipalResponse", "type": "object" }, "AuthSessionCursorResponse": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "created_at", "session_id" ], "title": "AuthSessionCursorResponse", "type": "object" }, "AuthSessionPageResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/AuthSessionSummaryResponse" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "$ref": "#/components/schemas/AuthSessionCursorResponse" }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "title": "AuthSessionPageResponse", "type": "object" }, "AuthSessionResponse": { "additionalProperties": false, "properties": { "ok": { "const": true, "title": "Ok", "type": "boolean" }, "password_change_required": { "title": "Password Change Required", "type": "boolean" } }, "required": [ "ok", "password_change_required" ], "title": "AuthSessionResponse", "type": "object" }, "AuthSessionRevokeResponse": { "additionalProperties": false, "properties": { "changed": { "title": "Changed", "type": "boolean" }, "policy_version": { "title": "Policy Version", "type": "integer" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "session_id", "changed", "policy_version" ], "title": "AuthSessionRevokeResponse", "type": "object" }, "AuthSessionSummaryResponse": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "current": { "title": "Current", "type": "boolean" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "last_used_at": { "format": "date-time", "title": "Last Used At", "type": "string" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Revoked At" }, "session_id": { "title": "Session Id", "type": "string" }, "source_kind": { "enum": [ "password", "key", "bootstrap" ], "title": "Source Kind", "type": "string" } }, "required": [ "session_id", "source_kind", "created_at", "last_used_at", "expires_at", "revoked_at", "current" ], "title": "AuthSessionSummaryResponse", "type": "object" }, "AuthSetupResponse": { "properties": { "first_owner": { "title": "First Owner", "type": "boolean" } }, "required": [ "first_owner" ], "title": "AuthSetupResponse", "type": "object" }, "BlockBody": { "additionalProperties": false, "properties": { "days": { "default": 90, "maximum": 365.0, "minimum": 1.0, "title": "Days", "type": "integer" }, "inbound_id": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Inbound Id" }, "number": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Number" }, "reason": { "maxLength": 200, "minLength": 1, "title": "Reason", "type": "string" } }, "required": [ "reason" ], "title": "BlockBody", "type": "object" }, "Body_add_case_originals_cases__case_id__originals_post": { "properties": { "dates": { "default": [], "items": { "type": "string" }, "title": "Dates", "type": "array" }, "documents": { "items": { "contentMediaType": "application/octet-stream", "type": "string" }, "title": "Documents", "type": "array" }, "sources": { "default": [], "items": { "type": "string" }, "title": "Sources", "type": "array" }, "titles": { "default": [], "items": { "type": "string" }, "title": "Titles", "type": "array" }, "types": { "default": [], "items": { "type": "string" }, "title": "Types", "type": "array" }, "versions": { "default": [], "items": { "type": "string" }, "title": "Versions", "type": "array" } }, "required": [ "documents" ], "title": "Body_add_case_originals_cases__case_id__originals_post", "type": "object" }, "Body_add_invoice_routing_invoices_post": { "properties": { "account": { "maxLength": 64, "title": "Account", "type": "string" }, "currency": { "default": "USD", "maxLength": 3, "title": "Currency", "type": "string" }, "file": { "anyOf": [ { "contentMediaType": "application/octet-stream", "type": "string" }, { "type": "null" } ], "title": "File" }, "first_day": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "First Day" }, "last_day": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "Last Day" }, "month": { "anyOf": [ { "maxLength": 7, "type": "string" }, { "type": "null" } ], "title": "Month" }, "note": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Note" }, "total": { "maxLength": 32, "title": "Total", "type": "string" } }, "required": [ "account", "total" ], "title": "Body_add_invoice_routing_invoices_post", "type": "object" }, "Body_create_import_expected_faxes_imports_post": { "properties": { "file": { "anyOf": [ { "contentMediaType": "application/octet-stream", "type": "string" }, { "type": "null" } ], "title": "File" }, "full_export": { "default": false, "title": "Full Export", "type": "boolean" }, "source": { "maxLength": 100, "minLength": 1, "title": "Source", "type": "string" } }, "required": [ "source" ], "title": "Body_create_import_expected_faxes_imports_post", "type": "object" }, "Body_create_import_imports_post": { "properties": { "file": { "anyOf": [ { "contentMediaType": "application/octet-stream", "type": "string" }, { "type": "null" } ], "title": "File" }, "manifest": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manifest" } }, "title": "Body_create_import_imports_post", "type": "object" }, "Body_hold_fax_routing_destinations__number__polling_hold_faxes_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" } }, "required": [ "file" ], "title": "Body_hold_fax_routing_destinations__number__polling_hold_faxes_post", "type": "object" }, "Body_import_caller_id_prices_routing_rate_cards__route__caller_id_prices_post": { "properties": { "billing_increment_seconds": { "anyOf": [ { "maximum": 3600.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Billing Increment Seconds" }, "currency": { "anyOf": [ { "maxLength": 3, "type": "string" }, { "type": "null" } ], "title": "Currency" }, "deck_format": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "title": "Deck Format" }, "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "minimum_seconds": { "anyOf": [ { "maximum": 3600.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Minimum Seconds" }, "published_on": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "Published On" }, "source_url": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Source Url" } }, "required": [ "file" ], "title": "Body_import_caller_id_prices_routing_rate_cards__route__caller_id_prices_post", "type": "object" }, "Body_import_carrier_list_routing_carrier_lists_files_post": { "properties": { "carrier": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Carrier" }, "date_order": { "default": "mdy", "maxLength": 3, "title": "Date Order", "type": "string" }, "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "file_date": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "File Date" }, "kind": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "title": "Kind" }, "source_url": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Source Url" } }, "required": [ "file" ], "title": "Body_import_carrier_list_routing_carrier_lists_files_post", "type": "object" }, "Body_import_channel_calls_routing_channels_files_post": { "properties": { "date_order": { "default": "mdy", "maxLength": 3, "title": "Date Order", "type": "string" }, "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "licensed": { "anyOf": [ { "maximum": 10000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Licensed" }, "numbers": { "anyOf": [ { "maxLength": 20000, "type": "string" }, { "type": "null" } ], "title": "Numbers" }, "source_format": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "title": "Source Format" }, "system": { "maxLength": 100, "minLength": 1, "title": "System", "type": "string" }, "time_zone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Time Zone" } }, "required": [ "file", "system" ], "title": "Body_import_channel_calls_routing_channels_files_post", "type": "object" }, "Body_import_closures_routing_closures_files_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "file_date": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "File Date" }, "source": { "default": "gouv", "maxLength": 16, "title": "Source", "type": "string" }, "source_url": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Source Url" } }, "required": [ "file" ], "title": "Body_import_closures_routing_closures_files_post", "type": "object" }, "Body_import_form_forms_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "name": { "maxLength": 200, "title": "Name", "type": "string" }, "positions": { "anyOf": [ { "contentMediaType": "application/octet-stream", "type": "string" }, { "type": "null" } ], "title": "Positions" } }, "required": [ "name", "file" ], "title": "Body_import_form_forms_post", "type": "object" }, "Body_import_jurisdiction_rates_routing_jurisdiction_rates_post": { "properties": { "carrier": { "maxLength": 64, "title": "Carrier", "type": "string" }, "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "read_on": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "Read On" }, "source_url": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Source Url" } }, "required": [ "file", "carrier" ], "title": "Body_import_jurisdiction_rates_routing_jurisdiction_rates_post", "type": "object" }, "Body_import_line_inventory_routing_line_inventory_files_post": { "properties": { "date_order": { "default": "mdy", "maxLength": 3, "title": "Date Order", "type": "string" }, "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" } }, "required": [ "file" ], "title": "Body_import_line_inventory_routing_line_inventory_files_post", "type": "object" }, "Body_import_routes_routing_renewals_routes_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "system": { "maxLength": 100, "minLength": 1, "title": "System", "type": "string" } }, "required": [ "file", "system" ], "title": "Body_import_routes_routing_renewals_routes_post", "type": "object" }, "Body_import_version_forms__form_id__versions_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "positions": { "anyOf": [ { "contentMediaType": "application/octet-stream", "type": "string" }, { "type": "null" } ], "title": "Positions" } }, "required": [ "file" ], "title": "Body_import_version_forms__form_id__versions_post", "type": "object" }, "Body_predict_document_routing_predict_post": { "properties": { "engine": { "default": "auto", "description": "The fax engine you would choose for this fax (as on POST /fax): auto (Faxbot chooses, the default), builtin or hylafax. A call over your SIP trunk is then measured and priced as that engine sends it.", "enum": [ "auto", "builtin", "hylafax" ], "title": "Engine", "type": "string" }, "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "to": { "maxLength": 40, "minLength": 1, "title": "To", "type": "string" } }, "required": [ "to", "file" ], "title": "Body_predict_document_routing_predict_post", "type": "object" }, "Body_send_case_packet_cases__case_id__faxes_post": { "properties": { "dates": { "default": [], "items": { "type": "string" }, "title": "Dates", "type": "array" }, "documents": { "items": { "contentMediaType": "application/octet-stream", "type": "string" }, "title": "Documents", "type": "array" }, "preview": { "default": false, "title": "Preview", "type": "boolean" }, "purpose": { "default": "", "title": "Purpose", "type": "string" }, "sources": { "default": [], "items": { "type": "string" }, "title": "Sources", "type": "array" }, "titles": { "default": [], "items": { "type": "string" }, "title": "Titles", "type": "array" }, "to": { "title": "To", "type": "string" }, "types": { "default": [], "items": { "type": "string" }, "title": "Types", "type": "array" }, "versions": { "default": [], "items": { "type": "string" }, "title": "Versions", "type": "array" } }, "required": [ "to", "documents" ], "title": "Body_send_case_packet_cases__case_id__faxes_post", "type": "object" }, "Body_send_fax_fax_post": { "properties": { "court": { "anyOf": [ { "maxLength": 20000, "type": "string" }, { "type": "null" } ], "description": "Send under the California court profile: the case details as one JSON object (purpose file or serve, county, case_number, plaintiff, defendant, documents with title and pages, and the sender). Filing adds the MC-005 cover sheet; the pages otherwise go exactly as given, by a fax call.", "title": "Court" }, "cover_in_header": { "default": false, "description": "The first page is a cover sheet whose notice goes in the header notice printed on every page instead, so that page is not sent. Needs a header notice for your organization or the mailbox; a recipient that needs a cover sheet still gets it.", "title": "Cover In Header", "type": "boolean" }, "engine": { "default": "auto", "description": "For a call over your SIP trunk, the fax engine that places it: auto (Faxbot chooses, the default), builtin (the built-in engine), or hylafax (the SSL Fax engine when it is running, else the built-in engine). Faxes sent together in one call always use the built-in engine.", "enum": [ "auto", "builtin", "hylafax" ], "title": "Engine", "type": "string" }, "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "labels": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Labels for this fax from your organization's list, such as legal; repeat the field.", "title": "Labels" }, "mailbox": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "description": "The mailbox this fax is sent from, so its sending rules apply. You must work in that mailbox.", "title": "Mailbox" }, "patient_birth_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The patient's birth date, such as 1980-04-30, for a recipient that confirms the patient.", "title": "Patient Birth Date" }, "patient_family_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The patient's family name, for a recipient that confirms the patient.", "title": "Patient Family Name" }, "patient_given_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The patient's given name, for a recipient that confirms the patient.", "title": "Patient Given Name" }, "patient_record_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Only for a recipient that takes documents into its health records (FHIR): the patient's medical record number there.", "title": "Patient Record Number" }, "patient_record_system": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The system that medical record number belongs to, as a web address or OID; the FHIR client's own is used when left out.", "title": "Patient Record System" }, "queue_only": { "default": false, "title": "Queue Only", "type": "boolean" }, "send_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The time this fax must be sent by: a date and time with an offset (2026-10-08T17:00-04:00), a date and time in the installation's time zone (2026-10-08 17:00), or a time (17:00, its next occurrence). Faxbot never holds the fax past it for the recipient's hours or a busy hour.", "title": "Send By" }, "send_by_call": { "default": false, "description": "Place a real call through your fax provider or carrier even when the number is one of this installation's own numbers, instead of delivering it inside Faxbot. Test faxes use this.", "title": "Send By Call", "type": "boolean" }, "send_now": { "default": false, "description": "Send at once even when this number sends faxes together; faxes waiting for it go in the same call.", "title": "Send Now", "type": "boolean" }, "to": { "title": "To", "type": "string" }, "urgent": { "default": false, "description": "Send before other faxes waiting for the same number or line, and without waiting to go together with other faxes.", "title": "Urgent", "type": "boolean" }, "workflow": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "The workflow this fax is part of, from your organization's sending rules.", "title": "Workflow" } }, "required": [ "to", "file" ], "title": "Body_send_fax_fax_post", "type": "object" }, "CallerIdIn": { "additionalProperties": false, "properties": { "account": { "maxLength": 64, "minLength": 1, "title": "Account", "type": "string" }, "bought_here": { "default": false, "title": "Bought Here", "type": "boolean" }, "caller_id": { "maxLength": 32, "minLength": 3, "title": "Caller Id", "type": "string" }, "evidence": { "maxLength": 2000, "minLength": 1, "title": "Evidence", "type": "string" }, "evidence_url": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Evidence Url" } }, "required": [ "account", "caller_id", "evidence" ], "title": "CallerIdIn", "type": "object" }, "CallerIdWithdrawIn": { "additionalProperties": false, "properties": { "account": { "maxLength": 64, "minLength": 1, "title": "Account", "type": "string" }, "caller_id": { "maxLength": 32, "minLength": 3, "title": "Caller Id", "type": "string" }, "note": { "default": "", "maxLength": 2000, "title": "Note", "type": "string" } }, "required": [ "account", "caller_id" ], "title": "CallerIdWithdrawIn", "type": "object" }, "CeilingEntry": { "additionalProperties": false, "properties": { "permission": { "maxLength": 100, "title": "Permission", "type": "string" }, "resource_id": { "maxLength": 100, "minLength": 1, "title": "Resource Id", "type": "string" } }, "required": [ "permission", "resource_id" ], "title": "CeilingEntry", "type": "object" }, "CheckBody": { "additionalProperties": false, "properties": { "replay": { "default": 200, "maximum": 1000.0, "minimum": 0.0, "title": "Replay", "type": "integer" } }, "title": "CheckBody", "type": "object" }, "ChecklistItem": { "additionalProperties": false, "properties": { "required": { "default": true, "title": "Required", "type": "boolean" }, "type": { "maxLength": 100, "minLength": 1, "title": "Type", "type": "string" }, "version": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Version" }, "within_days": { "anyOf": [ { "maximum": 3650.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Within Days" } }, "required": [ "type" ], "title": "ChecklistItem", "type": "object" }, "ChecklistPacket": { "additionalProperties": false, "properties": { "allow_missing": { "default": false, "title": "Allow Missing", "type": "boolean" }, "as_of": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "As Of" }, "checklist_id": { "maxLength": 40, "minLength": 1, "title": "Checklist Id", "type": "string" }, "preview": { "default": false, "title": "Preview", "type": "boolean" }, "purpose": { "default": "", "maxLength": 200, "title": "Purpose", "type": "string" }, "selection": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Picked" }, "maxItems": 50, "type": "array" }, { "type": "null" } ], "title": "Selection" }, "to": { "maxLength": 40, "minLength": 1, "title": "To", "type": "string" } }, "required": [ "to", "checklist_id" ], "title": "ChecklistPacket", "type": "object" }, "Choice": { "additionalProperties": false, "properties": { "documents": { "items": { "type": "string" }, "maxItems": 500, "minItems": 1, "title": "Documents", "type": "array" }, "note": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Note" }, "to": { "maxLength": 40, "minLength": 1, "title": "To", "type": "string" } }, "required": [ "to", "documents" ], "title": "Choice", "type": "object" }, "CloseIn": { "additionalProperties": false, "properties": { "note": { "maxLength": 400, "title": "Note", "type": "string" }, "outcome": { "enum": [ "cancelled", "completed_elsewhere" ], "title": "Outcome", "type": "string" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "outcome", "note", "version" ], "title": "CloseIn", "type": "object" }, "CodingTuning": { "additionalProperties": false, "properties": { "tune": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tune" }, "tune_jbig": { "default": false, "title": "Tune Jbig", "type": "boolean" } }, "title": "CodingTuning", "type": "object" }, "ConfigurationInputError": { "additionalProperties": false, "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Loc", "type": "array" }, "msg": { "const": "Invalid configuration input.", "title": "Msg", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "loc", "type", "msg" ], "title": "ConfigurationInputError", "type": "object" }, "ConfigurationValidationErrorResponse": { "additionalProperties": false, "examples": [ { "detail": [ { "loc": [ "body", "max_file_size_mb" ], "msg": "Invalid configuration input.", "type": "int_parsing" } ] } ], "properties": { "detail": { "items": { "$ref": "#/components/schemas/ConfigurationInputError" }, "title": "Detail", "type": "array" } }, "required": [ "detail" ], "title": "ConfigurationValidationErrorResponse", "type": "object" }, "ConfigurationWriteMeta": { "additionalProperties": false, "properties": { "active_revision_id": { "maxLength": 40, "minLength": 1, "pattern": "^[ -~]+$", "title": "Active Revision Id", "type": "string" }, "apply_state": { "enum": [ "applied", "pending_restart" ], "title": "Apply State", "type": "string" }, "desired_revision_id": { "maxLength": 40, "minLength": 1, "pattern": "^[ -~]+$", "title": "Desired Revision Id", "type": "string" }, "generation": { "minimum": 1.0, "title": "Generation", "type": "integer" }, "restart_recommended": { "title": "Restart Recommended", "type": "boolean" } }, "required": [ "active_revision_id", "desired_revision_id", "generation", "apply_state", "restart_recommended" ], "title": "ConfigurationWriteMeta", "type": "object" }, "ConfigurationWriteResponse": { "additionalProperties": false, "examples": [ { "_meta": { "active_revision_id": "00000000-0000-4000-8000-000000000001", "apply_state": "applied", "desired_revision_id": "00000000-0000-4000-8000-000000000001", "generation": 2, "restart_recommended": false }, "changed": true, "ok": true }, { "_meta": { "active_revision_id": "00000000-0000-4000-8000-000000000001", "apply_state": "pending_restart", "desired_revision_id": "00000000-0000-4000-8000-000000000002", "generation": 3, "restart_recommended": true }, "changed": true, "ok": true } ], "properties": { "_meta": { "$ref": "#/components/schemas/ConfigurationWriteMeta" }, "changed": { "title": "Changed", "type": "boolean" }, "ok": { "const": true, "title": "Ok", "type": "boolean" } }, "required": [ "ok", "changed", "_meta" ], "title": "ConfigurationWriteResponse", "type": "object" }, "ConfirmIn": { "additionalProperties": false, "properties": { "code": { "maxLength": 20, "minLength": 8, "title": "Code", "type": "string" } }, "required": [ "code" ], "title": "ConfirmIn", "type": "object" }, "Confirmation": { "additionalProperties": false, "properties": { "documents": { "items": { "type": "string" }, "maxItems": 500, "minItems": 1, "title": "Documents", "type": "array" }, "note": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Note" }, "received_fax_id": { "anyOf": [ { "maxLength": 40, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Received Fax Id" }, "to": { "maxLength": 40, "minLength": 1, "title": "To", "type": "string" } }, "required": [ "to", "documents" ], "title": "Confirmation", "type": "object" }, "ConflictIn": { "additionalProperties": false, "properties": { "choice": { "enum": [ "keep", "apply" ], "title": "Choice", "type": "string" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "choice", "version" ], "title": "ConflictIn", "type": "object" }, "ConnectorIn": { "additionalProperties": false, "properties": { "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "from_address": { "maxLength": 320, "title": "From Address", "type": "string" }, "host": { "maxLength": 255, "title": "Host", "type": "string" }, "match_number": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Match Number" }, "name": { "maxLength": 100, "title": "Name", "type": "string" }, "password": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "title": "Password" }, "port": { "default": 587, "title": "Port", "type": "integer" }, "recipients": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "maxLength": 20, "title": "Recipients" }, "security": { "default": "starttls", "title": "Security", "type": "string" }, "subject_template": { "default": "Fax from {from_number}", "maxLength": 200, "title": "Subject Template", "type": "string" }, "username": { "default": "", "maxLength": 200, "title": "Username", "type": "string" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Version" } }, "required": [ "name", "host", "from_address", "recipients" ], "title": "ConnectorIn", "type": "object" }, "ConsentIn": { "additionalProperties": false, "properties": { "allowed": { "title": "Allowed", "type": "boolean" } }, "required": [ "allowed" ], "title": "ConsentIn", "type": "object" }, "ConsoleBrandingResponse": { "additionalProperties": false, "properties": { "docs_base": { "title": "Docs Base", "type": "string" }, "logo_path": { "const": "/admin/ui/faxbot_full_logo.png", "title": "Logo Path", "type": "string" } }, "required": [ "docs_base", "logo_path" ], "title": "ConsoleBrandingResponse", "type": "object" }, "ConsoleContextResponse": { "additionalProperties": false, "properties": { "active_revision_id": { "title": "Active Revision Id", "type": "string" }, "branding": { "$ref": "#/components/schemas/ConsoleBrandingResponse" }, "generation": { "title": "Generation", "type": "integer" }, "inbound_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Inbound Enabled" }, "navigation": { "$ref": "#/components/schemas/ConsoleNavigationResponse" }, "permissions": { "items": { "type": "string" }, "title": "Permissions", "type": "array" }, "policy_version": { "title": "Policy Version", "type": "integer" }, "provider_names": { "additionalProperties": { "type": "string" }, "default": {}, "title": "Provider Names", "type": "object" }, "provider_view": { "anyOf": [ { "$ref": "#/components/schemas/ConsoleProviderResponse" }, { "type": "null" } ] }, "send": { "anyOf": [ { "$ref": "#/components/schemas/ConsoleSendResponse" }, { "type": "null" } ] } }, "required": [ "policy_version", "active_revision_id", "generation", "permissions", "navigation", "send", "inbound_enabled", "branding", "provider_view" ], "title": "ConsoleContextResponse", "type": "object" }, "ConsoleNavigationResponse": { "additionalProperties": false, "properties": { "inbox": { "title": "Inbox", "type": "boolean" }, "jobs": { "title": "Jobs", "type": "boolean" }, "send": { "title": "Send", "type": "boolean" }, "work": { "default": false, "title": "Work", "type": "boolean" } }, "required": [ "jobs", "inbox", "send" ], "title": "ConsoleNavigationResponse", "type": "object" }, "ConsoleProviderResponse": { "additionalProperties": false, "properties": { "active_inbound": { "title": "Active Inbound", "type": "string" }, "active_outbound": { "title": "Active Outbound", "type": "string" }, "extra_routes": { "default": [], "items": { "type": "string" }, "title": "Extra Routes", "type": "array" }, "install_enabled": { "title": "Install Enabled", "type": "boolean" }, "plugins_enabled": { "title": "Plugins Enabled", "type": "boolean" }, "trunk_preset": { "default": "", "title": "Trunk Preset", "type": "string" } }, "required": [ "plugins_enabled", "install_enabled", "active_outbound", "active_inbound" ], "title": "ConsoleProviderResponse", "type": "object" }, "ConsoleSendMailbox": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "label": { "title": "Label", "type": "string" } }, "required": [ "id", "label" ], "title": "ConsoleSendMailbox", "type": "object" }, "ConsoleSendResponse": { "additionalProperties": false, "properties": { "default_country": { "title": "Default Country", "type": "string" }, "fax_disabled": { "title": "Fax Disabled", "type": "boolean" }, "labels": { "default": [], "items": { "type": "string" }, "title": "Labels", "type": "array" }, "mailboxes": { "default": [], "items": { "$ref": "#/components/schemas/ConsoleSendMailbox" }, "title": "Mailboxes", "type": "array" }, "max_file_size_mb": { "title": "Max File Size Mb", "type": "integer" }, "number_example": { "title": "Number Example", "type": "string" }, "workflows": { "default": [], "items": { "$ref": "#/components/schemas/ConsoleSendWorkflow" }, "title": "Workflows", "type": "array" } }, "required": [ "fax_disabled", "max_file_size_mb", "default_country", "number_example" ], "title": "ConsoleSendResponse", "type": "object" }, "ConsoleSendWorkflow": { "additionalProperties": false, "properties": { "key": { "title": "Key", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "key", "name" ], "title": "ConsoleSendWorkflow", "type": "object" }, "ContextBody": { "additionalProperties": false, "properties": { "country": { "default": "", "maxLength": 2, "title": "Country", "type": "string" }, "mailboxes": { "additionalProperties": { "$ref": "#/components/schemas/MailboxCountry" }, "maxProperties": 500, "title": "Mailboxes", "type": "object" }, "organization_name": { "default": "", "maxLength": 200, "title": "Organization Name", "type": "string" } }, "title": "ContextBody", "type": "object" }, "ContinueIn": { "additionalProperties": false, "properties": { "first_page": { "maximum": 10000.0, "minimum": 2.0, "title": "First Page", "type": "integer" }, "reason": { "anyOf": [ { "maxLength": 400, "type": "string" }, { "type": "null" } ], "title": "Reason" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Version" } }, "required": [ "first_page" ], "title": "ContinueIn", "type": "object" }, "CountryConfirmIn": { "additionalProperties": false, "properties": { "account": { "maxLength": 64, "minLength": 1, "title": "Account", "type": "string" }, "country": { "maxLength": 2, "minLength": 2, "title": "Country", "type": "string" }, "evidence": { "default": "", "maxLength": 2000, "title": "Evidence", "type": "string" }, "evidence_url": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Evidence Url" } }, "required": [ "account", "country" ], "title": "CountryConfirmIn", "type": "object" }, "CoverIn": { "additionalProperties": false, "properties": { "needs_cover": { "title": "Needs Cover", "type": "boolean" } }, "required": [ "needs_cover" ], "title": "CoverIn", "type": "object" }, "CreateAPIKeyIn": { "properties": { "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner" }, "scopes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Scopes" } }, "title": "CreateAPIKeyIn", "type": "object" }, "CreateAPIKeyOut": { "properties": { "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "key_id": { "title": "Key Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner" }, "scopes": { "default": [], "items": { "type": "string" }, "title": "Scopes", "type": "array" }, "token": { "title": "Token", "type": "string" } }, "required": [ "key_id", "token" ], "title": "CreateAPIKeyOut", "type": "object" }, "DeadlineIn": { "additionalProperties": false, "properties": { "deadline": { "format": "date", "title": "Deadline", "type": "string" } }, "required": [ "deadline" ], "title": "DeadlineIn", "type": "object" }, "DecideIn": { "additionalProperties": false, "properties": { "note": { "anyOf": [ { "maxLength": 400, "type": "string" }, { "type": "null" } ], "title": "Note" }, "proposal_id": { "maxLength": 40, "minLength": 1, "title": "Proposal Id", "type": "string" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "proposal_id", "version" ], "title": "DecideIn", "type": "object" }, "DependencyIn": { "additionalProperties": false, "properties": { "answer": { "maxLength": 8, "minLength": 1, "title": "Answer", "type": "string" }, "note": { "default": "", "maxLength": 2000, "title": "Note", "type": "string" }, "question": { "maxLength": 16, "minLength": 1, "title": "Question", "type": "string" } }, "required": [ "question", "answer" ], "title": "DependencyIn", "type": "object" }, "DestinationPatch": { "additionalProperties": false, "properties": { "accepts_references": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Accepts References" }, "display_name": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "max_calls": { "anyOf": [ { "maximum": 20.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Calls" }, "notes": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "title": "Notes" }, "preferred_route": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Preferred Route" }, "version": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Version" } }, "title": "DestinationPatch", "type": "object" }, "DialingChange": { "additionalProperties": false, "properties": { "ceiling": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "title": "Ceiling" }, "state": { "maxLength": 16, "minLength": 1, "title": "State", "type": "string" } }, "required": [ "state" ], "title": "DialingChange", "type": "object" }, "DigitalAccountInput": { "additionalProperties": false, "properties": { "credentials": { "additionalProperties": { "maxLength": 32768, "type": "string" }, "default": {}, "propertyNames": { "maxLength": 64 }, "title": "Credentials", "type": "object" }, "expected_generation": { "title": "Expected Generation", "type": "integer" }, "key": { "maxLength": 32, "minLength": 1, "title": "Key", "type": "string" }, "label": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Label" }, "provider": { "enum": [ "hisp", "fhir" ], "title": "Provider", "type": "string" }, "settings": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "default": {}, "propertyNames": { "maxLength": 64 }, "title": "Settings", "type": "object" } }, "required": [ "key", "provider", "expected_generation" ], "title": "DigitalAccountInput", "type": "object" }, "DigitalAccountPatch": { "additionalProperties": false, "properties": { "credentials": { "anyOf": [ { "additionalProperties": { "maxLength": 32768, "type": "string" }, "propertyNames": { "maxLength": 64 }, "type": "object" }, { "type": "null" } ], "title": "Credentials" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "expected_generation": { "title": "Expected Generation", "type": "integer" }, "label": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Label" }, "settings": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "propertyNames": { "maxLength": 64 }, "type": "object" }, { "type": "null" } ], "title": "Settings" } }, "required": [ "expected_generation" ], "title": "DigitalAccountPatch", "type": "object" }, "DoneIn": { "additionalProperties": false, "properties": { "note": { "maxLength": 400, "title": "Note", "type": "string" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "note", "version" ], "title": "DoneIn", "type": "object" }, "DraftBody": { "additionalProperties": false, "properties": { "document": { "additionalProperties": true, "title": "Document", "type": "object" }, "expected_version": { "minimum": 0.0, "title": "Expected Version", "type": "integer" } }, "required": [ "document", "expected_version" ], "title": "DraftBody", "type": "object" }, "EnrollIn": { "additionalProperties": false, "properties": { "card": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "string" } ], "title": "Card" } }, "required": [ "card" ], "title": "EnrollIn", "type": "object" }, "EntityRef": { "additionalProperties": false, "properties": { "id": { "maxLength": 100, "minLength": 1, "title": "Id", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "version" ], "title": "EntityRef", "type": "object" }, "ExpectIn": { "additionalProperties": false, "properties": { "counterparty": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Counterparty" }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Description" }, "direct_address": { "anyOf": [ { "maxLength": 320, "type": "string" }, { "type": "null" } ], "title": "Direct Address" }, "due_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Due At" }, "due_hours": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Due Hours" }, "email_subject": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Email Subject" }, "fax_numbers": { "items": { "type": "string" }, "maxItems": 20, "title": "Fax Numbers", "type": "array" }, "form_field": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Form Field" }, "kind": { "maxLength": 100, "title": "Kind", "type": "string" }, "mailbox_id": { "maxLength": 40, "title": "Mailbox Id", "type": "string" }, "message_id": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Message Id" }, "owner_principal_id": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Owner Principal Id" }, "partner_id": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Partner Id" }, "reference": { "maxLength": 200, "title": "Reference", "type": "string" }, "required_parts": { "items": { "type": "string" }, "maxItems": 10, "title": "Required Parts", "type": "array" }, "required_revision": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Required Revision" }, "revision_field": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Revision Field" }, "subaddress": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Subaddress" } }, "required": [ "reference", "kind", "mailbox_id" ], "title": "ExpectIn", "type": "object" }, "ExplainBody": { "additionalProperties": false, "properties": { "as": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "As" }, "at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "At" }, "case_packet": { "default": false, "title": "Case Packet", "type": "boolean" }, "labels": { "items": { "type": "string" }, "maxItems": 50, "title": "Labels", "type": "array" }, "mailbox": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Mailbox" }, "pages": { "anyOf": [ { "maximum": 10000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "default": 1, "title": "Pages" }, "real_call": { "default": false, "title": "Real Call", "type": "boolean" }, "scope": { "anyOf": [ { "maxLength": 110, "type": "string" }, { "type": "null" } ], "title": "Scope" }, "size_bytes": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "default": 0, "title": "Size Bytes" }, "source": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "default": "active", "title": "Source" }, "to": { "maxLength": 64, "title": "To", "type": "string" }, "urgent": { "default": false, "title": "Urgent", "type": "boolean" }, "workflow": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Workflow" } }, "required": [ "to" ], "title": "ExplainBody", "type": "object" }, "ExtensionIn": { "additionalProperties": false, "properties": { "extension": { "pattern": "^[1-9][0-9]{2,5}$", "title": "Extension", "type": "string" }, "mailbox_id": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Mailbox Id" }, "name": { "maxLength": 100, "minLength": 1, "title": "Name", "type": "string" }, "numbers": { "items": { "type": "string" }, "maxItems": 20, "title": "Numbers", "type": "array" }, "receive": { "default": "copier", "pattern": "^(copier|intake)$", "title": "Receive", "type": "string" } }, "required": [ "name", "extension" ], "title": "ExtensionIn", "type": "object" }, "FSOutboundResultIn": { "description": "The channel variables mod_spandsp sets after txfax (``phase_e_handler`` in\nsrc/mod/applications/mod_spandsp/mod_spandsp_fax.c, github.com/signalwire/freeswitch, read 2026-10-08):\n``fax_success`` \"1\" or \"0\", ``fax_result_code`` (spandsp's T.30 completion code), ``fax_result_text``,\n``fax_document_transferred_pages`` (spandsp's ``pages_tx`` when sending: pages the receiving machine\nconfirmed) and ``fax_document_total_pages`` (pages in the file).", "properties": { "attempt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attempt Id" }, "fax_document_total_pages": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fax Document Total Pages" }, "fax_document_transferred_pages": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fax Document Transferred Pages" }, "fax_remote_station_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fax Remote Station Id" }, "fax_result_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fax Result Code" }, "fax_result_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fax Result Text" }, "fax_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fax Status" }, "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Job Id" }, "rtp_audio_in_packet_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rtp Audio In Packet Count" }, "uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uuid" } }, "title": "FSOutboundResultIn", "type": "object" }, "FaxApplicationInput": { "additionalProperties": false, "properties": { "expected_generation": { "title": "Expected Generation", "type": "integer" }, "name": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Name" } }, "required": [ "expected_generation" ], "title": "FaxApplicationInput", "type": "object" }, "FaxImagesIn": { "additionalProperties": false, "properties": { "accept": { "title": "Accept", "type": "boolean" } }, "required": [ "accept" ], "title": "FaxImagesIn", "type": "object" }, "FaxJobOut": { "properties": { "backend": { "default": "sip", "title": "Backend", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "delivery_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery State" }, "delivery_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Delivery Version" }, "dispatch_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dispatch Mode" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "id": { "title": "Id", "type": "string" }, "pages": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pages" }, "provider_sid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider Sid" }, "reconciliation_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reconciliation Reason" }, "status": { "title": "Status", "type": "string" }, "to": { "title": "To", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "to", "status", "created_at", "updated_at" ], "title": "FaxJobOut", "type": "object" }, "FaxLimits": { "additionalProperties": false, "properties": { "ecm": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ecm" }, "max_rate": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Rate" } }, "title": "FaxLimits", "type": "object" }, "FillIn": { "additionalProperties": false, "properties": { "resolution": { "default": "fine", "pattern": "^(fine|standard)$", "title": "Resolution", "type": "string" }, "values": { "additionalProperties": true, "title": "Values", "type": "object" } }, "title": "FillIn", "type": "object" }, "Group": { "additionalProperties": false, "properties": { "cost": { "anyOf": [ { "maxLength": 20, "minLength": 1, "pattern": "^[0-9]{1,13}(?:\\.[0-9]{1,6})?$", "type": "string" }, { "type": "null" } ], "title": "Cost" }, "id": { "maxLength": 32, "minLength": 1, "pattern": "^[a-z][a-z0-9_-]{0,31}$", "title": "Id", "type": "string" }, "label": { "maxLength": 100, "minLength": 1, "title": "Label", "type": "string" } }, "required": [ "id", "label", "cost" ], "title": "Group", "type": "object" }, "GroupCreate": { "additionalProperties": false, "properties": { "description": { "default": "", "maxLength": 4000, "title": "Description", "type": "string" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "name": { "maxLength": 4000, "title": "Name", "type": "string" } }, "required": [ "name", "expected_policy_version" ], "title": "GroupCreate", "type": "object" }, "GroupPatch": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "title": "Description" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "name": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "title": "Name" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "version", "expected_policy_version" ], "title": "GroupPatch", "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "HoldDecisionIn": { "additionalProperties": false, "properties": { "account": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Account" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "version" ], "title": "HoldDecisionIn", "type": "object" }, "HoldIn": { "additionalProperties": false, "properties": { "enabled": { "title": "Enabled", "type": "boolean" }, "label": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Label" }, "password": { "anyOf": [ { "maxLength": 20, "type": "string" }, { "type": "null" } ], "title": "Password" }, "selective": { "anyOf": [ { "maxLength": 20, "type": "string" }, { "type": "null" } ], "title": "Selective" } }, "required": [ "enabled" ], "title": "HoldIn", "type": "object" }, "HoldRefusalIn": { "additionalProperties": false, "properties": { "reason": { "maxLength": 500, "minLength": 1, "title": "Reason", "type": "string" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "version", "reason" ], "title": "HoldRefusalIn", "type": "object" }, "Hours": { "additionalProperties": false, "properties": { "days": { "items": { "type": "string" }, "maxItems": 7, "title": "Days", "type": "array" }, "from": { "maxLength": 5, "title": "From", "type": "string" }, "until": { "maxLength": 5, "title": "Until", "type": "string" } }, "required": [ "from", "until" ], "title": "Hours", "type": "object" }, "IafBody": { "additionalProperties": false, "properties": { "kind": { "pattern": "^(peer|endpoint)$", "title": "Kind", "type": "string" }, "label": { "maxLength": 200, "minLength": 1, "title": "Label", "type": "string" }, "number": { "maxLength": 40, "minLength": 3, "title": "Number", "type": "string" } }, "required": [ "number", "kind", "label" ], "title": "IafBody", "type": "object" }, "ImportManifestsIn": { "properties": { "items": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Items" }, "markdown": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Markdown" } }, "title": "ImportManifestsIn", "type": "object" }, "InboundEarlierFailure": { "properties": { "attempts": { "title": "Attempts", "type": "integer" }, "problem": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Problem" }, "resumed_at": { "format": "date-time", "title": "Resumed At", "type": "string" }, "resumed_by": { "title": "Resumed By", "type": "string" }, "resumed_by_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resumed By Name" }, "stopped_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Stopped At" } }, "required": [ "attempts", "resumed_at", "resumed_by" ], "title": "InboundEarlierFailure", "type": "object" }, "InboundFaxOut": { "properties": { "account_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Key" }, "account_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Label" }, "backend": { "title": "Backend", "type": "string" }, "can_fetch_again": { "default": false, "title": "Can Fetch Again", "type": "boolean" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "diversion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Diversion" }, "diversion_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Diversion Text" }, "diverted_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Diverted From" }, "earlier_failures": { "default": [], "items": { "$ref": "#/components/schemas/InboundEarlierFailure" }, "title": "Earlier Failures", "type": "array" }, "earlier_failures_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Earlier Failures Text" }, "fr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fr" }, "id": { "title": "Id", "type": "string" }, "is_test": { "default": false, "title": "Is Test", "type": "boolean" }, "mailbox": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mailbox" }, "pages": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pages" }, "problem": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Problem" }, "provider_fax_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider Fax Id" }, "provider_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider Note" }, "received_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Received At" }, "recovered": { "default": false, "title": "Recovered", "type": "boolean" }, "retry_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Retry At" }, "sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sha256" }, "size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Size Bytes" }, "source_received_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Source Received At" }, "status": { "title": "Status", "type": "string" }, "status_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Text" }, "subaddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subaddress" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "urgent": { "default": false, "title": "Urgent", "type": "boolean" } }, "required": [ "id", "status", "backend" ], "title": "InboundFaxOut", "type": "object" }, "IntegrationCreate": { "additionalProperties": false, "properties": { "display_name": { "maxLength": 4000, "title": "Display Name", "type": "string" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" } }, "required": [ "display_name", "expected_policy_version" ], "title": "IntegrationCreate", "type": "object" }, "IntroduceIn": { "additionalProperties": false, "properties": { "first": { "maxLength": 40, "minLength": 1, "title": "First", "type": "string" }, "second": { "maxLength": 40, "minLength": 1, "title": "Second", "type": "string" } }, "required": [ "first", "second" ], "title": "IntroduceIn", "type": "object" }, "IntroductionIn": { "additionalProperties": false, "properties": { "signature": { "maxLength": 128, "title": "Signature", "type": "string" }, "statement": { "maxLength": 4096, "title": "Statement", "type": "string" } }, "required": [ "statement", "signature" ], "title": "IntroductionIn", "type": "object" }, "KeyApprove": { "additionalProperties": false, "properties": { "ceiling": { "items": { "$ref": "#/components/schemas/CeilingEntry" }, "maxItems": 200, "title": "Ceiling", "type": "array" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "principal": { "$ref": "#/components/schemas/EntityRef" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "principal", "ceiling", "version", "expected_policy_version" ], "title": "KeyApprove", "type": "object" }, "KeyCreate": { "additionalProperties": false, "properties": { "ceiling": { "items": { "$ref": "#/components/schemas/CeilingEntry" }, "maxItems": 200, "title": "Ceiling", "type": "array" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "name": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "title": "Name" }, "note": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "title": "Note" }, "principal": { "$ref": "#/components/schemas/EntityRef" } }, "required": [ "principal", "ceiling", "expected_policy_version" ], "title": "KeyCreate", "type": "object" }, "KeyLogin": { "additionalProperties": false, "properties": { "api_key": { "maxLength": 1048576, "minLength": 1, "title": "Api Key", "type": "string" } }, "required": [ "api_key" ], "title": "KeyLogin", "type": "object" }, "KeyPatch": { "additionalProperties": false, "properties": { "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "name": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "title": "Name" }, "note": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "title": "Note" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "version", "expected_policy_version" ], "title": "KeyPatch", "type": "object" }, "Limits": { "additionalProperties": false, "properties": { "at_once": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "At Once" }, "calls_per_second": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Calls Per Second" }, "daily_limit": { "anyOf": [ { "$ref": "#/components/schemas/Money" }, { "type": "null" } ] } }, "title": "Limits", "type": "object" }, "LocalCalls": { "additionalProperties": false, "properties": { "filename": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Filename" }, "increment": { "default": 60, "maximum": 3600.0, "minimum": 1.0, "title": "Increment", "type": "integer" }, "line": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Line" }, "monthly_fee": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "title": "Monthly Fee" }, "plan": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Plan" }, "source_url": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Source Url" }, "text": { "maxLength": 4000000, "minLength": 1, "title": "Text", "type": "string" }, "toll_per_minute": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "title": "Toll Per Minute" } }, "required": [ "text" ], "title": "LocalCalls", "type": "object" }, "LookupIn": { "additionalProperties": false, "properties": { "number": { "maxLength": 40, "minLength": 3, "title": "Number", "type": "string" } }, "required": [ "number" ], "title": "LookupIn", "type": "object" }, "MailboxCountry": { "additionalProperties": false, "properties": { "country": { "default": "", "maxLength": 2, "title": "Country", "type": "string" } }, "title": "MailboxCountry", "type": "object" }, "MailboxCreate": { "additionalProperties": false, "properties": { "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "label": { "maxLength": 4000, "title": "Label", "type": "string" } }, "required": [ "label", "expected_policy_version" ], "title": "MailboxCreate", "type": "object" }, "MailboxPatch": { "additionalProperties": false, "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "label": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "title": "Label" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "version", "expected_policy_version" ], "title": "MailboxPatch", "type": "object" }, "MailboxSettingIn": { "additionalProperties": false, "properties": { "acknowledge_hours": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Acknowledge Hours" }, "backup_principal_id": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Backup Principal Id" }, "mailbox_id": { "maxLength": 40, "minLength": 1, "title": "Mailbox Id", "type": "string" }, "version": { "default": 0, "minimum": 0.0, "title": "Version", "type": "integer" } }, "required": [ "mailbox_id" ], "title": "MailboxSettingIn", "type": "object" }, "ManifestIn": { "properties": { "manifest": { "additionalProperties": true, "title": "Manifest", "type": "object" } }, "required": [ "manifest" ], "title": "ManifestIn", "type": "object" }, "ManifestValidateIn": { "properties": { "credentials": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Credentials" }, "file_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Url" }, "from_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Number" }, "manifest": { "additionalProperties": true, "title": "Manifest", "type": "object" }, "render_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "title": "Render Only" }, "settings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Settings" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" } }, "required": [ "manifest" ], "title": "ManifestValidateIn", "type": "object" }, "MatchIn": { "additionalProperties": false, "properties": { "inbound_fax_id": { "maxLength": 40, "minLength": 1, "title": "Inbound Fax Id", "type": "string" }, "note": { "anyOf": [ { "maxLength": 400, "type": "string" }, { "type": "null" } ], "title": "Note" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "inbound_fax_id", "version" ], "title": "MatchIn", "type": "object" }, "MemberAdd": { "additionalProperties": false, "properties": { "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "group_version": { "title": "Group Version", "type": "integer" }, "principal_id": { "maxLength": 100, "minLength": 1, "title": "Principal Id", "type": "string" }, "principal_version": { "title": "Principal Version", "type": "integer" } }, "required": [ "principal_id", "principal_version", "group_version", "expected_policy_version" ], "title": "MemberAdd", "type": "object" }, "MemberRemove": { "additionalProperties": false, "properties": { "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "group_version": { "title": "Group Version", "type": "integer" }, "membership_version": { "title": "Membership Version", "type": "integer" } }, "required": [ "membership_version", "group_version", "expected_policy_version" ], "title": "MemberRemove", "type": "object" }, "MobilePairOut": { "properties": { "base_urls": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": "Base Urls", "type": "object" }, "token": { "title": "Token", "type": "string" } }, "required": [ "base_urls", "token" ], "title": "MobilePairOut", "type": "object" }, "Money": { "additionalProperties": false, "properties": { "amount": { "maxLength": 20, "minLength": 1, "title": "Amount", "type": "string" }, "currency": { "maxLength": 3, "minLength": 3, "title": "Currency", "type": "string" } }, "required": [ "currency", "amount" ], "title": "Money", "type": "object" }, "MoveIn": { "additionalProperties": false, "properties": { "to_account": { "maxLength": 64, "minLength": 1, "title": "To Account", "type": "string" } }, "required": [ "to_account" ], "title": "MoveIn", "type": "object" }, "NewChecklist": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/ChecklistItem" }, "maxItems": 50, "minItems": 1, "title": "Items", "type": "array" }, "name": { "maxLength": 100, "minLength": 1, "title": "Name", "type": "string" }, "to": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "To" } }, "required": [ "name", "items" ], "title": "NewChecklist", "type": "object" }, "Node": { "additionalProperties": false, "properties": { "cost": { "anyOf": [ { "maxLength": 20, "minLength": 1, "pattern": "^[0-9]{1,13}(?:\\.[0-9]{1,6})?$", "type": "string" }, { "type": "null" } ], "title": "Cost" }, "group_id": { "anyOf": [ { "maxLength": 32, "minLength": 1, "pattern": "^[a-z][a-z0-9_-]{0,31}$", "type": "string" }, { "type": "null" } ], "title": "Group Id" }, "id": { "maxLength": 32, "minLength": 1, "pattern": "^[a-z][a-z0-9_-]{0,31}$", "title": "Id", "type": "string" }, "installed": { "title": "Installed", "type": "boolean" }, "label": { "maxLength": 100, "minLength": 1, "title": "Label", "type": "string" } }, "required": [ "id", "label", "cost", "installed", "group_id" ], "title": "Node", "type": "object" }, "NoticeFaxIn": { "additionalProperties": false, "properties": { "on": { "title": "On", "type": "boolean" } }, "required": [ "on" ], "title": "NoticeFaxIn", "type": "object" }, "NpiIn": { "additionalProperties": false, "properties": { "label": { "default": "", "maxLength": 200, "title": "Label", "type": "string" }, "npi": { "maxLength": 10, "minLength": 10, "title": "Npi", "type": "string" } }, "required": [ "npi" ], "title": "NpiIn", "type": "object" }, "NppesInput": { "additionalProperties": false, "properties": { "npi": { "maxLength": 10, "minLength": 10, "title": "Npi", "type": "string" } }, "required": [ "npi" ], "title": "NppesInput", "type": "object" }, "OriginalIn": { "additionalProperties": false, "properties": { "note": { "default": "", "maxLength": 2000, "title": "Note", "type": "string" }, "state": { "maxLength": 16, "minLength": 1, "title": "State", "type": "string" } }, "required": [ "state" ], "title": "OriginalIn", "type": "object" }, "OutageEndIn": { "additionalProperties": false, "properties": { "ended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Ended At" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "version" ], "title": "OutageEndIn", "type": "object" }, "OutageIn": { "additionalProperties": false, "properties": { "note": { "anyOf": [ { "maxLength": 300, "type": "string" }, { "type": "null" } ], "title": "Note" }, "source": { "maxLength": 100, "minLength": 1, "title": "Source", "type": "string" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Started At" } }, "required": [ "source" ], "title": "OutageIn", "type": "object" }, "OwnerEnrollmentInput": { "additionalProperties": false, "properties": { "display_name": { "maxLength": 200, "minLength": 1, "title": "Display Name", "type": "string" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "login": { "maxLength": 128, "minLength": 1, "title": "Login", "type": "string" } }, "required": [ "login", "display_name", "expected_policy_version" ], "title": "OwnerEnrollmentInput", "type": "object" }, "OwnerIn": { "additionalProperties": false, "properties": { "label": { "anyOf": [ { "maxLength": 120, "type": "string" }, { "type": "null" } ], "title": "Label" }, "move": { "default": false, "title": "Move", "type": "boolean" }, "note": { "anyOf": [ { "maxLength": 300, "type": "string" }, { "type": "null" } ], "title": "Note" }, "number": { "maxLength": 40, "minLength": 3, "title": "Number", "type": "string" }, "owner": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Owner" } }, "required": [ "number" ], "title": "OwnerIn", "type": "object" }, "PairIn": { "additionalProperties": false, "properties": { "code": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Code" }, "fax_id": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Fax Id" } }, "title": "PairIn", "type": "object" }, "PairOut": { "properties": { "code": { "title": "Code", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" } }, "required": [ "code", "expires_at" ], "title": "PairOut", "type": "object" }, "PasswordChange": { "additionalProperties": false, "properties": { "current_password": { "maxLength": 1024, "minLength": 1, "title": "Current Password", "type": "string" }, "password": { "maxLength": 1024, "minLength": 1, "title": "Password", "type": "string" } }, "required": [ "current_password", "password" ], "title": "PasswordChange", "type": "object" }, "PasswordLogin": { "additionalProperties": false, "properties": { "login": { "maxLength": 128, "minLength": 1, "title": "Login", "type": "string" }, "password": { "maxLength": 1024, "minLength": 1, "title": "Password", "type": "string" } }, "required": [ "login", "password" ], "title": "PasswordLogin", "type": "object" }, "PeerCallsIn": { "additionalProperties": false, "properties": { "accept": { "title": "Accept", "type": "boolean" }, "address": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Address" } }, "required": [ "accept" ], "title": "PeerCallsIn", "type": "object" }, "PersistSettingsIn": { "additionalProperties": false, "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Path" } }, "title": "PersistSettingsIn", "type": "object" }, "Picked": { "additionalProperties": false, "properties": { "item": { "anyOf": [ { "maximum": 49.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Item" }, "original_id": { "maxLength": 40, "minLength": 1, "title": "Original Id", "type": "string" } }, "required": [ "original_id" ], "title": "Picked", "type": "object" }, "PollingIn": { "additionalProperties": false, "properties": { "collect_days": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Collect Days" }, "collect_times": { "anyOf": [ { "maxLength": 60, "type": "string" }, { "type": "null" } ], "title": "Collect Times" }, "enabled": { "title": "Enabled", "type": "boolean" }, "label": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Label" }, "password": { "anyOf": [ { "maxLength": 20, "type": "string" }, { "type": "null" } ], "title": "Password" }, "selective": { "anyOf": [ { "maxLength": 20, "type": "string" }, { "type": "null" } ], "title": "Selective" }, "time_zone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Time Zone" } }, "required": [ "enabled" ], "title": "PollingIn", "type": "object" }, "PortfolioInput": { "additionalProperties": false, "properties": { "budget": { "anyOf": [ { "maxLength": 20, "minLength": 1, "pattern": "^[0-9]{1,13}(?:\\.[0-9]{1,6})?$", "type": "string" }, { "type": "null" } ], "title": "Budget" }, "currency": { "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string" }, "groups": { "items": { "$ref": "#/components/schemas/Group" }, "maxItems": 10, "title": "Groups", "type": "array" }, "horizon": { "maxLength": 200, "minLength": 1, "title": "Horizon", "type": "string" }, "nodes": { "items": { "$ref": "#/components/schemas/Node" }, "maxItems": 10, "minItems": 1, "title": "Nodes", "type": "array" }, "perspective": { "maxLength": 200, "minLength": 1, "title": "Perspective", "type": "string" }, "relationships": { "items": { "$ref": "#/components/schemas/Relationship" }, "maxItems": 45, "title": "Relationships", "type": "array" } }, "required": [ "currency", "horizon", "perspective", "budget", "nodes", "groups", "relationships" ], "title": "PortfolioInput", "type": "object" }, "PowerIn": { "additionalProperties": false, "properties": { "host": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Host" }, "port": { "default": 3493, "maximum": 65535.0, "minimum": 1.0, "title": "Port", "type": "integer" }, "reserve_minutes": { "default": 2, "maximum": 60.0, "minimum": 0.0, "title": "Reserve Minutes", "type": "integer" }, "ups_name": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Ups Name" } }, "title": "PowerIn", "type": "object" }, "ProviderIdentityConfirmation": { "additionalProperties": false, "properties": { "confirm_original_account": { "title": "Confirm Original Account", "type": "boolean" }, "expected_version": { "exclusiveMinimum": 0.0, "title": "Expected Version", "type": "integer" }, "provider_sid": { "pattern": "^[A-Za-z0-9_-]{1,100}$", "title": "Provider Sid", "type": "string" } }, "required": [ "expected_version", "provider_sid", "confirm_original_account" ], "title": "ProviderIdentityConfirmation", "type": "object" }, "PublicDetailErrorResponse": { "additionalProperties": false, "properties": { "detail": { "title": "Detail", "type": "string" } }, "required": [ "detail" ], "title": "PublicDetailErrorResponse", "type": "object" }, "PublishBody": { "additionalProperties": false, "properties": { "expected_active_revision": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Expected Active Revision" }, "expected_draft_version": { "minimum": 1.0, "title": "Expected Draft Version", "type": "integer" }, "note": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Note" } }, "required": [ "expected_draft_version" ], "title": "PublishBody", "type": "object" }, "PublishIn": { "additionalProperties": false, "properties": { "directory": { "maxLength": 200, "minLength": 3, "title": "Directory", "type": "string" }, "number": { "maxLength": 40, "minLength": 3, "title": "Number", "type": "string" } }, "required": [ "number", "directory" ], "title": "PublishIn", "type": "object" }, "QuoteName": { "additionalProperties": false, "properties": { "name": { "maxLength": 100, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "QuoteName", "type": "object" }, "RateCardIn": { "additionalProperties": false, "properties": { "billing_increment_seconds": { "default": 60, "title": "Billing Increment Seconds", "type": "integer" }, "captured_on": { "format": "date-time", "title": "Captured On", "type": "string" }, "currency": { "default": "USD", "title": "Currency", "type": "string" }, "direction": { "default": "outbound", "title": "Direction", "type": "string" }, "included_in_plan": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Included In Plan" }, "label": { "maxLength": 100, "title": "Label", "type": "string" }, "minimum_seconds": { "default": 0, "title": "Minimum Seconds", "type": "integer" }, "monthly_fee": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Monthly Fee" }, "per_call": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "default": "0", "title": "Per Call" }, "per_minute": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "default": "0", "title": "Per Minute" }, "per_page": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "default": "0", "title": "Per Page" }, "provider_id": { "maxLength": 64, "title": "Provider Id", "type": "string" }, "provider_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider Name" }, "rows": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Rows" }, "source_url": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Source Url" } }, "required": [ "provider_id", "label", "captured_on" ], "title": "RateCardIn", "type": "object" }, "RateCardsIn": { "additionalProperties": false, "properties": { "cards": { "items": { "$ref": "#/components/schemas/RateCardIn" }, "maxItems": 100, "title": "Cards", "type": "array" } }, "required": [ "cards" ], "title": "RateCardsIn", "type": "object" }, "RateRowIn": { "additionalProperties": false, "properties": { "billing_increment_seconds": { "default": 60, "title": "Billing Increment Seconds", "type": "integer" }, "captured_on": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Captured On" }, "destination_prefix": { "maxLength": 16, "title": "Destination Prefix", "type": "string" }, "minimum_seconds": { "default": 0, "title": "Minimum Seconds", "type": "integer" }, "origin": { "maxLength": 40, "title": "Origin", "type": "string" }, "per_call": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "default": "0", "title": "Per Call" }, "per_minute": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "default": "0", "title": "Per Minute" }, "per_page": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "default": "0", "title": "Per Page" }, "source_url": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Source Url" } }, "required": [ "origin", "destination_prefix" ], "title": "RateRowIn", "type": "object" }, "RateRowsIn": { "additionalProperties": false, "properties": { "rows": { "items": { "$ref": "#/components/schemas/RateRowIn" }, "maxItems": 500, "title": "Rows", "type": "array" } }, "required": [ "rows" ], "title": "RateRowsIn", "type": "object" }, "ReceiptTestIn": { "additionalProperties": false, "properties": { "origin": { "maxLength": 64, "minLength": 1, "title": "Origin", "type": "string" } }, "required": [ "origin" ], "title": "ReceiptTestIn", "type": "object" }, "ReceivedExplain": { "additionalProperties": false, "properties": { "account_key": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Account Key" }, "at": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "At" }, "diversion": { "anyOf": [ { "enum": [ "signed", "unanchored", "unchecked", "failed", "stated" ], "type": "string" }, { "type": "null" } ], "title": "Diversion" }, "diverted_from": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Diverted From" }, "from_number": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "From Number" }, "subaddress": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Subaddress" }, "to_number": { "maxLength": 100, "title": "To Number", "type": "string" } }, "required": [ "to_number" ], "title": "ReceivedExplain", "type": "object" }, "RecipientPages": { "additionalProperties": false, "properties": { "packing": { "anyOf": [ { "enum": [ "allow", "never" ], "type": "string" }, { "type": "null" } ], "title": "Packing" }, "shading": { "anyOf": [ { "enum": [ "always", "never" ], "type": "string" }, { "type": "null" } ], "title": "Shading" }, "trim_blank": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Trim Blank" } }, "title": "RecipientPages", "type": "object" }, "RecipientPatch": { "additionalProperties": false, "properties": { "reuse_days": { "anyOf": [ { "maximum": 3650.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Reuse Days" }, "version": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Version" } }, "title": "RecipientPatch", "type": "object" }, "ReferenceIn": { "additionalProperties": false, "properties": { "manifest": { "maxLength": 16384, "title": "Manifest", "type": "string" }, "signature": { "maxLength": 128, "title": "Signature", "type": "string" } }, "required": [ "manifest", "signature" ], "title": "ReferenceIn", "type": "object" }, "Registered": { "additionalProperties": false, "properties": { "numbers": { "items": { "type": "string" }, "maxItems": 500, "title": "Numbers", "type": "array" } }, "title": "Registered", "type": "object" }, "Relationship": { "additionalProperties": false, "properties": { "a": { "maxLength": 32, "minLength": 1, "pattern": "^[a-z][a-z0-9_-]{0,31}$", "title": "A", "type": "string" }, "b": { "maxLength": 32, "minLength": 1, "pattern": "^[a-z][a-z0-9_-]{0,31}$", "title": "B", "type": "string" }, "cautious": { "anyOf": [ { "maxLength": 21, "minLength": 1, "pattern": "^-?[0-9]{1,13}(?:\\.[0-9]{1,6})?$", "type": "string" }, { "type": "null" } ], "title": "Cautious" }, "expected": { "anyOf": [ { "maxLength": 21, "minLength": 1, "pattern": "^-?[0-9]{1,13}(?:\\.[0-9]{1,6})?$", "type": "string" }, { "type": "null" } ], "title": "Expected" } }, "required": [ "a", "b", "expected", "cautious" ], "title": "Relationship", "type": "object" }, "RenewalIn": { "additionalProperties": false, "properties": { "amount": { "maxLength": 32, "minLength": 1, "title": "Amount", "type": "string" }, "currency": { "default": "USD", "maxLength": 3, "minLength": 3, "title": "Currency", "type": "string" }, "licensed_channels": { "anyOf": [ { "maximum": 10000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Licensed Channels" }, "note": { "default": "", "maxLength": 2000, "title": "Note", "type": "string" }, "parallel_numbers": { "items": { "type": "string" }, "maxItems": 500, "title": "Parallel Numbers", "type": "array" }, "parallel_since": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "Parallel Since" }, "product": { "default": "", "maxLength": 100, "title": "Product", "type": "string" }, "renews_on": { "maxLength": 10, "minLength": 10, "title": "Renews On", "type": "string" }, "source_url": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Source Url" }, "system": { "maxLength": 100, "minLength": 1, "title": "System", "type": "string" } }, "required": [ "system", "renews_on", "amount" ], "title": "RenewalIn", "type": "object" }, "Repair": { "additionalProperties": false, "properties": { "preview": { "default": false, "title": "Preview", "type": "boolean" }, "reason": { "default": "", "maxLength": 500, "title": "Reason", "type": "string" }, "to": { "maxLength": 40, "minLength": 1, "title": "To", "type": "string" } }, "required": [ "to" ], "title": "Repair", "type": "object" }, "ReplyIn": { "additionalProperties": false, "properties": { "inbound_id": { "maxLength": 40, "minLength": 1, "title": "Inbound Id", "type": "string" } }, "required": [ "inbound_id" ], "title": "ReplyIn", "type": "object" }, "ReplyNumberBody": { "additionalProperties": false, "properties": { "number": { "default": "", "maxLength": 40, "title": "Number", "type": "string" } }, "title": "ReplyNumberBody", "type": "object" }, "RoleCreate": { "additionalProperties": false, "properties": { "description": { "default": "", "maxLength": 4000, "title": "Description", "type": "string" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "name": { "maxLength": 4000, "title": "Name", "type": "string" }, "permissions": { "items": { "maxLength": 100, "type": "string" }, "maxItems": 200, "title": "Permissions", "type": "array" } }, "required": [ "name", "permissions", "expected_policy_version" ], "title": "RoleCreate", "type": "object" }, "RolePatch": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "title": "Description" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "name": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "title": "Name" }, "permissions": { "anyOf": [ { "items": { "maxLength": 100, "type": "string" }, "maxItems": 200, "type": "array" }, { "type": "null" } ], "title": "Permissions" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "version", "expected_policy_version" ], "title": "RolePatch", "type": "object" }, "RotateAPIKeyOut": { "properties": { "key_id": { "title": "Key Id", "type": "string" }, "token": { "title": "Token", "type": "string" } }, "required": [ "key_id", "token" ], "title": "RotateAPIKeyOut", "type": "object" }, "RoutePages": { "additionalProperties": false, "properties": { "long_pages": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Long Pages" }, "trim_blank": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Trim Blank" } }, "title": "RoutePages", "type": "object" }, "Routing": { "additionalProperties": false, "properties": { "on": { "title": "On", "type": "boolean" } }, "required": [ "on" ], "title": "Routing", "type": "object" }, "RuleCreate": { "additionalProperties": false, "properties": { "account_key": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Account Key" }, "any_number": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Any Number" }, "days": { "anyOf": [ { "items": { "enum": [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ], "type": "string" }, "maxItems": 7, "type": "array" }, { "type": "null" } ], "title": "Days" }, "diversion_unsigned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Diversion Unsigned" }, "diverted_from": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Diverted From" }, "email_connector_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Email Connector Id" }, "email_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Email Off" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "end_minute": { "anyOf": [ { "maximum": 1439.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "End Minute" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "from_numbers": { "anyOf": [ { "items": { "maxLength": 40, "type": "string" }, "maxItems": 50, "type": "array" }, { "type": "null" } ], "title": "From Numbers" }, "keep_days": { "anyOf": [ { "maximum": 36500.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Keep Days" }, "mailbox_id": { "maxLength": 100, "minLength": 1, "title": "Mailbox Id", "type": "string" }, "position": { "anyOf": [ { "maximum": 100000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Position" }, "site_key": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Site Key" }, "start_minute": { "anyOf": [ { "maximum": 1439.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Start Minute" }, "subaddress": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Subaddress" }, "to_number": { "default": "", "maxLength": 100, "title": "To Number", "type": "string" }, "urgent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Urgent" } }, "required": [ "mailbox_id", "expected_policy_version" ], "title": "RuleCreate", "type": "object" }, "RulePatch": { "additionalProperties": false, "properties": { "account_key": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Account Key" }, "any_number": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Any Number" }, "days": { "anyOf": [ { "items": { "enum": [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ], "type": "string" }, "maxItems": 7, "type": "array" }, { "type": "null" } ], "title": "Days" }, "diversion_unsigned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Diversion Unsigned" }, "diverted_from": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Diverted From" }, "email_connector_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Email Connector Id" }, "email_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Email Off" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "end_minute": { "anyOf": [ { "maximum": 1439.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "End Minute" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "from_numbers": { "anyOf": [ { "items": { "maxLength": 40, "type": "string" }, "maxItems": 50, "type": "array" }, { "type": "null" } ], "title": "From Numbers" }, "keep_days": { "anyOf": [ { "maximum": 36500.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Keep Days" }, "mailbox_id": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Mailbox Id" }, "position": { "anyOf": [ { "maximum": 100000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Position" }, "site_key": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Site Key" }, "start_minute": { "anyOf": [ { "maximum": 1439.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Start Minute" }, "subaddress": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Subaddress" }, "to_number": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "To Number" }, "urgent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Urgent" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "version", "expected_policy_version" ], "title": "RulePatch", "type": "object" }, "ScheduleIn": { "additionalProperties": false, "properties": { "days": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 7, "type": "array" }, { "type": "null" } ], "title": "Days" }, "end": { "anyOf": [ { "maxLength": 5, "type": "string" }, { "type": "null" } ], "title": "End" }, "learn_busy": { "default": true, "title": "Learn Busy", "type": "boolean" }, "start": { "anyOf": [ { "maxLength": 5, "type": "string" }, { "type": "null" } ], "title": "Start" }, "time_zone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Time Zone" } }, "title": "ScheduleIn", "type": "object" }, "SendIn": { "additionalProperties": false, "properties": { "resolution": { "default": "fine", "pattern": "^(fine|standard)$", "title": "Resolution", "type": "string" }, "route": { "default": "auto", "pattern": "^(auto|fax)$", "title": "Route", "type": "string" }, "to": { "maxLength": 40, "minLength": 3, "title": "To", "type": "string" }, "values": { "additionalProperties": true, "title": "Values", "type": "object" }, "version_id": { "maxLength": 40, "minLength": 1, "title": "Version Id", "type": "string" } }, "required": [ "version_id", "to" ], "title": "SendIn", "type": "object" }, "SendOnlyBody": { "additionalProperties": false, "properties": { "numbers": { "items": { "type": "string" }, "maxItems": 50, "title": "Numbers", "type": "array" } }, "required": [ "numbers" ], "title": "SendOnlyBody", "type": "object" }, "SenderIn": { "additionalProperties": false, "properties": { "address": { "maxLength": 320, "title": "Address", "type": "string" }, "principal_id": { "maxLength": 40, "minLength": 1, "title": "Principal Id", "type": "string" } }, "required": [ "address", "principal_id" ], "title": "SenderIn", "type": "object" }, "SenderPinIn": { "additionalProperties": false, "properties": { "account": { "maxLength": 64, "minLength": 1, "title": "Account", "type": "string" }, "caller_id": { "maxLength": 32, "minLength": 3, "title": "Caller Id", "type": "string" }, "note": { "default": "", "maxLength": 2000, "title": "Note", "type": "string" }, "station_id": { "anyOf": [ { "maxLength": 20, "type": "string" }, { "type": "null" } ], "title": "Station Id" } }, "required": [ "account", "caller_id" ], "title": "SenderPinIn", "type": "object" }, "SessionRevoke": { "additionalProperties": false, "properties": { "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" } }, "required": [ "expected_policy_version" ], "title": "SessionRevoke", "type": "object" }, "SettleIn": { "additionalProperties": false, "properties": { "outcome": { "enum": [ "delivered", "not_delivered", "unknown" ], "title": "Outcome", "type": "string" }, "reason": { "maxLength": 400, "title": "Reason", "type": "string" }, "send_again": { "default": false, "title": "Send Again", "type": "boolean" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "outcome", "reason", "version" ], "title": "SettleIn", "type": "object" }, "SigningKeyInput": { "additionalProperties": false, "properties": { "algorithm": { "anyOf": [ { "enum": [ "RS384", "ES384" ], "type": "string" }, { "type": "null" } ], "title": "Algorithm" }, "expected_generation": { "title": "Expected Generation", "type": "integer" } }, "required": [ "expected_generation" ], "title": "SigningKeyInput", "type": "object" }, "SimulateInboundIn": { "properties": { "backend": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Backend" }, "fr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fr" }, "pages": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 1, "title": "Pages" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "received", "title": "Status" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" } }, "title": "SimulateInboundIn", "type": "object" }, "SourceUpdate": { "additionalProperties": false, "properties": { "name": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Name" }, "secret": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Secret" }, "senders": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SenderIn" }, "maxItems": 500, "type": "array" }, { "type": "null" } ], "title": "Senders" }, "settings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Settings" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "version" ], "title": "SourceUpdate", "type": "object" }, "Spend": { "additionalProperties": false, "properties": { "amount": { "maxLength": 20, "title": "Amount", "type": "string" }, "currency": { "maxLength": 3, "minLength": 3, "title": "Currency", "type": "string" } }, "required": [ "amount", "currency" ], "title": "Spend", "type": "object" }, "StatementIn": { "additionalProperties": false, "properties": { "signature": { "maxLength": 128, "title": "Signature", "type": "string" }, "statement": { "maxLength": 65536, "title": "Statement", "type": "string" } }, "required": [ "statement", "signature" ], "title": "StatementIn", "type": "object" }, "StationChange": { "additionalProperties": false, "properties": { "mode": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "title": "Mode" }, "station": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Station" } }, "title": "StationChange", "type": "object" }, "StepIn": { "additionalProperties": false, "properties": { "note": { "default": "", "maxLength": 2000, "title": "Note", "type": "string" }, "state": { "maxLength": 16, "minLength": 1, "title": "State", "type": "string" } }, "required": [ "state" ], "title": "StepIn", "type": "object" }, "SubjectRef": { "additionalProperties": false, "properties": { "id": { "maxLength": 100, "minLength": 1, "title": "Id", "type": "string" }, "kind": { "enum": [ "principal", "group" ], "title": "Kind", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "kind", "id", "version" ], "title": "SubjectRef", "type": "object" }, "SweepIn": { "additionalProperties": false, "properties": { "account": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Account" }, "days": { "default": 7, "maximum": 31.0, "minimum": 1.0, "title": "Days", "type": "integer" } }, "title": "SweepIn", "type": "object" }, "SystemIn": { "additionalProperties": false, "properties": { "system": { "maxLength": 100, "minLength": 1, "title": "System", "type": "string" } }, "required": [ "system" ], "title": "SystemIn", "type": "object" }, "TerminalTicketOut": { "properties": { "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "ticket": { "title": "Ticket", "type": "string" } }, "required": [ "ticket", "expires_at" ], "title": "TerminalTicketOut", "type": "object" }, "TestIn": { "additionalProperties": false, "properties": { "incident_id": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Incident Id" }, "number_a": { "maxLength": 40, "minLength": 3, "title": "Number A", "type": "string" }, "number_b": { "maxLength": 40, "minLength": 3, "title": "Number B", "type": "string" }, "route_a": { "maxLength": 64, "minLength": 1, "title": "Route A", "type": "string" }, "route_b": { "maxLength": 64, "minLength": 1, "title": "Route B", "type": "string" } }, "required": [ "route_a", "route_b", "number_a", "number_b" ], "title": "TestIn", "type": "object" }, "TollFreeIn": { "additionalProperties": false, "properties": { "action": { "maxLength": 16, "title": "Action", "type": "string" }, "alternate_number": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Alternate Number" }, "approved_by": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Approved By" }, "approved_on": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Approved On" }, "evidence": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "title": "Evidence" } }, "required": [ "action" ], "title": "TollFreeIn", "type": "object" }, "TrustBundleInput": { "additionalProperties": false, "properties": { "content": { "anyOf": [ { "maxLength": 6291456, "type": "string" }, { "type": "null" } ], "title": "Content" }, "url": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Url" } }, "title": "TrustBundleInput", "type": "object" }, "UpdatePluginConfigIn": { "additionalProperties": false, "description": "Submit only changed provider fields and the loaded expected_revision_id. An empty object submits no field edits.", "examples": [ {} ], "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "expected_revision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Revision Id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" }, "settings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Settings" } }, "title": "UpdatePluginConfigIn", "type": "object" }, "UpdateSettingsRequest": { "additionalProperties": false, "description": "Submit only changed fields and the loaded expected_revision_id. An empty object submits no field edits.", "examples": [ {} ], "properties": { "admin_allow_restart": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Admin Allow Restart" }, "ami_host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ami Host" }, "ami_password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ami Password" }, "ami_port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ami Port" }, "ami_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ami Username" }, "analysis_api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Analysis Api Key" }, "analysis_base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Analysis Base Url" }, "analysis_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Analysis Enabled" }, "analysis_interval_hours": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Analysis Interval Hours" }, "analysis_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Analysis Model" }, "analysis_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Analysis Provider" }, "api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" }, "artifact_ttl_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Artifact Ttl Days" }, "asterisk_inbound_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asterisk Inbound Secret" }, "audit_log_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Audit Log Enabled" }, "audit_log_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audit Log File" }, "audit_log_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audit Log Format" }, "audit_log_syslog": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Audit Log Syslog" }, "audit_log_syslog_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audit Log Syslog Address" }, "backend": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Backend" }, "case_suggestions_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Case Suggestions Enabled" }, "cleanup_interval_minutes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cleanup Interval Minutes" }, "database_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Database Url" }, "direct_allow_private_peers": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Direct Allow Private Peers" }, "direct_delivery_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Direct Delivery Enabled" }, "direct_fax_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Direct Fax Number" }, "direct_organization": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Direct Organization" }, "docs_base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Docs Base Url" }, "documo_api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Documo Api Key" }, "documo_base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Documo Base Url" }, "documo_use_sandbox": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Documo Use Sandbox" }, "efax_api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Efax Api Key" }, "efax_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Efax App Id" }, "efax_caller_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Efax Caller Id" }, "efax_csid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Efax Csid" }, "efax_delete_after_download": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Efax Delete After Download" }, "efax_poll_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Efax Poll Seconds" }, "efax_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Efax User Id" }, "efax_webhook_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Efax Webhook Secret" }, "enable_mcp_http": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Mcp Http" }, "enable_mcp_sse": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Mcp Sse" }, "enable_persisted_settings": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Persisted Settings" }, "enable_s3_diagnostics": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable S3 Diagnostics" }, "enforce_public_https": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enforce Public Https" }, "expected_revision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Revision Id" }, "fax_data_dir": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fax Data Dir" }, "fax_default_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fax Default Country" }, "fax_disabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Fax Disabled" }, "fax_friendly_documents": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fax Friendly Documents" }, "fax_friendly_whiten": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Fax Friendly Whiten" }, "fax_header": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fax Header" }, "fax_reply_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fax Reply Number" }, "fax_reply_numbers": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fax Reply Numbers" }, "fax_send_only_numbers": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fax Send Only Numbers" }, "fax_station_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fax Station Id" }, "faxbot_config_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Faxbot Config Path" }, "feature_plugin_install": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Feature Plugin Install" }, "feature_v3_plugins": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Feature V3 Plugins" }, "flowroute_access_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Flowroute Access Key" }, "flowroute_secret_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Flowroute Secret Key" }, "fs_caller_id_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fs Caller Id Number" }, "fs_esl_host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fs Esl Host" }, "fs_esl_password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fs Esl Password" }, "fs_esl_port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fs Esl Port" }, "fs_gateway_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fs Gateway Name" }, "fs_t38_enable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Fs T38 Enable" }, "humblefax_access_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Humblefax Access Key" }, "humblefax_from_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Humblefax From Number" }, "humblefax_poll_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Humblefax Poll Seconds" }, "humblefax_receive_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Humblefax Receive Enabled" }, "humblefax_secret_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Humblefax Secret Key" }, "inbound_backend": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Inbound Backend" }, "inbound_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Inbound Enabled" }, "inbound_get_rpm": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Inbound Get Rpm" }, "inbound_list_rpm": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Inbound List Rpm" }, "inbound_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Inbound Retention Days" }, "inbound_token_ttl_minutes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Inbound Token Ttl Minutes" }, "intake_email_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Intake Email Enabled" }, "intake_email_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intake Email From" }, "intake_email_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intake Email Subject" }, "intake_email_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intake Email To" }, "intake_smtp_host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intake Smtp Host" }, "intake_smtp_password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intake Smtp Password" }, "intake_smtp_port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Intake Smtp Port" }, "intake_smtp_security": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intake Smtp Security" }, "intake_smtp_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intake Smtp Username" }, "local_delivery_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Local Delivery Enabled" }, "max_file_size_mb": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max File Size Mb" }, "max_requests_per_minute": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Requests Per Minute" }, "mcp_http_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mcp Http Path" }, "mcp_sse_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mcp Sse Path" }, "mobile_local_base": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mobile Local Base" }, "oauth_audience": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Oauth Audience" }, "oauth_issuer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Oauth Issuer" }, "oauth_jwks_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Oauth Jwks Url" }, "outbound_backend": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Outbound Backend" }, "outbound_routes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Outbound Routes" }, "pdf_token_ttl_minutes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pdf Token Ttl Minutes" }, "persisted_env_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Persisted Env Path" }, "phaxio_api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phaxio Api Key" }, "phaxio_api_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phaxio Api Secret" }, "phaxio_callback_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phaxio Callback Token" }, "phaxio_inbound_verify_signature": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Phaxio Inbound Verify Signature" }, "phaxio_status_callback_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phaxio Status Callback Url" }, "phaxio_verify_signature": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Phaxio Verify Signature" }, "plan_budgets": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Plan Budgets" }, "providers_dir": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Providers Dir" }, "public_api_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Api Url" }, "received_registered_senders": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Received Registered Senders" }, "require_api_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Require Api Key" }, "require_mcp_oauth": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Require Mcp Oauth" }, "route_min_success_percent": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Route Min Success Percent" }, "s3_bucket": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "S3 Bucket" }, "s3_endpoint_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "S3 Endpoint Url" }, "s3_kms_key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "S3 Kms Key Id" }, "s3_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "S3 Prefix" }, "s3_region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "S3 Region" }, "signalwire_api_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Signalwire Api Token" }, "signalwire_fax_from_e164": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Signalwire Fax From E164" }, "signalwire_project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Signalwire Project Id" }, "signalwire_sms_from_e164": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Signalwire Sms From E164" }, "signalwire_space_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Signalwire Space Url" }, "signalwire_status_callback_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Signalwire Status Callback Url" }, "signalwire_status_poll_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Signalwire Status Poll Seconds" }, "signalwire_webhook_signing_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Signalwire Webhook Signing Key" }, "sinch_api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sinch Api Key" }, "sinch_api_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sinch Api Secret" }, "sinch_base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sinch Base Url" }, "sinch_inbound_basic_pass": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sinch Inbound Basic Pass" }, "sinch_inbound_basic_user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sinch Inbound Basic User" }, "sinch_project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sinch Project Id" }, "sinch_webhook_base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sinch Webhook Base Url" }, "sip_external_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip External Address" }, "sip_fax_answer_cap": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sip Fax Answer Cap" }, "sip_fax_compression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Fax Compression" }, "sip_fax_ecm": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sip Fax Ecm" }, "sip_fax_fine": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sip Fax Fine" }, "sip_fax_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sip Fax Lines" }, "sip_fax_max_rate": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sip Fax Max Rate" }, "sip_fax_preference_header": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sip Fax Preference Header" }, "sip_fax_tune_coding": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sip Fax Tune Coding" }, "sip_public_address_check_minutes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sip Public Address Check Minutes" }, "sip_router_ports": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sip Router Ports" }, "sip_sslfax_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sip Sslfax Enabled" }, "sip_sslfax_listener_port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sip Sslfax Listener Port" }, "sip_t38_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sip T38 Enabled" }, "sip_t38_error_correction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip T38 Error Correction" }, "sip_t38_max_datagram": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sip T38 Max Datagram" }, "sip_trunk_auth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Auth" }, "sip_trunk_caller_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Caller Id" }, "sip_trunk_calls_per_second": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sip Trunk Calls Per Second" }, "sip_trunk_codecs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Codecs" }, "sip_trunk_dial_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Dial Format" }, "sip_trunk_dial_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Dial Prefix" }, "sip_trunk_dids": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Dids" }, "sip_trunk_host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Host" }, "sip_trunk_max_calls": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sip Trunk Max Calls" }, "sip_trunk_outbound_proxy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Outbound Proxy" }, "sip_trunk_own_access": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Own Access" }, "sip_trunk_password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Password" }, "sip_trunk_port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sip Trunk Port" }, "sip_trunk_preset": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Preset" }, "sip_trunk_transport": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Transport" }, "sip_trunk_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sip Trunk Username" }, "stir_trust_anchors": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stir Trust Anchors" }, "storage_backend": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Storage Backend" }, "telnyx_api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telnyx Api Key" }, "telnyx_fax_connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telnyx Fax Connection Id" }, "telnyx_fax_from_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telnyx Fax From Number" }, "telnyx_fax_public_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telnyx Fax Public Key" }, "time_zone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Zone" }, "work_acknowledge_hours": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Work Acknowledge Hours" } }, "title": "UpdateSettingsRequest", "type": "object" }, "UpstreamIn": { "additionalProperties": false, "properties": { "note": { "anyOf": [ { "maxLength": 300, "type": "string" }, { "type": "null" } ], "title": "Note" }, "source_date": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "Source Date" }, "source_url": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Source Url" }, "upstream": { "anyOf": [ { "maxLength": 120, "type": "string" }, { "type": "null" } ], "title": "Upstream" } }, "title": "UpstreamIn", "type": "object" }, "UserCreate": { "additionalProperties": false, "properties": { "display_name": { "maxLength": 4000, "title": "Display Name", "type": "string" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "login": { "maxLength": 200, "title": "Login", "type": "string" } }, "required": [ "login", "display_name", "expected_policy_version" ], "title": "UserCreate", "type": "object" }, "UserPatch": { "additionalProperties": false, "properties": { "display_name": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "login": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Login" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "version", "expected_policy_version" ], "title": "UserPatch", "type": "object" }, "ValidateSettingsRequest": { "properties": { "ami_host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ami Host" }, "ami_password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ami Password" }, "ami_port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ami Port" }, "ami_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ami Username" }, "backend": { "title": "Backend", "type": "string" }, "efax_api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Efax Api Key" }, "efax_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Efax App Id" }, "efax_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Efax User Id" }, "phaxio_api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phaxio Api Key" }, "phaxio_api_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phaxio Api Secret" }, "sinch_api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sinch Api Key" }, "sinch_api_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sinch Api Secret" }, "sinch_project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sinch Project Id" } }, "required": [ "backend" ], "title": "ValidateSettingsRequest", "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" }, "VerificationIn": { "additionalProperties": false, "properties": { "signature": { "maxLength": 128, "title": "Signature", "type": "string" }, "statement": { "maxLength": 2048, "title": "Statement", "type": "string" } }, "required": [ "statement", "signature" ], "title": "VerificationIn", "type": "object" }, "VersionedAction": { "additionalProperties": false, "properties": { "expected_policy_version": { "minimum": 1.0, "title": "Expected Policy Version", "type": "integer" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "version", "expected_policy_version" ], "title": "VersionedAction", "type": "object" }, "api__app__batching__http__NumberSetting": { "additionalProperties": false, "properties": { "boundaries": { "anyOf": [ { "enum": [ "separators", "index_page", "page_headers" ], "type": "string" }, { "type": "null" } ], "title": "Boundaries" }, "boundaries_agreed": { "default": false, "title": "Boundaries Agreed", "type": "boolean" }, "enabled": { "title": "Enabled", "type": "boolean" }, "max_pages": { "anyOf": [ { "maximum": 200.0, "minimum": 2.0, "type": "integer" }, { "type": "null" } ], "title": "Max Pages" }, "max_wait_minutes": { "anyOf": [ { "maximum": 60.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Max Wait Minutes" }, "mixed_senders": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Mixed Senders" }, "recipient_agreed": { "default": false, "title": "Recipient Agreed", "type": "boolean" }, "version": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Version" } }, "required": [ "enabled" ], "title": "NumberSetting", "type": "object" }, "api__app__codec__http__NumberSetting": { "additionalProperties": false, "properties": { "clear_key": { "default": false, "title": "Clear Key", "type": "boolean" }, "decoder": { "anyOf": [ { "pattern": "^(any|capacity)$", "type": "string" }, { "type": "null" } ], "title": "Decoder" }, "enabled": { "title": "Enabled", "type": "boolean" }, "fec": { "anyOf": [ { "pattern": "^(low|medium|high)$", "type": "string" }, { "type": "null" } ], "title": "Fec" }, "recipient_agreed": { "default": false, "title": "Recipient Agreed", "type": "boolean" }, "shared_key": { "anyOf": [ { "maxLength": 200, "minLength": 8, "type": "string" }, { "type": "null" } ], "title": "Shared Key" }, "style": { "anyOf": [ { "pattern": "^(dense|picture)$", "type": "string" }, { "type": "null" } ], "title": "Style" }, "version": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Version" } }, "required": [ "enabled" ], "title": "NumberSetting", "type": "object" }, "api__app__direct__discovery_http__SettingsIn": { "additionalProperties": false, "properties": { "directories": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, { "type": "null" } ], "title": "Directories" }, "from_calls": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "From Calls" }, "well_known": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Well Known" } }, "title": "SettingsIn", "type": "object" }, "api__app__direct__notice_http__SignedIn": { "additionalProperties": false, "properties": { "signature": { "maxLength": 128, "title": "Signature", "type": "string" }, "statement": { "maxLength": 4096, "title": "Statement", "type": "string" } }, "required": [ "statement", "signature" ], "title": "SignedIn", "type": "object" }, "api__app__direct__relay_http__GrantIn": { "additionalProperties": false, "properties": { "countries": { "items": { "type": "string" }, "maxItems": 30, "title": "Countries", "type": "array" }, "hours": { "anyOf": [ { "$ref": "#/components/schemas/Hours" }, { "type": "null" } ] }, "monthly_pages": { "anyOf": [ { "maximum": 1000000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Monthly Pages" }, "monthly_spend": { "anyOf": [ { "$ref": "#/components/schemas/Spend" }, { "type": "null" } ] }, "partner": { "maxLength": 40, "title": "Partner", "type": "string" }, "regions": { "items": { "type": "string" }, "maxItems": 30, "title": "Regions", "type": "array" }, "same_organization": { "default": false, "title": "Same Organization", "type": "boolean" }, "together": { "default": false, "title": "Together", "type": "boolean" } }, "required": [ "partner" ], "title": "GrantIn", "type": "object" }, "api__app__direct__relay_http__QuoteIn": { "additionalProperties": false, "properties": { "countries": { "items": { "type": "string" }, "maxItems": 10, "minItems": 1, "title": "Countries", "type": "array" } }, "required": [ "countries" ], "title": "QuoteIn", "type": "object" }, "api__app__direct__send_once_http__GrantIn": { "additionalProperties": false, "properties": { "intake": { "maxLength": 200, "minLength": 1, "title": "Intake", "type": "string" }, "numbers": { "items": { "type": "string" }, "maxItems": 100, "minItems": 1, "title": "Numbers", "type": "array" } }, "required": [ "numbers", "intake" ], "title": "GrantIn", "type": "object" }, "api__app__direct__send_once_http__SignedIn": { "additionalProperties": false, "properties": { "signature": { "maxLength": 128, "title": "Signature", "type": "string" }, "statement": { "maxLength": 8192, "title": "Statement", "type": "string" } }, "required": [ "statement", "signature" ], "title": "SignedIn", "type": "object" }, "api__app__direct__transfer_http__SignedIn": { "additionalProperties": false, "properties": { "signature": { "maxLength": 128, "title": "Signature", "type": "string" }, "statement": { "maxLength": 4096, "title": "Statement", "type": "string" } }, "required": [ "statement", "signature" ], "title": "SignedIn", "type": "object" }, "api__app__header_notice_http__NoticeIn": { "additionalProperties": false, "properties": { "notice": { "anyOf": [ { "maxLength": 400, "type": "string" }, { "type": "null" } ], "title": "Notice" } }, "title": "NoticeIn", "type": "object" }, "api__app__intake__sources__http__SourceIn": { "additionalProperties": false, "properties": { "direction": { "enum": [ "receive", "send" ], "title": "Direction", "type": "string" }, "kind": { "enum": [ "email", "folder" ], "title": "Kind", "type": "string" }, "name": { "maxLength": 100, "title": "Name", "type": "string" }, "secret": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Secret" }, "senders": { "items": { "$ref": "#/components/schemas/SenderIn" }, "maxItems": 500, "title": "Senders", "type": "array" }, "settings": { "additionalProperties": true, "title": "Settings", "type": "object" } }, "required": [ "name", "kind", "direction" ], "title": "SourceIn", "type": "object" }, "api__app__intake__sources__http__VersionIn": { "additionalProperties": false, "properties": { "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Version" } }, "title": "VersionIn", "type": "object" }, "api__app__routing__countries_http__NoticeIn": { "additionalProperties": false, "properties": { "carrier": { "default": "", "maxLength": 100, "title": "Carrier", "type": "string" }, "closes_on": { "maxLength": 10, "minLength": 10, "title": "Closes On", "type": "string" }, "note": { "default": "", "maxLength": 2000, "title": "Note", "type": "string" }, "received_on": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "Received On" } }, "required": [ "closes_on" ], "title": "NoticeIn", "type": "object" }, "api__app__routing__inventory_http__QuoteIn": { "additionalProperties": false, "properties": { "currency": { "default": "USD", "maxLength": 3, "minLength": 3, "title": "Currency", "type": "string" }, "device_price": { "default": "", "maxLength": 32, "title": "Device Price", "type": "string" }, "lines_quoted": { "anyOf": [ { "maximum": 100000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Lines Quoted" }, "name": { "default": "", "maxLength": 100, "title": "Name", "type": "string" }, "note": { "default": "", "maxLength": 2000, "title": "Note", "type": "string" }, "per_line": { "default": "", "maxLength": 32, "title": "Per Line", "type": "string" }, "ports_per_device": { "anyOf": [ { "maximum": 64.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Ports Per Device" }, "published": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Published" }, "source_date": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "Source Date" }, "source_url": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Source Url" }, "term_months": { "anyOf": [ { "maximum": 120.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Term Months" } }, "title": "QuoteIn", "type": "object" }, "api__app__work__certainty_http__SettingsIn": { "additionalProperties": false, "properties": { "fallback_principal_id": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Fallback Principal Id" }, "settle_hours": { "maximum": 720.0, "minimum": 0.0, "title": "Settle Hours", "type": "integer" }, "version": { "minimum": 0.0, "title": "Version", "type": "integer" } }, "required": [ "settle_hours", "version" ], "title": "SettingsIn", "type": "object" }, "api__app__work__certainty_http__VersionIn": { "additionalProperties": false, "properties": { "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "version" ], "title": "VersionIn", "type": "object" }, "api__app__work__expectation_http__SourceIn": { "additionalProperties": false, "properties": { "due_hours": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Due Hours" }, "form_field": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Form Field" }, "format": { "enum": [ "csv", "json" ], "title": "Format", "type": "string" }, "id": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Id" }, "mailbox_id": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Mailbox Id" }, "mapping": { "additionalProperties": { "type": "string" }, "title": "Mapping", "type": "object" }, "name": { "maxLength": 100, "title": "Name", "type": "string" }, "revision_field": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Revision Field" }, "subaddress_template": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Subaddress Template" }, "subject_template": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Subject Template" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Version" } }, "required": [ "name", "format", "mapping" ], "title": "SourceIn", "type": "object" }, "api__app__work__http__SettingsIn": { "additionalProperties": false, "properties": { "mailboxes": { "items": { "$ref": "#/components/schemas/MailboxSettingIn" }, "maxItems": 200, "minItems": 1, "title": "Mailboxes", "type": "array" } }, "required": [ "mailboxes" ], "title": "SettingsIn", "type": "object" }, "api__app__work__http__VersionIn": { "additionalProperties": false, "properties": { "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "version" ], "title": "VersionIn", "type": "object" } } }, "info": { "contact": { "email": "support@faxbot.net", "name": "Faxbot Support", "url": "https://faxbot.net/" }, "description": "A proprietary, self-hosted fax API. Send faxes with a single function call. Use requires written permission from the owner.", "license": { "name": "Proprietary - written permission required", "url": "https://github.com/dmontgomery40/faxbot/blob/main/LICENSE" }, "title": "Faxbot API", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/_internal/asterisk/inbound": { "post": { "operationId": "asterisk_inbound__internal_asterisk_inbound_post", "parameters": [ { "in": "header", "name": "x-internal-secret", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Internal-Secret" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Asterisk Inbound", "tags": [ "Inbound" ] } }, "/_internal/freeswitch/outbound_result": { "post": { "deprecated": true, "description": "Deprecated: FreeSWITCH is removed in the next release.", "operationId": "freeswitch_outbound_result__internal_freeswitch_outbound_result_post", "parameters": [ { "in": "header", "name": "x-internal-secret", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Internal-Secret" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FSOutboundResultIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Freeswitch Outbound Result" } }, "/_internal/hylafax/inbound": { "post": { "description": "A fax the engine received: the same hand-over as Asterisk's, for images in the engine's out folder only.", "operationId": "engine_inbound__internal_hylafax_inbound_post", "parameters": [ { "in": "header", "name": "x-internal-secret", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Internal-Secret" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Engine Inbound" } }, "/_internal/hylafax/polled": { "post": { "description": "Another machine collected, or tried to collect, a fax Faxbot holds for it (hylafax/bin/polled): one\ncollection row on the held fax, once per report.", "operationId": "engine_polled__internal_hylafax_polled_post", "parameters": [ { "in": "header", "name": "x-internal-secret", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Internal-Secret" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Engine Polled" } }, "/_internal/hylafax/received-failed": { "post": { "description": "A call the engine answered that left no fax (hylafax/bin/sessions): its record and sentence.", "operationId": "engine_receive_failed__internal_hylafax_received_failed_post", "parameters": [ { "in": "header", "name": "x-internal-secret", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Internal-Secret" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Engine Receive Failed" } }, "/_internal/hylafax/result": { "post": { "operationId": "engine_result__internal_hylafax_result_post", "parameters": [ { "in": "header", "name": "x-internal-secret", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Internal-Secret" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Engine Result" } }, "/_internal/hylafax/started": { "post": { "description": "The engine started (again). Every fax it took earlier and never reported on waits for a person\n(uncertain): its call may have reached the other machine, and it is never sent again by itself.\nA result that arrives later still replaces that with the real outcome.", "operationId": "engine_started__internal_hylafax_started_post", "parameters": [ { "in": "header", "name": "x-internal-secret", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Internal-Secret" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Engine Started" } }, "/access/assignments": { "get": { "operationId": "list_assignments_access_assignments_get", "parameters": [ { "in": "query", "name": "subject_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Id" } }, { "in": "query", "name": "resource_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" } }, { "description": "Opaque cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Opaque cursor from the previous page.", "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Role assignments", "tags": [ "Access management" ] }, "post": { "operationId": "create_assignment_access_assignments_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignmentCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Assign a role", "tags": [ "Access management" ] } }, "/access/assignments/{assignment_id}/remove": { "post": { "operationId": "remove_assignment_access_assignments__assignment_id__remove_post", "parameters": [ { "in": "path", "name": "assignment_id", "required": true, "schema": { "title": "Assignment Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionedAction" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Remove a role assignment", "tags": [ "Access management" ] } }, "/access/audit": { "get": { "operationId": "list_audit_access_audit_get", "parameters": [ { "description": "Opaque cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Opaque cursor from the previous page.", "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "actor_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Actor Id" } }, { "in": "query", "name": "target_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Id" } }, { "in": "query", "name": "operation", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Operation" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Security audit log, newest first", "tags": [ "Access management" ] } }, "/access/groups": { "get": { "operationId": "list_groups_access_groups_get", "parameters": [ { "description": "Opaque cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Opaque cursor from the previous page.", "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Groups", "tags": [ "Access management" ] }, "post": { "operationId": "create_group_access_groups_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Create a group", "tags": [ "Access management" ] } }, "/access/groups/{group_id}": { "get": { "operationId": "get_group_access_groups__group_id__get", "parameters": [ { "in": "path", "name": "group_id", "required": true, "schema": { "title": "Group Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "One group with members and assignments", "tags": [ "Access management" ] }, "patch": { "operationId": "update_group_access_groups__group_id__patch", "parameters": [ { "in": "path", "name": "group_id", "required": true, "schema": { "title": "Group Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Change a group", "tags": [ "Access management" ] } }, "/access/groups/{group_id}/members": { "post": { "operationId": "add_member_access_groups__group_id__members_post", "parameters": [ { "in": "path", "name": "group_id", "required": true, "schema": { "title": "Group Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberAdd" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Add a member", "tags": [ "Access management" ] } }, "/access/groups/{group_id}/members/{membership_id}/remove": { "post": { "operationId": "remove_member_access_groups__group_id__members__membership_id__remove_post", "parameters": [ { "in": "path", "name": "group_id", "required": true, "schema": { "title": "Group Id", "type": "string" } }, { "in": "path", "name": "membership_id", "required": true, "schema": { "title": "Membership Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberRemove" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Remove a member", "tags": [ "Access management" ] } }, "/access/inbound-rules": { "get": { "operationId": "list_inbound_rules_access_inbound_rules_get", "parameters": [ { "description": "Opaque cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Opaque cursor from the previous page.", "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Inbound routing rules", "tags": [ "Access management" ] }, "post": { "operationId": "create_inbound_rule_access_inbound_rules_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Route a fax number to a mailbox", "tags": [ "Access management" ] } }, "/access/inbound-rules/explain": { "post": { "description": "The receiving rules' answer for a fax that has not arrived. Nothing is received or saved.", "operationId": "explain_received_access_inbound_rules_explain_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivedExplain" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Which mailbox and email a received fax would get, and why", "tags": [ "Access management" ] } }, "/access/inbound-rules/{rule_id}": { "patch": { "operationId": "update_inbound_rule_access_inbound_rules__rule_id__patch", "parameters": [ { "in": "path", "name": "rule_id", "required": true, "schema": { "title": "Rule Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulePatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Change an inbound routing rule", "tags": [ "Access management" ] } }, "/access/integrations": { "post": { "operationId": "create_integration_access_integrations_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Create an integration identity", "tags": [ "Access management" ] } }, "/access/keys": { "get": { "operationId": "list_keys_access_keys_get", "parameters": [ { "in": "query", "name": "principal_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Principal Id" } }, { "description": "Opaque cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Opaque cursor from the previous page.", "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "API keys", "tags": [ "Access management" ] }, "post": { "operationId": "create_key_access_keys_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Issue an API key (the token is shown once)", "tags": [ "Access management" ] } }, "/access/keys/{key_id}": { "patch": { "operationId": "update_key_access_keys__key_id__patch", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Change a key name, note or expiry", "tags": [ "Access management" ] } }, "/access/keys/{key_id}/approve": { "post": { "operationId": "approve_key_access_keys__key_id__approve_post", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyApprove" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Approve a migrated key that is waiting for review", "tags": [ "Access management" ] } }, "/access/keys/{key_id}/revoke": { "post": { "operationId": "revoke_key_access_keys__key_id__revoke_post", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionedAction" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Revoke a key", "tags": [ "Access management" ] } }, "/access/keys/{key_id}/rotate": { "post": { "operationId": "rotate_key_access_keys__key_id__rotate_post", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionedAction" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Replace a key secret (the token is shown once)", "tags": [ "Access management" ] } }, "/access/mailboxes": { "get": { "operationId": "list_mailboxes_access_mailboxes_get", "parameters": [ { "description": "Opaque cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Opaque cursor from the previous page.", "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Mailboxes", "tags": [ "Access management" ] }, "post": { "operationId": "create_mailbox_access_mailboxes_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailboxCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Create a mailbox", "tags": [ "Access management" ] } }, "/access/mailboxes/{mailbox_id}": { "patch": { "operationId": "update_mailbox_access_mailboxes__mailbox_id__patch", "parameters": [ { "in": "path", "name": "mailbox_id", "required": true, "schema": { "title": "Mailbox Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailboxPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Rename, enable or disable a mailbox", "tags": [ "Access management" ] } }, "/access/permissions": { "get": { "operationId": "list_permissions_access_permissions_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Permission catalogue", "tags": [ "Access management" ] } }, "/access/resources": { "get": { "operationId": "list_resources_access_resources_get", "parameters": [ { "in": "query", "name": "kind", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kind" } }, { "description": "Opaque cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Opaque cursor from the previous page.", "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Resources that can receive assignments", "tags": [ "Access management" ] } }, "/access/roles": { "get": { "operationId": "list_roles_access_roles_get", "parameters": [ { "description": "Opaque cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Opaque cursor from the previous page.", "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Roles", "tags": [ "Access management" ] }, "post": { "operationId": "create_role_access_roles_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Create a custom role", "tags": [ "Access management" ] } }, "/access/roles/{role_id}": { "patch": { "operationId": "update_role_access_roles__role_id__patch", "parameters": [ { "in": "path", "name": "role_id", "required": true, "schema": { "title": "Role Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolePatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Change a custom role", "tags": [ "Access management" ] } }, "/access/sessions": { "get": { "operationId": "list_sessions_access_sessions_get", "parameters": [ { "in": "query", "name": "principal_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Principal Id" } }, { "description": "Opaque cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Opaque cursor from the previous page.", "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Sessions (your own, or another principal with sessions:read)", "tags": [ "Access management" ] } }, "/access/sessions/{session_id}/revoke": { "post": { "operationId": "revoke_session_access_sessions__session_id__revoke_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionRevoke" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Revoke a session", "tags": [ "Access management" ] } }, "/access/users": { "get": { "operationId": "list_users_access_users_get", "parameters": [ { "in": "query", "name": "kind", "required": false, "schema": { "default": "all", "title": "Kind", "type": "string" } }, { "in": "query", "name": "q", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "description": "Opaque cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Opaque cursor from the previous page.", "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Users and integrations", "tags": [ "Access management" ] }, "post": { "operationId": "create_user_access_users_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Create a user with a temporary password", "tags": [ "Access management" ] } }, "/access/users/{principal_id}": { "get": { "operationId": "get_user_access_users__principal_id__get", "parameters": [ { "in": "path", "name": "principal_id", "required": true, "schema": { "title": "Principal Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "One user or integration", "tags": [ "Access management" ] }, "patch": { "operationId": "update_user_access_users__principal_id__patch", "parameters": [ { "in": "path", "name": "principal_id", "required": true, "schema": { "title": "Principal Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Change a user or integration", "tags": [ "Access management" ] } }, "/access/users/{principal_id}/reset-password": { "post": { "operationId": "reset_password_access_users__principal_id__reset_password_post", "parameters": [ { "in": "path", "name": "principal_id", "required": true, "schema": { "title": "Principal Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionedAction" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Reset a password to a temporary one", "tags": [ "Access management" ] } }, "/admin/api-keys": { "get": { "operationId": "admin_list_api_keys_admin_api_keys_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/APIKeyMeta" }, "title": "Response Admin List Api Keys Admin Api Keys Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin List Api Keys" }, "post": { "description": "Issue a key for a new integration identity holding exactly the requested scopes.", "operationId": "admin_create_api_key_admin_api_keys_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAPIKeyIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAPIKeyOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Create Api Key" } }, "/admin/api-keys/{key_id}": { "delete": { "operationId": "admin_revoke_api_key_admin_api_keys__key_id__delete", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Revoke Api Key" } }, "/admin/api-keys/{key_id}/rotate": { "post": { "description": "Replace the secret; the key id, identity and scopes stay the same.", "operationId": "admin_rotate_api_key_admin_api_keys__key_id__rotate_post", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotateAPIKeyOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Rotate Api Key" } }, "/admin/config": { "get": { "description": "Return sanitized effective configuration for operators.\nRequires current settings:read and uses one authorized active snapshot.", "operationId": "get_admin_config_admin_config_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Get Admin Config" } }, "/admin/db-status": { "get": { "operationId": "admin_db_status_admin_db_status_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Admin Db Status" } }, "/admin/diagnostics/engine/{view}": { "get": { "description": "A read-only list from the fax engine: registrations, contacts, calls or faxes.", "operationId": "engine_view_admin_diagnostics_engine__view__get", "parameters": [ { "in": "path", "name": "view", "required": true, "schema": { "title": "View", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Engine View", "tags": [ "Diagnostics" ] } }, "/admin/diagnostics/report": { "get": { "description": "The last diagnostics run, without contacting anything; empty until the first run.", "operationId": "last_report_admin_diagnostics_report_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Last Report", "tags": [ "Diagnostics" ] }, "post": { "description": "Run every check now. Read-only: no fax is sent and nothing is changed.", "operationId": "run_report_admin_diagnostics_report_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Run Report", "tags": [ "Diagnostics" ] } }, "/admin/fax-jobs": { "get": { "operationId": "list_admin_jobs_admin_fax_jobs_get", "parameters": [ { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "backend", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Backend" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "in": "query", "name": "since_hours", "required": false, "schema": { "anyOf": [ { "maximum": 8784, "minimum": 1, "type": "integer" }, { "type": "null" } ], "title": "Since Hours" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Admin Jobs" } }, "/admin/fax-jobs/{job_id}": { "get": { "operationId": "get_admin_job_admin_fax_jobs__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Admin Job" } }, "/admin/fax-jobs/{job_id}/delivery": { "get": { "description": "Bounded evidence from the accepted account, excluding captured secrets.", "operationId": "admin_delivery_history_admin_fax_jobs__job_id__delivery_get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Delivery History" } }, "/admin/fax-jobs/{job_id}/pdf": { "get": { "description": "Download the retained PDF with independent current document permission.", "operationId": "admin_get_job_pdf_admin_fax_jobs__job_id__pdf_get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Get Job Pdf" } }, "/admin/fax-jobs/{job_id}/reconcile": { "post": { "description": "Attach an operator-confirmed receipt; this never authorizes transmission.", "operationId": "admin_bind_provider_identity_admin_fax_jobs__job_id__reconcile_post", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderIdentityConfirmation" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Bind Provider Identity" } }, "/admin/fax-jobs/{job_id}/refresh": { "post": { "description": "Read status from the accepted account without authorizing another send.", "operationId": "admin_refresh_job_admin_fax_jobs__job_id__refresh_post", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Refresh Job" } }, "/admin/forwarded-trust": { "get": { "description": "The certificate authorities you trust for forwarded calls.", "operationId": "list_anchors_admin_forwarded_trust_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Anchors", "tags": [ "Forwarded calls" ] }, "post": { "description": "Trust the certificate authorities in pasted PEM certificates, or in a list at an https:// address you can\nreach (read once, now). Only certificate authorities are kept, each once.", "operationId": "add_anchors_admin_forwarded_trust_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnchorsIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add Anchors", "tags": [ "Forwarded calls" ] } }, "/admin/forwarded-trust/{fingerprint}": { "delete": { "description": "Stop trusting one certificate authority, named by the start of its fingerprint.", "operationId": "remove_anchor_admin_forwarded_trust__fingerprint__delete", "parameters": [ { "in": "path", "name": "fingerprint", "required": true, "schema": { "title": "Fingerprint", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Remove Anchor", "tags": [ "Forwarded calls" ] } }, "/admin/health-status": { "get": { "operationId": "get_health_status_admin_health_status_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Get Health Status" } }, "/admin/inbound/callbacks": { "get": { "operationId": "admin_inbound_callbacks_admin_inbound_callbacks_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Admin Inbound Callbacks" } }, "/admin/inbound/efax": { "get": { "description": "Whether Faxbot is checking eFax for received faxes, and received faxes still stored at eFax.", "operationId": "efax_inbound_status_admin_inbound_efax_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Efax Inbound Status", "tags": [ "Inbound" ] } }, "/admin/inbound/humblefax": { "get": { "description": "Whether Faxbot is checking HumbleFax for received faxes, when it last checked and what it found.", "operationId": "humblefax_inbound_status_admin_inbound_humblefax_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Humblefax Inbound Status", "tags": [ "Inbound" ] } }, "/admin/inbound/humblefax/check": { "post": { "description": "Check HumbleFax for received faxes now, as the next scheduled check would.", "operationId": "humblefax_inbound_check_admin_inbound_humblefax_check_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Humblefax Inbound Check", "tags": [ "Inbound" ] } }, "/admin/inbound/recover": { "post": { "description": "Bring in faxes the SIP trunk received but could not hand to Faxbot; Faxbot also checks every minute.", "operationId": "recover_inbound_admin_inbound_recover_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Recover Inbound", "tags": [ "Inbound" ] } }, "/admin/inbound/simulate": { "post": { "description": "Add a test fax with a real one-page PDF; it is marked as a test everywhere.", "operationId": "admin_inbound_simulate_admin_inbound_simulate_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulateInboundIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Admin Inbound Simulate" } }, "/admin/logs": { "get": { "description": "Return recent audit logs from in-process ring buffer with simple filtering.\nFor persistent logs, configure AUDIT_LOG_FILE and use external tooling; this endpoint focuses on interactive UI needs.", "operationId": "admin_logs_admin_logs_get", "parameters": [ { "in": "query", "name": "q", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "in": "query", "name": "event", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event" } }, { "in": "query", "name": "since", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 200, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Admin Logs" } }, "/admin/logs/tail": { "get": { "description": "Tail the audit log file when AUDIT_LOG_FILE is configured.\nReturns last N lines (default 2000), filtered by substring and/or event name when logs are JSON.", "operationId": "admin_logs_tail_admin_logs_tail_get", "parameters": [ { "in": "query", "name": "q", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "in": "query", "name": "event", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event" } }, { "in": "query", "name": "lines", "required": false, "schema": { "default": 2000, "title": "Lines", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Admin Logs Tail" } }, "/admin/plugins/http/import-manifests": { "post": { "description": "Bulk import provider manifests from a JSON list or Markdown.\nFor markdown, extracts JSON code fences and imports objects that look like manifests.", "operationId": "import_http_manifests_admin_plugins_http_import_manifests_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportManifestsIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "The v3 plugins feature is disabled." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Import Http Manifests" } }, "/admin/plugins/http/install": { "post": { "operationId": "install_http_manifest_admin_plugins_http_install_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManifestIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "The v3 plugins feature is disabled." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Install Http Manifest" } }, "/admin/plugins/http/validate": { "post": { "description": "Validate a draft without issuing a provider request.\n\nProvider transmission belongs to a captured, durable outbound attempt.\nKeep the legacy flag for a clear refusal to older administrative clients.", "operationId": "validate_http_manifest_admin_plugins_http_validate_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManifestValidateIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Validate Http Manifest" } }, "/admin/providers/accounts": { "get": { "operationId": "list_accounts_admin_providers_accounts_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Provider accounts", "tags": [ "Provider accounts" ] }, "post": { "operationId": "add_account_admin_providers_accounts_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add a provider account", "tags": [ "Provider accounts" ] } }, "/admin/providers/accounts/{key}": { "patch": { "operationId": "update_account_admin_providers_accounts__key__patch", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "title": "Key", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Change a provider account", "tags": [ "Provider accounts" ] } }, "/admin/providers/accounts/{key}/health": { "get": { "operationId": "account_health_admin_providers_accounts__key__health_get", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "title": "Key", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "One provider account's health", "tags": [ "Provider accounts" ] } }, "/admin/providers/accounts/{key}/telnyx-fax-application": { "post": { "description": "Create the Fax Application the account sends with, in the account's own Telnyx account, and save its ID.\n\nTelnyx sends the application's fax results to Faxbot's results address. The account must have its API key and\nno Fax Application yet, so a second press never makes a second application.", "operationId": "create_telnyx_fax_application_admin_providers_accounts__key__telnyx_fax_application_post", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "title": "Key", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaxApplicationInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create a Telnyx Fax Application for a Telnyx Fax API account", "tags": [ "Provider accounts" ] } }, "/admin/restart": { "post": { "description": "Optional: restart the API process (for containerized deployments). Controlled by ADMIN_ALLOW_RESTART.", "operationId": "admin_restart_admin_restart_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Admin Restart" } }, "/admin/settings": { "get": { "description": "Read the desired editor revision; credentials remain opaque.", "operationId": "get_admin_settings_admin_settings_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationValidationErrorResponse" } } }, "description": "Invalid configuration input; raw input and error context are omitted." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Get Admin Settings" }, "put": { "description": "Validate and durably apply one candidate, or stage it for coordinated restart.", "operationId": "update_admin_settings_admin_settings_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSettingsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "applied": { "summary": "Confirmed applied configuration", "value": { "_meta": { "active_revision_id": "00000000-0000-4000-8000-000000000001", "apply_state": "applied", "desired_revision_id": "00000000-0000-4000-8000-000000000001", "generation": 2, "restart_recommended": false }, "changed": true, "ok": true } }, "pending_restart": { "summary": "Confirmed desired configuration pending restart", "value": { "_meta": { "active_revision_id": "00000000-0000-4000-8000-000000000001", "apply_state": "pending_restart", "desired_revision_id": "00000000-0000-4000-8000-000000000002", "generation": 3, "restart_recommended": true }, "changed": true, "ok": true } } }, "schema": { "$ref": "#/components/schemas/ConfigurationWriteResponse" } } }, "description": "Confirmed canonical write receipt; read configuration values separately." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration or provider metadata could not be validated." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration changed. Reload before applying edits." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationValidationErrorResponse" } } }, "description": "Invalid configuration input; raw input and error context are omitted." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Update Admin Settings" } }, "/admin/settings/export": { "get": { "description": "Display the complete desired configuration with opaque secret placeholders.", "operationId": "export_settings_env_admin_settings_export_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationValidationErrorResponse" } } }, "description": "Invalid configuration input; raw input and error context are omitted." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Export Settings Env" } }, "/admin/settings/persist": { "post": { "deprecated": true, "description": "Deprecated: removed in the next release; back up with `faxbot admin backup` instead.\n\nAtomically export desired settings to the installation's private recovery file.\n\nRestoring historical jobs also requires the database and original installation\nkey. This export does not activate settings or change the canonical store.", "operationId": "persist_settings_admin_settings_persist_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistSettingsIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationValidationErrorResponse" } } }, "description": "Invalid configuration input; raw input and error context are omitted." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Persist Settings" } }, "/admin/settings/reload": { "post": { "description": "Read durable active/desired state without importing environment or promoting it.", "operationId": "admin_reload_settings_admin_settings_reload_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationValidationErrorResponse" } } }, "description": "Invalid configuration input; raw input and error context are omitted." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Admin Reload Settings" } }, "/admin/settings/validate": { "post": { "description": "Validate connectivity/non-destructive checks for the selected backend.", "operationId": "validate_settings_admin_settings_validate_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateSettingsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationValidationErrorResponse" } } }, "description": "Invalid configuration input; raw input and error context are omitted." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Validate Settings" } }, "/admin/sip/apply": { "post": { "description": "Write the trunk configuration Asterisk loads when it starts.", "operationId": "apply_admin_sip_apply_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Apply", "tags": [ "SIP trunk" ] } }, "/admin/sip/calls": { "get": { "description": "Recent trunk calls, newest first; pass next_cursor to read further back.", "operationId": "calls_admin_sip_calls_get", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "direction", "required": false, "schema": { "anyOf": [ { "pattern": "^(outbound|inbound)$", "type": "string" }, { "type": "null" } ], "title": "Direction" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Calls", "tags": [ "SIP trunk" ] } }, "/admin/sip/copiers": { "get": { "description": "Which copier makers document SIP fax with T.38, with what to set and where it was read, and your copier\nextensions.", "operationId": "copier_catalog_admin_sip_copiers_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Copier Catalog", "tags": [ "SIP trunk" ] } }, "/admin/sip/copiers/extensions": { "post": { "description": "A copier's own extension and sending key. The password is in this answer only; enter it on the copier.", "operationId": "add_extension_admin_sip_copiers_extensions_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionIn" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add Extension", "tags": [ "SIP trunk" ] } }, "/admin/sip/copiers/extensions/{copier_id}/remove": { "post": { "operationId": "remove_extension_admin_sip_copiers_extensions__copier_id__remove_post", "parameters": [ { "in": "path", "name": "copier_id", "required": true, "schema": { "title": "Copier Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Remove Extension", "tags": [ "SIP trunk" ] } }, "/admin/sip/copiers/received/{inbound_id}": { "get": { "description": "Whether a received fax was sent on to a copier, for anyone who may read that fax.", "operationId": "received_view_admin_sip_copiers_received__inbound_id__get", "parameters": [ { "in": "path", "name": "inbound_id", "required": true, "schema": { "title": "Inbound Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Received View", "tags": [ "SIP trunk" ] } }, "/admin/sip/engine/restart": { "post": { "description": "Restart the fax engine: it starts again as soon as no fax is going through (the engine reads\nthe request; Asterisk and the trunk settings are left as they are).", "operationId": "restart_engine_admin_sip_engine_restart_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Restart Engine", "tags": [ "SIP trunk" ] } }, "/admin/sip/negotiation": { "get": { "description": "Delivery setup → the trunk page: calls per compression, error correction and speed over 7, 30 or 90 days.", "operationId": "negotiation_summary_admin_sip_negotiation_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Negotiation Summary" } }, "/admin/sip/negotiation/received/{inbound_id}": { "get": { "description": "Faxes → Received, a fax's detail: what its call negotiated, for anyone who may read that fax.\n\nThe fax's own read check comes first, as for the detail (GET /inbound/{id}): someone who may not read\nthe fax gets the detail's answer, so this route never shows that the fax exists.", "operationId": "received_negotiation_admin_sip_negotiation_received__inbound_id__get", "parameters": [ { "in": "path", "name": "inbound_id", "required": true, "schema": { "title": "Inbound Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Received Negotiation" } }, "/admin/sip/network": { "get": { "description": "Whether T.38 fax data can come back through this network, where Faxbot runs, and what to do about it.", "operationId": "network_check_admin_sip_network_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Network Check", "tags": [ "SIP trunk" ] } }, "/admin/sip/network/check": { "post": { "description": "Check the network for fax over IP now; Faxbot turns T.38 on or off for new calls when the check says so.", "operationId": "check_network_again_admin_sip_network_check_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Check Network Again", "tags": [ "SIP trunk" ] } }, "/admin/sip/presets": { "get": { "description": "Carrier presets with their documented settings and sources.", "operationId": "presets_admin_sip_presets_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Presets", "tags": [ "SIP trunk" ] } }, "/admin/sip/send-only": { "get": { "description": "Send-only numbers (shown on faxes you send, never received on here) and numbers rented only to send from.", "operationId": "send_only_numbers_admin_sip_send_only_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Send Only Numbers", "tags": [ "SIP trunk" ] }, "put": { "description": "Save the send-only numbers; a number one of your accounts receives on is refused with the reason.", "operationId": "set_send_only_numbers_admin_sip_send_only_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendOnlyBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Send Only Numbers", "tags": [ "SIP trunk" ] } }, "/admin/sip/status": { "get": { "description": "Trunk registration and carrier reachability as Asterisk reports them; never includes secrets.\n\n``account`` names one trunk account (``faxbot delivery providers trunk status --account``); none is the first trunk.", "operationId": "status_admin_sip_status_get", "parameters": [ { "in": "query", "name": "account", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Account" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Status", "tags": [ "SIP trunk" ] } }, "/admin/sip/telnyx": { "get": { "description": "Whether Telnyx accepts fax over IP (T.38) on the trunk's numbers, from the last check (one trunk account).", "operationId": "telnyx_check_admin_sip_telnyx_get", "parameters": [ { "in": "query", "name": "account", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Account" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Telnyx Check", "tags": [ "SIP trunk" ] } }, "/admin/sip/telnyx/names": { "get": { "description": "Whether Telnyx looks up callers' names on each trunk number, what that costs, from the last check.", "operationId": "telnyx_names_admin_sip_telnyx_names_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Telnyx Names", "tags": [ "SIP trunk" ] } }, "/admin/sip/telnyx/numbers/{number}/name-lookup-off": { "post": { "description": "Turn off Telnyx's caller-name lookup for one trunk number, then read it back; changes nothing else.\n\nA number that is not one of the trunk's is refused before anything else. Every other request leaves one\naudit row naming the number and the result (turned_off, still_on, refused, not_found or unreachable).", "operationId": "telnyx_turn_off_name_lookup_admin_sip_telnyx_numbers__number__name_lookup_off_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Telnyx Turn Off Name Lookup", "tags": [ "SIP trunk" ] } }, "/admin/sip/telnyx/numbers/{number}/t38": { "post": { "description": "Turn on Telnyx's T.38 fax gateway for one trunk number, then read it back; changes nothing else.\n\nA number that is not one of the trunk's is refused before anything else. Every other request leaves one\naudit row naming the number and the result (turned_on, still_off, refused, not_found or unreachable).", "operationId": "telnyx_turn_on_t38_admin_sip_telnyx_numbers__number__t38_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "in": "query", "name": "account", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Account" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Telnyx Turn On T38", "tags": [ "SIP trunk" ] } }, "/admin/terminal/ticket": { "post": { "description": "A ticket, valid once for 60 seconds, that opens one terminal WebSocket as the caller.", "operationId": "admin_terminal_ticket_admin_terminal_ticket_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminalTicketOut" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Admin Terminal Ticket" } }, "/admin/tunnel/pair": { "post": { "description": "A six-digit code, valid once for five minutes, that pairs one phone as a device of this installation.", "operationId": "admin_tunnel_pair_admin_tunnel_pair_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PairOut" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Admin Tunnel Pair" } }, "/analysis": { "get": { "operationId": "get_analysis_analysis_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Analysis" } }, "/analysis/run": { "post": { "operationId": "run_analysis_analysis_run_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "202": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Run Analysis" } }, "/analysis/test": { "post": { "operationId": "test_analysis_analysis_test_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Test Analysis" } }, "/auth/context": { "get": { "description": "Current permission-scoped navigation and active configuration hints. These hints do not authorize later operations; each operation checks current access again.", "operationId": "console_context_auth_context_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsoleContextResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid access request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Console context", "tags": [ "Authentication" ] } }, "/auth/key-login": { "post": { "operationId": "key_login_auth_key_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyLogin" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthSessionResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid access request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Key Login", "tags": [ "Authentication" ] } }, "/auth/login": { "post": { "operationId": "password_login_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordLogin" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthSessionResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid access request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Password Login", "tags": [ "Authentication" ] } }, "/auth/logout": { "post": { "operationId": "logout_auth_logout_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthLogoutResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid access request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Logout", "tags": [ "Authentication" ] } }, "/auth/me": { "get": { "operationId": "me_auth_me_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthMeResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid access request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Me", "tags": [ "Authentication" ] } }, "/auth/owner/enroll": { "post": { "description": "Create a named Owner with a temporary password shown once. Allowed when /auth/me reports can_enroll_owner: the installation bootstrap credential or a complete Owner.", "operationId": "enroll_owner_auth_owner_enroll_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnerEnrollmentInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid access request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Enroll an owner", "tags": [ "Authentication" ] } }, "/auth/password": { "post": { "operationId": "change_password_auth_password_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChange" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthSessionResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid access request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Change Password", "tags": [ "Authentication" ] } }, "/auth/sessions": { "get": { "operationId": "sessions_auth_sessions_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor_time", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Cursor Time" } }, { "in": "query", "name": "cursor_id", "required": false, "schema": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Cursor Id" } }, { "description": "Another principal's sessions (requires sessions:read); omit for your own.", "in": "query", "name": "principal_id", "required": false, "schema": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "description": "Another principal's sessions (requires sessions:read); omit for your own.", "title": "Principal Id" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthSessionPageResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid access request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Sessions", "tags": [ "Authentication" ] } }, "/auth/sessions/{session_id}/revoke": { "post": { "operationId": "revoke_session_auth_sessions__session_id__revoke_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionRevoke" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthSessionRevokeResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid credential or session request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access target not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Access policy changed. Reload and try again." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid access request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Revoke Session", "tags": [ "Authentication" ] } }, "/auth/setup": { "get": { "description": "Public. Whether the installation still has no named Owner, so the sign-in page asks for the installation key that creates the first one. Nothing else is disclosed; once an Owner exists it is false.", "operationId": "sign_in_setup_auth_setup_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthSetupResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication request is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Invalid access request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthErrorResponse" } } }, "description": "Authentication or access service is temporarily unavailable." } }, "summary": "Sign-in setup", "tags": [ "Authentication" ] } }, "/batching/check": { "get": { "description": "Whether a fax to ``to`` would wait to go with others, for the Send page's \"Send now\" choice.", "operationId": "check_batching_check_get", "parameters": [ { "in": "query", "name": "to", "required": true, "schema": { "maxLength": 64, "minLength": 1, "title": "To", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Check", "tags": [ "Sending together" ] } }, "/batching/faxes/{job_id}": { "get": { "description": "A fax's waiting or shared-call details, for anyone who may read that fax.", "operationId": "fax_batching_faxes__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax", "tags": [ "Sending together" ] } }, "/batching/faxes/{job_id}/send-now": { "post": { "description": "Send a waiting fax now; the faxes waiting with it go in the same call. Never sends anything twice.", "operationId": "send_now_batching_faxes__job_id__send_now_post", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Send Now", "tags": [ "Sending together" ] } }, "/batching/numbers/{number}": { "delete": { "operationId": "delete_number_batching_numbers__number__delete", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Number", "tags": [ "Sending together" ] }, "get": { "operationId": "get_number_batching_numbers__number__get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Number", "tags": [ "Sending together" ] }, "put": { "operationId": "put_number_batching_numbers__number__put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__batching__http__NumberSetting" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Number", "tags": [ "Sending together" ] } }, "/caller-check/faxes/{inbound_id}": { "get": { "description": "What Received says about who called, for anyone who may read that fax; nothing when no stamp was kept.", "operationId": "fax_stamp_caller_check_faxes__inbound_id__get", "parameters": [ { "in": "path", "name": "inbound_id", "required": true, "schema": { "title": "Inbound Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax Stamp", "tags": [ "Received faxes" ] } }, "/caller-check/registered": { "get": { "operationId": "get_registered_caller_check_registered_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Registered", "tags": [ "Received faxes" ] }, "put": { "description": "Replace the registered senders for received faxes, as an audited configuration change.", "operationId": "put_registered_caller_check_registered_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registered" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Registered", "tags": [ "Received faxes" ] } }, "/case-checklists": { "get": { "description": "The newest version of each checklist, the synthetic example, and whether suggestions are on.", "operationId": "list_checklists_case_checklists_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Checklists", "tags": [ "Case ledger" ] }, "post": { "description": "Save a checklist; a name already in use gets a new version, and earlier versions never change.", "operationId": "add_checklist_case_checklists_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewChecklist" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add Checklist", "tags": [ "Case ledger" ] } }, "/case-checklists/{name}": { "get": { "description": "One checklist version (the newest unless one is named), with every version and how often each was used.", "operationId": "show_checklist_case_checklists__name__get", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "in": "query", "name": "version", "required": false, "schema": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "title": "Version" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Show Checklist", "tags": [ "Case ledger" ] } }, "/case-recipients/{number}": { "get": { "description": "How long references to documents this recipient acknowledged are trusted.", "operationId": "case_recipient_case_recipients__number__get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Case Recipient", "tags": [ "Case ledger" ] }, "patch": { "description": "Set the reuse period: a number of days, 0 for no limit, or null for Faxbot's default.", "operationId": "update_case_recipient_case_recipients__number__patch", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update Case Recipient", "tags": [ "Case ledger" ] } }, "/cases": { "get": { "description": "The newest cases this installation sent packets for, with recipient and document counts.", "operationId": "recent_cases_cases_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Recent Cases", "tags": [ "Case ledger" ] } }, "/cases/{case_id}/accept": { "post": { "description": "Record that the recipient confirmed it has these documents, with a note or its acknowledgement fax.", "operationId": "accept_documents_cases__case_id__accept_post", "parameters": [ { "in": "path", "name": "case_id", "required": true, "schema": { "title": "Case Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Confirmation" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Accept Documents", "tags": [ "Case ledger" ] } }, "/cases/{case_id}/checklist-packets": { "post": { "description": "Build a packet from a checklist: Faxbot's picks with reasons, missing items, then the confirmed send.", "operationId": "checklist_packet_cases__case_id__checklist_packets_post", "parameters": [ { "in": "path", "name": "case_id", "required": true, "schema": { "title": "Case Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChecklistPacket" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Checklist Packet", "tags": [ "Case ledger" ] } }, "/cases/{case_id}/documents": { "get": { "description": "What this recipient was sent for the case, and what it acknowledged.", "operationId": "case_documents_cases__case_id__documents_get", "parameters": [ { "in": "path", "name": "case_id", "required": true, "schema": { "title": "Case Id", "type": "string" } }, { "in": "query", "name": "to", "required": true, "schema": { "title": "To", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Case Documents", "tags": [ "Case ledger" ] } }, "/cases/{case_id}/faxes": { "post": { "description": "Send a packet: documents the recipient acknowledged are listed on an index page when it accepts that.", "operationId": "send_case_packet_cases__case_id__faxes_post", "parameters": [ { "in": "path", "name": "case_id", "required": true, "schema": { "title": "Case Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_case_packet_cases__case_id__faxes_post" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Send Case Packet", "tags": [ "Case ledger" ] } }, "/cases/{case_id}/invalidate": { "post": { "description": "The recipient could not find these documents: stop referring to them; the next packet sends them in full.", "operationId": "invalidate_documents_cases__case_id__invalidate_post", "parameters": [ { "in": "path", "name": "case_id", "required": true, "schema": { "title": "Case Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Choice" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Invalidate Documents", "tags": [ "Case ledger" ] } }, "/cases/{case_id}/originals": { "get": { "description": "The case's original documents, kept unchanged, with their type, date, source and version.", "operationId": "case_originals_cases__case_id__originals_get", "parameters": [ { "in": "path", "name": "case_id", "required": true, "schema": { "title": "Case Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Case Originals", "tags": [ "Case ledger" ] }, "post": { "description": "Keep documents in the case without sending them, for checklist packets and repairs.", "operationId": "add_case_originals_cases__case_id__originals_post", "parameters": [ { "in": "path", "name": "case_id", "required": true, "schema": { "title": "Case Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_add_case_originals_cases__case_id__originals_post" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add Case Originals", "tags": [ "Case ledger" ] } }, "/cases/{case_id}/repair": { "post": { "description": "Send every document of the case to this recipient again, as a new fax, for the reason a person gives.", "operationId": "repair_packet_cases__case_id__repair_post", "parameters": [ { "in": "path", "name": "case_id", "required": true, "schema": { "title": "Case Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Repair" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Repair Packet", "tags": [ "Case ledger" ] } }, "/certainty/counts": { "get": { "operationId": "counts_certainty_counts_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "How many uncertain sent faxes are open, yours, unassigned and overdue", "tags": [ "Uncertain sent faxes" ] } }, "/certainty/faxes/{fax_id}": { "get": { "operationId": "for_fax_certainty_faxes__fax_id__get", "parameters": [ { "in": "path", "name": "fax_id", "required": true, "schema": { "title": "Fax Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "One sent fax's uncertain outcomes, with the checks", "tags": [ "Uncertain sent faxes" ] } }, "/certainty/items": { "get": { "operationId": "list_items_certainty_items_get", "parameters": [ { "in": "query", "name": "view", "required": false, "schema": { "default": "all", "enum": [ "all", "mine", "unassigned", "overdue" ], "title": "View", "type": "string" } }, { "in": "query", "name": "state", "required": false, "schema": { "default": "open", "enum": [ "open", "settled", "any" ], "title": "State", "type": "string" } }, { "in": "query", "name": "fax_id", "required": false, "schema": { "anyOf": [ { "maxLength": 40, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Fax Id" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Uncertain sent faxes you can see, with their owner and deadline", "tags": [ "Uncertain sent faxes" ] } }, "/certainty/items/{item_id}": { "get": { "operationId": "get_item_certainty_items__item_id__get", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "One uncertain sent fax, with the checks ranked by cost", "tags": [ "Uncertain sent faxes" ] } }, "/certainty/items/{item_id}/assign": { "post": { "operationId": "assign_certainty_items__item_id__assign_post", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Give an uncertain sent fax to an owner", "tags": [ "Uncertain sent faxes" ] } }, "/certainty/items/{item_id}/assignees": { "get": { "operationId": "assignees_certainty_items__item_id__assignees_get", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "People who can see this fax and so can own it", "tags": [ "Uncertain sent faxes" ] } }, "/certainty/items/{item_id}/history": { "get": { "operationId": "history_certainty_items__item_id__history_get", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "An item's history, oldest first", "tags": [ "Uncertain sent faxes" ] } }, "/certainty/items/{item_id}/receipt-query": { "get": { "operationId": "draft_query_certainty_items__item_id__receipt_query_get", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/pdf": {} }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "The one-page receipt query, to check before sending", "tags": [ "Uncertain sent faxes" ] }, "post": { "operationId": "send_query_certainty_items__item_id__receipt_query_post", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__work__certainty_http__VersionIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Send the one-page receipt query to the recipient", "tags": [ "Uncertain sent faxes" ] } }, "/certainty/items/{item_id}/settle": { "post": { "operationId": "settle_certainty_items__item_id__settle_post", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettleIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Settle what happened: delivered, not delivered, or can't tell", "tags": [ "Uncertain sent faxes" ] } }, "/certainty/settings": { "get": { "operationId": "get_settings_certainty_settings_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Who settles uncertain sent faxes when the sender cannot, and how soon", "tags": [ "Uncertain sent faxes" ] }, "put": { "operationId": "put_settings_certainty_settings_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__work__certainty_http__SettingsIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Change the fallback person and the hours to settle an uncertain fax", "tags": [ "Uncertain sent faxes" ] } }, "/codec/numbers/{number}": { "delete": { "operationId": "delete_number_codec_numbers__number__delete", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Number", "tags": [ "Encoded pages (experimental)" ] }, "get": { "operationId": "get_number_codec_numbers__number__get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Number", "tags": [ "Encoded pages (experimental)" ] }, "put": { "operationId": "put_number_codec_numbers__number__put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__codec__http__NumberSetting" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Number", "tags": [ "Encoded pages (experimental)" ] } }, "/codec/received/{inbound_id}": { "get": { "description": "Check a received document once, or retry a failure after shared-key settings change.", "operationId": "received_codec_received__inbound_id__get", "parameters": [ { "in": "path", "name": "inbound_id", "required": true, "schema": { "title": "Inbound Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Received", "tags": [ "Encoded pages (experimental)" ] } }, "/codec/received/{inbound_id}/document": { "get": { "operationId": "received_document_codec_received__inbound_id__document_get", "parameters": [ { "in": "path", "name": "inbound_id", "required": true, "schema": { "title": "Inbound Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Received Document", "tags": [ "Encoded pages (experimental)" ] } }, "/continuations/faxes/{fax_id}": { "get": { "operationId": "for_fax_continuations_faxes__fax_id__get", "parameters": [ { "in": "path", "name": "fax_id", "required": true, "schema": { "title": "Fax Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Whether a fax that broke part way can send only its remaining pages", "tags": [ "Continuations" ] }, "post": { "description": "A person's request; the fax ID of the new fax comes from the broken call, so a repeat sends nothing more.\n\nA fax waiting to be settled is settled as not delivered with the new fax (its ``reason`` and ``version``\nare needed then, as for settling).", "operationId": "send_rest_continuations_faxes__fax_id__post", "parameters": [ { "in": "path", "name": "fax_id", "required": true, "schema": { "title": "Fax Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContinueIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Send only the remaining pages of a fax that broke part way, as a new fax", "tags": [ "Continuations" ] } }, "/court/deadline": { "post": { "description": "A deadline worked out from a fax service date, extended by two court days; for anyone signed in.", "operationId": "extend_deadline_court_deadline_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeadlineIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Extend Deadline", "tags": [ "Court profile" ] } }, "/court/faxes/{job_id}": { "get": { "description": "What Sent details say about a court fax, for anyone who may read that fax; ``court`` None otherwise.", "operationId": "fax_view_court_faxes__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax View", "tags": [ "Court profile" ] } }, "/court/faxes/{job_id}/record": { "get": { "description": "The court fax's transmission record with a draft proof, as a PDF, for anyone who may read that fax.", "operationId": "fax_record_court_faxes__job_id__record_get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax Record", "tags": [ "Court profile" ] } }, "/court/profile": { "get": { "operationId": "get_profile_court_profile_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Profile", "tags": [ "Court profile" ] } }, "/court/profile/attachments": { "put": { "operationId": "put_attachment_court_profile_attachments_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Attachment", "tags": [ "Court profile" ] } }, "/diagnostics/test-lines": { "get": { "operationId": "get_test_lines_diagnostics_test_lines_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Test Lines", "tags": [ "Diagnostics" ] } }, "/diagnostics/test-lines/replies": { "get": { "operationId": "get_replies_diagnostics_test_lines_replies_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Replies", "tags": [ "Diagnostics" ] } }, "/diagnostics/test-lines/sends/{send_id}": { "get": { "operationId": "get_send_diagnostics_test_lines_sends__send_id__get", "parameters": [ { "in": "path", "name": "send_id", "required": true, "schema": { "title": "Send Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Send", "tags": [ "Diagnostics" ] } }, "/diagnostics/test-lines/sends/{send_id}/receipt": { "get": { "description": "Faxbeep's public page for this test fax, looked up in Faxbeep's public API now (nothing is sent there).", "operationId": "get_receipt_diagnostics_test_lines_sends__send_id__receipt_get", "parameters": [ { "in": "path", "name": "send_id", "required": true, "schema": { "title": "Send Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Receipt", "tags": [ "Diagnostics" ] } }, "/diagnostics/test-lines/sends/{send_id}/reply": { "post": { "operationId": "mark_reply_diagnostics_test_lines_sends__send_id__reply_post", "parameters": [ { "in": "path", "name": "send_id", "required": true, "schema": { "title": "Send Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Mark Reply", "tags": [ "Diagnostics" ] } }, "/diagnostics/test-lines/{line_id}/send": { "post": { "description": "Send one test fax to a public test line: your explicit action (you also need to be allowed to send faxes).\nFaxbot never sends one by itself.", "operationId": "send_test_fax_diagnostics_test_lines__line_id__send_post", "parameters": [ { "in": "path", "name": "line_id", "required": true, "schema": { "title": "Line Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Send Test Fax", "tags": [ "Diagnostics" ] } }, "/digital/accounts": { "get": { "operationId": "list_accounts_digital_accounts_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "HISP accounts and FHIR clients", "tags": [ "Direct and FHIR" ] }, "post": { "operationId": "add_account_digital_accounts_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalAccountInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add a HISP account or FHIR client", "tags": [ "Direct and FHIR" ] } }, "/digital/accounts/{key}": { "patch": { "operationId": "update_account_digital_accounts__key__patch", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "title": "Key", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalAccountPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Change a HISP account or FHIR client", "tags": [ "Direct and FHIR" ] } }, "/digital/accounts/{key}/signing-key": { "post": { "operationId": "make_signing_key_digital_accounts__key__signing_key_post", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "title": "Key", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SigningKeyInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Make a FHIR client's signing key", "tags": [ "Direct and FHIR" ] } }, "/digital/accounts/{key}/trust-bundle": { "post": { "operationId": "load_trust_bundle_digital_accounts__key__trust_bundle_post", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "title": "Key", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrustBundleInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Load a HISP account's trust bundle", "tags": [ "Direct and FHIR" ] } }, "/digital/faxes/{job_id}": { "get": { "operationId": "fax_messages_digital_faxes__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "A sent fax's Direct message or FHIR document", "tags": [ "Direct and FHIR" ] } }, "/digital/jwks/{key}": { "get": { "description": "Public keys only, served without a key so the recipient's system can register this address.", "operationId": "public_keys_digital_jwks__key__get", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "title": "Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "A FHIR client's public key set", "tags": [ "Direct and FHIR" ] } }, "/digital/messages": { "get": { "operationId": "list_messages_digital_messages_get", "parameters": [ { "in": "query", "name": "direction", "required": false, "schema": { "anyOf": [ { "enum": [ "out", "in" ], "type": "string" }, { "type": "null" } ], "title": "Direction" } }, { "in": "query", "name": "kind", "required": false, "schema": { "anyOf": [ { "enum": [ "direct", "fhir" ], "type": "string" }, { "type": "null" } ], "title": "Kind" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Direct messages and FHIR documents sent and received", "tags": [ "Direct and FHIR" ] } }, "/digital/recipients/{number}": { "get": { "operationId": "get_recipient_digital_recipients__number__get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "A recipient's Direct address and FHIR endpoint", "tags": [ "Direct and FHIR" ] }, "post": { "operationId": "add_address_digital_recipients__number__post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add a recipient's Direct address or FHIR endpoint", "tags": [ "Direct and FHIR" ] } }, "/digital/recipients/{number}/addresses/{address_id}": { "post": { "operationId": "change_address_digital_recipients__number__addresses__address_id__post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "in": "path", "name": "address_id", "required": true, "schema": { "title": "Address Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressChange" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Confirm, withdraw or dismiss an address", "tags": [ "Direct and FHIR" ] } }, "/digital/recipients/{number}/nppes": { "post": { "description": "One read of the public NPI registry. What it lists for this number is filed as suggestions, never used.", "operationId": "nppes_suggestions_digital_recipients__number__nppes_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NppesInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Suggest addresses from the NPI registry", "tags": [ "Direct and FHIR" ] } }, "/direct/admission": { "get": { "description": "Line windows and preflight with partners: your receiving settings, each partner's choice, the windows issued\nand received, the preflight answers, and the measured retry picture.", "operationId": "admission_view_direct_admission_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admission View", "tags": [ "Direct delivery" ] } }, "/direct/admission/faxes/{job_id}": { "get": { "description": "What Sent details say about one fax's preflight answer and line window, for anyone who may read that fax.", "operationId": "admission_fax_direct_admission_faxes__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admission Fax", "tags": [ "Direct delivery" ] } }, "/direct/admission/grants": { "post": { "description": "A partner's signed request for a line window for one fax; answered with a signed window.", "operationId": "receive_grant_request_direct_admission_grants_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Receive Grant Request", "tags": [ "Direct delivery" ] } }, "/direct/admission/partners/{peer_id}": { "put": { "operationId": "save_admission_partner_direct_admission_partners__peer_id__put", "parameters": [ { "in": "path", "name": "peer_id", "required": true, "schema": { "title": "Peer Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmissionPartnerIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Save Admission Partner", "tags": [ "Direct delivery" ] } }, "/direct/admission/settings": { "put": { "operationId": "save_admission_settings_direct_admission_settings_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmissionSettingsIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Save Admission Settings", "tags": [ "Direct delivery" ] } }, "/direct/calls/pages": { "post": { "description": "A partner asks, signed, which pages of a broken fax call from it arrived here intact.", "operationId": "call_pages_direct_calls_pages_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__direct__transfer_http__SignedIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Call Pages", "tags": [ "Direct delivery" ] } }, "/direct/capabilities": { "post": { "description": "A partner's signed statement of what it accepts from this installation now (fax images).", "operationId": "receive_capabilities_direct_capabilities_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Receive Capabilities", "tags": [ "Direct delivery" ] } }, "/direct/card": { "get": { "operationId": "own_card_direct_card_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Own Card", "tags": [ "Direct delivery" ] } }, "/direct/deliveries": { "get": { "operationId": "list_deliveries_direct_deliveries_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Deliveries", "tags": [ "Direct delivery" ] }, "post": { "description": "Multipart fields ``manifest`` and ``signature`` and file ``document``.\n\nThe body is bounded before it is parsed, because the caller is not yet\nauthenticated: the signature is checked against the enrolled partner after.", "operationId": "receive_delivery_direct_deliveries_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Receive Delivery", "tags": [ "Direct delivery" ] } }, "/direct/deliveries/{message_id}": { "get": { "operationId": "delivery_status_direct_deliveries__message_id__get", "parameters": [ { "in": "path", "name": "message_id", "required": true, "schema": { "title": "Message Id", "type": "string" } }, { "in": "header", "name": "x-faxbot-direct-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Key" } }, { "in": "header", "name": "x-faxbot-direct-time", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Time" } }, { "in": "header", "name": "x-faxbot-direct-signature", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Signature" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delivery Status", "tags": [ "Direct delivery" ] } }, "/direct/discovery": { "get": { "operationId": "read_discovery_direct_discovery_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Read Discovery", "tags": [ "Direct delivery" ] } }, "/direct/discovery/introductions": { "post": { "description": "Introduce two partners who both agreed; each gets a signed hint about the other.", "operationId": "introduce_direct_discovery_introductions_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntroduceIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Introduce", "tags": [ "Direct delivery" ] } }, "/direct/discovery/lookup": { "post": { "description": "Look a number up in the trusted directories now.", "operationId": "look_up_number_direct_discovery_lookup_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Look Up Number", "tags": [ "Direct delivery" ] } }, "/direct/discovery/partners/{peer_id}/may-introduce": { "post": { "description": "Whether this partner may be introduced to your other partners (off by default).", "operationId": "set_may_introduce_direct_discovery_partners__peer_id__may_introduce_post", "parameters": [ { "in": "path", "name": "peer_id", "required": true, "schema": { "title": "Peer Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set May Introduce", "tags": [ "Direct delivery" ] } }, "/direct/discovery/publications": { "post": { "description": "The signed DNS record that publishes your number in a directory you control; Faxbot never writes DNS.", "operationId": "publish_direct_discovery_publications_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishIn" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Publish", "tags": [ "Direct delivery" ] } }, "/direct/discovery/publications/{publication_id}/check": { "post": { "operationId": "check_publication_direct_discovery_publications__publication_id__check_post", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Check Publication", "tags": [ "Direct delivery" ] } }, "/direct/discovery/publications/{publication_id}/withdraw": { "post": { "operationId": "withdraw_publication_direct_discovery_publications__publication_id__withdraw_post", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Withdraw Publication", "tags": [ "Direct delivery" ] } }, "/direct/discovery/settings": { "put": { "operationId": "save_settings_direct_discovery_settings_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__direct__discovery_http__SettingsIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Save Settings", "tags": [ "Direct delivery" ] } }, "/direct/discovery/suggestions/{suggestion_id}/dismiss": { "post": { "operationId": "dismiss_suggestion_direct_discovery_suggestions__suggestion_id__dismiss_post", "parameters": [ { "in": "path", "name": "suggestion_id", "required": true, "schema": { "title": "Suggestion Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Dismiss Suggestion", "tags": [ "Direct delivery" ] } }, "/direct/discovery/suggestions/{suggestion_id}/enroll": { "post": { "description": "Enroll a suggested recipient; it still has to be verified with a code by fax.", "operationId": "enroll_suggestion_direct_discovery_suggestions__suggestion_id__enroll_post", "parameters": [ { "in": "path", "name": "suggestion_id", "required": true, "schema": { "title": "Suggestion Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Enroll Suggestion", "tags": [ "Direct delivery" ] } }, "/direct/distribution/statements": { "post": { "description": "A partner's signed \"send once\" offer, acceptance or withdrawal.", "operationId": "receive_distribution_statement_direct_distribution_statements_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__direct__send_once_http__SignedIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Receive Distribution Statement", "tags": [ "Direct delivery" ] } }, "/direct/distributions": { "post": { "description": "A send's first document with the signed list of every recipient: multipart ``manifest``, ``signature``,\n``routing``, ``routing_signature`` and file ``document``.", "operationId": "receive_distribution_direct_distributions_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Receive Distribution", "tags": [ "Direct delivery" ] } }, "/direct/holdings": { "post": { "description": "A partner asks, signed, which documents it delivered here are still held.", "operationId": "receive_holdings_question_direct_holdings_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__direct__send_once_http__SignedIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Receive Holdings Question", "tags": [ "Direct delivery" ] } }, "/direct/introductions": { "post": { "description": "A partner's signed introduction to one of its partners (a hint only; the challenge fax still decides).", "operationId": "receive_introduction_direct_introductions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntroductionIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Receive Introduction", "tags": [ "Direct delivery" ] } }, "/direct/notices": { "get": { "description": "Notice faxes sent and received, with how each was paired; ``fax`` narrows to one received fax.", "operationId": "list_notices_direct_notices_get", "parameters": [ { "in": "query", "name": "fax", "required": false, "schema": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Fax" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Notices", "tags": [ "Direct delivery" ] }, "post": { "description": "A partner's signed link between a notice ID and the document it sends next; that document is held.", "operationId": "receive_notice_link_direct_notices_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__direct__notice_http__SignedIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Receive Notice Link", "tags": [ "Direct delivery" ] } }, "/direct/notices/paired": { "post": { "description": "A partner's signed statement that it paired our notice fax with the original.", "operationId": "receive_notice_paired_direct_notices_paired_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__direct__notice_http__SignedIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Receive Notice Paired", "tags": [ "Direct delivery" ] } }, "/direct/notices/{notice_id}/faxes": { "get": { "description": "Received faxes of one or two pages that may be this document's notice, newest first.", "operationId": "notice_candidates_direct_notices__notice_id__faxes_get", "parameters": [ { "in": "path", "name": "notice_id", "required": true, "schema": { "title": "Notice Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Notice Candidates", "tags": [ "Direct delivery" ] } }, "/direct/notices/{notice_id}/pair": { "post": { "description": "Pair a held document with its notice: the code typed from the page, the received fax, or neither (file it).", "operationId": "pair_notice_direct_notices__notice_id__pair_post", "parameters": [ { "in": "path", "name": "notice_id", "required": true, "schema": { "title": "Notice Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PairIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Pair Notice", "tags": [ "Direct delivery" ] } }, "/direct/patches": { "post": { "description": "A document as the changes to an earlier version this partner delivered: multipart ``manifest``,\n``signature``, ``patch``, ``patch_signature`` and file ``delta``.", "operationId": "receive_patch_direct_patches_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Receive Patch", "tags": [ "Direct delivery" ] } }, "/direct/peers": { "get": { "operationId": "list_peers_direct_peers_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Peers", "tags": [ "Direct delivery" ] }, "post": { "operationId": "enroll_direct_peers_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollIn" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Enroll", "tags": [ "Direct delivery" ] } }, "/direct/peers/{peer_id}/challenge": { "post": { "description": "Send the partner's number a one-page fax with a code they confirm from their Faxbot.", "operationId": "send_challenge_direct_peers__peer_id__challenge_post", "parameters": [ { "in": "path", "name": "peer_id", "required": true, "schema": { "title": "Peer Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Send Challenge", "tags": [ "Direct delivery" ] } }, "/direct/peers/{peer_id}/confirm": { "post": { "description": "Enter the code from a partner's challenge fax; Faxbot proves it to the partner with our key.", "operationId": "confirm_partner_code_direct_peers__peer_id__confirm_post", "parameters": [ { "in": "path", "name": "peer_id", "required": true, "schema": { "title": "Peer Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Confirm Partner Code", "tags": [ "Direct delivery" ] } }, "/direct/peers/{peer_id}/fax-images": { "post": { "description": "Accept fax images from this partner, or stop; the partner is told with a signed statement.", "operationId": "set_fax_images_direct_peers__peer_id__fax_images_post", "parameters": [ { "in": "path", "name": "peer_id", "required": true, "schema": { "title": "Peer Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaxImagesIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Fax Images", "tags": [ "Direct delivery" ] } }, "/direct/peers/{peer_id}/notice-fax": { "post": { "description": "Send each original to this partner directly with a one-page notice by fax (for intakes that need a fax event).", "operationId": "set_notice_fax_direct_peers__peer_id__notice_fax_post", "parameters": [ { "in": "path", "name": "peer_id", "required": true, "schema": { "title": "Peer Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoticeFaxIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Notice Fax", "tags": [ "Direct delivery" ] } }, "/direct/peers/{peer_id}/peer-calls": { "post": { "description": "Take fax calls from this partner inside the encrypted tunnel, or stop, and its address inside the tunnel.\n\nThe tunnel itself is set up outside Faxbot. The partner is told your choice with a signed statement. The\ntrunk page's Apply writes the partner's endpoint into Asterisk's file (sip_trunk.rendered_configuration) and\nloads it; until then the trunk page says its settings are not applied.", "operationId": "set_peer_calls_direct_peers__peer_id__peer_calls_post", "parameters": [ { "in": "path", "name": "peer_id", "required": true, "schema": { "title": "Peer Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeerCallsIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Peer Calls", "tags": [ "Direct delivery" ] } }, "/direct/peers/{peer_id}/peer-calls/check": { "post": { "description": "Whether a fax to this partner would go inside the tunnel now, checked in the fax engine's own network.", "operationId": "check_peer_calls_direct_peers__peer_id__peer_calls_check_post", "parameters": [ { "in": "path", "name": "peer_id", "required": true, "schema": { "title": "Peer Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Check Peer Calls", "tags": [ "Direct delivery" ] } }, "/direct/peers/{peer_id}/revoke": { "post": { "operationId": "revoke_peer_direct_peers__peer_id__revoke_post", "parameters": [ { "in": "path", "name": "peer_id", "required": true, "schema": { "title": "Peer Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Revoke Peer", "tags": [ "Direct delivery" ] } }, "/direct/peers/{peer_id}/send-once": { "post": { "description": "Let a partner send one copy to your intake, which files it for each of these numbers (signed).", "operationId": "grant_direct_peers__peer_id__send_once_post", "parameters": [ { "in": "path", "name": "peer_id", "required": true, "schema": { "title": "Peer Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__direct__send_once_http__GrantIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Grant", "tags": [ "Direct delivery" ] } }, "/direct/preflight": { "post": { "description": "A partner's signed preflight: whether this installation takes a document class from it now; signed answer.", "operationId": "receive_preflight_direct_preflight_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Receive Preflight", "tags": [ "Direct delivery" ] } }, "/direct/references": { "post": { "description": "A document's signed manifest alone: file the copy of it this partner delivered before.", "operationId": "receive_reference_direct_references_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Receive Reference", "tags": [ "Direct delivery" ] } }, "/direct/regions": { "post": { "description": "A fax image as its sender's new header regions around a page body this partner delivered before: multipart\n``manifest``, ``signature``, ``regions``, ``regions_signature`` and file ``image``.", "operationId": "receive_regions_direct_regions_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Receive Regions", "tags": [ "Direct delivery" ] } }, "/direct/relay/agreements": { "get": { "description": "Every relay agreement, both ways: partners who relay for you, and partners you relay for.", "operationId": "list_agreements_direct_relay_agreements_get", "parameters": [ { "in": "query", "name": "partner", "required": false, "schema": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "Partner" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Agreements", "tags": [ "Partner relay" ] }, "post": { "description": "Offer to send a partner's faxes as local calls here; the partner accepts from their Faxbot.", "operationId": "grant_direct_relay_agreements_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__direct__relay_http__GrantIn" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Grant", "tags": [ "Partner relay" ] } }, "/direct/relay/agreements/{agreement_id}/accept": { "post": { "description": "Accept a partner's offer to relay your faxes; it is active once the partner records it.", "operationId": "accept_direct_relay_agreements__agreement_id__accept_post", "parameters": [ { "in": "path", "name": "agreement_id", "required": true, "schema": { "title": "Agreement Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Accept", "tags": [ "Partner relay" ] } }, "/direct/relay/agreements/{agreement_id}/price": { "post": { "description": "Sign a new price statement from your current rate cards and give it to the partner.", "operationId": "refresh_price_direct_relay_agreements__agreement_id__price_post", "parameters": [ { "in": "path", "name": "agreement_id", "required": true, "schema": { "title": "Agreement Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Refresh Price", "tags": [ "Partner relay" ] } }, "/direct/relay/agreements/{agreement_id}/withdraw": { "post": { "description": "End an agreement at once; faxes already accepted for relaying still go and get their receipts.", "operationId": "withdraw_direct_relay_agreements__agreement_id__withdraw_post", "parameters": [ { "in": "path", "name": "agreement_id", "required": true, "schema": { "title": "Agreement Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Withdraw", "tags": [ "Partner relay" ] } }, "/direct/relay/costs": { "get": { "description": "What each relay agreement carried and cost, on both sides.", "operationId": "relay_costs_direct_relay_costs_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "maximum": 366, "minimum": 1, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Relay Costs", "tags": [ "Partner relay" ] } }, "/direct/relay/faxes": { "get": { "description": "Faxes relayed for partners and sent through partners, newest first.", "operationId": "relayed_faxes_direct_relay_faxes_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "maximum": 366, "minimum": 1, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Relayed Faxes", "tags": [ "Partner relay" ] } }, "/direct/relay/outcomes/{message_id}": { "get": { "description": "A sender asks, signed, what happened to a fax it relayed through this installation.", "operationId": "outcome_direct_relay_outcomes__message_id__get", "parameters": [ { "in": "path", "name": "message_id", "required": true, "schema": { "title": "Message Id", "type": "string" } }, { "in": "header", "name": "x-faxbot-direct-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Key" } }, { "in": "header", "name": "x-faxbot-direct-time", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Time" } }, { "in": "header", "name": "x-faxbot-direct-signature", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Signature" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Outcome", "tags": [ "Partner relay" ] } }, "/direct/relay/partners/{peer_id}/quote": { "post": { "description": "Ask a verified partner, signed, what sending your faxes through them would cost; nothing is relayed.", "operationId": "ask_quote_direct_relay_partners__peer_id__quote_post", "parameters": [ { "in": "path", "name": "peer_id", "required": true, "schema": { "title": "Peer Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__direct__relay_http__QuoteIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Ask Quote", "tags": [ "Partner relay" ] } }, "/direct/relay/recommendations": { "get": { "description": "Partners whose signed local price would have cost less than your own calls lately.", "operationId": "relay_recommendations_direct_relay_recommendations_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "maximum": 366, "minimum": 1, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Relay Recommendations", "tags": [ "Partner relay" ] } }, "/direct/relay/statements": { "post": { "description": "A partner's signed relay statement: an offer, acceptance, withdrawal, price, quote request or receipt.", "operationId": "receive_statement_direct_relay_statements_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Receive Statement", "tags": [ "Partner relay" ] } }, "/direct/repairs": { "get": { "description": "Fax calls to and from partners that broke part way, and how each was completed directly.", "operationId": "list_repairs_direct_repairs_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Repairs", "tags": [ "Direct delivery" ] } }, "/direct/send-once": { "get": { "description": "Every \"send once\" agreement, both ways: partners whose intake files your faxes, and yours for theirs.", "operationId": "list_agreements_direct_send_once_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Agreements", "tags": [ "Direct delivery" ] } }, "/direct/send-once/{agreement_id}/accept": { "post": { "description": "Accept a partner's offer: your faxes to its numbers then go once to its intake.", "operationId": "accept_direct_send_once__agreement_id__accept_post", "parameters": [ { "in": "path", "name": "agreement_id", "required": true, "schema": { "title": "Agreement Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Accept", "tags": [ "Direct delivery" ] } }, "/direct/send-once/{agreement_id}/withdraw": { "post": { "description": "End an agreement at once; the partner is told, signed. Faxes already accepted stay accepted.", "operationId": "withdraw_direct_send_once__agreement_id__withdraw_post", "parameters": [ { "in": "path", "name": "agreement_id", "required": true, "schema": { "title": "Agreement Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Withdraw", "tags": [ "Direct delivery" ] } }, "/direct/transfers": { "get": { "description": "Documents sent to and received from partners in pieces, with how many pieces each side holds.", "operationId": "list_transfers_direct_transfers_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Transfers", "tags": [ "Direct delivery" ] }, "post": { "description": "Preflight: the signed manifest and the signed list of pieces, before any document byte.", "operationId": "open_transfer_direct_transfers_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Open Transfer", "tags": [ "Direct delivery" ] } }, "/direct/transfers/{message_id}": { "get": { "description": "What this installation holds of a transfer: the missing pieces by sequence and SHA-256. Never a fence.", "operationId": "transfer_state_direct_transfers__message_id__get", "parameters": [ { "in": "path", "name": "message_id", "required": true, "schema": { "title": "Message Id", "type": "string" } }, { "in": "header", "name": "x-faxbot-direct-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Key" } }, { "in": "header", "name": "x-faxbot-direct-time", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Time" } }, { "in": "header", "name": "x-faxbot-direct-signature", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Signature" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Transfer State", "tags": [ "Direct delivery" ] } }, "/direct/transfers/{message_id}/commit": { "post": { "description": "Assemble the document from its pieces and accept it once; the same receipt as a single delivery.", "operationId": "commit_transfer_direct_transfers__message_id__commit_post", "parameters": [ { "in": "path", "name": "message_id", "required": true, "schema": { "title": "Message Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__direct__transfer_http__SignedIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Commit Transfer", "tags": [ "Direct delivery" ] } }, "/direct/transfers/{message_id}/pieces/{sequence}": { "put": { "description": "One piece at its offset, signed by the partner that opened the transfer.", "operationId": "put_piece_direct_transfers__message_id__pieces__sequence__put", "parameters": [ { "in": "path", "name": "message_id", "required": true, "schema": { "title": "Message Id", "type": "string" } }, { "in": "path", "name": "sequence", "required": true, "schema": { "title": "Sequence", "type": "integer" } }, { "in": "header", "name": "upload-offset", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Upload-Offset" } }, { "in": "header", "name": "x-faxbot-piece-sha256", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Piece-Sha256" } }, { "in": "header", "name": "x-faxbot-direct-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Key" } }, { "in": "header", "name": "x-faxbot-direct-time", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Time" } }, { "in": "header", "name": "x-faxbot-direct-signature", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Signature" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Piece", "tags": [ "Direct delivery" ] } }, "/direct/verifications": { "post": { "operationId": "receive_verification_direct_verifications_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Receive Verification", "tags": [ "Direct delivery" ] } }, "/efax-inbound": { "post": { "description": "eFax's notification that a fax arrived: with a valid signature, check eFax now.", "operationId": "efax_inbound_efax_inbound_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Efax Inbound", "tags": [ "Inbound" ] } }, "/efax-inbound/{key}": { "post": { "description": "eFax's notification for one eFax account, signed with that account's notification secret.", "operationId": "efax_account_inbound_efax_inbound__key__post", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "title": "Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Efax Account Inbound", "tags": [ "Inbound" ] } }, "/expected-faxes": { "get": { "operationId": "list_expected_expected_faxes_get", "parameters": [ { "in": "query", "name": "view", "required": false, "schema": { "default": "waiting", "enum": [ "waiting", "overdue", "proposed", "missing", "conflicts", "closed", "all" ], "title": "View", "type": "string" } }, { "in": "query", "name": "mailbox", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Mailbox" } }, { "in": "query", "name": "search", "required": false, "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Expected faxes you can see, with their state and due time", "tags": [ "Expected faxes" ] }, "post": { "operationId": "add_expected_expected_faxes_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpectIn" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Expect a fax: record what should arrive, from whom and by when", "tags": [ "Expected faxes" ] } }, "/expected-faxes/counts": { "get": { "operationId": "expected_counts_expected_faxes_counts_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "How many expected faxes you can see in each state", "tags": [ "Expected faxes" ] } }, "/expected-faxes/imports": { "get": { "operationId": "list_imports_expected_faxes_imports_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Recent imports of expected faxes", "tags": [ "Expected faxes" ] }, "post": { "operationId": "create_import_expected_faxes_imports_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_create_import_expected_faxes_imports_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import an open-work export (CSV or JSON) through a saved source", "tags": [ "Expected faxes" ] } }, "/expected-faxes/mailboxes": { "get": { "operationId": "expected_mailboxes_expected_faxes_mailboxes_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Mailboxes where you may add expected faxes", "tags": [ "Expected faxes" ] } }, "/expected-faxes/outages": { "get": { "operationId": "list_outages_expected_faxes_outages_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Declared outages of the systems expected faxes come from", "tags": [ "Expected faxes" ] }, "post": { "operationId": "start_outage_expected_faxes_outages_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutageIn" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Mark a source system down", "tags": [ "Expected faxes" ] } }, "/expected-faxes/outages/{outage_id}": { "get": { "operationId": "get_outage_expected_faxes_outages__outage_id__get", "parameters": [ { "in": "path", "name": "outage_id", "required": true, "schema": { "title": "Outage Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "One outage: what was done during it and the reconciliation lists", "tags": [ "Expected faxes" ] } }, "/expected-faxes/outages/{outage_id}/actions": { "post": { "operationId": "record_action_expected_faxes_outages__outage_id__actions_post", "parameters": [ { "in": "path", "name": "outage_id", "required": true, "schema": { "title": "Outage Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Record what was done by fax, email or phone during an outage", "tags": [ "Expected faxes" ] } }, "/expected-faxes/outages/{outage_id}/end": { "post": { "operationId": "end_outage_expected_faxes_outages__outage_id__end_post", "parameters": [ { "in": "path", "name": "outage_id", "required": true, "schema": { "title": "Outage Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutageEndIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Mark a source system back", "tags": [ "Expected faxes" ] } }, "/expected-faxes/outages/{outage_id}/reconcile": { "post": { "operationId": "reconcile_outage_expected_faxes_outages__outage_id__reconcile_post", "parameters": [ { "in": "path", "name": "outage_id", "required": true, "schema": { "title": "Outage Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Sort the export imported after an outage into three lists", "tags": [ "Expected faxes" ] } }, "/expected-faxes/report": { "get": { "operationId": "expected_report_expected_faxes_report_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "maximum": 365, "minimum": 1, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "What is still missing and which received faxes answered nothing", "tags": [ "Expected faxes" ] } }, "/expected-faxes/sources": { "get": { "operationId": "list_sources_expected_faxes_sources_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Saved import sources and their column mappings", "tags": [ "Expected faxes" ] }, "post": { "operationId": "save_source_expected_faxes_sources_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__work__expectation_http__SourceIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Save an import source and its column mapping", "tags": [ "Expected faxes" ] } }, "/expected-faxes/{expected_id}": { "get": { "operationId": "get_expected_expected_faxes__expected_id__get", "parameters": [ { "in": "path", "name": "expected_id", "required": true, "schema": { "title": "Expected Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "One expected fax", "tags": [ "Expected faxes" ] } }, "/expected-faxes/{expected_id}/close": { "post": { "operationId": "close_expected_expected_faxes__expected_id__close_post", "parameters": [ { "in": "path", "name": "expected_id", "required": true, "schema": { "title": "Expected Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloseIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Cancel it, or record that it was completed another way", "tags": [ "Expected faxes" ] } }, "/expected-faxes/{expected_id}/confirm": { "post": { "operationId": "confirm_expected_expected_faxes__expected_id__confirm_post", "parameters": [ { "in": "path", "name": "expected_id", "required": true, "schema": { "title": "Expected Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Confirm that a proposed received fax answers it", "tags": [ "Expected faxes" ] } }, "/expected-faxes/{expected_id}/conflict": { "post": { "operationId": "resolve_conflict_expected_faxes__expected_id__conflict_post", "parameters": [ { "in": "path", "name": "expected_id", "required": true, "schema": { "title": "Expected Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Keep the first version of an imported row, or use the import's", "tags": [ "Expected faxes" ] } }, "/expected-faxes/{expected_id}/export": { "get": { "operationId": "export_expected_expected_faxes__expected_id__export_get", "parameters": [ { "in": "path", "name": "expected_id", "required": true, "schema": { "title": "Expected Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/zip": {} }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Download evidence for an expected fax as a zip", "tags": [ "Expected faxes" ] } }, "/expected-faxes/{expected_id}/history": { "get": { "operationId": "expected_history_expected_faxes__expected_id__history_get", "parameters": [ { "in": "path", "name": "expected_id", "required": true, "schema": { "title": "Expected Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "An expected fax's history, oldest first", "tags": [ "Expected faxes" ] } }, "/expected-faxes/{expected_id}/match": { "post": { "operationId": "match_expected_expected_faxes__expected_id__match_post", "parameters": [ { "in": "path", "name": "expected_id", "required": true, "schema": { "title": "Expected Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Link a received fax to it by hand", "tags": [ "Expected faxes" ] } }, "/expected-faxes/{expected_id}/reject": { "post": { "operationId": "reject_expected_expected_faxes__expected_id__reject_post", "parameters": [ { "in": "path", "name": "expected_id", "required": true, "schema": { "title": "Expected Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Say a proposed received fax does not answer it", "tags": [ "Expected faxes" ] } }, "/fax": { "post": { "operationId": "send_fax_fax_post", "parameters": [ { "description": "Optional key for replaying the same fax request; 1 to 128 printable ASCII characters without spaces.", "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional key for replaying the same fax request; 1 to 128 printable ASCII characters without spaces.", "title": "Idempotency-Key" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_fax_fax_post" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaxJobOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Send Fax" } }, "/fax-machines/iaf": { "get": { "operationId": "list_iaf_fax_machines_iaf_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Iaf", "tags": [ "Their fax machine" ] }, "post": { "description": "Approve a number for Internet Aware Fax: another Faxbot (peer) or an IAF fax server (endpoint).", "operationId": "add_iaf_fax_machines_iaf_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IafBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add Iaf", "tags": [ "Their fax machine" ] } }, "/fax-machines/iaf/{server_id}": { "delete": { "operationId": "remove_iaf_fax_machines_iaf__server_id__delete", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Remove Iaf", "tags": [ "Their fax machine" ] } }, "/fax-machines/numbers/{number}": { "get": { "operationId": "read_fax_machine_fax_machines_numbers__number__get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Read Fax Machine", "tags": [ "Their fax machine" ] } }, "/fax-machines/numbers/{number}/forget": { "post": { "description": "Forget what failed with this number (fax over IP or audio fax, both directions): its next calls use the\nusual settings. What the calls themselves recorded stays.", "operationId": "forget_fax_machine_fax_machines_numbers__number__forget_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Forget Fax Machine", "tags": [ "Their fax machine" ] } }, "/fax/{job_id}": { "get": { "operationId": "get_fax_fax__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaxJobOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Fax" } }, "/fax/{job_id}/pdf": { "get": { "description": "Serve PDF file for cloud backend (e.g., Phaxio) to fetch.\nNo API auth; requires a valid, unexpired per-job token.", "operationId": "get_fax_pdf_fax__job_id__pdf_get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "in": "query", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Fax Pdf" } }, "/forms": { "get": { "operationId": "list_forms_forms_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Forms", "tags": [ "Registered forms" ] }, "post": { "description": "Import a new form from a fillable PDF, or from a PDF or SVG template with a field-position file.", "operationId": "import_form_forms_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_form_forms_post" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import Form", "tags": [ "Registered forms" ] } }, "/forms/deliveries": { "get": { "operationId": "list_deliveries_forms_deliveries_get", "parameters": [ { "in": "query", "name": "direction", "required": false, "schema": { "anyOf": [ { "pattern": "^(outbound|inbound)$", "type": "string" }, { "type": "null" } ], "title": "Direction" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Deliveries", "tags": [ "Registered forms" ] } }, "/forms/deliveries/{delivery_id}": { "get": { "description": "One form sent or received; a sent form's values only with fax:document for it.", "operationId": "get_delivery_forms_deliveries__delivery_id__get", "parameters": [ { "in": "path", "name": "delivery_id", "required": true, "schema": { "title": "Delivery Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Delivery", "tags": [ "Registered forms" ] } }, "/forms/deliveries/{delivery_id}/fax": { "post": { "description": "A person's decision: send the full pages of a form that did not reach the partner as an ordinary fax.", "operationId": "fax_delivery_forms_deliveries__delivery_id__fax_post", "parameters": [ { "in": "path", "name": "delivery_id", "required": true, "schema": { "title": "Delivery Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax Delivery", "tags": [ "Registered forms" ] } }, "/forms/partner/forms/{address}": { "get": { "operationId": "partner_form_forms_partner_forms__address__get", "parameters": [ { "in": "path", "name": "address", "required": true, "schema": { "title": "Address", "type": "string" } }, { "in": "header", "name": "x-faxbot-direct-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Key" } }, { "in": "header", "name": "x-faxbot-direct-time", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Time" } }, { "in": "header", "name": "x-faxbot-direct-signature", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Signature" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Partner Form", "tags": [ "Registered forms" ] } }, "/forms/partner/holdings": { "get": { "operationId": "partner_holdings_forms_partner_holdings_get", "parameters": [ { "in": "header", "name": "x-faxbot-direct-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Key" } }, { "in": "header", "name": "x-faxbot-direct-time", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Time" } }, { "in": "header", "name": "x-faxbot-direct-signature", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Faxbot-Direct-Signature" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Partner Holdings", "tags": [ "Registered forms" ] } }, "/forms/partners/{peer_id}": { "get": { "description": "Ask a partner, signed, which form versions it holds.", "operationId": "partner_forms_forms_partners__peer_id__get", "parameters": [ { "in": "path", "name": "peer_id", "required": true, "schema": { "title": "Peer Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Partner Forms", "tags": [ "Registered forms" ] } }, "/forms/received": { "get": { "description": "Forms partners delivered whose pages matched, for the Received screen.\n\nEach one is listed to whoever may read that received fax, and its values\nonly to whoever may open its document.", "operationId": "received_forms_forms_received_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Received Forms", "tags": [ "Registered forms" ] } }, "/forms/send": { "post": { "description": "Send a filled form: to a verified partner as values and page hashes, otherwise as a fax.", "operationId": "send_form_forms_send_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Send Form", "tags": [ "Registered forms" ] } }, "/forms/versions/{version_id}": { "get": { "operationId": "get_version_forms_versions__version_id__get", "parameters": [ { "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Version", "tags": [ "Registered forms" ] } }, "/forms/versions/{version_id}/pages/{page}": { "get": { "description": "The blank page as it is faxed, optionally with each field's box outlined (preview only).", "operationId": "preview_page_forms_versions__version_id__pages__page__get", "parameters": [ { "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } }, { "in": "path", "name": "page", "required": true, "schema": { "title": "Page", "type": "integer" } }, { "in": "query", "name": "fields", "required": false, "schema": { "default": false, "title": "Fields", "type": "boolean" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Preview Page", "tags": [ "Registered forms" ] } }, "/forms/versions/{version_id}/render": { "post": { "description": "The filled pages exactly as they would be faxed, with each page's hash.", "operationId": "render_version_forms_versions__version_id__render_post", "parameters": [ { "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } }, { "in": "query", "name": "format", "required": false, "schema": { "default": "pdf", "pattern": "^(pdf|png|json)$", "title": "Format", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "title": "Page", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FillIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Render Version", "tags": [ "Registered forms" ] } }, "/forms/versions/{version_id}/template": { "get": { "operationId": "get_template_forms_versions__version_id__template_get", "parameters": [ { "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Template", "tags": [ "Registered forms" ] } }, "/forms/{form_id}/versions": { "post": { "description": "Import a changed template or fields as the form's next version; earlier versions never change.", "operationId": "import_version_forms__form_id__versions_post", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "title": "Form Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_version_forms__form_id__versions_post" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import Version", "tags": [ "Registered forms" ] } }, "/header-notice": { "get": { "operationId": "get_notices_header_notice_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Notices", "tags": [ "Header notice" ] }, "put": { "operationId": "put_notice_header_notice_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__header_notice_http__NoticeIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Notice", "tags": [ "Header notice" ] } }, "/header-notice/faxes/{job_id}": { "get": { "description": "What Sent details say about a fax's header notice and cover, for anyone who may read that fax.", "operationId": "fax_notice_header_notice_faxes__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax Notice", "tags": [ "Header notice" ] } }, "/header-notice/for-send": { "get": { "description": "The notice a fax sent now (from ``mailbox``) would carry, so Send a fax can offer the cover choice.", "operationId": "notice_for_send_header_notice_for_send_get", "parameters": [ { "in": "query", "name": "mailbox", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Mailbox" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Notice For Send", "tags": [ "Header notice" ] } }, "/header-notice/mailboxes/{mailbox_id}": { "put": { "operationId": "put_mailbox_notice_header_notice_mailboxes__mailbox_id__put", "parameters": [ { "in": "path", "name": "mailbox_id", "required": true, "schema": { "title": "Mailbox Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__header_notice_http__NoticeIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Mailbox Notice", "tags": [ "Header notice" ] } }, "/header-notice/recipients/{number}": { "get": { "operationId": "get_recipient_cover_header_notice_recipients__number__get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Recipient Cover", "tags": [ "Header notice" ] }, "put": { "operationId": "put_recipient_cover_header_notice_recipients__number__put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Recipient Cover", "tags": [ "Header notice" ] } }, "/health": { "get": { "operationId": "health_health_get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Health" } }, "/health/ready": { "get": { "description": "200 when Faxbot is ready for what it is set up to do (sending, receiving or both), else 503.\n\nThe body is unchanged: ``status`` stays ready to send, and ``ready_to_receive`` answers for receiving.", "operationId": "health_ready_health_ready_get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Health Ready" } }, "/imports": { "post": { "operationId": "create_import_imports_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_create_import_imports_post" } } } }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import a document from another system into the work queue", "tags": [ "Work" ] } }, "/inbound": { "get": { "operationId": "list_inbound_inbound_get", "parameters": [ { "in": "query", "name": "to_number", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To Number" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "mailbox", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mailbox" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/InboundFaxOut" }, "title": "Response List Inbound Inbound Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Inbound" } }, "/inbound/{inbound_id}": { "get": { "operationId": "get_inbound_inbound__inbound_id__get", "parameters": [ { "in": "path", "name": "inbound_id", "required": true, "schema": { "title": "Inbound Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboundFaxOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Inbound" } }, "/inbound/{inbound_id}/fetch": { "post": { "description": "Ask Faxbot to fetch a received fax's document again now.", "operationId": "fetch_inbound_inbound__inbound_id__fetch_post", "parameters": [ { "in": "path", "name": "inbound_id", "required": true, "schema": { "title": "Inbound Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fetch Inbound", "tags": [ "Inbound" ] } }, "/inbound/{inbound_id}/pdf": { "get": { "description": "Document bytes need inbound:document, or the fax's unexpired download token.", "operationId": "get_inbound_pdf_inbound__inbound_id__pdf_get", "parameters": [ { "in": "path", "name": "inbound_id", "required": true, "schema": { "title": "Inbound Id", "type": "string" } }, { "in": "query", "name": "token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Inbound Pdf" } }, "/intake/connectors": { "get": { "operationId": "list_connectors_intake_connectors_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Connectors", "tags": [ "Intake" ] }, "post": { "operationId": "create_connector_intake_connectors_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorIn" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Connector", "tags": [ "Intake" ] } }, "/intake/connectors/{connector_id}": { "delete": { "operationId": "delete_connector_intake_connectors__connector_id__delete", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Connector", "tags": [ "Intake" ] }, "put": { "operationId": "update_connector_intake_connectors__connector_id__put", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update Connector", "tags": [ "Intake" ] } }, "/intake/connectors/{connector_id}/test": { "post": { "operationId": "test_connector_intake_connectors__connector_id__test_post", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Test Connector", "tags": [ "Intake" ] } }, "/intake/items": { "get": { "operationId": "list_items_intake_items_get", "parameters": [ { "in": "query", "name": "state", "required": false, "schema": { "anyOf": [ { "pattern": "^(received|sending|delivered|failed)$", "type": "string" }, { "type": "null" } ], "title": "State" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Items", "tags": [ "Intake" ] } }, "/intake/items/{item_id}/retry": { "post": { "operationId": "retry_item_intake_items__item_id__retry_post", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Retry Item", "tags": [ "Intake" ] } }, "/intake/sources": { "get": { "operationId": "list_sources_intake_sources_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Connectors with their status and counts", "tags": [ "Intake" ] }, "post": { "operationId": "create_source_intake_sources_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__intake__sources__http__SourceIn" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add a connector", "tags": [ "Intake" ] } }, "/intake/sources/choices": { "get": { "operationId": "choices_intake_sources_choices_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Mailboxes, people and mail services a connector can use", "tags": [ "Intake" ] } }, "/intake/sources/faxes/{job_id}": { "get": { "operationId": "fax_requester_intake_sources_faxes__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Who asked for a fax that came in by email or from a folder", "tags": [ "Intake" ] } }, "/intake/sources/items": { "get": { "operationId": "list_items_intake_sources_items_get", "parameters": [ { "in": "query", "name": "connector", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Connector" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "What connectors brought in or sent, newest first", "tags": [ "Intake" ] } }, "/intake/sources/{source_id}": { "delete": { "operationId": "remove_source_intake_sources__source_id__delete", "parameters": [ { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Remove a connector; what it filed and sent stays listed", "tags": [ "Intake" ] }, "put": { "operationId": "update_source_intake_sources__source_id__put", "parameters": [ { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Change a connector; settings you leave out stay as they are", "tags": [ "Intake" ] } }, "/intake/sources/{source_id}/pause": { "post": { "operationId": "pause_source_intake_sources__source_id__pause_post", "parameters": [ { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api__app__intake__sources__http__VersionIn" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Stop checking a connector; a sending connector loses its key", "tags": [ "Intake" ] } }, "/intake/sources/{source_id}/resume": { "post": { "operationId": "resume_source_intake_sources__source_id__resume_post", "parameters": [ { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Check a connector again; a sending connector gets a new key", "tags": [ "Intake" ] } }, "/intake/sources/{source_id}/test": { "post": { "operationId": "test_source_intake_sources__source_id__test_post", "parameters": [ { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Sign in or open the folder and look, without changing anything", "tags": [ "Intake" ] } }, "/mobile/pair": { "post": { "description": "Exchange a pairing code from the console for this device's own API key. Any failure is 403.", "operationId": "mobile_pair_mobile_pair_post", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "pattern": "^[0-9]{6}$", "type": "string" }, "device_name": { "type": "string" } }, "required": [ "code" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobilePairOut" } } }, "description": "Successful Response" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Pairing failed." } }, "summary": "Mobile Pair" } }, "/numbers/reply": { "get": { "operationId": "read_reply_number_numbers_reply_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Read Reply Number", "tags": [ "Reply number" ] }, "put": { "description": "Save the organization's reply number; an empty number lets Faxbot choose.", "operationId": "set_reply_number_numbers_reply_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyNumberBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Reply Number", "tags": [ "Reply number" ] } }, "/numbers/reply/mailboxes/{mailbox_id}": { "delete": { "description": "The mailbox's faxes show the organization's reply number again.", "operationId": "clear_mailbox_reply_number_numbers_reply_mailboxes__mailbox_id__delete", "parameters": [ { "in": "path", "name": "mailbox_id", "required": true, "schema": { "title": "Mailbox Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Clear Mailbox Reply Number", "tags": [ "Reply number" ] }, "put": { "description": "Give one mailbox a reply number of its own; it must be a number whose faxes reach that mailbox.", "operationId": "set_mailbox_reply_number_numbers_reply_mailboxes__mailbox_id__put", "parameters": [ { "in": "path", "name": "mailbox_id", "required": true, "schema": { "title": "Mailbox Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyNumberBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Mailbox Reply Number", "tags": [ "Reply number" ] } }, "/outbound/now": { "get": { "description": "What is sending now, what waits and why, what needs you, how today went, and how full your lines are.", "operationId": "outbound_board_outbound_now_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Outbound Board", "tags": [ "Faxes" ] } }, "/phaxio-callback": { "post": { "operationId": "phaxio_callback_phaxio_callback_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Phaxio Callback" } }, "/phaxio-inbound": { "post": { "operationId": "phaxio_inbound_phaxio_inbound_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Phaxio Inbound", "tags": [ "Inbound" ] } }, "/phaxio-inbound/{key}": { "post": { "description": "A received-fax notification for one Phaxio account; its signature covers this exact address.", "operationId": "phaxio_account_inbound_phaxio_inbound__key__post", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "title": "Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Phaxio Account Inbound", "tags": [ "Inbound" ] } }, "/plugins": { "get": { "deprecated": true, "description": "Deprecated: removed in the next release with FEATURE_V3_PLUGINS; read providers from /admin/settings.", "operationId": "list_plugins_plugins_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration or provider metadata could not be validated." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "The v3 plugins feature is disabled." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "List Plugins" } }, "/plugins/{plugin_id}/config": { "get": { "deprecated": true, "description": "Deprecated: removed in the next release; read provider settings from /admin/settings.", "operationId": "get_plugin_config_plugins__plugin_id__config_get", "parameters": [ { "in": "path", "name": "plugin_id", "required": true, "schema": { "title": "Plugin Id", "type": "string" } }, { "in": "query", "name": "role", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration or provider metadata could not be validated." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "The v3 plugins feature is disabled." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationValidationErrorResponse" } } }, "description": "Invalid configuration input; raw input and error context are omitted." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Get Plugin Config" }, "put": { "deprecated": true, "description": "Deprecated: removed in the next release; change provider settings with PUT /admin/settings.", "operationId": "update_plugin_config_plugins__plugin_id__config_put", "parameters": [ { "in": "path", "name": "plugin_id", "required": true, "schema": { "title": "Plugin Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePluginConfigIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "applied": { "summary": "Confirmed applied configuration", "value": { "_meta": { "active_revision_id": "00000000-0000-4000-8000-000000000001", "apply_state": "applied", "desired_revision_id": "00000000-0000-4000-8000-000000000001", "generation": 2, "restart_recommended": false }, "changed": true, "ok": true } }, "pending_restart": { "summary": "Confirmed desired configuration pending restart", "value": { "_meta": { "active_revision_id": "00000000-0000-4000-8000-000000000001", "apply_state": "pending_restart", "desired_revision_id": "00000000-0000-4000-8000-000000000002", "generation": 3, "restart_recommended": true }, "changed": true, "ok": true } } }, "schema": { "$ref": "#/components/schemas/ConfigurationWriteResponse" } } }, "description": "Confirmed canonical write receipt; read configuration values separately." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration or provider metadata could not be validated." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Authentication required or credentials no longer valid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Transport, browser request verification or operation is not permitted." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration changed. Reload before applying edits." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationValidationErrorResponse" } } }, "description": "Invalid configuration input; raw input and error context are omitted." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Too many authentication attempts. Try again later." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDetailErrorResponse" } } }, "description": "Configuration, authentication or access service is unavailable." } }, "summary": "Update Plugin Config" } }, "/power": { "get": { "description": "The UPS Faxbot reads and what it says now.", "operationId": "get_power_power_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Power", "tags": [ "Diagnostics" ] }, "put": { "description": "Set the UPS Faxbot reads through NUT, or turn the check off with an empty address.", "operationId": "put_power_power_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Power", "tags": [ "Diagnostics" ] } }, "/receiving/owners": { "post": { "description": "Name the one receiver of a number's faxes; another receiver's number is refused unless you move it.", "operationId": "set_owner_receiving_owners_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnerIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Owner", "tags": [ "Diagnostics" ] } }, "/receiving/readiness": { "get": { "description": "Whether each of your numbers can receive faxes now, from receiving evidence only.", "operationId": "get_readiness_receiving_readiness_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Readiness", "tags": [ "Diagnostics" ] } }, "/routing/after-answer/faxes/{job_id}": { "get": { "description": "What Sent details say about the keys a fax's calls pressed, for anyone who may read that fax.", "operationId": "fax_keys_routing_after_answer_faxes__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax Keys", "tags": [ "Delivery routes" ] } }, "/routing/after-answer/{number}": { "get": { "operationId": "get_keys_routing_after_answer__number__get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Keys", "tags": [ "Delivery routes" ] }, "put": { "operationId": "put_keys_routing_after_answer__number__put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfterAnswerChange" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Keys", "tags": [ "Delivery routes" ] } }, "/routing/analog-lines/{account}": { "get": { "operationId": "get_line_routing_analog_lines__account__get", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "title": "Account", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Line", "tags": [ "Delivery routes" ] } }, "/routing/analog-lines/{account}/local-calls": { "put": { "operationId": "put_local_calls_routing_analog_lines__account__local_calls_put", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "title": "Account", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalCalls" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Local Calls", "tags": [ "Delivery routes" ] } }, "/routing/analog-lines/{account}/routing": { "put": { "description": "Let Faxbot choose the line by itself, or stop it; a line that is the default sending account stays so.", "operationId": "put_routing_routing_analog_lines__account__routing_put", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "title": "Account", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Routing" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Routing", "tags": [ "Delivery routes" ] } }, "/routing/caller-id-prices": { "get": { "description": "The carrier decks Faxbot prices by caller ID, and the caller ID each sending account presents.", "operationId": "caller_id_prices_routing_caller_id_prices_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Caller Id Prices", "tags": [ "Countries" ] } }, "/routing/caller-id-prices/quote": { "get": { "description": "How a call to ``to`` is priced by caller ID on each sending account with a deck that covers it.", "operationId": "caller_id_quote_routing_caller_id_prices_quote_get", "parameters": [ { "in": "query", "name": "to", "required": true, "schema": { "maxLength": 40, "minLength": 3, "title": "To", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Caller Id Quote", "tags": [ "Countries" ] } }, "/routing/caller-ids/confirm": { "post": { "description": "Record that you hold this caller ID and may send faxes from it on this account, with your evidence; with\n``bought_here``, also that it was bought on this account. Earlier records stay as history.", "operationId": "confirm_caller_id_routing_caller_ids_confirm_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallerIdIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Confirm Caller Id", "tags": [ "Countries" ] } }, "/routing/caller-ids/withdraw": { "post": { "description": "Withdraw a caller-ID confirmation; calls from it are priced as unconfirmed again. History is kept.", "operationId": "withdraw_caller_id_routing_caller_ids_withdraw_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallerIdWithdrawIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Withdraw Caller Id", "tags": [ "Countries" ] } }, "/routing/capabilities": { "get": { "description": "Every capability, grouped by outcome, with its state here, prerequisites and links; never money.\n\n``findings=false`` (the Overview's read) leaves out how many suggestions each piece of advice has and what charge\nchecks found, which the Overview never shows and which would read every advice section.", "operationId": "capabilities_routing_capabilities_get", "parameters": [ { "in": "query", "name": "findings", "required": false, "schema": { "default": true, "title": "Findings", "type": "boolean" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Capabilities", "tags": [ "Delivery routes" ] } }, "/routing/carrier-lists/files": { "post": { "description": "Import a carrier's list of discontinued or grandfathered service areas: AT&T's workbook as published, or any\ncarrier's list as CSV. The same carrier's earlier list of that kind is kept as history.", "operationId": "import_carrier_list_routing_carrier_lists_files_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_carrier_list_routing_carrier_lists_files_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import Carrier List", "tags": [ "Line inventory" ] } }, "/routing/channels/files": { "post": { "description": "Import another fax server's or phone system's call records for one system.", "operationId": "import_channel_calls_routing_channels_files_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_channel_calls_routing_channels_files_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import Channel Calls", "tags": [ "Fax server renewal" ] } }, "/routing/channels/imports/{import_id}": { "delete": { "description": "Leave one imported file of call records out of the report; its calls stay as history.", "operationId": "remove_channel_import_routing_channels_imports__import_id__delete", "parameters": [ { "in": "path", "name": "import_id", "required": true, "schema": { "title": "Import Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Remove Channel Import", "tags": [ "Fax server renewal" ] } }, "/routing/charges": { "get": { "description": "How each account's charges are read, received-fax charges, and faxes Faxbot has no record of.", "operationId": "charges_routing_charges_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "maximum": 366, "minimum": 1, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Charges", "tags": [ "Delivery routes" ] } }, "/routing/charges/sweep": { "post": { "description": "List the account's faxes at its provider now and keep any Faxbot has no record of; never changes a fax.", "operationId": "sweep_routing_charges_sweep_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SweepIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Sweep", "tags": [ "Delivery routes" ] } }, "/routing/closures": { "get": { "description": "Copper-closure dates for your French sites and their numbers, and every line with a carrier's notice.", "operationId": "line_closures_routing_closures_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Line Closures", "tags": [ "Countries" ] } }, "/routing/closures/files": { "post": { "description": "Import Orange's commune-level trajectory file, or the government copy of it; the source's earlier file is kept\nas history.", "operationId": "import_closures_routing_closures_files_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_closures_routing_closures_files_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import Closures", "tags": [ "Countries" ] } }, "/routing/costs": { "get": { "operationId": "costs_routing_costs_get", "parameters": [ { "in": "query", "name": "since", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Costs", "tags": [ "Delivery routes" ] } }, "/routing/country-rules": { "get": { "description": "Countries whose regulator licenses calls over the internet, and whether each affected account is confirmed.", "operationId": "country_rules_routing_country_rules_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Country Rules", "tags": [ "Countries" ] } }, "/routing/country-rules/confirm": { "post": { "description": "Record that an account's provider meets a country's rules, with your evidence. Nothing is blocked either way.", "operationId": "confirm_country_rules_routing_country_rules_confirm_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountryConfirmIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Confirm Country Rules", "tags": [ "Countries" ] } }, "/routing/country-rules/withdraw": { "post": { "description": "Withdraw a confirmation; the account shows the country's rules as not confirmed again.", "operationId": "withdraw_country_rules_routing_country_rules_withdraw_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountryConfirmIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Withdraw Country Rules", "tags": [ "Countries" ] } }, "/routing/destinations": { "get": { "operationId": "list_destinations_routing_destinations_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Destinations", "tags": [ "Delivery routes" ] } }, "/routing/destinations/{number}": { "get": { "operationId": "get_destination_routing_destinations__number__get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "in": "query", "name": "pages", "required": false, "schema": { "default": 1, "maximum": 1000, "minimum": 1, "title": "Pages", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Destination", "tags": [ "Delivery routes" ] }, "patch": { "operationId": "patch_destination_routing_destinations__number__patch", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Patch Destination", "tags": [ "Delivery routes" ] } }, "/routing/destinations/{number}/coding-tuning": { "get": { "description": "Your smaller-pages choice for one number, what is in force for its calls and why.", "operationId": "get_coding_tuning_routing_destinations__number__coding_tuning_get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Coding Tuning" }, "put": { "description": "Keep your smaller-pages choice for one number; saving also clears what Faxbot learned for it.", "operationId": "put_coding_tuning_routing_destinations__number__coding_tuning_put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodingTuning" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Coding Tuning" } }, "/routing/destinations/{number}/fax-limits": { "get": { "operationId": "get_fax_limits_routing_destinations__number__fax_limits_get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Fax Limits" }, "put": { "operationId": "put_fax_limits_routing_destinations__number__fax_limits_put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaxLimits" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Fax Limits" } }, "/routing/destinations/{number}/pages": { "get": { "description": "Recipients, Details: how long a page this number's machine takes, and its page settings.", "operationId": "get_recipient_pages_routing_destinations__number__pages_get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Recipient Pages" }, "put": { "operationId": "put_recipient_pages_routing_destinations__number__pages_put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientPages" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Recipient Pages" } }, "/routing/destinations/{number}/polling": { "get": { "operationId": "get_polling_routing_destinations__number__polling_get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Polling", "tags": [ "Delivery routes" ] }, "put": { "operationId": "put_polling_routing_destinations__number__polling_put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PollingIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Polling", "tags": [ "Delivery routes" ] } }, "/routing/destinations/{number}/polling/collect": { "post": { "operationId": "collect_now_routing_destinations__number__polling_collect_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "202": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Collect Now", "tags": [ "Delivery routes" ] } }, "/routing/destinations/{number}/polling/hold": { "get": { "operationId": "get_hold_routing_destinations__number__polling_hold_get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Hold", "tags": [ "Delivery routes" ] }, "put": { "operationId": "put_hold_routing_destinations__number__polling_hold_put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HoldIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Hold", "tags": [ "Delivery routes" ] } }, "/routing/destinations/{number}/polling/hold/faxes": { "post": { "description": "Hold one document (PDF or fax TIFF) for the number to collect.", "operationId": "hold_fax_routing_destinations__number__polling_hold_faxes_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_hold_fax_routing_destinations__number__polling_hold_faxes_post" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Hold Fax", "tags": [ "Delivery routes" ] } }, "/routing/destinations/{number}/polling/hold/faxes/{hold_id}": { "delete": { "operationId": "withdraw_fax_routing_destinations__number__polling_hold_faxes__hold_id__delete", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "in": "path", "name": "hold_id", "required": true, "schema": { "title": "Hold Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Withdraw Fax", "tags": [ "Delivery routes" ] } }, "/routing/destinations/{number}/schedule": { "get": { "operationId": "get_schedule_routing_destinations__number__schedule_get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Schedule", "tags": [ "Delivery routes" ] }, "put": { "operationId": "put_schedule_routing_destinations__number__schedule_put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Schedule", "tags": [ "Delivery routes" ] } }, "/routing/destinations/{number}/toll-free": { "get": { "description": "A recipient's toll-free fax number and every approval recorded for it, newest first.", "operationId": "get_toll_free_routing_destinations__number__toll_free_get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Toll Free", "tags": [ "Delivery routes" ] }, "post": { "description": "Put a recipient's toll-free number on file, record who at the recipient approved it, or withdraw it.\n\nEach change is a new row (never an edit) and one audit row. Faxbot uses the toll-free number only while an\napproval is the newest row (``tollfree.approved_alternate``).", "operationId": "record_toll_free_routing_destinations__number__toll_free_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TollFreeIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Record Toll Free", "tags": [ "Delivery routes" ] } }, "/routing/destinations/{number}/toll-free/suggestions": { "get": { "description": "Toll-free fax numbers the public NPI registry (NPPES) lists for a provider; a suggestion, never an approval.\n\nOne read of the public registry per request. Nothing is recorded: the person still records who agreed.", "operationId": "toll_free_suggestions_routing_destinations__number__toll_free_suggestions_get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "in": "query", "name": "npi", "required": false, "schema": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "Npi" } }, { "in": "query", "name": "name", "required": false, "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Name" } }, { "in": "query", "name": "city", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "City" } }, { "in": "query", "name": "state", "required": false, "schema": { "anyOf": [ { "maxLength": 2, "type": "string" }, { "type": "null" } ], "title": "State" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Toll Free Suggestions", "tags": [ "Delivery routes" ] } }, "/routing/dialing": { "get": { "operationId": "get_dialing_routing_dialing_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Dialing", "tags": [ "Delivery routes" ] } }, "/routing/dialing/{class_key}": { "put": { "operationId": "put_dialing_routing_dialing__class_key__put", "parameters": [ { "in": "path", "name": "class_key", "required": true, "schema": { "title": "Class Key", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialingChange" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Dialing", "tags": [ "Delivery routes" ] } }, "/routing/explain": { "post": { "description": "Which route a fax would take, and why. Sends nothing and writes nothing.", "operationId": "explain_route_routing_explain_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExplainBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Explain Route", "tags": [ "Sending rules" ] } }, "/routing/families": { "get": { "description": "Route problems (open first), recent 2-by-2 tests and the shared-upstream table.", "operationId": "list_families_routing_families_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Families", "tags": [ "Delivery routes" ] } }, "/routing/families/tests": { "post": { "description": "Record a 2-by-2 test of two sending accounts against two of your own numbers. Nothing is sent.", "operationId": "create_test_routing_families_tests_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Test", "tags": [ "Delivery routes" ] } }, "/routing/families/tests/{test_id}": { "get": { "operationId": "get_test_routing_families_tests__test_id__get", "parameters": [ { "in": "path", "name": "test_id", "required": true, "schema": { "title": "Test Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Test", "tags": [ "Delivery routes" ] } }, "/routing/families/tests/{test_id}/send/{cell}": { "post": { "description": "Send one of a test's four faxes: your explicit action, once per cell (you also need to be allowed to send\nfaxes). Faxbot never sends them by itself.", "operationId": "send_test_fax_routing_families_tests__test_id__send__cell__post", "parameters": [ { "in": "path", "name": "test_id", "required": true, "schema": { "title": "Test Id", "type": "string" } }, { "in": "path", "name": "cell", "required": true, "schema": { "title": "Cell", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Send Test Fax", "tags": [ "Delivery routes" ] } }, "/routing/families/{incident_id}/close": { "post": { "description": "Close a route problem by hand, for example after fixing the trunk; its lessons are set aside.", "operationId": "close_family_routing_families__incident_id__close_post", "parameters": [ { "in": "path", "name": "incident_id", "required": true, "schema": { "title": "Incident Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Close Family", "tags": [ "Delivery routes" ] } }, "/routing/fax-costs": { "get": { "description": "Costs for up to 100 sent faxes at once, for the Sent list; faxes this person cannot read are left out.", "operationId": "fax_costs_routing_fax_costs_get", "parameters": [ { "in": "query", "name": "ids", "required": false, "schema": { "default": "", "maxLength": 4200, "title": "Ids", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax Costs", "tags": [ "Delivery routes" ] } }, "/routing/faxes/{job_id}/cost": { "get": { "description": "What one sent fax cost, for anyone who may read that fax.", "operationId": "fax_cost_routing_faxes__job_id__cost_get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax Cost", "tags": [ "Delivery routes" ] } }, "/routing/faxes/{job_id}/original": { "post": { "description": "Record that the recipient asked for the original of this fax, that you sent it, or that the request was\nwithdrawn. Faxbot sends nothing itself.", "operationId": "original_request_routing_faxes__job_id__original_post", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OriginalIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Original Request", "tags": [ "Countries" ] } }, "/routing/faxes/{job_id}/route": { "get": { "description": "Why a sent fax took its route, for anyone who may read that fax.", "operationId": "fax_route_routing_faxes__job_id__route_get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax Route", "tags": [ "Delivery routes" ] } }, "/routing/faxes/{job_id}/sender-evidence": { "get": { "description": "The sender's evidence for a fax to a registered-sender recipient: the identity registered then, the kept\npages, each call with the answering station, and any request for the original. For anyone who may read it.", "operationId": "sender_evidence_routing_faxes__job_id__sender_evidence_get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Sender Evidence", "tags": [ "Countries" ] } }, "/routing/holds": { "get": { "description": "Faxes your rules held: everyone's for someone with Approve faxes, else the ones you sent.", "operationId": "list_holds_routing_holds_get", "parameters": [ { "in": "query", "name": "state", "required": false, "schema": { "default": "open", "pattern": "^(open|released|refused|all)$", "title": "State", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Holds", "tags": [ "Delivery routes" ] } }, "/routing/holds/{hold_id}/approve": { "post": { "description": "Approve a held fax, or send a fax with no allowed route by an account anyway. Audited.", "operationId": "approve_hold_routing_holds__hold_id__approve_post", "parameters": [ { "in": "path", "name": "hold_id", "required": true, "schema": { "title": "Hold Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HoldDecisionIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Approve Hold", "tags": [ "Delivery routes" ] } }, "/routing/holds/{hold_id}/check-again": { "post": { "description": "Let Faxbot try the accounts a no-route fax's rules allow again (its sender, or someone with Approve faxes).", "operationId": "check_hold_again_routing_holds__hold_id__check_again_post", "parameters": [ { "in": "path", "name": "hold_id", "required": true, "schema": { "title": "Hold Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HoldDecisionIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Check Hold Again", "tags": [ "Delivery routes" ] } }, "/routing/holds/{hold_id}/refuse": { "post": { "description": "Refuse a held fax: it fails with your name and reason, and nothing is sent. Audited.", "operationId": "refuse_hold_routing_holds__hold_id__refuse_post", "parameters": [ { "in": "path", "name": "hold_id", "required": true, "schema": { "title": "Hold Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HoldRefusalIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Refuse Hold", "tags": [ "Delivery routes" ] } }, "/routing/inbound-costs": { "get": { "description": "Costs for up to 100 received faxes at once; faxes this person cannot read are left out.", "operationId": "inbound_costs_routing_inbound_costs_get", "parameters": [ { "in": "query", "name": "ids", "required": false, "schema": { "default": "", "maxLength": 4200, "title": "Ids", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Inbound Costs", "tags": [ "Delivery routes" ] } }, "/routing/inbound/{inbound_id}/cost": { "get": { "description": "What the call that brought in one received fax cost, for anyone who may read that fax.", "operationId": "inbound_cost_routing_inbound__inbound_id__cost_get", "parameters": [ { "in": "path", "name": "inbound_id", "required": true, "schema": { "title": "Inbound Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Inbound Cost", "tags": [ "Delivery routes" ] } }, "/routing/invoices": { "get": { "description": "Each invoice entered (its newest version), with the part your faxes don't explain.", "operationId": "list_invoices_routing_invoices_get", "parameters": [ { "in": "query", "name": "account", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Account" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Invoices", "tags": [ "Delivery routes" ] }, "post": { "description": "Enter an invoice total for one account and billing period; entering it again adds a corrected version.", "operationId": "add_invoice_routing_invoices_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_add_invoice_routing_invoices_post" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add Invoice", "tags": [ "Delivery routes" ] } }, "/routing/invoices/{invoice_id}": { "get": { "description": "One invoice, its explanation, and every version entered for its account and period.", "operationId": "get_invoice_routing_invoices__invoice_id__get", "parameters": [ { "in": "path", "name": "invoice_id", "required": true, "schema": { "title": "Invoice Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Invoice", "tags": [ "Delivery routes" ] } }, "/routing/invoices/{invoice_id}/file": { "get": { "description": "The invoice file entered with this invoice, checked against what was kept.", "operationId": "invoice_file_routing_invoices__invoice_id__file_get", "parameters": [ { "in": "path", "name": "invoice_id", "required": true, "schema": { "title": "Invoice Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Invoice File", "tags": [ "Delivery routes" ] } }, "/routing/jurisdiction-rates": { "post": { "description": "Import a carrier's US prices for calls within one state and between states (a CSV such as AnveoDirect's\nrate file). The carrier's earlier prices are kept as history.", "operationId": "import_jurisdiction_rates_routing_jurisdiction_rates_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_jurisdiction_rates_routing_jurisdiction_rates_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import Jurisdiction Rates", "tags": [ "Number advice" ] } }, "/routing/line-inventory": { "get": { "description": "Your line inventory, each line's match against the carrier lists you imported, and its dates.", "operationId": "line_inventory_routing_line_inventory_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Line Inventory", "tags": [ "Line inventory" ] } }, "/routing/line-inventory/files": { "post": { "description": "Import your line inventory (CSV or Excel). It replaces the current one, which is kept as history; contract\nend dates become each line's contract-end notice.", "operationId": "import_line_inventory_routing_line_inventory_files_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_line_inventory_routing_line_inventory_files_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import Line Inventory", "tags": [ "Line inventory" ] } }, "/routing/line-notices/{number}": { "delete": { "description": "Withdraw a line's carrier notice; its history stays.", "operationId": "remove_line_notice_routing_line_notices__number__delete", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Remove Line Notice", "tags": [ "Countries" ] }, "put": { "description": "Record a carrier's notice that this line closes on a date (from its letter). Earlier notices stay as history.", "operationId": "record_line_notice_routing_line_notices__number__put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__routing__countries_http__NoticeIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Record Line Notice", "tags": [ "Countries" ] } }, "/routing/npi": { "get": { "description": "Your NPIs and the numbers each one's newest registry read lists, with when it was read.", "operationId": "read_npi_routing_npi_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Read Npi", "tags": [ "Number advice" ] }, "post": { "description": "Add one of your NPIs (one per location if you have several), then read its record from NPPES once.", "operationId": "add_npi_routing_npi_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NpiIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add Npi", "tags": [ "Number advice" ] } }, "/routing/npi/check": { "post": { "description": "Read each of your NPIs from NPPES now and keep what it lists.", "operationId": "check_npi_routing_npi_check_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Check Npi", "tags": [ "Number advice" ] } }, "/routing/npi/{npi}": { "delete": { "description": "Stop treating an NPI as yours; what was read stays as history.", "operationId": "remove_npi_routing_npi__npi__delete", "parameters": [ { "in": "path", "name": "npi", "required": true, "schema": { "title": "Npi", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Remove Npi", "tags": [ "Number advice" ] } }, "/routing/numbers/{number}/dependencies": { "post": { "description": "Record your answer about what else depends on one of your numbers (broadband, other lines, emergency use,\nwhere it is printed). Earlier answers stay as history.", "operationId": "answer_dependency_routing_numbers__number__dependencies_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependencyIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Answer Dependency", "tags": [ "Number advice" ] } }, "/routing/numbers/{number}/move": { "get": { "description": "The number's move as a checked plan: each step's state and evidence. Faxbot never places the port order.", "operationId": "read_move_routing_numbers__number__move_get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Read Move", "tags": [ "Number advice" ] }, "post": { "description": "Start a move of one of your numbers to another of your accounts: a checked plan, never a port order.", "operationId": "start_move_routing_numbers__number__move_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Start Move", "tags": [ "Number advice" ] } }, "/routing/numbers/{number}/move/forget": { "post": { "description": "Forget what earlier calls on the old carrier taught Faxbot about this number, and record it with the move.", "operationId": "forget_for_move_routing_numbers__number__move_forget_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Forget For Move", "tags": [ "Number advice" ] } }, "/routing/numbers/{number}/move/steps/{step}": { "post": { "description": "Record a step you took (the new account is ready, the port is ordered, the carrier completed it), or finish\nor abandon the move.", "operationId": "record_move_step_routing_numbers__number__move_steps__step__post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "in": "path", "name": "step", "required": true, "schema": { "title": "Step", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Record Move Step", "tags": [ "Number advice" ] } }, "/routing/numbers/{number}/move/tests": { "post": { "description": "Start a receipt test from one of the routes Faxbot sends by. Faxbot then matches the test fax you send through\nthat route to its arrival; it sends nothing by itself.", "operationId": "start_receipt_test_routing_numbers__number__move_tests_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiptTestIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Start Receipt Test", "tags": [ "Number advice" ] } }, "/routing/page-routes": { "get": { "description": "Providers: long pages for each route, and the installation's setting for blank page bottoms.", "operationId": "get_route_pages_routing_page_routes_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Route Pages" } }, "/routing/page-routes/{route}": { "put": { "operationId": "put_route_pages_routing_page_routes__route__put", "parameters": [ { "in": "path", "name": "route", "required": true, "schema": { "title": "Route", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutePages" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Route Pages" } }, "/routing/plans": { "get": { "description": "Each plan's budget or allowance this billing period, what is committed, and the burn-down (estimates).", "operationId": "plans_routing_plans_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Plans", "tags": [ "Delivery routes" ] } }, "/routing/plans/allocation": { "get": { "description": "Each limited plan's pages or minutes left, which waiting faxes get them, and what is kept for later.", "operationId": "plan_allocation_routing_plans_allocation_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Plan Allocation", "tags": [ "Delivery routes" ] } }, "/routing/portfolio/plan": { "post": { "description": "Compare explicit setup bundles under one budget and two declared benefit scenarios. Inputs are not saved.", "operationId": "portfolio_plan_routing_portfolio_plan_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortfolioInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Portfolio Plan", "tags": [ "Delivery routes" ] } }, "/routing/pots-quotes": { "get": { "description": "Each POTS-replacement quote you entered, with the fax lines it could leave out and one shared trunk instead.", "operationId": "pots_quotes_routing_pots_quotes_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Pots Quotes", "tags": [ "Line inventory" ] }, "put": { "description": "Record a POTS-replacement quote (or start from a published price). Earlier entries stay as history.", "operationId": "record_pots_quote_routing_pots_quotes_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__routing__inventory_http__QuoteIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Record Pots Quote", "tags": [ "Line inventory" ] } }, "/routing/pots-quotes/remove": { "post": { "description": "Withdraw a POTS-replacement quote; its history stays.", "operationId": "remove_pots_quote_routing_pots_quotes_remove_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteName" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Remove Pots Quote", "tags": [ "Line inventory" ] } }, "/routing/predict": { "get": { "description": "What a fax of ``pages`` pages to ``to`` would take and cost on each route; estimates only, nothing is sent.", "operationId": "predict_routes_routing_predict_get", "parameters": [ { "in": "query", "name": "to", "required": true, "schema": { "maxLength": 40, "minLength": 1, "title": "To", "type": "string" } }, { "in": "query", "name": "pages", "required": false, "schema": { "default": 1, "maximum": 1000, "minimum": 1, "title": "Pages", "type": "integer" } }, { "in": "query", "name": "layout", "required": false, "schema": { "default": "normal", "maxLength": 16, "title": "Layout", "type": "string" } }, { "in": "query", "name": "resolution", "required": false, "schema": { "default": "fine", "maxLength": 16, "title": "Resolution", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Predict Routes", "tags": [ "Delivery routes" ] }, "post": { "description": "What this document faxed to ``to`` would take and cost, and the account and pages Faxbot would send it with;\nestimates only, nothing is sent or kept. Your sending rules decide its accounts as for a fax you send now, every\naccount's best pages are measured on its own tariff, and the accounts are ranked as the delivery worker ranks\nthem. It draws the document's pages as sending one does, so it takes the permission to send faxes and the same\nsize and page limits as ``POST /fax``.", "operationId": "predict_document_routing_predict_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_predict_document_routing_predict_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Predict Document", "tags": [ "Delivery routes" ] } }, "/routing/published-plans": { "get": { "description": "A provider's published plans for the installation country, where its API has no published price.", "operationId": "published_plans_routing_published_plans_get", "parameters": [ { "in": "query", "name": "provider_id", "required": true, "schema": { "title": "Provider Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Published Plans", "tags": [ "Delivery routes" ] } }, "/routing/published-plans/in-use": { "get": { "description": "Published plans for each sending provider in use with no sending rate card yet, such as eFax.", "operationId": "published_plans_in_use_routing_published_plans_in_use_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Published Plans In Use", "tags": [ "Delivery routes" ] } }, "/routing/quote": { "get": { "description": "What one fax would cost by each account your rules allow, from where its calls start. Sends nothing.\n\nA fax a monthly plan carries reads \"In your plan\", never $0.00; an unknown price says so.", "operationId": "quote_routing_quote_get", "parameters": [ { "in": "query", "name": "to", "required": true, "schema": { "maxLength": 64, "title": "To", "type": "string" } }, { "in": "query", "name": "pages", "required": false, "schema": { "default": 1, "maximum": 1000, "minimum": 1, "title": "Pages", "type": "integer" } }, { "in": "query", "name": "site", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Site" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Quote", "tags": [ "Delivery routes" ] } }, "/routing/rate-cards": { "get": { "operationId": "list_rate_cards_routing_rate_cards_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Rate Cards", "tags": [ "Delivery routes" ] }, "put": { "operationId": "put_rate_cards_routing_rate_cards_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateCardsIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Rate Cards", "tags": [ "Delivery routes" ] } }, "/routing/rate-cards/{provider_id}/rows": { "put": { "description": "Replace the prices by where calls start that you entered for one sending card; earlier rows are kept as\nhistory (superseded), never changed. Shipped published rows are not affected.", "operationId": "put_rate_rows_routing_rate_cards__provider_id__rows_put", "parameters": [ { "in": "path", "name": "provider_id", "required": true, "schema": { "title": "Provider Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateRowsIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Rate Rows", "tags": [ "Delivery routes" ] } }, "/routing/rate-cards/{route}/caller-id-prices": { "post": { "description": "Import a carrier's rate deck priced by caller ID for one sending route (Twilio's voice price file, or\nFaxbot's own layout). The route's earlier deck is kept as history.", "operationId": "import_caller_id_prices_routing_rate_cards__route__caller_id_prices_post", "parameters": [ { "in": "path", "name": "route", "required": true, "schema": { "title": "Route", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_caller_id_prices_routing_rate_cards__route__caller_id_prices_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import Caller Id Prices", "tags": [ "Countries" ] } }, "/routing/recipient-check": { "get": { "description": "Before the first fax to ``to``: whether NPPES lists that number for the provider ``name``. A warning at most;\nit never stops a fax.", "operationId": "recipient_check_routing_recipient_check_get", "parameters": [ { "in": "query", "name": "to", "required": true, "schema": { "maxLength": 64, "minLength": 1, "title": "To", "type": "string" } }, { "in": "query", "name": "name", "required": false, "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Name" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Recipient Check", "tags": [ "Number advice" ] } }, "/routing/recommendations/billing-steps": { "get": { "description": "Per number: how its calls end against the carrier's billing step over the last 30 days (estimates).", "operationId": "billing_step_recommendations_routing_recommendations_billing_steps_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Billing Step Recommendations", "tags": [ "Delivery routes" ] } }, "/routing/recommendations/carriers": { "get": { "description": "What your last 30 days of faxing would have cost at each carrier's published prices. Advice only.", "operationId": "carrier_recommendations_routing_recommendations_carriers_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Carrier Recommendations", "tags": [ "Delivery routes" ] } }, "/routing/recommendations/facts": { "get": { "description": "What one missing fact (a partner, a recipient's approval, a price, a plan's allowance) would have saved, per\nrecipient, over the last ``days`` days. Advice only: nothing is enrolled, approved or entered.", "operationId": "fact_advice_routing_recommendations_facts_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 90, "maximum": 183, "minimum": 7, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fact Advice", "tags": [ "Number advice" ] } }, "/routing/recommendations/fax-friendly": { "get": { "description": "Savings & optimization, Opportunities: whether lightening shaded areas and removing specks would have saved time on your\nrecent faxes (pages/friendly.py), or what it saved when it is on.", "operationId": "fax_friendly_recommendation_routing_recommendations_fax_friendly_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax Friendly Recommendation" } }, "/routing/recommendations/fax-marker": { "get": { "description": "Calls marked as fax against calls not marked, from history; never changes the setting.", "operationId": "fax_marker_recommendations_routing_recommendations_fax_marker_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 90, "maximum": 366, "minimum": 7, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax Marker Recommendations", "tags": [ "Delivery routes" ] } }, "/routing/recommendations/lines": { "get": { "description": "Per number: keep, move the termination, investigate or can likely go, with the evidence. Advice only.", "operationId": "line_advice_routing_recommendations_lines_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 90, "maximum": 183, "minimum": 30, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Line Advice", "tags": [ "Number advice" ] } }, "/routing/recommendations/numbers": { "get": { "description": "Where each of your numbers should live: what it costs at each of your accounts, and how to move it (advice).", "operationId": "number_placement_routing_recommendations_numbers_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "maximum": 183, "minimum": 7, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Number Placement", "tags": [ "Number advice" ] } }, "/routing/recommendations/partners": { "get": { "description": "The numbers whose faxes cost the most again and again: candidates for direct partners (advice only).", "operationId": "partner_recommendations_routing_recommendations_partners_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Partner Recommendations", "tags": [ "Delivery routes" ] } }, "/routing/recommendations/plans": { "get": { "description": "Whether each monthly plan is worth its fee at your traffic (estimates; Faxbot never cancels anything).", "operationId": "plan_recommendations_routing_recommendations_plans_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Plan Recommendations", "tags": [ "Delivery routes" ] } }, "/routing/recommendations/receiving": { "get": { "description": "Receiving advice from call history: shared channels, quiet numbers and connections (estimates, never applied).\n\nThe shared-channel advice is chosen on the ``days`` before the last ``days``\nand checked on the last ``days``.", "operationId": "receiving_recommendations_routing_recommendations_receiving_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "maximum": 183, "minimum": 7, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Receiving Recommendations", "tags": [ "Delivery routes" ] } }, "/routing/recommendations/sending": { "get": { "description": "Numbers where another route cost less per delivered fax than the one Faxbot uses first now.", "operationId": "sending_recommendations_routing_recommendations_sending_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Sending Recommendations", "tags": [ "Delivery routes" ] } }, "/routing/recommendations/sites": { "get": { "description": "Which site's trunk US calls would cost less from, where a carrier prices calls within a state differently.", "operationId": "site_recommendations_routing_recommendations_sites_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "maximum": 183, "minimum": 7, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Site Recommendations", "tags": [ "Number advice" ] } }, "/routing/recommendations/toll-free": { "get": { "description": "Recipients with a toll-free fax number on file, approved or not; the recipient pays for those calls.", "operationId": "toll_free_recommendations_routing_recommendations_toll_free_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Toll Free Recommendations", "tags": [ "Delivery routes" ] } }, "/routing/recommendations/trunks": { "get": { "description": "Whether one trunk's traffic fits on another and what moving it would save (advice only; WP-T, B6).", "operationId": "trunk_recommendations_routing_recommendations_trunks_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Trunk Recommendations", "tags": [ "Delivery routes" ] } }, "/routing/reconcile": { "post": { "description": "Ask the SIP trunk carrier now what each open call cost; never changes a delivery.", "operationId": "reconcile_routing_reconcile_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Reconcile", "tags": [ "Delivery routes" ] } }, "/routing/renewals": { "get": { "description": "One page per fax server renewal (amount and date, channels at peak, the parallel run, what is left to move),\nand the channel report for Faxbot's own trunk and each fax server whose call records you imported.\n\n``per_channel`` (such as 387.48) values the channels the peak never needed at that line-item price instead of the\nrenewal's average; it is read for this page only and never stored.", "operationId": "renewals_routing_renewals_get", "parameters": [ { "in": "query", "name": "per_channel", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Per Channel" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Renewals", "tags": [ "Fax server renewal" ] }, "put": { "description": "Record a fax server's renewal and the numbers Faxbot runs beside it. Earlier entries stay as history.", "operationId": "record_renewal_routing_renewals_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewalIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Record Renewal", "tags": [ "Fax server renewal" ] } }, "/routing/renewals/remove": { "post": { "description": "Withdraw a fax server's renewal; its history stays.", "operationId": "remove_renewal_routing_renewals_remove_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Remove Renewal", "tags": [ "Fax server renewal" ] } }, "/routing/renewals/routes": { "post": { "description": "Import a fax server's number-to-user routing (number, user, email, cover sheet); it replaces the system's\nearlier routing, which is kept as history.", "operationId": "import_routes_routing_renewals_routes_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_routes_routing_renewals_routes_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import Routes", "tags": [ "Fax server renewal" ] } }, "/routing/rules": { "get": { "operationId": "get_rules_routing_rules_get", "parameters": [ { "in": "query", "name": "scope", "required": false, "schema": { "default": "organization", "maxLength": 110, "title": "Scope", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Rules", "tags": [ "Sending rules" ] } }, "/routing/rules/apply-to-waiting": { "post": { "description": "Re-decide faxes not yet sent under the active rules; never a fax already submitted or uncertain. Audited.", "operationId": "apply_rules_to_waiting_routing_rules_apply_to_waiting_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Apply Rules To Waiting", "tags": [ "Delivery routes" ] } }, "/routing/rules/draft": { "delete": { "operationId": "discard_draft_routing_rules_draft_delete", "parameters": [ { "in": "query", "name": "scope", "required": false, "schema": { "default": "organization", "maxLength": 110, "title": "Scope", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Discard Draft", "tags": [ "Sending rules" ] }, "put": { "operationId": "save_draft_routing_rules_draft_put", "parameters": [ { "in": "query", "name": "scope", "required": false, "schema": { "default": "organization", "maxLength": 110, "title": "Scope", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Save Draft", "tags": [ "Sending rules" ] } }, "/routing/rules/draft/check": { "post": { "operationId": "check_draft_routing_rules_draft_check_post", "parameters": [ { "in": "query", "name": "scope", "required": false, "schema": { "default": "organization", "maxLength": 110, "title": "Scope", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Check Draft", "tags": [ "Sending rules" ] } }, "/routing/rules/publish": { "post": { "operationId": "publish_routing_rules_publish_post", "parameters": [ { "in": "query", "name": "scope", "required": false, "schema": { "default": "organization", "maxLength": 110, "title": "Scope", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Publish", "tags": [ "Sending rules" ] } }, "/routing/rules/revisions": { "get": { "operationId": "list_revisions_routing_rules_revisions_get", "parameters": [ { "in": "query", "name": "scope", "required": false, "schema": { "default": "organization", "maxLength": 110, "title": "Scope", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Revisions", "tags": [ "Sending rules" ] } }, "/routing/rules/revisions/{first}/diff/{second}": { "get": { "operationId": "diff_revisions_routing_rules_revisions__first__diff__second__get", "parameters": [ { "in": "path", "name": "first", "required": true, "schema": { "title": "First", "type": "integer" } }, { "in": "path", "name": "second", "required": true, "schema": { "title": "Second", "type": "integer" } }, { "in": "query", "name": "scope", "required": false, "schema": { "default": "organization", "maxLength": 110, "title": "Scope", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Diff Revisions", "tags": [ "Sending rules" ] } }, "/routing/rules/revisions/{number}": { "get": { "operationId": "get_revision_routing_rules_revisions__number__get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "integer" } }, { "in": "query", "name": "scope", "required": false, "schema": { "default": "organization", "maxLength": 110, "title": "Scope", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Revision", "tags": [ "Sending rules" ] } }, "/routing/rules/revisions/{number}/restore": { "post": { "operationId": "restore_revision_routing_rules_revisions__number__restore_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "integer" } }, { "in": "query", "name": "scope", "required": false, "schema": { "default": "organization", "maxLength": 110, "title": "Scope", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Restore Revision", "tags": [ "Sending rules" ] } }, "/routing/savings": { "get": { "description": "What sending together, direct delivery and case packets saved in the last ``days`` (estimates).", "operationId": "savings_routing_savings_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "maximum": 366, "minimum": 1, "title": "Days", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Savings", "tags": [ "Delivery routes" ] } }, "/routing/savings/mechanisms": { "get": { "description": "Every way Faxbot saves money, each with whether it is on, works here and has been tested; never money.", "operationId": "savings_mechanisms_routing_savings_mechanisms_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Savings Mechanisms", "tags": [ "Delivery routes" ] } }, "/routing/sender-pins": { "get": { "description": "Recipients that recognise your faxes by the number they come from, and the trunk registered with each.", "operationId": "sender_pins_routing_sender_pins_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Sender Pins", "tags": [ "Countries" ] } }, "/routing/sender-pins/{number}": { "delete": { "description": "End a recipient's pin; faxes to it go by your sending rules again. Its history stays.", "operationId": "unpin_sender_routing_sender_pins__number__delete", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "in": "query", "name": "note", "required": false, "schema": { "default": "", "maxLength": 2000, "title": "Note", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Unpin Sender", "tags": [ "Countries" ] }, "put": { "description": "Pin a recipient to the trunk, caller ID and station ID registered with it; faxes to it never go another way.\nEarlier pins stay as history.", "operationId": "pin_sender_routing_sender_pins__number__put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SenderPinIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Pin Sender", "tags": [ "Countries" ] } }, "/routing/stations/answer-cap": { "get": { "description": "Each trunk's answer cap: its switch, whether Faxbot uses it there, and the sentence beside the switch.", "operationId": "get_answer_cap_routing_stations_answer_cap_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Answer Cap", "tags": [ "Delivery routes" ] } }, "/routing/stations/faxes/{job_id}": { "get": { "description": "What Sent details say about the stations a fax's calls answered as, for anyone who may read that fax.", "operationId": "fax_stations_routing_stations_faxes__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Fax Stations", "tags": [ "Delivery routes" ] } }, "/routing/stations/mailboxes": { "get": { "description": "Each mailbox's choice for when a number answers as another fax machine, where it is set.", "operationId": "get_mailbox_modes_routing_stations_mailboxes_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Mailbox Modes", "tags": [ "Delivery routes" ] } }, "/routing/stations/mailboxes/{mailbox_id}": { "put": { "operationId": "put_mailbox_mode_routing_stations_mailboxes__mailbox_id__put", "parameters": [ { "in": "path", "name": "mailbox_id", "required": true, "schema": { "title": "Mailbox Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StationChange" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Mailbox Mode", "tags": [ "Delivery routes" ] } }, "/routing/stations/{number}": { "get": { "operationId": "get_stations_routing_stations__number__get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Stations", "tags": [ "Delivery routes" ] }, "put": { "operationId": "put_stations_routing_stations__number__put", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StationChange" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Stations", "tags": [ "Delivery routes" ] } }, "/routing/upstreams/{provider}": { "put": { "description": "Record which carrier a provider uses upstream, with where that is published; empty means unknown.", "operationId": "put_upstream_routing_upstreams__provider__put", "parameters": [ { "in": "path", "name": "provider", "required": true, "schema": { "title": "Provider", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpstreamIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Upstream", "tags": [ "Delivery routes" ] } }, "/screening": { "get": { "operationId": "read_screening_screening_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Read Screening", "tags": [ "Blocked senders" ] } }, "/screening/senders": { "post": { "description": "Block a sender: a number, or the sender of a received fax. Expires after ``days`` (90 by default).", "operationId": "block_sender_screening_senders_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Block Sender", "tags": [ "Blocked senders" ] } }, "/screening/senders/{entry_id}": { "delete": { "description": "Unblock: the entry keeps its history, marked removed by you, now.", "operationId": "unblock_sender_screening_senders__entry_id__delete", "parameters": [ { "in": "path", "name": "entry_id", "required": true, "schema": { "title": "Entry Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Unblock Sender", "tags": [ "Blocked senders" ] } }, "/setup/plans": { "get": { "operationId": "list_plans_setup_plans_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Plans", "tags": [ "Guided setup" ] }, "post": { "description": "Compile a plan from what Faxbot knows and keep it. Sends nothing and changes no setting or rule.", "operationId": "preview_plan_setup_plans_post", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Preview Plan", "tags": [ "Guided setup" ] } }, "/setup/plans/latest": { "get": { "description": "The newest plan (or none), and the mailboxes the description form asks about.", "operationId": "latest_plan_setup_plans_latest_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Latest Plan", "tags": [ "Guided setup" ] } }, "/setup/plans/{number}": { "get": { "operationId": "get_plan_setup_plans__number__get", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Plan", "tags": [ "Guided setup" ] } }, "/setup/plans/{number}/apply": { "post": { "description": "Apply the chosen suggestions of a previewed plan; refused when anything it builds on changed.", "operationId": "apply_plan_setup_plans__number__apply_post", "parameters": [ { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "integer" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Apply Plan", "tags": [ "Guided setup" ] } }, "/signalwire-callback": { "post": { "operationId": "signalwire_callback_signalwire_callback_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Signalwire Callback" } }, "/sinch-inbound": { "post": { "operationId": "sinch_inbound_sinch_inbound_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Sinch Inbound", "tags": [ "Inbound" ] } }, "/sinch-inbound/{key}": { "post": { "description": "A received-fax notification for one Sinch account, checked with that account's basic auth.", "operationId": "sinch_account_inbound_sinch_inbound__key__post", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "title": "Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Sinch Account Inbound", "tags": [ "Inbound" ] } }, "/telnyx-fax-callback": { "post": { "description": "Telnyx's fax results. A notice signed with the attempt's account key makes Faxbot read the fax's status at\nonce from that account; the status read decides, never the notice's own fields. The Fax Application's own\naddress carries no attempt, so a notice there changes nothing and Faxbot keeps checking by itself.", "operationId": "telnyx_fax_callback_telnyx_fax_callback_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Telnyx Fax Callback" } }, "/work": { "get": { "operationId": "list_work_work_get", "parameters": [ { "in": "query", "name": "view", "required": false, "schema": { "default": "all", "enum": [ "all", "mine", "unassigned", "overdue" ], "title": "View", "type": "string" } }, { "in": "query", "name": "state", "required": false, "schema": { "anyOf": [ { "enum": [ "open", "acknowledged", "done" ], "type": "string" }, { "type": "null" } ], "title": "State" } }, { "in": "query", "name": "mailbox", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Mailbox" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "inbound_fax_id", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Inbound Fax Id" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Work items you can see, with their owner, target and state", "tags": [ "Work" ] } }, "/work/counts": { "get": { "operationId": "work_counts_work_counts_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "How many items you can see in each state", "tags": [ "Work" ] } }, "/work/settings": { "get": { "operationId": "get_settings_work_settings_get", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Acknowledgement targets and backup people", "tags": [ "Work" ] }, "put": { "operationId": "put_settings_work_settings_put", "parameters": [ { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__work__http__SettingsIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Change mailbox acknowledgement targets and backup people", "tags": [ "Work" ] } }, "/work/{item_id}": { "get": { "operationId": "get_work_work__item_id__get", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "One work item", "tags": [ "Work" ] } }, "/work/{item_id}/acknowledge": { "post": { "operationId": "acknowledge_work_work__item_id__acknowledge_post", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__work__http__VersionIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "The owner acknowledges the item", "tags": [ "Work" ] } }, "/work/{item_id}/assign": { "post": { "operationId": "assign_work_work__item_id__assign_post", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Give an item to an owner", "tags": [ "Work" ] } }, "/work/{item_id}/assignees": { "get": { "operationId": "work_assignees_work__item_id__assignees_get", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "People who can see this document and so can own it", "tags": [ "Work" ] } }, "/work/{item_id}/done": { "post": { "operationId": "complete_work_work__item_id__done_post", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DoneIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Mark an item done, with a short note", "tags": [ "Work" ] } }, "/work/{item_id}/export": { "get": { "operationId": "export_work_work__item_id__export_get", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/zip": {} }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Download evidence for an item as a zip", "tags": [ "Work" ] } }, "/work/{item_id}/history": { "get": { "operationId": "work_history_work__item_id__history_get", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "An item's history, oldest first", "tags": [ "Work" ] } }, "/work/{item_id}/reopen": { "post": { "operationId": "reopen_work_work__item_id__reopen_post", "parameters": [ { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "Explicit API key takes precedence over a browser session.", "in": "header", "name": "x-api-key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Explicit API key takes precedence over a browser session.", "title": "X-Api-Key" } }, { "description": "Required with browser cookies for state-changing requests.", "in": "header", "name": "x-csrf-token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required with browser cookies for state-changing requests.", "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__app__work__http__VersionIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Reopen a done item", "tags": [ "Work" ] } } }, "x-faxbot-source": { "coverage": "source declarations; no live installation state or provider verification", "source_files": { "api/app/callback_locator.py": "9faecd06f0a17c77e2f4d7253a4ceac1bcfdf3fc081fb3fc09b8af16eb78fd32", "api/app/config_values.py": "5285949b8a2390156ee6252147b8491801424dfc98c5d620560df27aaa6a351b", "api/app/main.py": "04d662876b3b029d5a9b68708a7d344cf9289aaad575470f15100a52205ce178", "api/app/outbound_callbacks.py": "634458c8901c2118c2b165579cb48fc8ae7eddf2da73bcb476b9c88da2862625", "api/app/provider_catalog.py": "a392e004704541e7fef46ff433378a72bdd74fbc01eb33968efaefb88beb6242", "api/app/provider_signatures.py": "f881a0530a5f46fa794909c52c33c05d9dd32750473b9d425eddd664918e9400", "config/provider_traits.json": "68567a0b79aec92697cafb2fc1db9d8f4b641473cfb3e5f39efe882703190601" }, "source_ref": "main", "source_sha": "54a01d98c5cff32876f631aff96fd151546b3689", "source_tree_dirty": false } }