{"openapi":"3.1.0","info":{"title":"All American Notice — Public API","description":"Programmatic notice creation, lifecycle tracking, and HMAC-signed webhooks for construction CRMs, ERPs, and custom back-office tools.\n\n**Authentication:** Send an `Authorization: Bearer <YOUR_KEY>` header. Keys prefixed `aan_test_*` run against the sandbox (no postage, no charges); `aan_live_*` keys hit production. Generate keys at /client → Developer.\n\n**Webhook signature:** every POST sent to a registered endpoint carries an `X-AAN-Signature: t=<unix_ts>,v1=<sha256>` header where v1 = `HMAC-SHA256(secret, f\"{ts}.\" + raw_body)`. Verify before processing.","contact":{"name":"AAN Developer Support","email":"developers@allamericannotice.com"},"version":"1.0.0"},"paths":{"/api/account/api-keys/scopes":{"get":{"tags":["api-keys"],"summary":"List Scopes","description":"List of scopes that can be assigned to a key (for the UI dropdown).","operationId":"list_scopes_api_account_api_keys_scopes_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/api-keys":{"get":{"tags":["api-keys"],"summary":"List Keys","operationId":"list_keys_api_account_api_keys_get","parameters":[{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyPublic"},"title":"Response List Keys Api Account Api Keys Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["api-keys"],"summary":"Create Key","operationId":"create_key_api_account_api_keys_post","parameters":[{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/api-keys/{key_id}/rotate":{"post":{"tags":["api-keys"],"summary":"Rotate Key","operationId":"rotate_key_api_account_api_keys__key_id__rotate_post","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"string","title":"Key Id"}},{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/api-keys/{key_id}":{"delete":{"tags":["api-keys"],"summary":"Revoke Key","operationId":"revoke_key_api_account_api_keys__key_id__delete","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"string","title":"Key Id"}},{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/api-keys/_settings":{"get":{"tags":["api-keys"],"summary":"Get Api Settings","description":"Read the master client's API settings (for the Developer tab UI).","operationId":"get_api_settings_api_account_api_keys__settings_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["api-keys"],"summary":"Patch Api Settings","operationId":"patch_api_settings_api_account_api_keys__settings_patch","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSettingsUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/notices":{"post":{"tags":["api-v1-notices"],"summary":"Create Notice","description":"Create a new notice from an external system.\n\n**Threshold-hold rule:** if `amount_due` (or `contract_amount` as fallback)\nis **>=** the account's configured `auto_request_threshold`, the notice is\nplaced directly into the full-service queue with status `request`.\nOtherwise it lands in `hold` until the client either updates the amount\nor releases it manually.\n\nRead your account's current threshold at GET /api/v1/account; update it\nat PATCH /api/v1/account/settings.\n\n**Sandbox mode** (`aan_test_*` keys): notice is persisted with\n`api_mode = \"test\"`, flagged in the admin queue, and will skip Lob /\nStripe / Zoho when slice 3 lands. PDFs still generate.","operationId":"create_notice_api_v1_notices_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticeCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticeResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["api-v1-notices"],"summary":"List Notices","description":"List notices created via API by this account.\n\nPagination is cursor-based: pass the `next_cursor` from the previous\nresponse. Filters are AND-combined.","operationId":"list_notices_api_v1_notices_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by status (hold, request, in_progress, sent, etc.)","title":"Status"},"description":"Filter by status (hold, request, in_progress, sent, etc.)"},{"name":"mode","in":"query","required":false,"schema":{"anyOf":[{"enum":["live","test"],"type":"string"},{"type":"null"}],"description":"Filter by api_mode","title":"Mode"},"description":"Filter by api_mode"},{"name":"external_reference","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by your CRM/ERP id","title":"External Reference"},"description":"Filter by your CRM/ERP id"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pagination cursor (use next_cursor from previous response)","title":"Cursor"},"description":"Pagination cursor (use next_cursor from previous response)"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticeListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/notices/{notice_id}":{"get":{"tags":["api-v1-notices"],"summary":"Get Notice","operationId":"get_notice_api_v1_notices__notice_id__get","parameters":[{"name":"notice_id","in":"path","required":true,"schema":{"type":"string","title":"Notice Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticeDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/notices/{notice_id}/tracking":{"get":{"tags":["api-v1-notices"],"summary":"Get Notice Tracking","operationId":"get_notice_tracking_api_v1_notices__notice_id__tracking_get","parameters":[{"name":"notice_id","in":"path","required":true,"schema":{"type":"string","title":"Notice Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/notices/{notice_id}/affidavit.pdf":{"get":{"tags":["api-v1-notices"],"summary":"Get Notice Affidavit Pdf","description":"§713.18 Affidavit of Mailing PDF. Re-uses the same generator as the admin UI.","operationId":"get_notice_affidavit_pdf_api_v1_notices__notice_id__affidavit_pdf_get","parameters":[{"name":"notice_id","in":"path","required":true,"schema":{"type":"string","title":"Notice Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/notices/{notice_id}/release-hold":{"post":{"tags":["api-v1-notices"],"summary":"Release Hold","description":"Manually move a notice from `hold` to `request` (full-service queue).\n\nUse case: the API caller's CRM pushed an order below the auto-request\nthreshold, but the user has decided to send it anyway.","operationId":"release_hold_api_v1_notices__notice_id__release_hold_post","parameters":[{"name":"notice_id","in":"path","required":true,"schema":{"type":"string","title":"Notice Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseHoldResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/account":{"get":{"tags":["api-v1-account"],"summary":"Get Account","operationId":"get_account_api_v1_account_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInfo"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/account/settings":{"patch":{"tags":["api-v1-account"],"summary":"Update Settings","operationId":"update_settings_api_v1_account_settings_patch","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInfo"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/activity":{"get":{"tags":["api-activity"],"summary":"List Activity","description":"Stripe-style request log — recent /api/v1 calls for this account.\n\nJWT-authenticated (not API-key) so it can power the Developer-tab UI.","operationId":"list_activity_api_account_activity_get","parameters":[{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"key_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by api_key_id","title":"Key Id"},"description":"Filter by api_key_id"},{"name":"status_min","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":599,"minimum":100},{"type":"null"}],"title":"Status Min"}},{"name":"status_max","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":599,"minimum":100},{"type":"null"}],"title":"Status Max"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"created_at ISO string from previous page","title":"Cursor"},"description":"created_at ISO string from previous page"},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/activity/summary":{"get":{"tags":["api-activity"],"summary":"Summary","description":"Quick counts for the Developer-tab summary cards.","operationId":"summary_api_account_activity_summary_get","parameters":[{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"hours","in":"query","required":false,"schema":{"type":"integer","maximum":720,"minimum":1,"default":24,"title":"Hours"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/webhooks/events":{"get":{"tags":["webhooks"],"summary":"List Event Types","operationId":"list_event_types_api_account_webhooks_events_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/webhooks":{"get":{"tags":["webhooks"],"summary":"List Webhooks","operationId":"list_webhooks_api_account_webhooks_get","parameters":[{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["webhooks"],"summary":"Create Webhook","operationId":"create_webhook_api_account_webhooks_post","parameters":[{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/webhooks/{ep_id}":{"patch":{"tags":["webhooks"],"summary":"Update Webhook","operationId":"update_webhook_api_account_webhooks__ep_id__patch","parameters":[{"name":"ep_id","in":"path","required":true,"schema":{"type":"string","title":"Ep Id"}},{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["webhooks"],"summary":"Delete Webhook","operationId":"delete_webhook_api_account_webhooks__ep_id__delete","parameters":[{"name":"ep_id","in":"path","required":true,"schema":{"type":"string","title":"Ep Id"}},{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/webhooks/{ep_id}/rotate-secret":{"post":{"tags":["webhooks"],"summary":"Rotate Webhook Secret","operationId":"rotate_webhook_secret_api_account_webhooks__ep_id__rotate_secret_post","parameters":[{"name":"ep_id","in":"path","required":true,"schema":{"type":"string","title":"Ep Id"}},{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/webhooks/{ep_id}/test":{"post":{"tags":["webhooks"],"summary":"Send Test Webhook","description":"Fire a synthetic `webhook.ping` event so the user can verify their endpoint.","operationId":"send_test_webhook_api_account_webhooks__ep_id__test_post","parameters":[{"name":"ep_id","in":"path","required":true,"schema":{"type":"string","title":"Ep Id"}},{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/webhooks/deliveries":{"get":{"tags":["webhooks"],"summary":"List Deliveries","operationId":"list_deliveries_api_account_webhooks_deliveries_get","parameters":[{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"endpoint_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endpoint Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/account/webhooks/deliveries/{delivery_id}/replay":{"post":{"tags":["webhooks"],"summary":"Replay Delivery","description":"Re-queue an exhausted/failed delivery for another attempt cycle.","operationId":"replay_delivery_api_account_webhooks_deliveries__delivery_id__replay_post","parameters":[{"name":"delivery_id","in":"path","required":true,"schema":{"type":"string","title":"Delivery Id"}},{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/openapi.json":{"get":{"tags":["developer-portal"],"summary":"Public Openapi","operationId":"public_openapi_api_v1_openapi_json_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/postman.json":{"get":{"tags":["developer-portal"],"summary":"Public Postman","operationId":"public_postman_api_v1_postman_json_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/docs.html":{"get":{"tags":["developer-portal"],"summary":"Public Swagger","description":"A pre-skinned Swagger UI page wired to the curated spec above. Embedded\ninside the marketing /developers page via iframe.","operationId":"public_swagger_api_v1_docs_html_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"AccountInfo":{"properties":{"client_id":{"type":"string","title":"Client Id"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"mode":{"type":"string","title":"Mode"},"sandbox":{"type":"boolean","title":"Sandbox"},"key_id":{"type":"string","title":"Key Id"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes"},"settings":{"additionalProperties":true,"type":"object","title":"Settings"}},"type":"object","required":["client_id","mode","sandbox","key_id","scopes","settings"],"title":"AccountInfo"},"AccountStatement":{"properties":{"customer_name":{"type":"string","title":"Customer Name"},"statement_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement Date"},"line_items":{"items":{"$ref":"#/components/schemas/StatementLineItem"},"type":"array","title":"Line Items","default":[]},"subtotal":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Subtotal"},"previous_payments":{"type":"number","title":"Previous Payments","default":0.0},"amount_due":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Due"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"uploaded_file_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uploaded File Key"},"uploaded_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uploaded Filename"}},"type":"object","required":["customer_name"],"title":"AccountStatement","description":"Account statement to include with notices (required for Texas)"},"AddLeadsToCampaign":{"properties":{"lead_ids":{"items":{"type":"string"},"type":"array","title":"Lead Ids"}},"type":"object","required":["lead_ids"],"title":"AddLeadsToCampaign"},"AddNoteRequest":{"properties":{"content":{"type":"string","title":"Content"},"is_internal":{"type":"boolean","title":"Is Internal","default":true}},"type":"object","required":["content"],"title":"AddNoteRequest"},"AddRecipientRequest":{"properties":{"name":{"type":"string","title":"Name"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"address":{"type":"string","title":"Address"},"city":{"type":"string","title":"City"},"state":{"type":"string","title":"State"},"zip_code":{"type":"string","title":"Zip Code"},"recipient_type":{"type":"string","title":"Recipient Type","default":"Owner"},"postage_type":{"type":"string","title":"Postage Type","default":"certified_ereturn"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},"type":"object","required":["name","address","city","state","zip_code"],"title":"AddRecipientRequest","description":"Request model for adding recipients to self-service orders"},"AddToQueueRequest":{"properties":{"texas_agent_type":{"type":"string","title":"Texas Agent Type","default":"aa_notice"}},"type":"object","title":"AddToQueueRequest","description":"Request to add an order to the Texas queue"},"AddToTexasQueueRequest":{"properties":{"notice_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notice Type"},"agent_type":{"type":"string","title":"Agent Type","default":"company"},"texas_work_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Texas Work Month"},"texas_work_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Texas Work Year"}},"type":"object","title":"AddToTexasQueueRequest","description":"Request to add an order to Texas print queue"},"AdminAddRequest":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["email"],"title":"AdminAddRequest"},"AdminStatusUpdateRequest":{"properties":{"status":{"type":"string","title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","required":["status"],"title":"AdminStatusUpdateRequest","description":"Request model for admin status transitions"},"AdminUserCreate":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"password":{"type":"string","title":"Password"},"full_name":{"type":"string","title":"Full Name"},"phone":{"type":"string","title":"Phone","default":""},"admin_permissions":{"items":{"type":"string"},"type":"array","title":"Admin Permissions","default":[]}},"type":"object","required":["email","password","full_name"],"title":"AdminUserCreate"},"AdminUserUpdate":{"properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"admin_permissions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Admin Permissions"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}},"type":"object","title":"AdminUserUpdate"},"AffidavitRequest":{"properties":{"acknowledged":{"type":"boolean","title":"Acknowledged","default":true},"notes":{"type":"string","title":"Notes","default":""}},"type":"object","title":"AffidavitRequest"},"AgentSigningPatch":{"properties":{"agent_signing_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Agent Signing Enabled"},"agent_signer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Signer Name"},"agent_signer_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Signer Title"}},"type":"object","title":"AgentSigningPatch"},"ApiKeyCreateRequest":{"properties":{"name":{"type":"string","maxLength":80,"minLength":1,"title":"Name"},"mode":{"type":"string","enum":["live","test"],"title":"Mode","default":"test"},"scopes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Scopes"}},"type":"object","required":["name"],"title":"ApiKeyCreateRequest"},"ApiKeyCreatedResponse":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"mode":{"type":"string","enum":["live","test"],"title":"Mode"},"prefix":{"type":"string","title":"Prefix"},"last_4":{"type":"string","title":"Last 4"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes"},"created_at":{"type":"string","title":"Created At"},"last_used_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Used At"},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revoked At"},"secret":{"type":"string","title":"Secret"}},"type":"object","required":["id","name","mode","prefix","last_4","scopes","created_at","secret"],"title":"ApiKeyCreatedResponse","description":"One-time response that includes the FULL secret. Shown to the user once."},"ApiKeyPublic":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"mode":{"type":"string","enum":["live","test"],"title":"Mode"},"prefix":{"type":"string","title":"Prefix"},"last_4":{"type":"string","title":"Last 4"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes"},"created_at":{"type":"string","title":"Created At"},"last_used_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Used At"},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revoked At"}},"type":"object","required":["id","name","mode","prefix","last_4","scopes","created_at"],"title":"ApiKeyPublic","description":"Sanitized — never includes the secret."},"ApiSettingsUpdate":{"properties":{"auto_request_threshold":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Auto Request Threshold"},"hold_grace_period_days":{"anyOf":[{"type":"integer","maximum":365.0,"minimum":0.0},{"type":"null"}],"title":"Hold Grace Period Days"}},"type":"object","title":"ApiSettingsUpdate"},"ApplyMasterScheduleRequest":{"properties":{"settings":{"$ref":"#/components/schemas/MasterScheduleSettings"},"apply_to_statuses":{"items":{"type":"string"},"type":"array","title":"Apply To Statuses","default":["in_progress","pending"]},"lead_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Lead Ids"}},"type":"object","required":["settings"],"title":"ApplyMasterScheduleRequest"},"ApproveForMailBody":{"properties":{"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"type":"object","title":"ApproveForMailBody"},"ArchiveTestOrdersRequest":{"properties":{"order_ids":{"items":{"type":"string"},"type":"array","title":"Order Ids"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","default":"Marked as test order for cleanup"}},"type":"object","required":["order_ids"],"title":"ArchiveTestOrdersRequest"},"AssignOrderRequest":{"properties":{"staff_id":{"type":"string","title":"Staff Id"}},"type":"object","required":["staff_id"],"title":"AssignOrderRequest"},"AutoInvoicePreference":{"properties":{"auto_invoice":{"type":"boolean","title":"Auto Invoice"}},"type":"object","required":["auto_invoice"],"title":"AutoInvoicePreference"},"BillingConfigurationPatch":{"properties":{"tier":{"anyOf":[{"type":"string","enum":["basic","pro","enterprise"]},{"type":"null"}],"title":"Tier"},"billing_mode":{"anyOf":[{"type":"string","enum":["per_notice_card","per_notice_invoice","periodic_15_day"]},{"type":"null"}],"title":"Billing Mode"},"activate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Activate","description":"When True, set account_status='active' so the customer can start receiving notices. When False, force it back to awaiting_billing_setup."}},"type":"object","title":"BillingConfigurationPatch"},"BillingTypeUpdate":{"properties":{"billing_type":{"type":"string","title":"Billing Type"}},"type":"object","required":["billing_type"],"title":"BillingTypeUpdate"},"BlogPostCreate":{"properties":{"title":{"type":"string","maxLength":200,"minLength":1,"title":"Title"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug"},"content":{"type":"string","minLength":1,"title":"Content"},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Excerpt"},"meta_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Meta Description"},"meta_keywords":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Meta Keywords"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","default":[]},"featured_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Featured Image"},"author_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Author Name","default":"All American Notice"},"post_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Post Status"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"additionalProperties":true,"type":"object","required":["title","content"],"title":"BlogPostCreate"},"BlogPostUpdate":{"properties":{"title":{"type":"string","maxLength":200,"minLength":1,"title":"Title"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug"},"content":{"type":"string","minLength":1,"title":"Content"},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Excerpt"},"meta_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Meta Description"},"meta_keywords":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Meta Keywords"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","default":[]},"featured_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Featured Image"},"author_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Author Name","default":"All American Notice"},"post_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Post Status"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"additionalProperties":true,"type":"object","required":["title","content"],"title":"BlogPostUpdate"},"Body_bulk_add_document_api_bulk_orders_add_document_post":{"properties":{"order_numbers":{"type":"string","title":"Order Numbers","description":"Comma or newline separated order numbers"},"document_name":{"type":"string","title":"Document Name"},"document_type":{"type":"string","title":"Document Type","default":"attachment"},"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["order_numbers","document_name","file"],"title":"Body_bulk_add_document_api_bulk_orders_add_document_post"},"Body_bulk_mark_as_contacted_api_leads_bulk_mark_contacted_post":{"properties":{"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"target_list_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target List Id"},"lead_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Lead Ids"},"contact_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Date"}},"type":"object","title":"Body_bulk_mark_as_contacted_api_leads_bulk_mark_contacted_post"},"Body_bulk_update_state_api_leads_bulk_state_post":{"properties":{"lead_ids":{"items":{"type":"string"},"type":"array","title":"Lead Ids"},"state":{"type":"string","title":"State"}},"type":"object","required":["lead_ids","state"],"title":"Body_bulk_update_state_api_leads_bulk_state_post"},"Body_client_upload_api_notary_client_upload__token__post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_client_upload_api_notary_client_upload__token__post"},"Body_import_leads_api_leads_import_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_import_leads_api_leads_import_post"},"Body_public_upload_file_api_public_upload__order_id__post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_public_upload_file_api_public_upload__order_id__post"},"Body_reschedule_lead_emails_api_email_campaigns__campaign_id__reschedule_lead__lead_id__post":{"properties":{"start_from_step":{"type":"integer","title":"Start From Step","description":"Step to start/restart from","default":1},"delay_hours":{"type":"integer","title":"Delay Hours","description":"Hours from now to schedule first email","default":0}},"type":"object","title":"Body_reschedule_lead_emails_api_email_campaigns__campaign_id__reschedule_lead__lead_id__post"},"Body_reset_all_schedules_api_email_campaigns__campaign_id__reset_all_schedules_post":{"properties":{"delay_hours":{"type":"integer","title":"Delay Hours","description":"Hours from now to start","default":0},"include_statuses":{"items":{"type":"string"},"type":"array","title":"Include Statuses","default":["in_progress","pending"]}},"type":"object","title":"Body_reset_all_schedules_api_email_campaigns__campaign_id__reset_all_schedules_post"},"Body_trigger_campaign_emails_now_api_email_campaigns__campaign_id__trigger_now_post":{"properties":{"lead_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Lead Ids","description":"Specific lead IDs to trigger, or null for all overdue"},"force_all_pending":{"type":"boolean","title":"Force All Pending","description":"Send all pending emails regardless of schedule","default":false}},"type":"object","title":"Body_trigger_campaign_emails_now_api_email_campaigns__campaign_id__trigger_now_post"},"Body_upload_batch_orders_api_batch_import_upload_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_batch_orders_api_batch_import_upload_post"},"Body_upload_blog_cover_api_admin_blog_cover_upload_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_blog_cover_api_admin_blog_cover_upload_post"},"Body_upload_linkedin_image_api_admin_linkedin_images__slug__upload_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_linkedin_image_api_admin_linkedin_images__slug__upload_post"},"Body_upload_manual_proof_api_proof_of_mailing_orders__order_id__manual_proof_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"},"scope":{"type":"string","title":"Scope"},"recipient_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Id"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"acceptance_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Acceptance Date"},"mailed_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mailed By"}},"type":"object","required":["file","scope"],"title":"Body_upload_manual_proof_api_proof_of_mailing_orders__order_id__manual_proof_post"},"Body_upload_notarized_api_admin_orders__order_id__notarized_upload_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_notarized_api_admin_orders__order_id__notarized_upload_post"},"Body_upload_onboarding_doc_api_admin_clients__client_id__onboarding_docs_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"},"doc_type":{"type":"string","title":"Doc Type","default":"signed_agreement"},"notes":{"type":"string","title":"Notes","default":""}},"type":"object","required":["file"],"title":"Body_upload_onboarding_doc_api_admin_clients__client_id__onboarding_docs_post"},"Body_upload_order_file_api_orders__order_id__files_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_order_file_api_orders__order_id__files_post"},"Body_upload_poa_api_admin_clients__client_id__poa_upload_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_poa_api_admin_clients__client_id__poa_upload_post"},"Body_validate_batch_file_api_batch_import_validate_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_validate_batch_file_api_batch_import_validate_post"},"BranchInfo":{"properties":{"id":{"type":"string","title":"Id","default":""},"name":{"type":"string","title":"Name","default":""},"address":{"type":"string","title":"Address","default":""},"city":{"type":"string","title":"City","default":""},"state":{"type":"string","title":"State","default":""},"zip_code":{"type":"string","title":"Zip Code","default":""},"phone":{"type":"string","title":"Phone","default":""},"email":{"type":"string","title":"Email","default":""},"contact_name":{"type":"string","title":"Contact Name","default":""},"is_active":{"type":"boolean","title":"Is Active","default":true},"default_signing_agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Signing Agent Id"}},"type":"object","title":"BranchInfo","description":"Branch information for enterprise clients"},"BulkCompanyInput":{"properties":{"companies":{"items":{"$ref":"#/components/schemas/CompanyInput"},"type":"array","title":"Companies"},"use_search_fallback":{"type":"boolean","title":"Use Search Fallback","default":false}},"type":"object","required":["companies"],"title":"BulkCompanyInput"},"BulkDeleteRequest":{"properties":{"lead_ids":{"items":{"type":"string"},"type":"array","title":"Lead Ids"}},"type":"object","required":["lead_ids"],"title":"BulkDeleteRequest"},"BulkNoteRequest":{"properties":{"order_numbers":{"items":{"type":"string"},"type":"array","title":"Order Numbers"},"note_text":{"type":"string","title":"Note Text"},"note_type":{"type":"string","title":"Note Type","default":"general"}},"type":"object","required":["order_numbers","note_text"],"title":"BulkNoteRequest"},"BulkRequest":{"properties":{"ids":{"items":{"type":"string"},"type":"array","title":"Ids"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","required":["ids"],"title":"BulkRequest"},"BulkResetRequest":{"properties":{"lead_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Lead Ids"},"reset_to_step":{"type":"integer","title":"Reset To Step","default":1},"delay_hours":{"type":"integer","title":"Delay Hours","default":0},"only_unsent":{"type":"boolean","title":"Only Unsent","default":true}},"type":"object","title":"BulkResetRequest"},"BulkRetractionRequest":{"properties":{"recipient_ids":{"items":{"type":"string"},"type":"array","title":"Recipient Ids"},"custom_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Message"},"mail_type":{"type":"string","title":"Mail Type","default":"first_class"}},"type":"object","required":["recipient_ids"],"title":"BulkRetractionRequest","description":"Request to send retraction packages to multiple recipients at once"},"BulkStatusRequest":{"properties":{"lead_ids":{"items":{"type":"string"},"type":"array","title":"Lead Ids"},"status":{"$ref":"#/components/schemas/LeadStatus"}},"type":"object","required":["lead_ids","status"],"title":"BulkStatusRequest"},"BulkStepAssignmentRequest":{"properties":{"target_step":{"type":"integer","title":"Target Step"},"direction":{"type":"string","title":"Direction","default":"set"},"steps_to_move":{"type":"integer","title":"Steps To Move","default":1},"lead_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Lead Ids"},"include_statuses":{"items":{"type":"string"},"type":"array","title":"Include Statuses","default":["in_progress"]},"recalculate_schedule":{"type":"boolean","title":"Recalculate Schedule","default":true},"delay_hours":{"type":"integer","title":"Delay Hours","default":0}},"type":"object","required":["target_step"],"title":"BulkStepAssignmentRequest"},"BulkTagRequest":{"properties":{"lead_ids":{"items":{"type":"string"},"type":"array","title":"Lead Ids"},"tag":{"type":"string","title":"Tag"}},"type":"object","required":["lead_ids","tag"],"title":"BulkTagRequest"},"CCEmailsUpdateRequest":{"properties":{"cc_emails":{"items":{"type":"string"},"type":"array","title":"Cc Emails","default":[]}},"type":"object","title":"CCEmailsUpdateRequest"},"CalculateRequest":{"properties":{"state":{"type":"string","maxLength":2,"minLength":2,"title":"State"},"first_furnish_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Furnish Date"},"last_furnish_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Furnish Date"}},"type":"object","required":["state"],"title":"CalculateRequest"},"CampaignCreate":{"properties":{"name":{"type":"string","title":"Name"},"sequence_id":{"type":"string","title":"Sequence Id","default":"standard_outreach"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"daily_limit":{"type":"integer","title":"Daily Limit","default":1000},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date"},"target_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target State"}},"type":"object","required":["name"],"title":"CampaignCreate"},"CampaignFilters":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"created":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created"},"has_email":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Email"},"never_emailed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Never Emailed"}},"type":"object","title":"CampaignFilters","description":"Filters to apply when creating a campaign"},"CampaignUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"daily_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Daily Limit"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}},"type":"object","title":"CampaignUpdate"},"CancelOrderRequest":{"properties":{"reason":{"type":"string","title":"Reason"},"cancel_document_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cancel Document File Id"}},"type":"object","required":["reason"],"title":"CancelOrderRequest","description":"Request model for cancelling an order"},"CancelRevisionRequest":{"properties":{"cancel_reason":{"type":"string","title":"Cancel Reason"}},"type":"object","required":["cancel_reason"],"title":"CancelRevisionRequest","description":"Request to cancel a revision without mailing"},"ChangeNoticeTypeRequest":{"properties":{"new_notice_type":{"type":"string","title":"New Notice Type"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","required":["new_notice_type"],"title":"ChangeNoticeTypeRequest","description":"Request to change a Texas order's notice type"},"ChangeOrderTypeRequest":{"properties":{"new_notice_type":{"type":"string","title":"New Notice Type"},"reason":{"type":"string","title":"Reason"}},"type":"object","required":["new_notice_type","reason"],"title":"ChangeOrderTypeRequest","description":"Request model for changing an order's notice type (Admin only)"},"ChangePasswordRequest":{"properties":{"current_password":{"type":"string","title":"Current Password"},"new_password":{"type":"string","title":"New Password"}},"type":"object","required":["current_password","new_password"],"title":"ChangePasswordRequest"},"ChargeAcknowledgement":{"properties":{"acknowledged":{"type":"boolean","title":"Acknowledged","default":true}},"type":"object","title":"ChargeAcknowledgement"},"ChatMessage":{"properties":{"content":{"type":"string","title":"Content"}},"type":"object","required":["content"],"title":"ChatMessage","description":"A single chat message"},"ChecklistItemSubmission":{"properties":{"key":{"type":"string","title":"Key"},"confirmed_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confirmed Value"},"confirmed":{"type":"boolean","title":"Confirmed","default":false},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["key"],"title":"ChecklistItemSubmission"},"ChecklistSaveBody":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ChecklistItemSubmission"},"type":"array","title":"Items"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"final_attest":{"type":"boolean","title":"Final Attest","default":false}},"type":"object","required":["items"],"title":"ChecklistSaveBody"},"CheckoutResponse":{"properties":{"checkout_url":{"type":"string","title":"Checkout Url"},"session_id":{"type":"string","title":"Session Id"}},"type":"object","required":["checkout_url","session_id"],"title":"CheckoutResponse"},"ClearMailBlockRequest":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","title":"ClearMailBlockRequest"},"ClientControls":{"properties":{"active":{"type":"boolean","title":"Active","default":true},"enable_login":{"type":"boolean","title":"Enable Login","default":true},"stop_service":{"type":"boolean","title":"Stop Service","default":false},"disable_title_case":{"type":"boolean","title":"Disable Title Case","default":false},"require_branch":{"type":"boolean","title":"Require Branch","default":false},"require_job_number":{"type":"boolean","title":"Require Job Number","default":false},"require_customer_number":{"type":"boolean","title":"Require Customer Number","default":false},"show_account_statement":{"type":"boolean","title":"Show Account Statement","default":false},"show_amount_due_table":{"type":"boolean","title":"Show Amount Due Table","default":false},"show_complete_and_hold":{"type":"boolean","title":"Show Complete And Hold","default":false},"show_date_on_notice":{"type":"boolean","title":"Show Date On Notice","default":true},"show_extended_footer":{"type":"boolean","title":"Show Extended Footer","default":false},"show_job_number_on_notices":{"type":"boolean","title":"Show Job Number On Notices","default":true},"show_postal_notes":{"type":"boolean","title":"Show Postal Notes","default":false},"show_search_dropdown":{"type":"boolean","title":"Show Search Dropdown","default":true},"show_sub_account_selection":{"type":"boolean","title":"Show Sub Account Selection","default":false},"show_verify":{"type":"boolean","title":"Show Verify","default":false},"show_restricted":{"type":"boolean","title":"Show Restricted","default":false},"show_signing_agents":{"type":"boolean","title":"Show Signing Agents","default":false},"show_drafts":{"type":"boolean","title":"Show Drafts","default":false},"show_self_service_requests":{"type":"boolean","title":"Show Self Service Requests","default":true},"show_state_requirements":{"type":"boolean","title":"Show State Requirements","default":true},"show_lien_release_option":{"type":"boolean","title":"Show Lien Release Option","default":true},"show_clone":{"type":"boolean","title":"Show Clone","default":true},"page_break_after_branch":{"type":"boolean","title":"Page Break After Branch","default":false},"allow_update_requestor_info":{"type":"boolean","title":"Allow Update Requestor Info","default":false},"disable_cc_surcharge":{"type":"boolean","title":"Disable Cc Surcharge","default":false},"disable_job_info_request":{"type":"boolean","title":"Disable Job Info Request","default":false},"piggy_back_allowed":{"type":"boolean","title":"Piggy Back Allowed","default":false},"share_bond_companies":{"type":"boolean","title":"Share Bond Companies","default":true},"share_customers":{"type":"boolean","title":"Share Customers","default":false},"share_general_contractors":{"type":"boolean","title":"Share General Contractors","default":true},"send_completed_alerts":{"type":"boolean","title":"Send Completed Alerts","default":false},"completed_alerts_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completed Alerts Email"},"send_email_alerts":{"type":"boolean","title":"Send Email Alerts","default":false},"open_access_client":{"type":"boolean","title":"Open Access Client","default":false},"print_customer_copy":{"type":"boolean","title":"Print Customer Copy","default":false},"email_usps_report":{"type":"boolean","title":"Email Usps Report","default":false},"return_receipt_to_us":{"type":"boolean","title":"Return Receipt To Us","default":false},"has_power_of_attorney":{"type":"boolean","title":"Has Power Of Attorney","default":false},"use_print_queue":{"type":"boolean","title":"Use Print Queue","default":false},"show_all_in_print_queue":{"type":"boolean","title":"Show All In Print Queue","default":false},"auto_hide_recipients_60_day":{"type":"boolean","title":"Auto Hide Recipients 60 Day","default":false},"assisted_lien_release_allowed":{"type":"boolean","title":"Assisted Lien Release Allowed","default":false},"rate_includes_postage":{"type":"number","title":"Rate Includes Postage","default":0.0},"default_postage":{"type":"string","title":"Default Postage","default":"certified"},"do_not_contact":{"type":"boolean","title":"Do Not Contact","default":false},"has_credit":{"type":"boolean","title":"Has Credit","default":false},"good_payment":{"type":"boolean","title":"Good Payment","default":false},"require_prepay":{"type":"boolean","title":"Require Prepay","default":false},"skip_review":{"type":"boolean","title":"Skip Review","default":false},"first_notice_free":{"type":"boolean","title":"First Notice Free","default":false},"unbilled_notification_threshold":{"type":"number","title":"Unbilled Notification Threshold","default":500.0},"unbilled_notifications_enabled":{"type":"boolean","title":"Unbilled Notifications Enabled","default":true},"white_label":{"type":"boolean","title":"White Label","default":false},"billing_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Type"}},"type":"object","title":"ClientControls","description":"Client account controls and feature toggles"},"ClientNoteCreate":{"properties":{"content":{"type":"string","title":"Content"},"note_type":{"type":"string","title":"Note Type","default":"general"}},"type":"object","required":["content"],"title":"ClientNoteCreate","description":"Create a note for a client"},"ClientOrderReviewRequest":{"properties":{"action":{"type":"string","title":"Action"},"comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comments"}},"type":"object","required":["action"],"title":"ClientOrderReviewRequest","description":"Request model for client order review actions"},"ClientProfileCreate":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"password":{"type":"string","title":"Password"},"company_name":{"type":"string","title":"Company Name"},"contact_name":{"type":"string","title":"Contact Name","default":""},"phone":{"type":"string","title":"Phone","default":""},"fax":{"type":"string","title":"Fax","default":""},"address":{"type":"string","title":"Address","default":""},"city":{"type":"string","title":"City","default":""},"state":{"type":"string","title":"State","default":""},"zip_code":{"type":"string","title":"Zip Code","default":""},"owner_name":{"type":"string","title":"Owner Name","default":""},"owner_email":{"type":"string","title":"Owner Email","default":""},"tier":{"type":"string","title":"Tier","default":"basic"},"receipt_email":{"type":"string","title":"Receipt Email","default":""},"job_description":{"type":"string","title":"Job Description","default":""},"referral_source":{"type":"string","title":"Referral Source","default":""},"white_label":{"type":"boolean","title":"White Label","default":false},"customer_color":{"type":"string","title":"Customer Color","default":""},"customer_website":{"type":"string","title":"Customer Website","default":""},"customer_notes":{"type":"string","title":"Customer Notes","default":""},"order_information":{"type":"string","title":"Order Information","default":""}},"type":"object","required":["email","password","company_name"],"title":"ClientProfileCreate","description":"Create a new client profile"},"ClientProfileUpdate":{"properties":{"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"fax":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fax"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip Code"},"owner_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Name"},"owner_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Email"},"tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tier"},"receipt_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Email"},"billing_frequency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Frequency"},"job_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Description"},"referral_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referral Source"},"researcher":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Researcher"},"white_label":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"White Label"},"customer_color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Color"},"customer_website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Website"},"has_credit_card_on_file":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Credit Card On File"},"customer_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Notes"},"order_information":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Information"},"lien_notary_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lien Notary Name"},"lien_notary_county":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lien Notary County"},"controls":{"anyOf":[{"$ref":"#/components/schemas/ClientControls"},{"type":"null"}]},"custom_fee_schedule":{"anyOf":[{"additionalProperties":{"type":"number"},"type":"object"},{"type":"null"}],"title":"Custom Fee Schedule"}},"type":"object","title":"ClientProfileUpdate","description":"Update client profile"},"ClientSubUserCreate":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Password"},"full_name":{"type":"string","title":"Full Name"},"phone":{"type":"string","title":"Phone","default":""},"permission_tier":{"type":"string","title":"Permission Tier","default":"admin"},"send_setup_link":{"type":"boolean","title":"Send Setup Link","default":false}},"type":"object","required":["email","full_name"],"title":"ClientSubUserCreate"},"ClientSubUserUpdate":{"properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"permission_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Tier"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}},"type":"object","title":"ClientSubUserUpdate"},"CompanyInput":{"properties":{"company_name":{"type":"string","title":"Company Name"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"}},"type":"object","required":["company_name"],"title":"CompanyInput"},"CompleteSetupRequest":{"properties":{"session_id":{"type":"string","title":"Session Id"}},"type":"object","required":["session_id"],"title":"CompleteSetupRequest"},"CompletedPacketResendRequest":{"properties":{"override_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Override Emails"}},"type":"object","title":"CompletedPacketResendRequest"},"ComposeRequest":{"properties":{"subject":{"type":"string","maxLength":200,"minLength":1,"title":"Subject"},"html_body":{"type":"string","minLength":1,"title":"Html Body"},"preheader":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Preheader"}},"type":"object","required":["subject","html_body"],"title":"ComposeRequest"},"ContactFormRequest":{"properties":{"name":{"type":"string","title":"Name"},"email":{"type":"string","title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"subject":{"type":"string","title":"Subject"},"message":{"type":"string","title":"Message"}},"type":"object","required":["name","email","subject","message"],"title":"ContactFormRequest","description":"Contact form request model"},"ConvertRescindToRevisionRequest":{"properties":{"reason":{"type":"string","title":"Reason"},"admin_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Admin Note"}},"type":"object","required":["reason"],"title":"ConvertRescindToRevisionRequest","description":"Request model for converting a rescind request to a revision"},"CreateCheckoutRequest":{"properties":{"order_id":{"type":"string","title":"Order Id"},"origin_url":{"type":"string","title":"Origin Url"}},"type":"object","required":["order_id","origin_url"],"title":"CreateCheckoutRequest"},"CreateInvoiceFromOrderBody":{"properties":{"order_id":{"type":"string","title":"Order Id"},"amount":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Amount","description":"Override; defaults to order.amount_due"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"}},"type":"object","required":["order_id"],"title":"CreateInvoiceFromOrderBody"},"CreateInvoiceRequest":{"properties":{"client_id":{"type":"string","title":"Client Id"},"billing_period_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Period Start"},"billing_period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Period End"},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date"},"include_order_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Include Order Ids"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["client_id"],"title":"CreateInvoiceRequest"},"CustomerInfo":{"properties":{"company_name":{"type":"string","maxLength":200,"minLength":1,"title":"Company Name"},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name"},"address":{"type":"string","title":"Address"},"city":{"type":"string","title":"City"},"state":{"type":"string","maxLength":2,"minLength":2,"title":"State"},"zip_code":{"type":"string","title":"Zip Code"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},"type":"object","required":["company_name","address","city","state","zip_code"],"title":"CustomerInfo","description":"Who hired the claimant (typically the GC for a sub, or the sub for a supplier)."},"DebugKeyRequest":{"properties":{"name":{"type":"string","maxLength":80,"title":"Name","default":"Debug key — auto-generated"},"duration_hours":{"type":"integer","maximum":72.0,"minimum":1.0,"title":"Duration Hours","default":24}},"type":"object","title":"DebugKeyRequest"},"DeletionRequestIn":{"properties":{"reason":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Reason"},"confirm_email":{"type":"string","title":"Confirm Email","description":"The user's own email — sanity check that the right account is being requested"}},"type":"object","required":["confirm_email"],"title":"DeletionRequestIn"},"DepositCheckoutRequest":{"properties":{"amount":{"type":"number","exclusiveMinimum":0.0,"title":"Amount","description":"Deposit amount in dollars"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","default":"Postage deposit"},"email_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email To"},"payment_methods":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Payment Methods","description":"Stripe payment method types — defaults to ['card','us_bank_account'] (Card + ACH)."},"send_email":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Email","description":"If True, also email the link to the client immediately.","default":false},"order_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order Count","description":"(metadata) # orders the deposit covers"},"per_order_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Per Order Rate","description":"(metadata) per-order rate used"}},"type":"object","required":["amount"],"title":"DepositCheckoutRequest"},"DepositManualRequest":{"properties":{"amount":{"type":"number","exclusiveMinimum":0.0,"title":"Amount"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","default":"Postage deposit"},"method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Method","default":"manual"},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference"}},"type":"object","required":["amount"],"title":"DepositManualRequest"},"DepositSettingsRequest":{"properties":{"requires_postage_deposit":{"type":"boolean","title":"Requires Postage Deposit"}},"type":"object","required":["requires_postage_deposit"],"title":"DepositSettingsRequest"},"DiagnoseDeliveryReq":{"properties":{"delivery_id":{"type":"string","title":"Delivery Id"}},"type":"object","required":["delivery_id"],"title":"DiagnoseDeliveryReq"},"DiagnoseTenantReq":{"properties":{"user_id":{"type":"string","title":"User Id"},"question":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Question"}},"type":"object","required":["user_id"],"title":"DiagnoseTenantReq"},"DocumentFeesUpdate":{"properties":{"preliminary_notice_researched":{"type":"number","title":"Preliminary Notice Researched","default":30.0},"preliminary_notice_not_researched":{"type":"number","title":"Preliminary Notice Not Researched","default":13.0},"notice_of_intent_to_lien":{"type":"number","title":"Notice Of Intent To Lien","default":30.0},"mechanics_lien":{"type":"number","title":"Mechanics Lien","default":250.0},"claim_on_bond":{"type":"number","title":"Claim On Bond","default":30.0},"satisfaction_of_lien":{"type":"number","title":"Satisfaction Of Lien","default":125.0},"research_only":{"type":"number","title":"Research Only","default":20.0}},"type":"object","title":"DocumentFeesUpdate"},"DomainCheckRequest":{"properties":{"domain":{"type":"string","title":"Domain"}},"type":"object","required":["domain"],"title":"DomainCheckRequest","description":"Check domain before using credits"},"DomainSearchRequest":{"properties":{"domain":{"type":"string","title":"Domain"},"positions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Positions"}},"type":"object","required":["domain"],"title":"DomainSearchRequest","description":"Search for company info and prospects by domain"},"DraftReplyReq":{"properties":{"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"},"error_pattern":{"type":"string","maxLength":2000,"minLength":4,"title":"Error Pattern"},"tone":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Tone","default":"friendly_professional"}},"type":"object","required":["error_pattern"],"title":"DraftReplyReq"},"DraftReplyResponse":{"properties":{"draft":{"type":"string","title":"Draft"},"reply_id":{"type":"string","title":"Reply Id"},"suggested_subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Suggested Subject"},"model":{"type":"string","title":"Model","default":"claude-sonnet-4-5-20250929"}},"type":"object","required":["draft","reply_id"],"title":"DraftReplyResponse"},"DuplicateCheckRequest":{"properties":{"project_address":{"type":"string","title":"Project Address"},"project_city":{"type":"string","title":"Project City"},"project_state":{"type":"string","title":"Project State"},"job_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Name"},"job_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Number"},"who_hired_company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Who Hired Company"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"}},"type":"object","required":["project_address","project_city","project_state"],"title":"DuplicateCheckRequest"},"EmailCampaignCreate":{"properties":{"name":{"type":"string","minLength":1,"title":"Name"},"subject":{"type":"string","minLength":1,"title":"Subject"},"body_html":{"type":"string","minLength":1,"title":"Body Html"},"lead_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Lead Ids"},"filter_status":{"anyOf":[{"items":{"$ref":"#/components/schemas/LeadStatus"},"type":"array"},{"type":"null"}],"title":"Filter Status"},"filter_tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Filter Tags"},"filter_never_emailed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Filter Never Emailed","default":false},"target_list_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target List Id"},"filters":{"anyOf":[{"$ref":"#/components/schemas/CampaignFilters"},{"type":"null"}]},"lead_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lead Limit"}},"type":"object","required":["name","subject","body_html"],"title":"EmailCampaignCreate"},"EmailFinderRequest":{"properties":{"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"domain":{"type":"string","title":"Domain"}},"type":"object","required":["first_name","last_name","domain"],"title":"EmailFinderRequest","description":"Find email by name and domain"},"EmailInvoiceOverride":{"properties":{"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Html"}},"type":"object","title":"EmailInvoiceOverride"},"EmailNotificationEntry":{"properties":{"email":{"type":"string","title":"Email"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","default":""},"is_primary":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Primary","default":false},"preferences":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Preferences"}},"type":"object","required":["email"],"title":"EmailNotificationEntry"},"EmailNotificationsUpdateRequest":{"properties":{"email_notifications":{"items":{"$ref":"#/components/schemas/EmailNotificationEntry"},"type":"array","title":"Email Notifications","default":[]}},"type":"object","title":"EmailNotificationsUpdateRequest"},"EmailProofRequest":{"properties":{"recipient_email":{"type":"string","format":"email","title":"Recipient Email"},"recipient_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Name"},"include_tracking_details":{"type":"boolean","title":"Include Tracking Details","default":true},"custom_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Message"}},"type":"object","required":["recipient_email"],"title":"EmailProofRequest","description":"Request to email proof of mailing to client"},"EmailScheduleItem":{"properties":{"step":{"type":"integer","title":"Step"},"template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Id"},"subject_override":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject Override"},"scheduled_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scheduled At"},"sent":{"type":"boolean","title":"Sent","default":false},"sent_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sent At"}},"type":"object","required":["step"],"title":"EmailScheduleItem"},"EmbedStatusResponse":{"properties":{"procore_project_id":{"type":"string","title":"Procore Project Id"},"aan_user_id":{"type":"string","title":"Aan User Id"},"already_filed":{"type":"boolean","title":"Already Filed"},"latest_order_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Latest Order Id"},"latest_work_order_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Latest Work Order Number"},"latest_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Latest Status"},"latest_filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Latest Filed At"},"document_available":{"type":"boolean","title":"Document Available","default":false},"document_doc_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Doc Type"}},"type":"object","required":["procore_project_id","aan_user_id","already_filed"],"title":"EmbedStatusResponse"},"EscalateReq":{"properties":{"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"},"context_text":{"type":"string","maxLength":10000,"minLength":10,"title":"Context Text"}},"type":"object","required":["context_text"],"title":"EscalateReq"},"ExplainActivityReq":{"properties":{"activity_id":{"type":"string","title":"Activity Id"}},"type":"object","required":["activity_id"],"title":"ExplainActivityReq"},"ExtraCharge":{"properties":{"description":{"type":"string","title":"Description"},"amount":{"type":"number","title":"Amount"}},"type":"object","required":["description","amount"],"title":"ExtraCharge"},"FileNoticeRequest":{"properties":{"notice_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notice Type"},"notes":{"anyOf":[{"type":"string","maxLength":400},{"type":"null"}],"title":"Notes"}},"type":"object","title":"FileNoticeRequest","description":"One-click body. Embed callers DO NOT get to choose notice_type:\nthe iframe is intentionally scoped to preliminary notices only —\nliens, bond claims, and other advanced documents must be filed\nfrom the AAN portal (see `/dashboard` → New Work Order) so the\ncustomer can review the document-specific data fields.\n\nThe `notice_type` field exists here only so the polling worker's\n`create_or_get_order_from_procore_project` helper has a uniform\nsignature. The embed route at `/embed/file-notice` ignores any\nvalue the iframe might POST and the helper defaults to the\nstate-specific preliminary notice (NOTICE_TO_OWNER for FL, etc.)."},"FileNoticeResponse":{"properties":{"order_id":{"type":"string","title":"Order Id"},"work_order_number":{"type":"string","title":"Work Order Number"},"status":{"type":"string","title":"Status"},"message":{"type":"string","title":"Message"}},"type":"object","required":["order_id","work_order_number","status","message"],"title":"FileNoticeResponse"},"FileRegistration":{"properties":{"order_id":{"type":"string","title":"Order Id"},"s3_key":{"type":"string","title":"S3 Key"},"original_filename":{"type":"string","title":"Original Filename"},"file_size":{"type":"integer","title":"File Size"},"content_type":{"type":"string","title":"Content Type"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["order_id","s3_key","original_filename","file_size","content_type"],"title":"FileRegistration"},"FilteredMarketingRequest":{"properties":{"subject_template":{"type":"string","title":"Subject Template","default":"Hi {contact_name} its Beth haven't touched base in a while"},"body_html":{"type":"string","title":"Body Html"},"reply_to":{"type":"string","title":"Reply To","default":"info@allamericannotice.com"},"test_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Test Email"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"created":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"never_emailed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Never Emailed","default":false},"import_batch":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Import Batch"}},"type":"object","required":["body_html"],"title":"FilteredMarketingRequest","description":"Request model for filter-based marketing campaign"},"FixOnlyRevisionRequest":{"properties":{"revision_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Reason","default":"Fix-only revision - no mailing required"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","title":"FixOnlyRevisionRequest","description":"Request to complete a revision without mailing (fix-only)"},"ForgotPasswordRequest":{"properties":{"email":{"type":"string","title":"Email"}},"type":"object","required":["email"],"title":"ForgotPasswordRequest"},"GenerateLinkRequest":{"properties":{"amount":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Amount"}},"type":"object","title":"GenerateLinkRequest","description":"Optional override — by default we use invoice.amount_due."},"GenerateSeoRequest":{"properties":{"title":{"type":"string","maxLength":300,"minLength":3,"title":"Title"},"content":{"type":"string","minLength":50,"title":"Content"},"category":{"type":"string","title":"Category","default":""}},"type":"object","required":["title","content"],"title":"GenerateSeoRequest"},"GenerateSingleTrackingRequest":{"properties":{"mail_type":{"type":"string","title":"Mail Type","default":"certified_return_receipt"}},"type":"object","title":"GenerateSingleTrackingRequest","description":"Request to generate tracking for a single recipient"},"GenericNotarizationRequest":{"properties":{"signer_email":{"type":"string","title":"Signer Email"},"signer_first_name":{"type":"string","title":"Signer First Name"},"signer_last_name":{"type":"string","title":"Signer Last Name"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"}},"type":"object","required":["signer_email","signer_first_name","signer_last_name"],"title":"GenericNotarizationRequest","description":"Request to send any document for notarization"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HandshakeRequest":{"properties":{"procore_token":{"type":"string","maxLength":8192,"minLength":10,"title":"Procore Token"}},"type":"object","required":["procore_token"],"title":"HandshakeRequest","description":"The frontend reads `procore_token` out of the iframe URL and POSTs\nit here. We return a short-lived AAN session token + the project\nsummary the widget needs to render its one-button UI."},"HandshakeResponse":{"properties":{"embed_session_token":{"type":"string","title":"Embed Session Token"},"expires_at":{"type":"string","title":"Expires At"},"aan_company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Aan Company Name"},"procore_company_id":{"type":"string","title":"Procore Company Id"},"procore_project_id":{"type":"string","title":"Procore Project Id"},"procore_user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Procore User Email"},"aan_connected":{"type":"boolean","title":"Aan Connected"}},"type":"object","required":["embed_session_token","expires_at","procore_company_id","procore_project_id","aan_connected"],"title":"HandshakeResponse"},"ImpersonateEnd":{"properties":{"session_id":{"type":"string","title":"Session Id"}},"type":"object","required":["session_id"],"title":"ImpersonateEnd"},"ImpersonateStart":{"properties":{"target_user_id":{"type":"string","title":"Target User Id"},"mode":{"type":"string","pattern":"^(read_only|write)$","title":"Mode"},"reason":{"type":"string","maxLength":400,"minLength":6,"title":"Reason"},"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Password"}},"type":"object","required":["target_user_id","mode","reason"],"title":"ImpersonateStart"},"ImportProspectsRequest":{"properties":{"prospects":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Prospects"}},"type":"object","required":["prospects"],"title":"ImportProspectsRequest","description":"Import selected prospects to leads database"},"ImportScrapedRequest":{"properties":{"contractors":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Contractors"}},"type":"object","required":["contractors"],"title":"ImportScrapedRequest","description":"Import scraped contractors to leads"},"IndexNowRequest":{"properties":{"urls":{"items":{"type":"string"},"type":"array","title":"Urls"}},"type":"object","required":["urls"],"title":"IndexNowRequest"},"IndexNowResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"submitted_urls":{"items":{"type":"string"},"type":"array","title":"Submitted Urls"},"failed_urls":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Failed Urls"}},"type":"object","required":["success","message","submitted_urls"],"title":"IndexNowResponse"},"InvoiceLineItem":{"properties":{"order_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Id"},"work_order_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Order Number"},"description":{"type":"string","title":"Description"},"quantity":{"type":"integer","title":"Quantity","default":1},"unit_price":{"type":"number","title":"Unit Price"},"total":{"type":"number","title":"Total"},"notice_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notice Type"},"project_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project State"},"line_item_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line Item Type"},"revision_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Reason"},"postage_waived":{"type":"boolean","title":"Postage Waived","default":false},"waive_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Waive Reason"}},"type":"object","required":["description","unit_price","total"],"title":"InvoiceLineItem"},"JobNimbusConfig":{"properties":{"api_key":{"type":"string","minLength":8,"title":"Api Key"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret"}},"type":"object","required":["api_key"],"title":"JobNimbusConfig"},"KickBackRequest":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","title":"KickBackRequest"},"LeadCreate":{"properties":{"company_name":{"type":"string","minLength":1,"title":"Company Name"},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip Code"},"source":{"$ref":"#/components/schemas/LeadSource","default":"manual"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","default":[]}},"type":"object","required":["company_name"],"title":"LeadCreate"},"LeadRequest":{"properties":{"contact_name":{"type":"string","maxLength":120,"minLength":1,"title":"Contact Name"},"email":{"type":"string","format":"email","title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"state":{"type":"string","maxLength":2,"minLength":2,"title":"State"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"first_furnish_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Furnish Date"},"last_furnish_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Furnish Date"},"deadlines_snapshot":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Deadlines Snapshot"},"consent_reminders":{"type":"boolean","title":"Consent Reminders","default":true}},"type":"object","required":["contact_name","email","state"],"title":"LeadRequest"},"LeadSource":{"type":"string","enum":["manual","import","website","referral","other"],"title":"LeadSource"},"LeadStatus":{"type":"string","enum":["new","contacted","interested","not_interested","converted","unsubscribed"],"title":"LeadStatus"},"LeadUpdate":{"properties":{"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip Code"},"status":{"anyOf":[{"$ref":"#/components/schemas/LeadStatus"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags"}},"type":"object","title":"LeadUpdate"},"LienDocumentRequest":{"properties":{"document_type":{"type":"string","title":"Document Type"}},"type":"object","required":["document_type"],"title":"LienDocumentRequest","description":"Request model for generating lien documents"},"MailingRequest":{"properties":{"mail_type":{"type":"string","title":"Mail Type","default":"certified_return_receipt"},"recipient_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Recipient Ids"}},"type":"object","title":"MailingRequest"},"ManageOrderOverrideRequest":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"service_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Type"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","title":"ManageOrderOverrideRequest"},"MarkFailedBody":{"properties":{"reason":{"type":"string","title":"Reason"}},"type":"object","required":["reason"],"title":"MarkFailedBody"},"MarkInvoicePaidRequest":{"properties":{"amount":{"type":"number","title":"Amount"},"payment_method":{"type":"string","title":"Payment Method","description":"check, wire, ach, stripe, credit"},"payment_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Date"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Number"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["amount","payment_method"],"title":"MarkInvoicePaidRequest"},"MarketingEmailRequest":{"properties":{"state":{"type":"string","title":"State"},"subject_template":{"type":"string","title":"Subject Template","default":"Hi {contact_name} its Beth haven't touched base in a while"},"body_html":{"type":"string","title":"Body Html"},"reply_to":{"type":"string","title":"Reply To","default":"info@allamericannotice.com"},"test_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Test Email"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}},"type":"object","required":["state","body_html"],"title":"MarketingEmailRequest"},"MasterScheduleSettings":{"properties":{"steps":{"items":{"$ref":"#/components/schemas/MasterScheduleStep"},"type":"array","title":"Steps"},"start_delay_hours":{"type":"integer","title":"Start Delay Hours","default":0},"respect_business_hours":{"type":"boolean","title":"Respect Business Hours","default":true}},"type":"object","required":["steps"],"title":"MasterScheduleSettings"},"MasterScheduleStep":{"properties":{"step":{"type":"integer","title":"Step"},"delay_days":{"type":"integer","title":"Delay Days","default":2},"send_time_hour":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Send Time Hour"},"send_time_minute":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Send Time Minute","default":0},"template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Id"},"subject_override":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject Override"}},"type":"object","required":["step"],"title":"MasterScheduleStep"},"MechanicsLienRequest":{"properties":{"order_id":{"type":"string","title":"Order Id"},"amount_claimed":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Claimed"},"work_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Description"},"first_furnishing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Furnishing Date"},"last_furnishing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Furnishing Date"},"custom_legal_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Legal Description"}},"type":"object","required":["order_id"],"title":"MechanicsLienRequest"},"MoneyEmailSettingsPayload":{"properties":{"admin_cc":{"items":{"type":"string"},"type":"array","title":"Admin Cc","default":[]}},"type":"object","title":"MoneyEmailSettingsPayload"},"NDARequest":{"properties":{"partner_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Name"},"partner_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Address"},"partner_signer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Signer Name"},"partner_signer_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Signer Title"},"aan_signer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Aan Signer Name"},"aan_signer_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Aan Signer Title"},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date"}},"type":"object","title":"NDARequest"},"NotarizationMethodUpdate":{"properties":{"notarization_method":{"type":"string","title":"Notarization Method"}},"type":"object","required":["notarization_method"],"title":"NotarizationMethodUpdate","description":"Request to update notarization method for an order"},"NotarizationRequest":{"properties":{"order_id":{"type":"string","title":"Order Id"},"signer_email":{"type":"string","title":"Signer Email"},"signer_first_name":{"type":"string","title":"Signer First Name"},"signer_last_name":{"type":"string","title":"Signer Last Name"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","default":"Please review and sign this Sworn Statement of Account"}},"type":"object","required":["order_id","signer_email","signer_first_name","signer_last_name"],"title":"NotarizationRequest","description":"Request to send a document for notarization"},"NoticeCreate":{"properties":{"notice_type":{"type":"string","title":"Notice Type","examples":["notice_to_owner","mechanics_lien","notice_of_intent"]},"state":{"type":"string","maxLength":2,"minLength":2,"title":"State","examples":["FL"]},"job_name":{"type":"string","maxLength":200,"minLength":1,"title":"Job Name"},"job_number":{"type":"string","maxLength":80,"minLength":1,"title":"Job Number"},"project_address":{"type":"string","title":"Project Address"},"project_city":{"type":"string","title":"Project City"},"project_zip":{"type":"string","title":"Project Zip"},"first_day_on_job":{"type":"string","title":"First Day On Job","examples":["2026-02-15"]},"last_day_on_job":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Day On Job"},"work_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Description"},"contract_amount":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Contract Amount"},"amount_due":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Amount Due","description":"Unpaid balance — used to decide threshold-hold."},"customer":{"$ref":"#/components/schemas/CustomerInfo"},"recipients":{"items":{"$ref":"#/components/schemas/RecipientInput"},"type":"array","title":"Recipients","default":[]},"service_type":{"type":"string","enum":["full_service","self_service"],"title":"Service Type","default":"full_service"},"is_rush":{"type":"boolean","title":"Is Rush","default":false},"legal_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Description"},"external_reference":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"External Reference","description":"Your own CRM/ERP id for cross-referencing."}},"type":"object","required":["notice_type","state","job_name","job_number","project_address","project_city","project_zip","first_day_on_job","customer"],"title":"NoticeCreate","description":"Public schema for POST /api/v1/notices. The caller is responsible\nfor the accuracy of every field (per ToS — see PRD section on liability)."},"NoticeDetail":{"properties":{"id":{"type":"string","title":"Id"},"work_order_number":{"type":"string","title":"Work Order Number"},"status":{"type":"string","title":"Status"},"notice_type":{"type":"string","title":"Notice Type"},"state":{"type":"string","title":"State"},"job_name":{"type":"string","title":"Job Name"},"job_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Number"},"project_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Address"},"project_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project City"},"project_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Zip"},"contract_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Contract Amount"},"amount_due":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Due"},"service_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Type"},"external_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Reference"},"mode":{"type":"string","title":"Mode"},"sandbox":{"type":"boolean","title":"Sandbox"},"threshold_at_creation":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Threshold At Creation"},"threshold_balance_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Threshold Balance Used"},"threshold_promoted_to_request":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Threshold Promoted To Request"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"sent_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sent At"},"recipients":{"items":{"$ref":"#/components/schemas/RecipientSummary"},"type":"array","title":"Recipients","default":[]}},"type":"object","required":["id","work_order_number","status","notice_type","state","job_name","mode","sandbox"],"title":"NoticeDetail"},"NoticeListItem":{"properties":{"id":{"type":"string","title":"Id"},"work_order_number":{"type":"string","title":"Work Order Number"},"status":{"type":"string","title":"Status"},"notice_type":{"type":"string","title":"Notice Type"},"state":{"type":"string","title":"State"},"job_name":{"type":"string","title":"Job Name"},"external_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Reference"},"amount_due":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Due"},"mode":{"type":"string","title":"Mode"},"sandbox":{"type":"boolean","title":"Sandbox"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"sent_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sent At"}},"type":"object","required":["id","work_order_number","status","notice_type","state","job_name","mode","sandbox"],"title":"NoticeListItem"},"NoticeListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NoticeListItem"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["data","has_more"],"title":"NoticeListResponse"},"NoticeResponse":{"properties":{"id":{"type":"string","title":"Id"},"work_order_number":{"type":"string","title":"Work Order Number"},"status":{"type":"string","enum":["hold","request"],"title":"Status"},"mode":{"type":"string","enum":["live","test"],"title":"Mode"},"sandbox":{"type":"boolean","title":"Sandbox"},"threshold_applied":{"type":"number","title":"Threshold Applied"},"contract_balance_used":{"type":"number","title":"Contract Balance Used"},"promoted_to_request":{"type":"boolean","title":"Promoted To Request"},"external_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Reference"},"created_at":{"type":"string","title":"Created At"},"message":{"type":"string","title":"Message"}},"type":"object","required":["id","work_order_number","status","mode","sandbox","threshold_applied","contract_balance_used","promoted_to_request","created_at","message"],"title":"NoticeResponse"},"NotificationSettingsUpdate":{"properties":{"new_client_notification_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New Client Notification Email"},"new_order_notification_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New Order Notification Email"},"payment_notification_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Notification Email"},"enable_new_client_notifications":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enable New Client Notifications"},"enable_new_order_notifications":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enable New Order Notifications"},"enable_payment_notifications":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enable Payment Notifications"}},"type":"object","title":"NotificationSettingsUpdate"},"OrderCreate":{"properties":{"service_type":{"type":"string","title":"Service Type","default":"full_service"},"notice_type":{"type":"string","title":"Notice Type"},"job_name":{"type":"string","title":"Job Name"},"project_address":{"type":"string","title":"Project Address"},"project_city":{"type":"string","title":"Project City"},"project_state":{"type":"string","title":"Project State"},"project_zip":{"type":"string","title":"Project Zip"},"first_day_on_job":{"type":"string","title":"First Day On Job"},"last_day_on_job":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Day On Job"},"job_number":{"type":"string","title":"Job Number"},"work_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Description"},"who_hired_them":{"$ref":"#/components/schemas/WhoHiredThem"},"contract_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Contract Amount"},"amount_due":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Due"},"is_rush":{"type":"boolean","title":"Is Rush","default":false},"request_professional_review":{"type":"boolean","title":"Request Professional Review","default":false},"recipients":{"items":{"$ref":"#/components/schemas/RecipientInfo"},"type":"array","title":"Recipients","default":[]},"requires_research":{"type":"boolean","title":"Requires Research","default":true},"mailing_class":{"type":"string","title":"Mailing Class","default":"certified"},"admin_created_for_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Admin Created For User Id"},"legal_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Description"},"branch_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Branch Id"},"signing_agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signing Agent Id"},"client_signor_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Signor Name"},"client_signor_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Signor Title"}},"type":"object","required":["notice_type","job_name","project_address","project_city","project_state","project_zip","first_day_on_job","job_number","who_hired_them"],"title":"OrderCreate"},"OrderEditRequest":{"properties":{"job_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Name"},"project_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Address"},"project_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project City"},"project_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project State"},"project_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Zip"},"first_day_on_job":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Day On Job"},"last_day_on_job":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Day On Job"},"job_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Number"},"work_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Description"},"contract_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Contract Amount"},"amount_due":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Due"},"who_hired_them":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Who Hired Them"},"edit_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Edit Reason"}},"type":"object","title":"OrderEditRequest"},"OrderStatusUpdateRequest":{"properties":{"status":{"type":"string","title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","required":["status"],"title":"OrderStatusUpdateRequest"},"OrderWaiverRequest":{"properties":{"waiver_type":{"type":"string","title":"Waiver Type"},"payment_amount":{"type":"number","title":"Payment Amount","default":0.0},"through_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Through Date"},"signatory_name":{"type":"string","title":"Signatory Name"},"signatory_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signatory Title"},"payment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method","default":"check"},"check_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Check Number"},"check_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Check Date"},"include_notary":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Notary","default":false},"comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comments"}},"type":"object","required":["waiver_type","signatory_name"],"title":"OrderWaiverRequest","description":"Request to generate a waiver from an order"},"PasswordChangeRequest":{"properties":{"new_password":{"type":"string","title":"New Password"},"confirm_password":{"type":"string","title":"Confirm Password"}},"type":"object","required":["new_password","confirm_password"],"title":"PasswordChangeRequest","description":"Password change request"},"PayAndSendRequest":{"properties":{"order_id":{"type":"string","title":"Order Id"},"origin_url":{"type":"string","title":"Origin Url"}},"type":"object","required":["order_id","origin_url"],"title":"PayAndSendRequest","description":"Request for Pay & Send checkout"},"PayAndSendResponse":{"properties":{"checkout_url":{"type":"string","title":"Checkout Url"},"session_id":{"type":"string","title":"Session Id"}},"type":"object","required":["checkout_url","session_id"],"title":"PayAndSendResponse","description":"Response for Pay & Send checkout"},"PerNoticeBillingPreferenceRequest":{"properties":{"per_notice_auto_charge":{"type":"string","title":"Per Notice Auto Charge"}},"type":"object","required":["per_notice_auto_charge"],"title":"PerNoticeBillingPreferenceRequest"},"PerNoticeResendRequest":{"properties":{"invoice_id":{"type":"string","title":"Invoice Id"}},"type":"object","required":["invoice_id"],"title":"PerNoticeResendRequest"},"PostageBillingRequest":{"properties":{"billing_type":{"type":"string","title":"Billing Type"},"recipient_count":{"type":"integer","title":"Recipient Count"},"postage_rate":{"type":"number","title":"Postage Rate"},"description":{"type":"string","title":"Description"},"waive_charge":{"type":"boolean","title":"Waive Charge","default":false},"waive_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Waive Reason"}},"type":"object","required":["billing_type","recipient_count","postage_rate","description"],"title":"PostageBillingRequest","description":"Request model for billing postage on revisions/rescind"},"PostageOverrideRequest":{"properties":{"mail_type":{"type":"string","title":"Mail Type"}},"type":"object","required":["mail_type"],"title":"PostageOverrideRequest"},"PostageRatesUpdate":{"properties":{"first_class":{"type":"number","title":"First Class"},"certified_ereturn":{"type":"number","title":"Certified Ereturn"},"registered":{"type":"number","title":"Registered"}},"type":"object","required":["first_class","certified_ereturn","registered"],"title":"PostageRatesUpdate"},"PricingUpdate":{"properties":{"document_fee":{"type":"number","title":"Document Fee","default":30.0},"postage_type":{"type":"string","title":"Postage Type","default":"certified_ereturn"},"recipient_count":{"type":"integer","title":"Recipient Count","default":1},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"extra_charges":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExtraCharge"},"type":"array"},{"type":"null"}],"title":"Extra Charges"},"rush_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rush Fee"}},"type":"object","title":"PricingUpdate"},"ProjectInfoSubmission":{"properties":{"order_id":{"type":"string","title":"Order Id"},"token":{"type":"string","title":"Token"},"owner_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Name"},"owner_company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Company"},"owner_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Address"},"owner_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner City"},"owner_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner State"},"owner_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Zip"},"owner_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Phone"},"owner_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Email"},"gc_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gc Name"},"gc_company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gc Company"},"gc_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gc Address"},"gc_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gc City"},"gc_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gc State"},"gc_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gc Zip"},"gc_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gc Phone"},"gc_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gc Email"},"lender_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lender Name"},"lender_company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lender Company"},"lender_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lender Address"},"lender_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lender City"},"lender_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lender State"},"lender_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lender Zip"},"lender_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lender Phone"},"surety_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Surety Name"},"surety_company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Surety Company"},"surety_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Surety Address"},"surety_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Surety City"},"surety_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Surety State"},"surety_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Surety Zip"},"bond_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bond Number"},"has_noc":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Noc","default":false},"noc_recording_info":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noc Recording Info"},"additional_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additional Notes"},"submitter_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submitter Name"},"submitter_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submitter Email"}},"type":"object","required":["order_id","token"],"title":"ProjectInfoSubmission","description":"Data submitted by customer via web form"},"ProofreadConfirmBody":{"properties":{"admin_attestation":{"type":"boolean","title":"Admin Attestation","default":true},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"type":"object","title":"ProofreadConfirmBody"},"ProspectCtx":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"trade":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trade"},"company_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Size"},"monthly_notice_volume":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Monthly Notice Volume"}},"type":"object","title":"ProspectCtx"},"PushMemoBody":{"properties":{"order_id":{"type":"string","title":"Order Id"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"type":"object","required":["order_id"],"title":"PushMemoBody"},"RecipientCreate":{"properties":{"name":{"type":"string","title":"Name"},"recipient_type":{"type":"string","title":"Recipient Type"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip Code"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"is_primary":{"type":"boolean","title":"Is Primary","default":false},"postage_type":{"type":"string","title":"Postage Type","default":"certified"}},"type":"object","required":["name","recipient_type"],"title":"RecipientCreate","description":"Request model for creating a recipient"},"RecipientDelete":{"properties":{"reason":{"type":"string","title":"Reason"}},"type":"object","required":["reason"],"title":"RecipientDelete"},"RecipientHide":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","title":"RecipientHide","description":"Request to hide a recipient from the notice"},"RecipientInfo":{"properties":{"name":{"type":"string","title":"Name"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"address":{"type":"string","title":"Address"},"city":{"type":"string","title":"City"},"state":{"type":"string","title":"State"},"zip_code":{"type":"string","title":"Zip Code"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"recipient_type":{"type":"string","title":"Recipient Type","default":"Owner"},"postage_type":{"type":"string","title":"Postage Type","default":"certified"},"tracking_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracking Number"},"is_deleted":{"type":"boolean","title":"Is Deleted","default":false},"deleted_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deleted Reason"},"deleted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deleted At"},"deleted_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deleted By"},"is_hidden":{"type":"boolean","title":"Is Hidden","default":false},"hidden_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hidden Reason"},"hidden_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hidden At"},"hidden_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hidden By"},"is_soft_deleted":{"type":"boolean","title":"Is Soft Deleted","default":false},"soft_deleted_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Soft Deleted Reason"},"soft_deleted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Soft Deleted At"},"soft_deleted_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Soft Deleted By"}},"type":"object","required":["name","address","city","state","zip_code"],"title":"RecipientInfo"},"RecipientInput":{"properties":{"name":{"type":"string","title":"Name"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"address":{"type":"string","title":"Address"},"city":{"type":"string","title":"City"},"state":{"type":"string","maxLength":2,"minLength":2,"title":"State"},"zip_code":{"type":"string","title":"Zip Code"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"recipient_type":{"type":"string","title":"Recipient Type","default":"Owner"},"postage_type":{"type":"string","title":"Postage Type","default":"certified"}},"type":"object","required":["name","address","city","state","zip_code"],"title":"RecipientInput","description":"A party that should receive the notice (owner / GC / lender / sub)."},"RecipientSoftDelete":{"properties":{"reason":{"type":"string","title":"Reason"}},"type":"object","required":["reason"],"title":"RecipientSoftDelete","description":"Request to soft-delete a recipient (admin only)"},"RecipientSummary":{"properties":{"name":{"type":"string","title":"Name"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"address":{"type":"string","title":"Address"},"city":{"type":"string","title":"City"},"state":{"type":"string","title":"State"},"zip_code":{"type":"string","title":"Zip Code"},"recipient_type":{"type":"string","title":"Recipient Type"},"tracking_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracking Number"},"tracking_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracking Status"}},"type":"object","required":["name","address","city","state","zip_code","recipient_type"],"title":"RecipientSummary"},"RecipientUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"recipient_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Type"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip Code"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"is_primary":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Primary"},"postage_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postage Type"},"is_hidden":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Hidden"}},"type":"object","title":"RecipientUpdate","description":"Request model for updating a recipient"},"RecordPaymentRequest":{"properties":{"amount":{"type":"number","title":"Amount"},"method":{"type":"string","title":"Method","default":"stripe"},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["amount"],"title":"RecordPaymentRequest","description":"Request to record a manual payment on an invoice"},"RefreshTrackingRequest":{"properties":{"recipient_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Recipient Ids"}},"type":"object","title":"RefreshTrackingRequest","description":"Request to refresh tracking for specific recipients"},"RejectRequest":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","title":"RejectRequest"},"ReleaseHoldResponse":{"properties":{"id":{"type":"string","title":"Id"},"work_order_number":{"type":"string","title":"Work Order Number"},"previous_status":{"type":"string","title":"Previous Status"},"new_status":{"type":"string","title":"New Status"},"message":{"type":"string","title":"Message"}},"type":"object","required":["id","work_order_number","previous_status","new_status","message"],"title":"ReleaseHoldResponse"},"ReminderCreate":{"properties":{"order_id":{"type":"string","title":"Order Id"},"reminder_date":{"type":"string","title":"Reminder Date"},"reminder_type":{"type":"string","title":"Reminder Type","default":"email"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"type":"object","required":["order_id","reminder_date"],"title":"ReminderCreate"},"ReminderUpdate":{"properties":{"reminder_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reminder Date"},"reminder_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reminder Type"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}},"type":"object","title":"ReminderUpdate"},"ReplyToLeadRequest":{"properties":{"to_email":{"type":"string","title":"To Email"},"subject":{"type":"string","title":"Subject"},"body":{"type":"string","title":"Body"},"reply_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reply Id"}},"type":"object","required":["to_email","subject","body"],"title":"ReplyToLeadRequest"},"RescindDocumentRequest":{"properties":{"reason":{"type":"string","title":"Reason"},"original_notice_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Notice Date"},"send_first_class":{"type":"boolean","title":"Send First Class","default":true}},"type":"object","required":["reason"],"title":"RescindDocumentRequest","description":"Request model for generating rescind documents"},"RescindPackageRequest":{"properties":{"reason":{"type":"string","title":"Reason","default":"At the request of the claimant."},"original_notice_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Notice Date"},"postage_type":{"type":"string","title":"Postage Type","default":"first_class"},"recipient_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Recipient Ids"}},"type":"object","title":"RescindPackageRequest","description":"Request model for creating a full rescind package"},"RescindProcessRequest":{"properties":{"reason":{"type":"string","title":"Reason","default":"At the request of the claimant."},"original_notice_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Notice Date"}},"type":"object","title":"RescindProcessRequest","description":"Request to process a rescind (mail canceled notices to all recipients)"},"RescindRequestPayload":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment"}},"type":"object","title":"RescindRequestPayload"},"ResearchChecklistSubmission":{"properties":{"checklist_responses":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Checklist Responses"},"researcher_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Researcher Notes"}},"type":"object","required":["checklist_responses"],"title":"ResearchChecklistSubmission","description":"Schema for submitting a completed research checklist"},"ResearchData":{"properties":{"legal_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Description"},"property_owner":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Owner"},"property_owner_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Owner Address"},"property_control_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Control Number"},"parcel_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parcel Number"},"county":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"County"},"has_bond":{"type":"boolean","title":"Has Bond","default":false},"bond_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bond Number"},"bond_company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bond Company"},"bond_company_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bond Company Address"},"has_notice_of_commencement":{"type":"boolean","title":"Has Notice Of Commencement","default":false},"noc_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noc Date"},"noc_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noc Number"},"noc_or_book":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noc Or Book"},"noc_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noc Page"},"noc_recording_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noc Recording Date"},"noc_book_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noc Book Page"},"noc_instrument_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noc Instrument Number"},"noc_expiration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noc Expiration Date"},"noc_designee":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noc Designee"},"permit_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permit Number"},"permit_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permit Date"},"permit_amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permit Amount"},"additional_recipients":{"items":{"$ref":"#/components/schemas/RecipientInfo"},"type":"array","title":"Additional Recipients","default":[]},"additional_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additional Notes"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"lien_or_book":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lien Or Book"},"lien_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lien Page"},"lien_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lien Document Number"},"lien_filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lien Filing Date"},"lien_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lien Amount"},"lender_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lender Name"},"lender_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lender Address"},"loan_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Loan Number"},"folio_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folio Number"},"property_appraiser_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Appraiser Url"},"recording_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Date"},"recording_book":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Book"},"recording_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Page"},"recording_instrument_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Instrument Number"},"nto_served_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nto Served Date"},"ntc_served_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ntc Served Date"},"job_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Type"}},"type":"object","title":"ResearchData"},"ResearchPacketFlag":{"properties":{"is_research_packet":{"type":"boolean","title":"Is Research Packet"}},"type":"object","required":["is_research_packet"],"title":"ResearchPacketFlag"},"ResendMailRequest":{"properties":{"recipient_ids":{"items":{"type":"string"},"type":"array","title":"Recipient Ids"},"mailing_type":{"type":"string","title":"Mailing Type","default":"resend"},"use_certified":{"type":"boolean","title":"Use Certified","default":true},"use_return_receipt":{"type":"boolean","title":"Use Return Receipt","default":true}},"type":"object","required":["recipient_ids"],"title":"ResendMailRequest","description":"Request to resend mail via Lob"},"ResetPasswordRequest":{"properties":{"token":{"type":"string","title":"Token"},"new_password":{"type":"string","title":"New Password"}},"type":"object","required":["token","new_password"],"title":"ResetPasswordRequest"},"RespondBody":{"properties":{"objection":{"type":"string","maxLength":2000,"minLength":2,"title":"Objection"},"prospect":{"anyOf":[{"$ref":"#/components/schemas/ProspectCtx"},{"type":"null"}]},"tier_offered":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tier Offered"},"deal_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Size"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id"}},"type":"object","required":["objection"],"title":"RespondBody"},"RestoreRushRequest":{"properties":{"activity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Activity Id"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","title":"RestoreRushRequest","description":"Admin-only body for undoing a rush removal.\n\nOptionally pin the restore to a specific `rush_removed` activity\nentry id (useful when there have been multiple removals). Default\nbehaviour is to replay the most recent `rush_removed` entry."},"RetractionLetterRequest":{"properties":{"recipient_id":{"type":"string","title":"Recipient Id"},"custom_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Message"}},"type":"object","required":["recipient_id"],"title":"RetractionLetterRequest","description":"Request to send a retraction letter to a recipient"},"RetractionRequest":{"properties":{"reason":{"type":"string","title":"Reason"},"recipient_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Recipient Ids"},"custom_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Message"}},"type":"object","required":["reason"],"title":"RetractionRequest","description":"Request model for creating a retraction package"},"ReturnedMailCreate":{"properties":{"recipient_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Id"},"recipient_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Name"},"recipient_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Address"},"return_reason":{"type":"string","enum":["refused","unclaimed","moved_not_forwardable","no_such_address","vacant","attempted_not_known","insufficient_address","other"],"title":"Return Reason"},"usps_endorsement_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usps Endorsement Date"},"mail_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mail Class"},"certified_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Certified Number"},"mailed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mailed Date"},"box_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Number","description":"Physical box/file #"},"file_location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Location","description":"Free-form file location/cabinet/drawer notes"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"envelope_status":{"type":"string","enum":["sealed","opened_in_litigation","destroyed"],"title":"Envelope Status","default":"sealed"},"scanned_envelope_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scanned Envelope Url"}},"type":"object","required":["return_reason"],"title":"ReturnedMailCreate","description":"Payload to log a returned mail piece."},"ReturnedMailUpdate":{"properties":{"return_reason":{"anyOf":[{"type":"string","enum":["refused","unclaimed","moved_not_forwardable","no_such_address","vacant","attempted_not_known","insufficient_address","other"]},{"type":"null"}],"title":"Return Reason"},"usps_endorsement_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usps Endorsement Date"},"box_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Number"},"file_location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Location"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"envelope_status":{"anyOf":[{"type":"string","enum":["sealed","opened_in_litigation","destroyed"]},{"type":"null"}],"title":"Envelope Status"},"scanned_envelope_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scanned Envelope Url"},"recipient_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Name"},"recipient_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Address"},"certified_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Certified Number"},"mail_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mail Class"},"mailed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mailed Date"}},"type":"object","title":"ReturnedMailUpdate"},"ReviewActionRequest":{"properties":{"action":{"type":"string","title":"Action"},"feedback":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Feedback"},"postage_recommendations":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postage Recommendations"}},"type":"object","required":["action"],"title":"ReviewActionRequest"},"RevisionApproval":{"properties":{"approved":{"type":"boolean","title":"Approved"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["approved"],"title":"RevisionApproval","description":"Request model for approving/rejecting a revision"},"RevisionEditRequest":{"properties":{"job_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Name"},"project_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Address"},"project_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project City"},"project_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project State"},"project_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Zip"},"first_day_on_job":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Day On Job"},"last_day_on_job":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Day On Job"},"job_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Number"},"work_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Description"},"contract_amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Amount"},"amount_due":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount Due"},"who_hired_them":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Who Hired Them"},"notice_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notice Date"},"property_owner":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Owner"},"legal_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Description"},"county":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"County"},"revision_note":{"type":"string","title":"Revision Note"}},"type":"object","required":["revision_note"],"title":"RevisionEditRequest","description":"Request to edit order fields during revision"},"RevisionProcessRequest":{"properties":{"revision_note":{"type":"string","title":"Revision Note","default":"Revision processed"},"revision_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Reason"},"recipient_mail_options":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Recipient Mail Options"},"waive_postage":{"type":"boolean","title":"Waive Postage","default":false},"waive_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Waive Reason"}},"type":"object","title":"RevisionProcessRequest","description":"Request to process a revision (mail revised notices)"},"RevisionRequestPayload":{"properties":{"reason":{"type":"string","title":"Reason"},"corrections":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Corrections"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment"}},"type":"object","required":["reason"],"title":"RevisionRequestPayload"},"SatisfactionOfLienRequest":{"properties":{"order_id":{"type":"string","title":"Order Id"},"amount_satisfied":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Satisfied"},"lien_recording_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lien Recording Date"},"lien_instrument_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lien Instrument Number"},"lien_book":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lien Book"},"lien_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lien Page"}},"type":"object","required":["order_id"],"title":"SatisfactionOfLienRequest"},"SavedCustomerCreate":{"properties":{"company_name":{"type":"string","title":"Company Name"},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name"},"address":{"type":"string","title":"Address"},"city":{"type":"string","title":"City"},"state":{"type":"string","title":"State"},"zip_code":{"type":"string","title":"Zip Code"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"do_not_contact":{"type":"boolean","title":"Do Not Contact","default":false},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"auto_assign_id":{"type":"boolean","title":"Auto Assign Id","default":false}},"type":"object","required":["company_name","address","city","state","zip_code"],"title":"SavedCustomerCreate"},"SavedCustomerUpdate":{"properties":{"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip Code"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"do_not_contact":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Do Not Contact"},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"}},"type":"object","title":"SavedCustomerUpdate"},"SendAllRecipientsRequest":{"properties":{"mail_type":{"type":"string","title":"Mail Type","default":"certified_return_receipt"}},"type":"object","title":"SendAllRecipientsRequest","description":"Request to send notices to all recipients"},"SendCustomEmailRequest":{"properties":{"order_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Id"},"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"},"subject":{"type":"string","title":"Subject"},"body_text":{"type":"string","title":"Body Text"}},"type":"object","required":["subject","body_text"],"title":"SendCustomEmailRequest"},"SendInvoiceRequest":{"properties":{"override_total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Override Total"},"note_to_client":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note To Client"}},"type":"object","title":"SendInvoiceRequest"},"SendMailRequest":{"properties":{"recipient_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Recipient Ids"},"use_recipient_postage_type":{"type":"boolean","title":"Use Recipient Postage Type","default":true},"use_certified":{"type":"boolean","title":"Use Certified","default":true},"use_return_receipt":{"type":"boolean","title":"Use Return Receipt","default":true}},"type":"object","title":"SendMailRequest","description":"Request to send mail via Lob\n\nWhen use_recipient_postage_type is True (default), the recipient's\nindividual postage_type setting is used. Otherwise, use_certified \nand use_return_receipt will override for all recipients."},"SendOrderEmailRequest":{"properties":{"subject":{"type":"string","title":"Subject"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"body_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Html"},"to_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Email"},"to_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"To Emails"},"cc_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cc Emails"},"attachment_file_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Attachment File Ids"}},"type":"object","required":["subject"],"title":"SendOrderEmailRequest"},"SendRecipientNoticeRequest":{"properties":{"recipient_id":{"type":"string","title":"Recipient Id"},"mail_type":{"type":"string","title":"Mail Type","default":"first_class"}},"type":"object","required":["recipient_id"],"title":"SendRecipientNoticeRequest","description":"Request to send a single recipient's notice via Lob"},"SendRequest":{"properties":{"subject":{"type":"string","maxLength":200,"minLength":1,"title":"Subject"},"html_body":{"type":"string","minLength":1,"title":"Html Body"},"preheader":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Preheader"},"mode":{"type":"string","pattern":"^(test|subscribers|clients|all)$","title":"Mode"},"test_recipients":{"anyOf":[{"items":{"type":"string","format":"email"},"type":"array"},{"type":"null"}],"title":"Test Recipients"},"attachment_filename":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Attachment Filename"},"attachment_content_b64":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Attachment Content B64"},"scheduled_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scheduled At"}},"type":"object","required":["subject","html_body","mode"],"title":"SendRequest"},"SendRescindPackageRequest":{"properties":{"reason":{"type":"string","title":"Reason","default":"At the request of the claimant."},"waive_charge":{"type":"boolean","title":"Waive Charge","default":false},"waive_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Waive Reason"}},"type":"object","title":"SendRescindPackageRequest","description":"Request model for sending rescind packages via Lob"},"SendRetractionPackageRequest":{"properties":{"recipient_id":{"type":"string","title":"Recipient Id"},"custom_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Message"},"mail_type":{"type":"string","title":"Mail Type","default":"first_class"}},"type":"object","required":["recipient_id"],"title":"SendRetractionPackageRequest","description":"Request to send retraction package to mailing service"},"SendTemplateRequest":{"properties":{"template":{"type":"string","title":"Template"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Id"},"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"},"tracking_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracking Number"}},"type":"object","required":["template"],"title":"SendTemplateRequest"},"SendToClientBody":{"properties":{"to_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Email"},"note_to_client":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note To Client"}},"type":"object","title":"SendToClientBody"},"SendToReviewRequest":{"properties":{"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","title":"SendToReviewRequest"},"SendToServiceBody":{"properties":{"vendor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor"},"signer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signer Email"},"signer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signer Name"},"send_via_vendor_email":{"type":"boolean","title":"Send Via Vendor Email","default":true},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"type":"object","title":"SendToServiceBody"},"SetPasswordRequest":{"properties":{"token":{"type":"string","title":"Token"},"new_password":{"type":"string","title":"New Password"}},"type":"object","required":["token","new_password"],"title":"SetPasswordRequest"},"SettingsUpdate":{"properties":{"auto_request_threshold":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Auto Request Threshold"},"hold_grace_period_days":{"anyOf":[{"type":"integer","maximum":365.0,"minimum":0.0},{"type":"null"}],"title":"Hold Grace Period Days"},"default_service_level":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Service Level"},"default_mailing_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Mailing Class"}},"type":"object","title":"SettingsUpdate"},"SetupSessionRequest":{"properties":{"origin_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin Url"}},"type":"object","title":"SetupSessionRequest"},"SignatureUpdateRequest":{"properties":{"signature_html":{"type":"string","title":"Signature Html","default":""},"signature_logo_url":{"type":"string","title":"Signature Logo Url","default":""}},"type":"object","title":"SignatureUpdateRequest"},"StartRevisionRequest":{"properties":{"note":{"type":"string","title":"Note"}},"type":"object","required":["note"],"title":"StartRevisionRequest","description":"Request to start a revision on a completed order"},"StatementLineItem":{"properties":{"invoice_number":{"type":"string","title":"Invoice Number"},"invoice_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Date"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"amount":{"type":"number","title":"Amount"}},"type":"object","required":["invoice_number","amount"],"title":"StatementLineItem","description":"Individual line item on an account statement"},"StatusResponse":{"properties":{"connected":{"type":"boolean","title":"Connected"},"configured":{"type":"boolean","title":"Configured"},"env":{"type":"string","title":"Env"},"procore_user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Procore User Email"},"procore_company_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Procore Company Id"},"procore_company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Procore Company Name"},"installed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Installed At"},"scopes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scopes"},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expires At"}},"type":"object","required":["connected","configured","env"],"title":"StatusResponse"},"StopLeadRequest":{"properties":{"reason":{"type":"string","title":"Reason","default":"manually_removed"}},"type":"object","title":"StopLeadRequest"},"SubscribeRequest":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"first_name":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"First Name"},"source":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Source","default":"signup"}},"type":"object","required":["email"],"title":"SubscribeRequest"},"SubscriberUpdate":{"properties":{"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","title":"SubscriberUpdate"},"SuperAdminSetupRequest":{"properties":{"email":{"type":"string","title":"Email"},"password":{"type":"string","title":"Password"},"full_name":{"type":"string","title":"Full Name"},"setup_key":{"type":"string","title":"Setup Key"}},"type":"object","required":["email","password","full_name","setup_key"],"title":"SuperAdminSetupRequest","description":"One-time super admin setup request"},"TargetListCreate":{"properties":{"name":{"type":"string","minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"lead_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Lead Ids"},"filter_status":{"anyOf":[{"items":{"$ref":"#/components/schemas/LeadStatus"},"type":"array"},{"type":"null"}],"title":"Filter Status"},"filter_tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Filter Tags"},"filter_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter State"},"filter_never_emailed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Filter Never Emailed","default":false}},"type":"object","required":["name"],"title":"TargetListCreate"},"TargetListUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"lead_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Lead Ids"},"filter_status":{"anyOf":[{"items":{"$ref":"#/components/schemas/LeadStatus"},"type":"array"},{"type":"null"}],"title":"Filter Status"},"filter_tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Filter Tags"},"filter_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter State"},"filter_never_emailed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Filter Never Emailed"}},"type":"object","title":"TargetListUpdate"},"TermsVersionCreate":{"properties":{"version":{"type":"string","title":"Version","description":"Version identifier (e.g., '1.0', '2.0')"},"title":{"type":"string","title":"Title","default":"Terms and Conditions"},"content_html":{"type":"string","title":"Content Html","description":"HTML content of the terms"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"Brief summary of changes"},"effective_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Effective Date"}},"type":"object","required":["version","content_html"],"title":"TermsVersionCreate","description":"Create a new T&C version"},"TermsVersionUpdate":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"content_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Html"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"effective_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Effective Date"}},"type":"object","title":"TermsVersionUpdate","description":"Update T&C version (only before it's been accepted by anyone)"},"TestEmailRequest":{"properties":{"to_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Email"}},"type":"object","title":"TestEmailRequest"},"TexasBatchReleaseRequest":{"properties":{"notice_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notice Type"},"order_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Order Ids"}},"type":"object","title":"TexasBatchReleaseRequest","description":"Request to batch release Texas queue orders to Lob"},"TexasEarlyReleaseRequest":{"properties":{"order_id":{"type":"string","title":"Order Id"}},"type":"object","required":["order_id"],"title":"TexasEarlyReleaseRequest"},"TexasOrderCreate":{"properties":{"source_order_id":{"type":"string","title":"Source Order Id"},"notice_type":{"type":"string","title":"Notice Type"},"texas_work_month":{"type":"integer","title":"Texas Work Month"},"texas_work_year":{"type":"integer","title":"Texas Work Year"},"contracted_with":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contracted With"},"bond_info":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Bond Info"},"retainage_info":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Retainage Info"},"claim_info":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Claim Info"}},"type":"object","required":["source_order_id","notice_type","texas_work_month","texas_work_year"],"title":"TexasOrderCreate","description":"Create a Texas notice order (cloned from research-only order)"},"TexasQueueReleaseRequest":{"properties":{"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"}},"type":"object","title":"TexasQueueReleaseRequest","description":"Request to release Texas queue for a client"},"ThresholdSettingsPatch":{"properties":{"auto_request_threshold":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Auto Request Threshold"},"threshold_mode":{"anyOf":[{"type":"string","enum":["per_order","cumulative"]},{"type":"null"}],"title":"Threshold Mode"},"auto_promote_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Auto Promote Enabled"},"default_service_type":{"anyOf":[{"type":"string","enum":["full_service","self_service"]},{"type":"null"}],"title":"Default Service Type"}},"type":"object","title":"ThresholdSettingsPatch"},"ThresholdUpdate":{"properties":{"threshold_usd":{"type":"number","minimum":0.0,"title":"Threshold Usd"}},"type":"object","required":["threshold_usd"],"title":"ThresholdUpdate"},"Token":{"properties":{"access_token":{"type":"string","title":"Access Token"},"token_type":{"type":"string","title":"Token Type"},"user":{"additionalProperties":true,"type":"object","title":"User"}},"type":"object","required":["access_token","token_type","user"],"title":"Token"},"TrackingEntry":{"properties":{"recipient_name":{"type":"string","title":"Recipient Name"},"recipient_type":{"type":"string","title":"Recipient Type"},"tracking_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracking Number"},"tracking_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracking Status"},"carrier":{"type":"string","title":"Carrier","default":"USPS"},"mailed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mailed At"},"delivered_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Delivered At"},"last_updated":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Updated"}},"type":"object","required":["recipient_name","recipient_type"],"title":"TrackingEntry"},"TrackingResponse":{"properties":{"notice_id":{"type":"string","title":"Notice Id"},"work_order_number":{"type":"string","title":"Work Order Number"},"status":{"type":"string","title":"Status"},"sandbox":{"type":"boolean","title":"Sandbox"},"tracking":{"items":{"$ref":"#/components/schemas/TrackingEntry"},"type":"array","title":"Tracking"}},"type":"object","required":["notice_id","work_order_number","status","sandbox","tracking"],"title":"TrackingResponse"},"UnrushOrderRequest":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"supporting_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Supporting File Id"}},"type":"object","title":"UnrushOrderRequest","description":"Client-portal / admin request body for removing a rush flag.\n\nBoth `reason` and `supporting_file_id` are optional. When present,\nthey are recorded verbatim in the order's `activity_log` so we\nkeep a clear audit trail of who removed the rush and why."},"UnsuppressRequest":{"properties":{"emails":{"items":{"type":"string"},"type":"array","title":"Emails"},"reason":{"type":"string","title":"Reason","default":""},"also_clear_lead_unsubscribed":{"type":"boolean","title":"Also Clear Lead Unsubscribed","default":true},"expected_last_reason":{"type":"string","title":"Expected Last Reason","default":""}},"type":"object","required":["emails"],"title":"UnsuppressRequest"},"UpdateAmountBody":{"properties":{"amount_due":{"type":"number","minimum":0.0,"title":"Amount Due"},"service_type":{"anyOf":[{"type":"string","pattern":"^(full_service|self_service)$"},{"type":"null"}],"title":"Service Type"},"recipients":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Recipients"}},"type":"object","required":["amount_due"],"title":"UpdateAmountBody"},"UpdateBillingSettingsRequest":{"properties":{"billing_cycle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Cycle"},"credit_established":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Established"},"advanced_docs_prepay":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Advanced Docs Prepay"},"auto_invoice_email":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Auto Invoice Email"},"auto_invoice_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Auto Invoice Enabled"},"payment_terms_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Payment Terms Days"},"late_fee_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Late Fee Percentage"}},"type":"object","title":"UpdateBillingSettingsRequest"},"UpdateInvoiceRequest":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"line_items":{"anyOf":[{"items":{"$ref":"#/components/schemas/InvoiceLineItem"},"type":"array"},{"type":"null"}],"title":"Line Items"}},"type":"object","title":"UpdateInvoiceRequest"},"UpdateScheduleRequest":{"properties":{"email_schedule":{"items":{"$ref":"#/components/schemas/EmailScheduleItem"},"type":"array","title":"Email Schedule"}},"type":"object","required":["email_schedule"],"title":"UpdateScheduleRequest"},"UploadUrlRequest":{"properties":{"order_id":{"type":"string","title":"Order Id"},"filename":{"type":"string","title":"Filename"},"content_type":{"type":"string","title":"Content Type"},"file_size":{"type":"integer","title":"File Size"}},"type":"object","required":["order_id","filename","content_type","file_size"],"title":"UploadUrlRequest"},"UserLogin":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"password":{"type":"string","title":"Password"}},"type":"object","required":["email","password"],"title":"UserLogin"},"UserSettingsUpdate":{"properties":{"settings":{"additionalProperties":true,"type":"object","title":"Settings"}},"type":"object","required":["settings"],"title":"UserSettingsUpdate"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WaiverEmailRequest":{"properties":{"to_email":{"type":"string","title":"To Email"},"recipient_name":{"type":"string","title":"Recipient Name"},"waiver_type":{"type":"string","title":"Waiver Type"},"project_name":{"type":"string","title":"Project Name"},"project_address":{"type":"string","title":"Project Address"},"payment_amount":{"type":"number","title":"Payment Amount"},"pdf_base64":{"type":"string","title":"Pdf Base64"},"filename":{"type":"string","title":"Filename"},"custom_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Message"},"cc_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cc Emails"}},"type":"object","required":["to_email","recipient_name","waiver_type","project_name","project_address","payment_amount","pdf_base64","filename"],"title":"WaiverEmailRequest","description":"Request to send waiver via email"},"WaiverGenerateRequest":{"properties":{"waiver_type":{"type":"string","title":"Waiver Type"},"claimant_name":{"type":"string","title":"Claimant Name"},"claimant_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claimant Address"},"claimant_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claimant City"},"claimant_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claimant State","default":"FL"},"claimant_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claimant Zip"},"claimant_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claimant Phone"},"payment_amount":{"type":"number","title":"Payment Amount","default":0.0},"through_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Through Date"},"contractor_name":{"type":"string","title":"Contractor Name"},"owner_name":{"type":"string","title":"Owner Name"},"owner_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Address"},"owner_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner City"},"owner_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner State"},"owner_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Zip"},"project_name":{"type":"string","title":"Project Name"},"project_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Number"},"project_address":{"type":"string","title":"Project Address"},"project_city":{"type":"string","title":"Project City"},"project_state":{"type":"string","title":"Project State","default":"FL"},"project_county":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project County"},"property_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Description"},"permit_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permit Number"},"comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comments"},"signatory_name":{"type":"string","title":"Signatory Name"},"signatory_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signatory Title"},"include_notary":{"type":"boolean","title":"Include Notary","default":false},"payment_method":{"type":"string","title":"Payment Method","default":"check"},"check_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Check Number"},"check_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Check Date"},"amount_paid":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Paid"},"amount_billed_due":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Billed Due"},"amount_to_become_due":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount To Become Due"},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name"},"customer_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Address"}},"type":"object","required":["waiver_type","claimant_name","contractor_name","owner_name","project_name","project_address","project_city","signatory_name"],"title":"WaiverGenerateRequest"},"WaiverRequest":{"properties":{"waiver_type":{"type":"string","title":"Waiver Type"},"through_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Through Date"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount"},"check_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Check Number"},"maker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Maker"},"include_signature_line":{"type":"boolean","title":"Include Signature Line","default":true}},"type":"object","required":["waiver_type"],"title":"WaiverRequest","description":"Request model for generating a waiver"},"WebhookCreate":{"properties":{"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url"},"name":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Name"},"events":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Events"},"mode":{"type":"string","enum":["live","test","both"],"title":"Mode","default":"both"}},"type":"object","required":["url","events"],"title":"WebhookCreate"},"WebhookUpdate":{"properties":{"url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Url"},"name":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Name"},"events":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Events"},"mode":{"anyOf":[{"type":"string","enum":["live","test","both"]},{"type":"null"}],"title":"Mode"},"is_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Enabled"}},"type":"object","title":"WebhookUpdate"},"WebinarRegistrationRequest":{"properties":{"event_key":{"type":"string","title":"Event Key","default":"fl-liens-2026-09-17"},"full_name":{"type":"string","title":"Full Name"},"email":{"type":"string","format":"email","title":"Email"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"}},"type":"object","required":["full_name","email"],"title":"WebinarRegistrationRequest"},"WhoHiredThem":{"properties":{"company_name":{"type":"string","title":"Company Name"},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name"},"address":{"type":"string","title":"Address"},"city":{"type":"string","title":"City"},"state":{"type":"string","title":"State"},"zip_code":{"type":"string","title":"Zip Code"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"do_not_contact":{"type":"boolean","title":"Do Not Contact","default":false},"recipient_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Type"},"postage_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postage Type"}},"type":"object","required":["company_name","address","city","state","zip_code"],"title":"WhoHiredThem"},"ZapierHookSubscribe":{"properties":{"target_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Target Url","description":"Zapier-supplied hook URL"},"event":{"type":"string","title":"Event","description":"One of: ['notice.created', 'notice.held', 'notice.released', 'notice.mailed', 'notice.delivered', 'notice.returned', 'invoice.paid']"}},"type":"object","required":["target_url","event"],"title":"ZapierHookSubscribe"},"ZohoSettingsInput":{"properties":{"client_id":{"type":"string","title":"Client Id"},"client_secret":{"type":"string","title":"Client Secret"},"refresh_token":{"type":"string","title":"Refresh Token"},"organization_id":{"type":"string","title":"Organization Id"},"accounts_base_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounts Base Url","default":"https://accounts.zoho.com"},"api_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Domain","default":"https://www.zohoapis.com"},"enabled":{"type":"boolean","title":"Enabled","default":true},"postage_expense_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postage Expense Account Id"},"paid_through_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid Through Account Id"}},"type":"object","required":["client_id","client_secret","refresh_token","organization_id"],"title":"ZohoSettingsInput"},"models__signing_agent_models__SigningAgentCreate":{"properties":{"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"license_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Number"},"commission_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commission State"},"commission_expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commission Expiry"},"is_notary":{"type":"boolean","title":"Is Notary","default":false},"is_active":{"type":"boolean","title":"Is Active","default":true},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["name"],"title":"SigningAgentCreate"},"models__signing_agent_models__SigningAgentUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"license_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Number"},"commission_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commission State"},"commission_expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commission Expiry"},"is_notary":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Notary"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","title":"SigningAgentUpdate"},"models__user_models__StaffUserCreate":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"password":{"type":"string","title":"Password"},"full_name":{"type":"string","title":"Full Name"},"phone":{"type":"string","title":"Phone","default":""},"department":{"type":"string","title":"Department","default":""},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions","default":[]}},"type":"object","required":["email","password","full_name"],"title":"StaffUserCreate"},"models__user_models__StaffUserUpdate":{"properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Department"},"permissions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Permissions"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}},"type":"object","title":"StaffUserUpdate"},"models__user_models__UserCreate":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"password":{"type":"string","title":"Password"},"full_name":{"type":"string","title":"Full Name"},"company_name":{"type":"string","title":"Company Name","default":""},"company_address":{"type":"string","title":"Company Address","default":""},"company_city":{"type":"string","title":"Company City","default":""},"company_state":{"type":"string","title":"Company State","default":""},"company_zip":{"type":"string","title":"Company Zip","default":""},"phone":{"type":"string","title":"Phone","default":""},"work_description":{"type":"string","title":"Work Description","default":""},"role":{"type":"string","title":"Role","default":"master_client"},"is_high_volume":{"type":"boolean","title":"Is High Volume","default":false},"referral_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referral Source"},"referral_source_other":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referral Source Other"}},"type":"object","required":["email","password","full_name"],"title":"UserCreate"},"models__user_models__UserUpdate":{"properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"company_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Address"},"company_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company City"},"company_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company State"},"company_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Zip"},"work_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Description"},"is_high_volume":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is High Volume"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}},"type":"object","title":"UserUpdate"},"routes__admin_ai_support__ChatReq":{"properties":{"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id"},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"},"message":{"type":"string","maxLength":4000,"minLength":1,"title":"Message"}},"type":"object","required":["message"],"title":"ChatReq"},"routes__dev_assistant__ChatReq":{"properties":{"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id"},"message":{"type":"string","maxLength":500,"minLength":1,"title":"Message"},"integration_hint":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Integration Hint"}},"type":"object","required":["message"],"title":"ChatReq"},"routes__email__SendEmailRequest":{"properties":{"to_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Email"},"subject":{"type":"string","title":"Subject"},"message":{"type":"string","title":"Message"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Id"},"to_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"To Emails"},"cc_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cc Emails"},"body_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Html"},"attachment_file_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Attachment File Ids","description":"IDs from db.order_files to fetch from S3 and attach"}},"type":"object","required":["subject","message"],"title":"SendEmailRequest"},"routes__revisions__RevisionRequest":{"properties":{"reason":{"type":"string","title":"Reason"},"changes_requested":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Changes Requested"},"priority":{"type":"string","title":"Priority","default":"normal"}},"type":"object","required":["reason"],"title":"RevisionRequest","description":"Request model for requesting a revision"},"routes__staff__StaffUserCreate":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"password":{"type":"string","title":"Password"},"full_name":{"type":"string","title":"Full Name"},"phone":{"type":"string","title":"Phone","default":""},"department":{"type":"string","title":"Department","default":""},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions","default":[]},"role":{"type":"string","title":"Role","default":"staff"},"admin_permissions":{"items":{"type":"string"},"type":"array","title":"Admin Permissions","default":[]}},"type":"object","required":["email","password","full_name"],"title":"StaffUserCreate"},"routes__staff__StaffUserUpdate":{"properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Department"},"permissions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Permissions"},"admin_permissions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Admin Permissions"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}},"type":"object","title":"StaffUserUpdate"},"routes__texas__MassNotarizationRequest":{"properties":{"order_ids":{"items":{"type":"string"},"type":"array","title":"Order Ids"},"signer_email":{"type":"string","title":"Signer Email"},"signer_first_name":{"type":"string","title":"Signer First Name"},"signer_last_name":{"type":"string","title":"Signer Last Name"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","default":"Please review and sign these Sworn Statements"}},"type":"object","required":["order_ids","signer_email","signer_first_name","signer_last_name"],"title":"MassNotarizationRequest","description":"Request for mass notarization of bonded notices"},"server__MassNotarizationRequest":{"properties":{"order_ids":{"items":{"type":"string"},"type":"array","title":"Order Ids"},"signer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signer Email"},"signer_first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signer First Name"},"signer_last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signer Last Name"}},"type":"object","required":["order_ids"],"title":"MassNotarizationRequest","description":"Request to send multiple bonded notices for notarization"},"server__RevisionRequest":{"properties":{"revision_note":{"type":"string","title":"Revision Note"},"recipient_overrides":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Recipient Overrides"}},"type":"object","required":["revision_note"],"title":"RevisionRequest"},"server__SendEmailRequest":{"properties":{"to_email":{"type":"string","title":"To Email"},"subject":{"type":"string","title":"Subject"},"message":{"type":"string","title":"Message"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Id"}},"type":"object","required":["to_email","subject","message"],"title":"SendEmailRequest"},"server__SigningAgentCreate":{"properties":{"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip Code"},"license_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Number"},"commission_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commission State"},"commission_expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commission Expiry"},"is_notary":{"type":"boolean","title":"Is Notary","default":false},"is_active":{"type":"boolean","title":"Is Active","default":true},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"work_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Description"}},"type":"object","required":["name"],"title":"SigningAgentCreate"},"server__SigningAgentUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip Code"},"license_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Number"},"commission_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commission State"},"commission_expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commission Expiry"},"is_notary":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Notary"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"work_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Description"}},"type":"object","title":"SigningAgentUpdate"},"server__UserCreate":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"password":{"type":"string","title":"Password"},"full_name":{"type":"string","title":"Full Name"},"company_name":{"type":"string","title":"Company Name","default":""},"company_address":{"type":"string","title":"Company Address","default":""},"company_city":{"type":"string","title":"Company City","default":""},"company_state":{"type":"string","title":"Company State","default":""},"company_zip":{"type":"string","title":"Company Zip","default":""},"phone":{"type":"string","title":"Phone","default":""},"work_description":{"type":"string","title":"Work Description","default":""},"role":{"type":"string","title":"Role","default":"master_client"},"is_high_volume":{"type":"boolean","title":"Is High Volume","default":false},"referral_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referral Source"},"referral_source_other":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referral Source Other"},"terms_accepted":{"type":"boolean","title":"Terms Accepted","default":false}},"type":"object","required":["email","password","full_name"],"title":"UserCreate"},"server__UserUpdate":{"properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"company_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Address"},"company_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company City"},"company_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company State"},"company_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Zip"},"work_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Description"},"is_high_volume":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is High Volume"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"},"cc_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cc Emails"},"signing_agents":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Signing Agents"}},"type":"object","title":"UserUpdate"}},"securitySchemes":{"BearerApiKey":{"type":"http","scheme":"bearer","bearerFormat":"AAN API key (aan_live_* or aan_test_*)"}}},"servers":[{"url":"https://allamericannotice.com","description":"Production"}],"security":[{"BearerApiKey":[]}]}